From 73e97187ff5f33e9c868e623db97462bda3d75b1 Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Tue, 16 Jul 2024 08:22:20 -0500 Subject: [PATCH 01/42] Use nullable reference types and datetimeoffset --- ShipEngineSDK/Api/BatchesApi.cs | 8 +++---- ShipEngineSDK/Api/DownloadsApi.cs | 8 +++---- ShipEngineSDK/Api/LabelsApi.cs | 8 +++---- ShipEngineSDK/Api/ManifestsApi.cs | 8 +++---- ShipEngineSDK/Api/PackagePickupsApi.cs | 8 +++---- ShipEngineSDK/Api/ShipmentsApi.cs | 16 ++++++------- ShipEngineSDK/Api/TrackingApi.cs | 24 +++++++++---------- ShipEngineSDK/Model/AccountSettingsImages.cs | 4 ++-- .../Model/AddressValidatingShipment.cs | 6 ++--- ShipEngineSDK/Model/Batch.cs | 4 ++-- ShipEngineSDK/Model/BulkRate.cs | 2 +- .../Model/CalculateRatesResponseBody.cs | 6 ++--- .../CreateAccountSettingsImageRequestBody.cs | 4 ++-- ...AndProcessBatchRequestBodyProcessLabels.cs | 2 +- .../Model/CreateAndValidateShipment.cs | 6 ++--- .../Model/CreateBatchResponseBody.cs | 4 ++-- .../Model/CreateLabelFromRateResponseBody.cs | 6 ++--- .../CreateLabelFromShipmentResponseBody.cs | 6 ++--- ShipEngineSDK/Model/CreateLabelRequestBody.cs | 6 ++--- .../Model/CreateLabelResponseBody.cs | 6 ++--- .../CreateManifestByObjectRequestBody.cs | 2 +- .../Model/CreateManifestResponseBody.cs | 4 ++-- .../Model/CreateReturnLabelResponseBody.cs | 6 ++--- .../Model/CreateWarehouseRequestBody.cs | 2 +- .../Model/CreateWarehouseResponseBody.cs | 2 +- ShipEngineSDK/Model/DeprecatedManifest.cs | 4 ++-- .../Model/EstimateRatesRequestBody.cs | 4 ++-- .../GetAccountSettingsImagesResponseBody.cs | 4 ++-- .../Model/GetBatchByExternalIdResponseBody.cs | 4 ++-- .../Model/GetBatchByIdResponseBody.cs | 4 ++-- ...etLabelByExternalShipmentIdResponseBody.cs | 6 ++--- .../Model/GetLabelByIdResponseBody.cs | 6 ++--- .../Model/GetManifestByIdResponseBody.cs | 4 ++-- .../Model/GetPickupByIdResponseBody.cs | 4 ++-- .../Model/GetRateByIdResponseBody.cs | 4 ++-- .../GetShipmentByExternalIdResponseBody.cs | 6 ++--- .../Model/GetShipmentByIdResponseBody.cs | 6 ++--- .../GetTrackingLogFromLabelResponseBody.cs | 6 ++--- .../Model/GetTrackingLogResponseBody.cs | 6 ++--- .../Model/GetWarehouseByIdResponseBody.cs | 2 +- ShipEngineSDK/Model/Label.cs | 6 ++--- .../Model/ListAccountImagesResponseBody.cs | 4 ++-- .../ListAccountSettingsImagesResponseBody.cs | 4 ++-- ShipEngineSDK/Model/ListLabelsResponseBody.cs | 6 ++--- ShipEngineSDK/Model/Manifest.cs | 4 ++-- ShipEngineSDK/Model/PartialShipment.cs | 6 ++--- ShipEngineSDK/Model/Pickup.cs | 4 ++-- ShipEngineSDK/Model/PickupResponseBody.cs | 4 ++-- ShipEngineSDK/Model/PickupWindow.cs | 4 ++-- ShipEngineSDK/Model/PickupWindows.cs | 4 ++-- .../Model/ProcessBatchRequestBody.cs | 2 +- ShipEngineSDK/Model/Rate.cs | 4 ++-- ShipEngineSDK/Model/RateEstimate.cs | 4 ++-- ShipEngineSDK/Model/RateEstimateOptions.cs | 2 +- .../Model/SchedulePickupRequestBody.cs | 4 ++-- .../Model/SchedulePickupResponseBody.cs | 4 ++-- ShipEngineSDK/Model/Shipment.cs | 6 ++--- ShipEngineSDK/Model/TrackEvent.cs | 4 ++-- ShipEngineSDK/Model/TrackingInformation.cs | 6 ++--- .../UpdateAccountSettingsImageRequestBody.cs | 4 ++-- .../Model/UpdateShipmentRequestBody.cs | 6 ++--- .../Model/UpdateShipmentResponseBody.cs | 6 ++--- .../Model/UpdateWarehouseRequestBody.cs | 2 +- ShipEngineSDK/Model/UpsInvoice.cs | 2 +- ShipEngineSDK/Model/Warehouse.cs | 2 +- openapitools.json | 4 +++- 66 files changed, 169 insertions(+), 167 deletions(-) diff --git a/ShipEngineSDK/Api/BatchesApi.cs b/ShipEngineSDK/Api/BatchesApi.cs index b5d49c22..40fe8a35 100644 --- a/ShipEngineSDK/Api/BatchesApi.cs +++ b/ShipEngineSDK/Api/BatchesApi.cs @@ -171,7 +171,7 @@ public partial interface IShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchesResponseBody) - Task ListBatches(BatchStatus? status, int? page, int? pageSize, SortDir? sortDir, string batchNumber, BatchesSortBy? sortBy, CancellationToken cancellationToken = default); + Task ListBatches(BatchStatus? status, int? page, int? pageSize, SortDir? sortDir, string? batchNumber, BatchesSortBy? sortBy, CancellationToken cancellationToken = default); /// /// List Batches List Batches associated with your Shipengine account @@ -187,7 +187,7 @@ public partial interface IShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchesResponseBody) - Task ListBatches(HttpClient methodClient, BatchStatus? status, int? page, int? pageSize, SortDir? sortDir, string batchNumber, BatchesSortBy? sortBy, CancellationToken cancellationToken = default); + Task ListBatches(HttpClient methodClient, BatchStatus? status, int? page, int? pageSize, SortDir? sortDir, string? batchNumber, BatchesSortBy? sortBy, CancellationToken cancellationToken = default); /// /// Process Batch ID Labels Process Batch ID Labels @@ -549,7 +549,7 @@ public async Task ListBatchErrors(HttpClient method /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchesResponseBody) - public Task ListBatches(BatchStatus? status = default, int? page = default, int? pageSize = default, SortDir? sortDir = default, string batchNumber = default, BatchesSortBy? sortBy = default, CancellationToken cancellationToken = default) + public Task ListBatches(BatchStatus? status = default, int? page = default, int? pageSize = default, SortDir? sortDir = default, string? batchNumber = default, BatchesSortBy? sortBy = default, CancellationToken cancellationToken = default) { return ListBatches(_client, status, page, pageSize, sortDir, batchNumber, sortBy, cancellationToken); } @@ -568,7 +568,7 @@ public Task ListBatches(BatchStatus? status = default, /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchesResponseBody) - public async Task ListBatches(HttpClient methodClient, BatchStatus? status = default, int? page = default, int? pageSize = default, SortDir? sortDir = default, string batchNumber = default, BatchesSortBy? sortBy = default, CancellationToken cancellationToken = default) + public async Task ListBatches(HttpClient methodClient, BatchStatus? status = default, int? page = default, int? pageSize = default, SortDir? sortDir = default, string? batchNumber = default, BatchesSortBy? sortBy = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/batches"); diff --git a/ShipEngineSDK/Api/DownloadsApi.cs b/ShipEngineSDK/Api/DownloadsApi.cs index 6c24cf09..b200c5cc 100644 --- a/ShipEngineSDK/Api/DownloadsApi.cs +++ b/ShipEngineSDK/Api/DownloadsApi.cs @@ -38,7 +38,7 @@ public partial interface IShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (System.IO.Stream) - Task DownloadFile(string subdir, string filename, string dir, string download, int? rotation, CancellationToken cancellationToken = default); + Task DownloadFile(string subdir, string filename, string dir, string? download, int? rotation, CancellationToken cancellationToken = default); /// /// Download File Get File @@ -53,7 +53,7 @@ public partial interface IShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (System.IO.Stream) - Task DownloadFile(HttpClient methodClient, string subdir, string filename, string dir, string download, int? rotation, CancellationToken cancellationToken = default); + Task DownloadFile(HttpClient methodClient, string subdir, string filename, string dir, string? download, int? rotation, CancellationToken cancellationToken = default); } @@ -74,7 +74,7 @@ public partial class ShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (System.IO.Stream) - public Task DownloadFile(string subdir, string filename, string dir, string download = default, int? rotation = default, CancellationToken cancellationToken = default) + public Task DownloadFile(string subdir, string filename, string dir, string? download = default, int? rotation = default, CancellationToken cancellationToken = default) { return DownloadFile(_client, subdir, filename, dir, download, rotation, cancellationToken); } @@ -92,7 +92,7 @@ public partial class ShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (System.IO.Stream) - public async Task DownloadFile(HttpClient methodClient, string subdir, string filename, string dir, string download = default, int? rotation = default, CancellationToken cancellationToken = default) + public async Task DownloadFile(HttpClient methodClient, string subdir, string filename, string dir, string? download = default, int? rotation = default, CancellationToken cancellationToken = default) { // verify the required parameter 'subdir' is set if (subdir == null) diff --git a/ShipEngineSDK/Api/LabelsApi.cs b/ShipEngineSDK/Api/LabelsApi.cs index 59a7cd78..5610ca2c 100644 --- a/ShipEngineSDK/Api/LabelsApi.cs +++ b/ShipEngineSDK/Api/LabelsApi.cs @@ -204,7 +204,7 @@ public partial interface IShipEngine /// Controls which field the query is sorted by. (optional, default to created_at) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListLabelsResponseBody) - Task ListLabels(LabelStatus? labelStatus, string serviceCode, string carrierId, string trackingNumber, string batchId, string rateId, string shipmentId, string warehouseId, DateTime? createdAtStart, DateTime? createdAtEnd, int? page, int? pageSize, SortDir? sortDir, string sortBy, CancellationToken cancellationToken = default); + Task ListLabels(LabelStatus? labelStatus, string? serviceCode, string? carrierId, string? trackingNumber, string? batchId, string? rateId, string? shipmentId, string? warehouseId, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, int? page, int? pageSize, SortDir? sortDir, string? sortBy, CancellationToken cancellationToken = default); /// /// List labels This endpoint returns a list of labels that you've [created](https://www.shipengine.com/docs/labels/create-a-label/). You can optionally filter the results as well as control their sort order and the number of results returned at a time. By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want to get your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id` @@ -228,7 +228,7 @@ public partial interface IShipEngine /// Controls which field the query is sorted by. (optional, default to created_at) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListLabelsResponseBody) - Task ListLabels(HttpClient methodClient, LabelStatus? labelStatus, string serviceCode, string carrierId, string trackingNumber, string batchId, string rateId, string shipmentId, string warehouseId, DateTime? createdAtStart, DateTime? createdAtEnd, int? page, int? pageSize, SortDir? sortDir, string sortBy, CancellationToken cancellationToken = default); + Task ListLabels(HttpClient methodClient, LabelStatus? labelStatus, string? serviceCode, string? carrierId, string? trackingNumber, string? batchId, string? rateId, string? shipmentId, string? warehouseId, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, int? page, int? pageSize, SortDir? sortDir, string? sortBy, CancellationToken cancellationToken = default); /// /// Void a Label By ID Void a label by ID to get a refund. @@ -612,7 +612,7 @@ public async Task GetTrackingLogFromLabel(H /// Controls which field the query is sorted by. (optional, default to created_at) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListLabelsResponseBody) - public Task ListLabels(LabelStatus? labelStatus = default, string serviceCode = default, string carrierId = default, string trackingNumber = default, string batchId = default, string rateId = default, string shipmentId = default, string warehouseId = default, DateTime? createdAtStart = default, DateTime? createdAtEnd = default, int? page = default, int? pageSize = default, SortDir? sortDir = default, string sortBy = default, CancellationToken cancellationToken = default) + public Task ListLabels(LabelStatus? labelStatus = default, string? serviceCode = default, string? carrierId = default, string? trackingNumber = default, string? batchId = default, string? rateId = default, string? shipmentId = default, string? warehouseId = default, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, int? page = default, int? pageSize = default, SortDir? sortDir = default, string? sortBy = default, CancellationToken cancellationToken = default) { return ListLabels(_client, labelStatus, serviceCode, carrierId, trackingNumber, batchId, rateId, shipmentId, warehouseId, createdAtStart, createdAtEnd, page, pageSize, sortDir, sortBy, cancellationToken); } @@ -639,7 +639,7 @@ public Task ListLabels(LabelStatus? labelStatus = defaul /// Controls which field the query is sorted by. (optional, default to created_at) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListLabelsResponseBody) - public async Task ListLabels(HttpClient methodClient, LabelStatus? labelStatus = default, string serviceCode = default, string carrierId = default, string trackingNumber = default, string batchId = default, string rateId = default, string shipmentId = default, string warehouseId = default, DateTime? createdAtStart = default, DateTime? createdAtEnd = default, int? page = default, int? pageSize = default, SortDir? sortDir = default, string sortBy = default, CancellationToken cancellationToken = default) + public async Task ListLabels(HttpClient methodClient, LabelStatus? labelStatus = default, string? serviceCode = default, string? carrierId = default, string? trackingNumber = default, string? batchId = default, string? rateId = default, string? shipmentId = default, string? warehouseId = default, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, int? page = default, int? pageSize = default, SortDir? sortDir = default, string? sortBy = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/labels"); diff --git a/ShipEngineSDK/Api/ManifestsApi.cs b/ShipEngineSDK/Api/ManifestsApi.cs index 4ff1c6f9..155f56f0 100644 --- a/ShipEngineSDK/Api/ManifestsApi.cs +++ b/ShipEngineSDK/Api/ManifestsApi.cs @@ -105,7 +105,7 @@ public partial interface IShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListManifestsResponseBody) - Task ListManifests(string warehouseId, DateTime? shipDateStart, DateTime? shipDateEnd, DateTime? createdAtStart, DateTime? createdAtEnd, string carrierId, int? page, int? pageSize, List labelIds, CancellationToken cancellationToken = default); + Task ListManifests(string? warehouseId, DateTimeOffset? shipDateStart, DateTimeOffset? shipDateEnd, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, string? carrierId, int? page, int? pageSize, List? labelIds, CancellationToken cancellationToken = default); /// /// List Manifests Similar to querying shipments, we allow you to query manifests since there will likely be a large number over a long period of time. @@ -124,7 +124,7 @@ public partial interface IShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListManifestsResponseBody) - Task ListManifests(HttpClient methodClient, string warehouseId, DateTime? shipDateStart, DateTime? shipDateEnd, DateTime? createdAtStart, DateTime? createdAtEnd, string carrierId, int? page, int? pageSize, List labelIds, CancellationToken cancellationToken = default); + Task ListManifests(HttpClient methodClient, string? warehouseId, DateTimeOffset? shipDateStart, DateTimeOffset? shipDateEnd, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, string? carrierId, int? page, int? pageSize, List? labelIds, CancellationToken cancellationToken = default); } @@ -275,7 +275,7 @@ public async Task GetManifestRequestById(HttpClient /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListManifestsResponseBody) - public Task ListManifests(string warehouseId = default, DateTime? shipDateStart = default, DateTime? shipDateEnd = default, DateTime? createdAtStart = default, DateTime? createdAtEnd = default, string carrierId = default, int? page = default, int? pageSize = default, List labelIds = default, CancellationToken cancellationToken = default) + public Task ListManifests(string? warehouseId = default, DateTimeOffset? shipDateStart = default, DateTimeOffset? shipDateEnd = default, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, string? carrierId = default, int? page = default, int? pageSize = default, List? labelIds = default, CancellationToken cancellationToken = default) { return ListManifests(_client, warehouseId, shipDateStart, shipDateEnd, createdAtStart, createdAtEnd, carrierId, page, pageSize, labelIds, cancellationToken); } @@ -297,7 +297,7 @@ public Task ListManifests(string warehouseId = defaul /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListManifestsResponseBody) - public async Task ListManifests(HttpClient methodClient, string warehouseId = default, DateTime? shipDateStart = default, DateTime? shipDateEnd = default, DateTime? createdAtStart = default, DateTime? createdAtEnd = default, string carrierId = default, int? page = default, int? pageSize = default, List labelIds = default, CancellationToken cancellationToken = default) + public async Task ListManifests(HttpClient methodClient, string? warehouseId = default, DateTimeOffset? shipDateStart = default, DateTimeOffset? shipDateEnd = default, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, string? carrierId = default, int? page = default, int? pageSize = default, List? labelIds = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/manifests"); diff --git a/ShipEngineSDK/Api/PackagePickupsApi.cs b/ShipEngineSDK/Api/PackagePickupsApi.cs index 5e3baf49..6265ac0e 100644 --- a/ShipEngineSDK/Api/PackagePickupsApi.cs +++ b/ShipEngineSDK/Api/PackagePickupsApi.cs @@ -81,7 +81,7 @@ public partial interface IShipEngine /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetPickupsResponseBody) - Task ListScheduledPickups(string carrierId, string warehouseId, DateTime? createdAtStart, DateTime? createdAtEnd, int? page, int? pageSize, CancellationToken cancellationToken = default); + Task ListScheduledPickups(string? carrierId, string? warehouseId, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, int? page, int? pageSize, CancellationToken cancellationToken = default); /// /// List Scheduled Pickups List all pickups that have been scheduled for this carrier @@ -97,7 +97,7 @@ public partial interface IShipEngine /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetPickupsResponseBody) - Task ListScheduledPickups(HttpClient methodClient, string carrierId, string warehouseId, DateTime? createdAtStart, DateTime? createdAtEnd, int? page, int? pageSize, CancellationToken cancellationToken = default); + Task ListScheduledPickups(HttpClient methodClient, string? carrierId, string? warehouseId, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, int? page, int? pageSize, CancellationToken cancellationToken = default); /// /// Schedule a Pickup Schedule a package pickup with a carrier @@ -224,7 +224,7 @@ public async Task GetPickupById(HttpClient methodClie /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetPickupsResponseBody) - public Task ListScheduledPickups(string carrierId = default, string warehouseId = default, DateTime? createdAtStart = default, DateTime? createdAtEnd = default, int? page = default, int? pageSize = default, CancellationToken cancellationToken = default) + public Task ListScheduledPickups(string? carrierId = default, string? warehouseId = default, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, int? page = default, int? pageSize = default, CancellationToken cancellationToken = default) { return ListScheduledPickups(_client, carrierId, warehouseId, createdAtStart, createdAtEnd, page, pageSize, cancellationToken); } @@ -243,7 +243,7 @@ public Task ListScheduledPickups(string carrierId = defa /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetPickupsResponseBody) - public async Task ListScheduledPickups(HttpClient methodClient, string carrierId = default, string warehouseId = default, DateTime? createdAtStart = default, DateTime? createdAtEnd = default, int? page = default, int? pageSize = default, CancellationToken cancellationToken = default) + public async Task ListScheduledPickups(HttpClient methodClient, string? carrierId = default, string? warehouseId = default, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, int? page = default, int? pageSize = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/pickups"); diff --git a/ShipEngineSDK/Api/ShipmentsApi.cs b/ShipEngineSDK/Api/ShipmentsApi.cs index 4bfb4094..1dba8b32 100644 --- a/ShipEngineSDK/Api/ShipmentsApi.cs +++ b/ShipEngineSDK/Api/ShipmentsApi.cs @@ -119,7 +119,7 @@ public partial interface IShipEngine /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentRatesResponseBody) - Task ListShipmentRates(string shipmentId, DateTime? createdAtStart, CancellationToken cancellationToken = default); + Task ListShipmentRates(string shipmentId, DateTimeOffset? createdAtStart, CancellationToken cancellationToken = default); /// /// Get Shipment Rates Get Rates for the shipment information associated with the shipment ID @@ -131,7 +131,7 @@ public partial interface IShipEngine /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentRatesResponseBody) - Task ListShipmentRates(HttpClient methodClient, string shipmentId, DateTime? createdAtStart, CancellationToken cancellationToken = default); + Task ListShipmentRates(HttpClient methodClient, string shipmentId, DateTimeOffset? createdAtStart, CancellationToken cancellationToken = default); /// /// List Shipments Get list of Shipments @@ -152,7 +152,7 @@ public partial interface IShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentsResponseBody) - Task ListShipments(ShipmentStatus? shipmentStatus, string batchId, string tag, DateTime? createdAtStart, DateTime? createdAtEnd, DateTime? modifiedAtStart, DateTime? modifiedAtEnd, int? page, int? pageSize, string salesOrderId, SortDir? sortDir, ShipmentsSortBy? sortBy, CancellationToken cancellationToken = default); + Task ListShipments(ShipmentStatus? shipmentStatus, string? batchId, string? tag, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, DateTimeOffset? modifiedAtStart, DateTimeOffset? modifiedAtEnd, int? page, int? pageSize, string? salesOrderId, SortDir? sortDir, ShipmentsSortBy? sortBy, CancellationToken cancellationToken = default); /// /// List Shipments Get list of Shipments @@ -174,7 +174,7 @@ public partial interface IShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentsResponseBody) - Task ListShipments(HttpClient methodClient, ShipmentStatus? shipmentStatus, string batchId, string tag, DateTime? createdAtStart, DateTime? createdAtEnd, DateTime? modifiedAtStart, DateTime? modifiedAtEnd, int? page, int? pageSize, string salesOrderId, SortDir? sortDir, ShipmentsSortBy? sortBy, CancellationToken cancellationToken = default); + Task ListShipments(HttpClient methodClient, ShipmentStatus? shipmentStatus, string? batchId, string? tag, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, DateTimeOffset? modifiedAtStart, DateTimeOffset? modifiedAtEnd, int? page, int? pageSize, string? salesOrderId, SortDir? sortDir, ShipmentsSortBy? sortBy, CancellationToken cancellationToken = default); /// /// Parse shipping info The shipment-recognition API makes it easy for you to extract shipping data from unstructured text, including people's names, addresses, package weights and dimensions, insurance and delivery requirements, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's shipment-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed shipment data is returned in the same structure that's used for other ShipEngine APIs, so you can easily use the parsed data to create a shipping label. > **Note:** Shipment recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland. @@ -492,7 +492,7 @@ public async Task GetShipmentById(HttpClient method /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentRatesResponseBody) - public Task ListShipmentRates(string shipmentId, DateTime? createdAtStart = default, CancellationToken cancellationToken = default) + public Task ListShipmentRates(string shipmentId, DateTimeOffset? createdAtStart = default, CancellationToken cancellationToken = default) { return ListShipmentRates(_client, shipmentId, createdAtStart, cancellationToken); } @@ -507,7 +507,7 @@ public Task ListShipmentRates(string shipmentId, /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentRatesResponseBody) - public async Task ListShipmentRates(HttpClient methodClient, string shipmentId, DateTime? createdAtStart = default, CancellationToken cancellationToken = default) + public async Task ListShipmentRates(HttpClient methodClient, string shipmentId, DateTimeOffset? createdAtStart = default, CancellationToken cancellationToken = default) { // verify the required parameter 'shipmentId' is set if (shipmentId == null) @@ -550,7 +550,7 @@ public async Task ListShipmentRates(HttpClient me /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentsResponseBody) - public Task ListShipments(ShipmentStatus? shipmentStatus = default, string batchId = default, string tag = default, DateTime? createdAtStart = default, DateTime? createdAtEnd = default, DateTime? modifiedAtStart = default, DateTime? modifiedAtEnd = default, int? page = default, int? pageSize = default, string salesOrderId = default, SortDir? sortDir = default, ShipmentsSortBy? sortBy = default, CancellationToken cancellationToken = default) + public Task ListShipments(ShipmentStatus? shipmentStatus = default, string? batchId = default, string? tag = default, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, DateTimeOffset? modifiedAtStart = default, DateTimeOffset? modifiedAtEnd = default, int? page = default, int? pageSize = default, string? salesOrderId = default, SortDir? sortDir = default, ShipmentsSortBy? sortBy = default, CancellationToken cancellationToken = default) { return ListShipments(_client, shipmentStatus, batchId, tag, createdAtStart, createdAtEnd, modifiedAtStart, modifiedAtEnd, page, pageSize, salesOrderId, sortDir, sortBy, cancellationToken); } @@ -575,7 +575,7 @@ public Task ListShipments(ShipmentStatus? shipmentSta /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentsResponseBody) - public async Task ListShipments(HttpClient methodClient, ShipmentStatus? shipmentStatus = default, string batchId = default, string tag = default, DateTime? createdAtStart = default, DateTime? createdAtEnd = default, DateTime? modifiedAtStart = default, DateTime? modifiedAtEnd = default, int? page = default, int? pageSize = default, string salesOrderId = default, SortDir? sortDir = default, ShipmentsSortBy? sortBy = default, CancellationToken cancellationToken = default) + public async Task ListShipments(HttpClient methodClient, ShipmentStatus? shipmentStatus = default, string? batchId = default, string? tag = default, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, DateTimeOffset? modifiedAtStart = default, DateTimeOffset? modifiedAtEnd = default, int? page = default, int? pageSize = default, string? salesOrderId = default, SortDir? sortDir = default, ShipmentsSortBy? sortBy = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/shipments"); diff --git a/ShipEngineSDK/Api/TrackingApi.cs b/ShipEngineSDK/Api/TrackingApi.cs index c3e211e4..b788627b 100644 --- a/ShipEngineSDK/Api/TrackingApi.cs +++ b/ShipEngineSDK/Api/TrackingApi.cs @@ -35,7 +35,7 @@ public partial interface IShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetTrackingLogResponseBody) - Task GetTrackingLog(string carrierCode, string trackingNumber, CancellationToken cancellationToken = default); + Task GetTrackingLog(string? carrierCode, string? trackingNumber, CancellationToken cancellationToken = default); /// /// Get Tracking Information Retrieve package tracking information @@ -47,7 +47,7 @@ public partial interface IShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetTrackingLogResponseBody) - Task GetTrackingLog(HttpClient methodClient, string carrierCode, string trackingNumber, CancellationToken cancellationToken = default); + Task GetTrackingLog(HttpClient methodClient, string? carrierCode, string? trackingNumber, CancellationToken cancellationToken = default); /// /// Start Tracking a Package Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package, and receive notifications via webhooks whenever the shipping status changes. @@ -58,7 +58,7 @@ public partial interface IShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task StartTracking(string carrierCode, string trackingNumber, CancellationToken cancellationToken = default); + Task StartTracking(string? carrierCode, string? trackingNumber, CancellationToken cancellationToken = default); /// /// Start Tracking a Package Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package, and receive notifications via webhooks whenever the shipping status changes. @@ -70,7 +70,7 @@ public partial interface IShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task StartTracking(HttpClient methodClient, string carrierCode, string trackingNumber, CancellationToken cancellationToken = default); + Task StartTracking(HttpClient methodClient, string? carrierCode, string? trackingNumber, CancellationToken cancellationToken = default); /// /// Stop Tracking a Package Unsubscribe from tracking updates for a package. @@ -81,7 +81,7 @@ public partial interface IShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task StopTracking(string carrierCode, string trackingNumber, CancellationToken cancellationToken = default); + Task StopTracking(string? carrierCode, string? trackingNumber, CancellationToken cancellationToken = default); /// /// Stop Tracking a Package Unsubscribe from tracking updates for a package. @@ -93,7 +93,7 @@ public partial interface IShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task StopTracking(HttpClient methodClient, string carrierCode, string trackingNumber, CancellationToken cancellationToken = default); + Task StopTracking(HttpClient methodClient, string? carrierCode, string? trackingNumber, CancellationToken cancellationToken = default); } @@ -111,7 +111,7 @@ public partial class ShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetTrackingLogResponseBody) - public Task GetTrackingLog(string carrierCode = default, string trackingNumber = default, CancellationToken cancellationToken = default) + public Task GetTrackingLog(string? carrierCode = default, string? trackingNumber = default, CancellationToken cancellationToken = default) { return GetTrackingLog(_client, carrierCode, trackingNumber, cancellationToken); } @@ -126,7 +126,7 @@ public Task GetTrackingLog(string carrierCode = defa /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetTrackingLogResponseBody) - public async Task GetTrackingLog(HttpClient methodClient, string carrierCode = default, string trackingNumber = default, CancellationToken cancellationToken = default) + public async Task GetTrackingLog(HttpClient methodClient, string? carrierCode = default, string? trackingNumber = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/tracking"); @@ -156,7 +156,7 @@ public async Task GetTrackingLog(HttpClient methodCl /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public Task StartTracking(string carrierCode = default, string trackingNumber = default, CancellationToken cancellationToken = default) + public Task StartTracking(string? carrierCode = default, string? trackingNumber = default, CancellationToken cancellationToken = default) { return StartTracking(_client, carrierCode, trackingNumber, cancellationToken); } @@ -171,7 +171,7 @@ public Task StartTracking(string carrierCode = default, string trackingN /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public async Task StartTracking(HttpClient methodClient, string carrierCode = default, string trackingNumber = default, CancellationToken cancellationToken = default) + public async Task StartTracking(HttpClient methodClient, string? carrierCode = default, string? trackingNumber = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/tracking/start"); @@ -201,7 +201,7 @@ public async Task StartTracking(HttpClient methodClient, string carrierC /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public Task StopTracking(string carrierCode = default, string trackingNumber = default, CancellationToken cancellationToken = default) + public Task StopTracking(string? carrierCode = default, string? trackingNumber = default, CancellationToken cancellationToken = default) { return StopTracking(_client, carrierCode, trackingNumber, cancellationToken); } @@ -216,7 +216,7 @@ public Task StopTracking(string carrierCode = default, string trackingNu /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public async Task StopTracking(HttpClient methodClient, string carrierCode = default, string trackingNumber = default, CancellationToken cancellationToken = default) + public async Task StopTracking(HttpClient methodClient, string? carrierCode = default, string? trackingNumber = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/tracking/stop"); diff --git a/ShipEngineSDK/Model/AccountSettingsImages.cs b/ShipEngineSDK/Model/AccountSettingsImages.cs index 6c450d6c..05054427 100644 --- a/ShipEngineSDK/Model/AccountSettingsImages.cs +++ b/ShipEngineSDK/Model/AccountSettingsImages.cs @@ -128,7 +128,7 @@ public override bool CanConvert(Type typeToConvert) => /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the image was modified in ShipEngine. @@ -138,7 +138,7 @@ public override bool CanConvert(Type typeToConvert) => /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at")] - public DateTime ModifiedAt { get; set; } + public DateTimeOffset ModifiedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/AddressValidatingShipment.cs b/ShipEngineSDK/Model/AddressValidatingShipment.cs index f0e11f7c..0b9e6e1c 100644 --- a/ShipEngineSDK/Model/AddressValidatingShipment.cs +++ b/ShipEngineSDK/Model/AddressValidatingShipment.cs @@ -141,7 +141,7 @@ public partial class AddressValidatingShipment /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The date and time that the shipment was created in ShipEngine. @@ -151,7 +151,7 @@ public partial class AddressValidatingShipment /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the shipment was created or last modified. @@ -161,7 +161,7 @@ public partial class AddressValidatingShipment /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at")] - public DateTime ModifiedAt { get; set; } + public DateTimeOffset ModifiedAt { get; set; } /// /// The recipient's mailing address diff --git a/ShipEngineSDK/Model/Batch.cs b/ShipEngineSDK/Model/Batch.cs index 8195e9b3..e5b186c1 100644 --- a/ShipEngineSDK/Model/Batch.cs +++ b/ShipEngineSDK/Model/Batch.cs @@ -100,7 +100,7 @@ public partial class Batch /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time the batch was processed in ShipEngine @@ -111,7 +111,7 @@ public partial class Batch /// [JsonPropertyName("processed_at")] [JsonRequired] - public DateTime ProcessedAt { get; set; } + public DateTimeOffset ProcessedAt { get; set; } /// /// The number of errors that occurred while generating the batch diff --git a/ShipEngineSDK/Model/BulkRate.cs b/ShipEngineSDK/Model/BulkRate.cs index 12f62922..0cbd0297 100644 --- a/ShipEngineSDK/Model/BulkRate.cs +++ b/ShipEngineSDK/Model/BulkRate.cs @@ -67,7 +67,7 @@ public partial class BulkRate /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// An array of errors that were returned while retrieving the bulk rate diff --git a/ShipEngineSDK/Model/CalculateRatesResponseBody.cs b/ShipEngineSDK/Model/CalculateRatesResponseBody.cs index bb5f107f..fc801a3b 100644 --- a/ShipEngineSDK/Model/CalculateRatesResponseBody.cs +++ b/ShipEngineSDK/Model/CalculateRatesResponseBody.cs @@ -144,7 +144,7 @@ public partial class CalculateRatesResponseBody /// [JsonPropertyName("ship_date")] [JsonRequired] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The date and time that the shipment was created in ShipEngine. @@ -155,7 +155,7 @@ public partial class CalculateRatesResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the shipment was created or last modified. @@ -166,7 +166,7 @@ public partial class CalculateRatesResponseBody /// [JsonPropertyName("modified_at")] [JsonRequired] - public DateTime ModifiedAt { get; set; } + public DateTimeOffset ModifiedAt { get; set; } /// /// The recipient's mailing address diff --git a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs index 8d784395..3dd0a42d 100644 --- a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs @@ -133,7 +133,7 @@ public override bool CanConvert(Type typeToConvert) => /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the image was modified in ShipEngine. @@ -143,7 +143,7 @@ public override bool CanConvert(Type typeToConvert) => /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at")] - public DateTime ModifiedAt { get; set; } + public DateTimeOffset ModifiedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs index 865c859f..acad886c 100644 --- a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs +++ b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs @@ -59,7 +59,7 @@ public partial class CreateAndProcessBatchRequestBodyProcessLabels /// 2018-09-23T15:00Z /// [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateAndValidateShipment.cs b/ShipEngineSDK/Model/CreateAndValidateShipment.cs index 2e5b8441..2fc80fd6 100644 --- a/ShipEngineSDK/Model/CreateAndValidateShipment.cs +++ b/ShipEngineSDK/Model/CreateAndValidateShipment.cs @@ -133,7 +133,7 @@ public partial class CreateAndValidateShipment /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The date and time that the shipment was created in ShipEngine. @@ -143,7 +143,7 @@ public partial class CreateAndValidateShipment /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the shipment was created or last modified. @@ -153,7 +153,7 @@ public partial class CreateAndValidateShipment /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at")] - public DateTime ModifiedAt { get; set; } + public DateTimeOffset ModifiedAt { get; set; } /// /// The recipient's mailing address diff --git a/ShipEngineSDK/Model/CreateBatchResponseBody.cs b/ShipEngineSDK/Model/CreateBatchResponseBody.cs index b3fb1d4e..fce16421 100644 --- a/ShipEngineSDK/Model/CreateBatchResponseBody.cs +++ b/ShipEngineSDK/Model/CreateBatchResponseBody.cs @@ -100,7 +100,7 @@ public partial class CreateBatchResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time the batch was processed in ShipEngine @@ -111,7 +111,7 @@ public partial class CreateBatchResponseBody /// [JsonPropertyName("processed_at")] [JsonRequired] - public DateTime ProcessedAt { get; set; } + public DateTimeOffset ProcessedAt { get; set; } /// /// The number of errors that occurred while generating the batch diff --git a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs index 7262deb6..93d0b6cc 100644 --- a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs @@ -108,7 +108,7 @@ public partial class CreateLabelFromRateResponseBody /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -118,7 +118,7 @@ public partial class CreateLabelFromRateResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. @@ -245,7 +245,7 @@ public partial class CreateLabelFromRateResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("voided_at")] - public DateTime VoidedAt { get; set; } + public DateTimeOffset VoidedAt { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. diff --git a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs index 89bff431..6cd4e69f 100644 --- a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs @@ -108,7 +108,7 @@ public partial class CreateLabelFromShipmentResponseBody /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -118,7 +118,7 @@ public partial class CreateLabelFromShipmentResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. @@ -245,7 +245,7 @@ public partial class CreateLabelFromShipmentResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("voided_at")] - public DateTime VoidedAt { get; set; } + public DateTimeOffset VoidedAt { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. diff --git a/ShipEngineSDK/Model/CreateLabelRequestBody.cs b/ShipEngineSDK/Model/CreateLabelRequestBody.cs index a3186a7f..a2e32152 100644 --- a/ShipEngineSDK/Model/CreateLabelRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelRequestBody.cs @@ -129,7 +129,7 @@ public partial class CreateLabelRequestBody /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -139,7 +139,7 @@ public partial class CreateLabelRequestBody /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. @@ -266,7 +266,7 @@ public partial class CreateLabelRequestBody /// 2018-09-23T15:00Z /// [JsonPropertyName("voided_at")] - public DateTime VoidedAt { get; set; } + public DateTimeOffset VoidedAt { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. diff --git a/ShipEngineSDK/Model/CreateLabelResponseBody.cs b/ShipEngineSDK/Model/CreateLabelResponseBody.cs index b1164dc6..ab0b734a 100644 --- a/ShipEngineSDK/Model/CreateLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelResponseBody.cs @@ -129,7 +129,7 @@ public partial class CreateLabelResponseBody /// [JsonPropertyName("ship_date")] [JsonRequired] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -140,7 +140,7 @@ public partial class CreateLabelResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. @@ -279,7 +279,7 @@ public partial class CreateLabelResponseBody /// [JsonPropertyName("voided_at")] [JsonRequired] - public DateTime VoidedAt { get; set; } + public DateTimeOffset VoidedAt { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. diff --git a/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs b/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs index 1d04776a..c4d843d7 100644 --- a/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs +++ b/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs @@ -73,7 +73,7 @@ public partial class CreateManifestByObjectRequestBody /// [JsonPropertyName("ship_date")] [JsonRequired] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateManifestResponseBody.cs b/ShipEngineSDK/Model/CreateManifestResponseBody.cs index 31d6d921..cebeae76 100644 --- a/ShipEngineSDK/Model/CreateManifestResponseBody.cs +++ b/ShipEngineSDK/Model/CreateManifestResponseBody.cs @@ -76,7 +76,7 @@ public partial class CreateManifestResponseBody [JsonPropertyName("created_at")] [JsonRequired] [Obsolete] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date-time that the manifests shipments will be picked up @@ -88,7 +88,7 @@ public partial class CreateManifestResponseBody [JsonPropertyName("ship_date")] [JsonRequired] [Obsolete] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The number of shipments that are included in this manifest diff --git a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs index 82578d5e..29abb891 100644 --- a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs @@ -108,7 +108,7 @@ public partial class CreateReturnLabelResponseBody /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -118,7 +118,7 @@ public partial class CreateReturnLabelResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. @@ -245,7 +245,7 @@ public partial class CreateReturnLabelResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("voided_at")] - public DateTime VoidedAt { get; set; } + public DateTimeOffset VoidedAt { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. diff --git a/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs b/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs index 38fc0f89..36b347b5 100644 --- a/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs +++ b/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs @@ -64,7 +64,7 @@ public partial class CreateWarehouseRequestBody /// 2019-06-25T18:12:35.583Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The origin address of the warehouse diff --git a/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs b/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs index 1316e575..21c292db 100644 --- a/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs +++ b/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs @@ -66,7 +66,7 @@ public partial class CreateWarehouseResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The origin address of the warehouse diff --git a/ShipEngineSDK/Model/DeprecatedManifest.cs b/ShipEngineSDK/Model/DeprecatedManifest.cs index ac4c18a7..d0cbca3f 100644 --- a/ShipEngineSDK/Model/DeprecatedManifest.cs +++ b/ShipEngineSDK/Model/DeprecatedManifest.cs @@ -59,7 +59,7 @@ public partial class DeprecatedManifest /// [JsonPropertyName("created_at")] [Obsolete] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date-time that the manifests shipments will be picked up @@ -70,7 +70,7 @@ public partial class DeprecatedManifest /// [JsonPropertyName("ship_date")] [Obsolete] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The number of shipments that are included in this manifest diff --git a/ShipEngineSDK/Model/EstimateRatesRequestBody.cs b/ShipEngineSDK/Model/EstimateRatesRequestBody.cs index 62dd7c5d..b43e0d46 100644 --- a/ShipEngineSDK/Model/EstimateRatesRequestBody.cs +++ b/ShipEngineSDK/Model/EstimateRatesRequestBody.cs @@ -153,7 +153,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// [JsonPropertyName("ship_date")] [JsonRequired] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// @@ -421,7 +421,7 @@ public override EstimateRatesRequestBody Read(ref Utf8JsonReader reader, Type ty newEstimateRatesRequestBody.Dimensions = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("dimensions"), DeserializingOptions); newEstimateRatesRequestBody.Confirmation = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("confirmation"), DeserializingOptions); newEstimateRatesRequestBody.AddressResidentialIndicator = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("address_residential_indicator"), DeserializingOptions); - newEstimateRatesRequestBody.ShipDate = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("ship_date"), DeserializingOptions); + newEstimateRatesRequestBody.ShipDate = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("ship_date"), DeserializingOptions); // deserialization is considered successful at this point if no exception has been thrown. return newEstimateRatesRequestBody; diff --git a/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs b/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs index 9c0c6343..5f0bebc4 100644 --- a/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs +++ b/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs @@ -128,7 +128,7 @@ public override bool CanConvert(Type typeToConvert) => /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the image was modified in ShipEngine. @@ -138,7 +138,7 @@ public override bool CanConvert(Type typeToConvert) => /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at")] - public DateTime ModifiedAt { get; set; } + public DateTimeOffset ModifiedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs b/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs index f0ccb18b..e60ece45 100644 --- a/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs @@ -100,7 +100,7 @@ public partial class GetBatchByExternalIdResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time the batch was processed in ShipEngine @@ -111,7 +111,7 @@ public partial class GetBatchByExternalIdResponseBody /// [JsonPropertyName("processed_at")] [JsonRequired] - public DateTime ProcessedAt { get; set; } + public DateTimeOffset ProcessedAt { get; set; } /// /// The number of errors that occurred while generating the batch diff --git a/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs b/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs index d09f9535..11ba977a 100644 --- a/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs @@ -100,7 +100,7 @@ public partial class GetBatchByIdResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time the batch was processed in ShipEngine @@ -111,7 +111,7 @@ public partial class GetBatchByIdResponseBody /// [JsonPropertyName("processed_at")] [JsonRequired] - public DateTime ProcessedAt { get; set; } + public DateTimeOffset ProcessedAt { get; set; } /// /// The number of errors that occurred while generating the batch diff --git a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs index 8614d9cc..202c4710 100644 --- a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs @@ -108,7 +108,7 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -118,7 +118,7 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. @@ -245,7 +245,7 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("voided_at")] - public DateTime VoidedAt { get; set; } + public DateTimeOffset VoidedAt { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. diff --git a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs index 5e6d7cbb..4f333348 100644 --- a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs @@ -108,7 +108,7 @@ public partial class GetLabelByIdResponseBody /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -118,7 +118,7 @@ public partial class GetLabelByIdResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. @@ -245,7 +245,7 @@ public partial class GetLabelByIdResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("voided_at")] - public DateTime VoidedAt { get; set; } + public DateTimeOffset VoidedAt { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. diff --git a/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs b/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs index 602f584f..a56191ff 100644 --- a/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs @@ -59,7 +59,7 @@ public partial class GetManifestByIdResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date-time that the manifests shipments will be picked up @@ -70,7 +70,7 @@ public partial class GetManifestByIdResponseBody /// [JsonPropertyName("ship_date")] [JsonRequired] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The number of shipments that are included in this manifest diff --git a/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs b/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs index dc285722..8af4f052 100644 --- a/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs @@ -56,7 +56,7 @@ public partial class GetPickupByIdResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the pickup was cancelled in ShipEngine. @@ -66,7 +66,7 @@ public partial class GetPickupByIdResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("cancelled_at")] - public DateTime CancelledAt { get; set; } + public DateTimeOffset CancelledAt { get; set; } /// /// The carrier_id associated with the pickup diff --git a/ShipEngineSDK/Model/GetRateByIdResponseBody.cs b/ShipEngineSDK/Model/GetRateByIdResponseBody.cs index ed24acea..adeec0ea 100644 --- a/ShipEngineSDK/Model/GetRateByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetRateByIdResponseBody.cs @@ -160,7 +160,7 @@ public partial class GetRateByIdResponseBody /// 2018-09-23T00:00Z /// [JsonPropertyName("estimated_delivery_date")] - public DateTime EstimatedDeliveryDate { get; set; } + public DateTimeOffset EstimatedDeliveryDate { get; set; } /// /// The carrier delivery days @@ -174,7 +174,7 @@ public partial class GetRateByIdResponseBody /// /// ship date [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// Indicates if the rates been negotiated diff --git a/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs b/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs index 6bd3aa1e..879513de 100644 --- a/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs @@ -146,7 +146,7 @@ public partial class GetShipmentByExternalIdResponseBody /// [JsonPropertyName("ship_date")] [JsonRequired] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The date and time that the shipment was created in ShipEngine. @@ -157,7 +157,7 @@ public partial class GetShipmentByExternalIdResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the shipment was created or last modified. @@ -168,7 +168,7 @@ public partial class GetShipmentByExternalIdResponseBody /// [JsonPropertyName("modified_at")] [JsonRequired] - public DateTime ModifiedAt { get; set; } + public DateTimeOffset ModifiedAt { get; set; } /// /// The recipient's mailing address diff --git a/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs b/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs index d3f45911..2a7f1381 100644 --- a/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs @@ -146,7 +146,7 @@ public partial class GetShipmentByIdResponseBody /// [JsonPropertyName("ship_date")] [JsonRequired] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The date and time that the shipment was created in ShipEngine. @@ -157,7 +157,7 @@ public partial class GetShipmentByIdResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the shipment was created or last modified. @@ -168,7 +168,7 @@ public partial class GetShipmentByIdResponseBody /// [JsonPropertyName("modified_at")] [JsonRequired] - public DateTime ModifiedAt { get; set; } + public DateTimeOffset ModifiedAt { get; set; } /// /// The recipient's mailing address diff --git a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs index 54c6875c..722c97ff 100644 --- a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs @@ -126,7 +126,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -137,7 +137,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// [JsonPropertyName("estimated_delivery_date")] [JsonRequired] - public DateTime EstimatedDeliveryDate { get; set; } + public DateTimeOffset EstimatedDeliveryDate { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -147,7 +147,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("actual_delivery_date")] - public DateTime ActualDeliveryDate { get; set; } + public DateTimeOffset ActualDeliveryDate { get; set; } /// /// Exception description diff --git a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs index 333d854e..ad09d39b 100644 --- a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs @@ -130,7 +130,7 @@ public partial class GetTrackingLogResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -141,7 +141,7 @@ public partial class GetTrackingLogResponseBody /// [JsonPropertyName("estimated_delivery_date")] [JsonRequired] - public DateTime EstimatedDeliveryDate { get; set; } + public DateTimeOffset EstimatedDeliveryDate { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -151,7 +151,7 @@ public partial class GetTrackingLogResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("actual_delivery_date")] - public DateTime ActualDeliveryDate { get; set; } + public DateTimeOffset ActualDeliveryDate { get; set; } /// /// Exception description diff --git a/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs b/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs index 670c6bd9..ebac785d 100644 --- a/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs @@ -66,7 +66,7 @@ public partial class GetWarehouseByIdResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The origin address of the warehouse diff --git a/ShipEngineSDK/Model/Label.cs b/ShipEngineSDK/Model/Label.cs index 94bf7ba4..b4c29d3b 100644 --- a/ShipEngineSDK/Model/Label.cs +++ b/ShipEngineSDK/Model/Label.cs @@ -108,7 +108,7 @@ public partial class Label /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -118,7 +118,7 @@ public partial class Label /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. @@ -245,7 +245,7 @@ public partial class Label /// 2018-09-23T15:00Z /// [JsonPropertyName("voided_at")] - public DateTime VoidedAt { get; set; } + public DateTimeOffset VoidedAt { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. diff --git a/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs b/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs index 78f0c13a..dc7d91d4 100644 --- a/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs +++ b/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs @@ -85,7 +85,7 @@ public class ListAccountImagesResponseBodyItem /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the image was modified in ShipEngine. @@ -95,7 +95,7 @@ public class ListAccountImagesResponseBodyItem /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at")] - public DateTime ModifiedAt { get; set; } + public DateTimeOffset ModifiedAt { get; set; } } /// diff --git a/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs b/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs index 6a774a55..6c94e0c8 100644 --- a/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs +++ b/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs @@ -85,7 +85,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the image was modified in ShipEngine. @@ -95,7 +95,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at")] - public DateTime ModifiedAt { get; set; } + public DateTimeOffset ModifiedAt { get; set; } } /// diff --git a/ShipEngineSDK/Model/ListLabelsResponseBody.cs b/ShipEngineSDK/Model/ListLabelsResponseBody.cs index b108bd76..4d9f7d0c 100644 --- a/ShipEngineSDK/Model/ListLabelsResponseBody.cs +++ b/ShipEngineSDK/Model/ListLabelsResponseBody.cs @@ -71,7 +71,7 @@ public class ListLabelsResponseBodyItem /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -81,7 +81,7 @@ public class ListLabelsResponseBodyItem /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. @@ -221,7 +221,7 @@ public class ListLabelsResponseBodyItem /// 2018-09-23T15:00Z /// [JsonPropertyName("voided_at")] - public DateTime? VoidedAt { get; set; } + public DateTimeOffset? VoidedAt { get; set; } /// /// Gets or Sets LabelDownloadType diff --git a/ShipEngineSDK/Model/Manifest.cs b/ShipEngineSDK/Model/Manifest.cs index 3740c107..114e965f 100644 --- a/ShipEngineSDK/Model/Manifest.cs +++ b/ShipEngineSDK/Model/Manifest.cs @@ -56,7 +56,7 @@ public partial class Manifest /// 2019-07-12T13:37:39.050Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date-time that the manifests shipments will be picked up @@ -66,7 +66,7 @@ public partial class Manifest /// 2019-07-12T13:37:39.050Z /// [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The number of shipments that are included in this manifest diff --git a/ShipEngineSDK/Model/PartialShipment.cs b/ShipEngineSDK/Model/PartialShipment.cs index f619006c..966518c7 100644 --- a/ShipEngineSDK/Model/PartialShipment.cs +++ b/ShipEngineSDK/Model/PartialShipment.cs @@ -133,7 +133,7 @@ public partial class PartialShipment /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The date and time that the shipment was created in ShipEngine. @@ -143,7 +143,7 @@ public partial class PartialShipment /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the shipment was created or last modified. @@ -153,7 +153,7 @@ public partial class PartialShipment /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at")] - public DateTime ModifiedAt { get; set; } + public DateTimeOffset ModifiedAt { get; set; } /// /// The recipient's mailing address diff --git a/ShipEngineSDK/Model/Pickup.cs b/ShipEngineSDK/Model/Pickup.cs index f8c34e51..b38e4aaf 100644 --- a/ShipEngineSDK/Model/Pickup.cs +++ b/ShipEngineSDK/Model/Pickup.cs @@ -53,7 +53,7 @@ public partial class Pickup /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the pickup was cancelled in ShipEngine. @@ -63,7 +63,7 @@ public partial class Pickup /// 2018-09-23T15:00Z /// [JsonPropertyName("cancelled_at")] - public DateTime CancelledAt { get; set; } + public DateTimeOffset CancelledAt { get; set; } /// /// The carrier_id associated with the pickup diff --git a/ShipEngineSDK/Model/PickupResponseBody.cs b/ShipEngineSDK/Model/PickupResponseBody.cs index 37874e2f..4421fc84 100644 --- a/ShipEngineSDK/Model/PickupResponseBody.cs +++ b/ShipEngineSDK/Model/PickupResponseBody.cs @@ -56,7 +56,7 @@ public partial class PickupResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the pickup was cancelled in ShipEngine. @@ -66,7 +66,7 @@ public partial class PickupResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("cancelled_at")] - public DateTime CancelledAt { get; set; } + public DateTimeOffset CancelledAt { get; set; } /// /// The carrier_id associated with the pickup diff --git a/ShipEngineSDK/Model/PickupWindow.cs b/ShipEngineSDK/Model/PickupWindow.cs index 748d89df..74687f9d 100644 --- a/ShipEngineSDK/Model/PickupWindow.cs +++ b/ShipEngineSDK/Model/PickupWindow.cs @@ -37,7 +37,7 @@ public partial class PickupWindow /// [JsonPropertyName("start_at")] [JsonRequired] - public DateTime StartAt { get; set; } + public DateTimeOffset StartAt { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -48,7 +48,7 @@ public partial class PickupWindow /// [JsonPropertyName("end_at")] [JsonRequired] - public DateTime EndAt { get; set; } + public DateTimeOffset EndAt { get; set; } /// diff --git a/ShipEngineSDK/Model/PickupWindows.cs b/ShipEngineSDK/Model/PickupWindows.cs index 52ebe8c2..252d7484 100644 --- a/ShipEngineSDK/Model/PickupWindows.cs +++ b/ShipEngineSDK/Model/PickupWindows.cs @@ -36,7 +36,7 @@ public partial class PickupWindows /// 2018-09-23T15:00Z /// [JsonPropertyName("start_at")] - public DateTime StartAt { get; set; } + public DateTimeOffset StartAt { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -46,7 +46,7 @@ public partial class PickupWindows /// 2018-09-23T15:00Z /// [JsonPropertyName("end_at")] - public DateTime EndAt { get; set; } + public DateTimeOffset EndAt { get; set; } /// diff --git a/ShipEngineSDK/Model/ProcessBatchRequestBody.cs b/ShipEngineSDK/Model/ProcessBatchRequestBody.cs index b622f258..80fac23d 100644 --- a/ShipEngineSDK/Model/ProcessBatchRequestBody.cs +++ b/ShipEngineSDK/Model/ProcessBatchRequestBody.cs @@ -52,7 +52,7 @@ public partial class ProcessBatchRequestBody /// 2018-09-23T15:00Z /// [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// diff --git a/ShipEngineSDK/Model/Rate.cs b/ShipEngineSDK/Model/Rate.cs index b2724562..8e9a380a 100644 --- a/ShipEngineSDK/Model/Rate.cs +++ b/ShipEngineSDK/Model/Rate.cs @@ -160,7 +160,7 @@ public partial class Rate /// 2018-09-23T00:00Z /// [JsonPropertyName("estimated_delivery_date")] - public DateTime EstimatedDeliveryDate { get; set; } + public DateTimeOffset EstimatedDeliveryDate { get; set; } /// /// The carrier delivery days @@ -174,7 +174,7 @@ public partial class Rate /// /// ship date [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// Indicates if the rates been negotiated diff --git a/ShipEngineSDK/Model/RateEstimate.cs b/ShipEngineSDK/Model/RateEstimate.cs index 4d66cf04..ec5ece2a 100644 --- a/ShipEngineSDK/Model/RateEstimate.cs +++ b/ShipEngineSDK/Model/RateEstimate.cs @@ -142,7 +142,7 @@ public partial class RateEstimate /// 2018-09-23T00:00Z /// [JsonPropertyName("estimated_delivery_date")] - public DateTime EstimatedDeliveryDate { get; set; } + public DateTimeOffset EstimatedDeliveryDate { get; set; } /// /// The carrier delivery days @@ -156,7 +156,7 @@ public partial class RateEstimate /// /// ship date [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// Indicates if the rates been negotiated diff --git a/ShipEngineSDK/Model/RateEstimateOptions.cs b/ShipEngineSDK/Model/RateEstimateOptions.cs index 1ec93264..bd71d1f5 100644 --- a/ShipEngineSDK/Model/RateEstimateOptions.cs +++ b/ShipEngineSDK/Model/RateEstimateOptions.cs @@ -140,7 +140,7 @@ public partial class RateEstimateOptions /// 2018-09-23T15:00Z /// [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// diff --git a/ShipEngineSDK/Model/SchedulePickupRequestBody.cs b/ShipEngineSDK/Model/SchedulePickupRequestBody.cs index 8a6fee65..6b340f6a 100644 --- a/ShipEngineSDK/Model/SchedulePickupRequestBody.cs +++ b/ShipEngineSDK/Model/SchedulePickupRequestBody.cs @@ -54,7 +54,7 @@ public partial class SchedulePickupRequestBody /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the pickup was cancelled in ShipEngine. @@ -64,7 +64,7 @@ public partial class SchedulePickupRequestBody /// 2018-09-23T15:00Z /// [JsonPropertyName("cancelled_at")] - public DateTime CancelledAt { get; set; } + public DateTimeOffset CancelledAt { get; set; } /// /// The carrier_id associated with the pickup diff --git a/ShipEngineSDK/Model/SchedulePickupResponseBody.cs b/ShipEngineSDK/Model/SchedulePickupResponseBody.cs index 867969ff..9ea58afd 100644 --- a/ShipEngineSDK/Model/SchedulePickupResponseBody.cs +++ b/ShipEngineSDK/Model/SchedulePickupResponseBody.cs @@ -53,7 +53,7 @@ public partial class SchedulePickupResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the pickup was cancelled in ShipEngine. @@ -63,7 +63,7 @@ public partial class SchedulePickupResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("cancelled_at")] - public DateTime CancelledAt { get; set; } + public DateTimeOffset CancelledAt { get; set; } /// /// The carrier_id associated with the pickup diff --git a/ShipEngineSDK/Model/Shipment.cs b/ShipEngineSDK/Model/Shipment.cs index 732f622e..2ab70631 100644 --- a/ShipEngineSDK/Model/Shipment.cs +++ b/ShipEngineSDK/Model/Shipment.cs @@ -146,7 +146,7 @@ public partial class Shipment /// [JsonPropertyName("ship_date")] [JsonRequired] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The date and time that the shipment was created in ShipEngine. @@ -157,7 +157,7 @@ public partial class Shipment /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the shipment was created or last modified. @@ -168,7 +168,7 @@ public partial class Shipment /// [JsonPropertyName("modified_at")] [JsonRequired] - public DateTime ModifiedAt { get; set; } + public DateTimeOffset ModifiedAt { get; set; } /// /// The recipient's mailing address diff --git a/ShipEngineSDK/Model/TrackEvent.cs b/ShipEngineSDK/Model/TrackEvent.cs index 307147af..59db5c3d 100644 --- a/ShipEngineSDK/Model/TrackEvent.cs +++ b/ShipEngineSDK/Model/TrackEvent.cs @@ -45,7 +45,7 @@ public partial class TrackEvent /// [JsonPropertyName("occurred_at")] [JsonRequired] - public DateTime OccurredAt { get; set; } + public DateTimeOffset OccurredAt { get; set; } /// /// Carrier timestamp for the event, it is assumed to be the local time of where the event occurred. @@ -55,7 +55,7 @@ public partial class TrackEvent /// 2018-09-23T15:00Z /// [JsonPropertyName("carrier_occurred_at")] - public DateTime CarrierOccurredAt { get; set; } + public DateTimeOffset CarrierOccurredAt { get; set; } /// /// Event description diff --git a/ShipEngineSDK/Model/TrackingInformation.cs b/ShipEngineSDK/Model/TrackingInformation.cs index aa34bc6c..5d4e4264 100644 --- a/ShipEngineSDK/Model/TrackingInformation.cs +++ b/ShipEngineSDK/Model/TrackingInformation.cs @@ -121,7 +121,7 @@ public partial class TrackingInformation /// 2018-09-23T15:00Z /// [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -131,7 +131,7 @@ public partial class TrackingInformation /// 2018-09-23T15:00Z /// [JsonPropertyName("estimated_delivery_date")] - public DateTime EstimatedDeliveryDate { get; set; } + public DateTimeOffset EstimatedDeliveryDate { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -141,7 +141,7 @@ public partial class TrackingInformation /// 2018-09-23T15:00Z /// [JsonPropertyName("actual_delivery_date")] - public DateTime ActualDeliveryDate { get; set; } + public DateTimeOffset ActualDeliveryDate { get; set; } /// /// Exception description diff --git a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs index bf14f118..344e41bf 100644 --- a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs @@ -129,7 +129,7 @@ public override bool CanConvert(Type typeToConvert) => /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the image was modified in ShipEngine. @@ -139,7 +139,7 @@ public override bool CanConvert(Type typeToConvert) => /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at")] - public DateTime ModifiedAt { get; set; } + public DateTimeOffset ModifiedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs b/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs index 639a5ca7..7d2d35a6 100644 --- a/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs @@ -138,7 +138,7 @@ public partial class UpdateShipmentRequestBody /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date")] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The date and time that the shipment was created in ShipEngine. @@ -148,7 +148,7 @@ public partial class UpdateShipmentRequestBody /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the shipment was created or last modified. @@ -158,7 +158,7 @@ public partial class UpdateShipmentRequestBody /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at")] - public DateTime ModifiedAt { get; set; } + public DateTimeOffset ModifiedAt { get; set; } /// /// The recipient's mailing address diff --git a/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs b/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs index eacc9753..d1aa48ce 100644 --- a/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs @@ -146,7 +146,7 @@ public partial class UpdateShipmentResponseBody /// [JsonPropertyName("ship_date")] [JsonRequired] - public DateTime ShipDate { get; set; } + public DateTimeOffset ShipDate { get; set; } /// /// The date and time that the shipment was created in ShipEngine. @@ -157,7 +157,7 @@ public partial class UpdateShipmentResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the shipment was created or last modified. @@ -167,7 +167,7 @@ public partial class UpdateShipmentResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at")] - public DateTime ModifiedAt { get; set; } + public DateTimeOffset ModifiedAt { get; set; } /// /// The recipient's mailing address diff --git a/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs b/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs index 3ed81bf6..92b72d2f 100644 --- a/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs @@ -64,7 +64,7 @@ public partial class UpdateWarehouseRequestBody /// 2019-06-25T18:12:35.583Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The origin address of the warehouse diff --git a/ShipEngineSDK/Model/UpsInvoice.cs b/ShipEngineSDK/Model/UpsInvoice.cs index 61a3dd3b..cd084f33 100644 --- a/ShipEngineSDK/Model/UpsInvoice.cs +++ b/ShipEngineSDK/Model/UpsInvoice.cs @@ -33,7 +33,7 @@ public partial class UpsInvoice /// /// invoice date [JsonPropertyName("invoice_date")] - public DateTime InvoiceDate { get; set; } + public DateTimeOffset InvoiceDate { get; set; } /// /// invoice number diff --git a/ShipEngineSDK/Model/Warehouse.cs b/ShipEngineSDK/Model/Warehouse.cs index 49fef122..5e6a7e11 100644 --- a/ShipEngineSDK/Model/Warehouse.cs +++ b/ShipEngineSDK/Model/Warehouse.cs @@ -63,7 +63,7 @@ public partial class Warehouse /// 2019-06-25T18:12:35.583Z /// [JsonPropertyName("created_at")] - public DateTime CreatedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The origin address of the warehouse diff --git a/openapitools.json b/openapitools.json index d49bc8ea..2e604f6e 100644 --- a/openapitools.json +++ b/openapitools.json @@ -17,7 +17,9 @@ "targetFramework": "netstandard2.0", "validatable": false, "sourceFolder": "", - "optionalProjectFile": false + "optionalProjectFile": false, + "nullableReferenceTypes": true, + "useDateTimeOffset": true } } } From 78b6c05e45072d8a1df39caaa3427870b3d8e196 Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Tue, 16 Jul 2024 09:00:12 -0500 Subject: [PATCH 02/42] Add ability to manually publish a beta version --- .github/workflows/ci-cd.yaml | 13 +++++++++++-- CHANGELOG.md | 4 ++++ ShipEngineSDK/ShipEngineSDK.csproj | 2 +- openapitools.json | 2 +- package.json | 2 +- 5 files changed, 18 insertions(+), 5 deletions(-) diff --git a/.github/workflows/ci-cd.yaml b/.github/workflows/ci-cd.yaml index 3bb49dbd..2bd66a02 100644 --- a/.github/workflows/ci-cd.yaml +++ b/.github/workflows/ci-cd.yaml @@ -5,7 +5,9 @@ name: CI -on: [push] +on: + push: + workflow_dispatch: jobs: dot_net_framework_test: @@ -95,10 +97,16 @@ jobs: nuget-deploy: runs-on: ubuntu-latest needs: [dot_net_framework_test, dot_net_core_test] - if: github.ref == 'refs/heads/main' + if: github.ref == 'refs/heads/main' || github.event_name == 'workflow_dispatch' steps: # Checkout code if release was created - uses: actions/checkout@v2 + + - uses: bbonkr/get-version-action@v1 + id: get_version + with: + project: './ShipEngineSDK/ShipEngineSDK.csproj' + show_log_message: true # Setup Dotnet if release was created - name: Setup dotnet 8.0.x @@ -109,6 +117,7 @@ jobs: - name: publish on version change id: publish_nuget uses: alirezanet/publish-nuget@v3.1.0 + if: github.ref == 'refs/heads/main' || (github.event_name == 'workflow_dispatch' && steps.get_version.outputs.pre-release != '') with: # Filepath of the project to be packaged, relative to root of repository diff --git a/CHANGELOG.md b/CHANGELOG.md index b5c12baa..ebabd7f8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -151,3 +151,7 @@ Updated nuget package dependencies ### Added - Created new SDK methods for the entire API that sit next to the pre-existing methods. The pre-existing methods will be deprecated eventually. + +## 3.0.0-beta.1 + +- Created new SDK methods for the entire API that sit next to the pre-existing methods. The pre-existing methods will be deprecated eventually. \ No newline at end of file diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index 634fbcf9..b018cb3e 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; - 2.1.0 + 3.0.0-beta.1 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET diff --git a/openapitools.json b/openapitools.json index 2e604f6e..063d5145 100644 --- a/openapitools.json +++ b/openapitools.json @@ -13,7 +13,7 @@ "packageName": "ShipEngineSDK", "ignoreFileOverride": "./.openapi-generator-ignore", "additionalProperties": { - "packageVersion": "2.1.0", + "packageVersion": "3.0.0-beta.1", "targetFramework": "netstandard2.0", "validatable": false, "sourceFolder": "", diff --git a/package.json b/package.json index 0e76ce8f..8b929de6 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "shipengine-dotnet", - "version": "1.0.0", + "version": "3.0.0-beta.1", "description": "Package primarily used to generate the API and models from OpenApi spec\"", "main": "index.js", "directories": { From 0f235e1def4521efc7031aa9e84686e2a538119e Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Tue, 16 Jul 2024 09:16:22 -0500 Subject: [PATCH 03/42] Regenerate the API methods and models --- ShipEngineSDK/Api/AccountApi.cs | 403 ++++++ ShipEngineSDK/Api/AddressesApi.cs | 162 +++ ShipEngineSDK/Api/CarrierAccountsApi.cs | 319 +++++ ShipEngineSDK/Api/CarriersApi.cs | 477 ++++++ ShipEngineSDK/Api/InsuranceApi.cs | 266 ++++ ShipEngineSDK/Api/PackageTypesApi.cs | 351 +++++ ShipEngineSDK/Api/RatesApi.cs | 288 ++++ ShipEngineSDK/Api/ServicePointsApi.cs | 184 +++ ShipEngineSDK/Api/TagsApi.cs | 288 ++++ ShipEngineSDK/Api/TokensApi.cs | 96 ++ ShipEngineSDK/Api/WarehousesApi.cs | 425 ++++++ ShipEngineSDK/Api/WebhooksApi.cs | 351 +++++ ShipEngineSDK/Model/AbstractOpenAPISchema.cs | 50 + ShipEngineSDK/Model/AccountSettings.cs | 59 + .../Model/AddFundsToCarrierRequestBody.cs | 71 + .../Model/AddFundsToCarrierResponseBody.cs | 62 + .../Model/AddFundsToInsuranceRequestBody.cs | 71 + .../Model/AddFundsToInsuranceResponseBody.cs | 71 + ShipEngineSDK/Model/AddToBatchRequestBody.cs | 69 + ShipEngineSDK/Model/Address.cs | 191 +++ .../Model/AddressResidentialIndicator.cs | 83 ++ ShipEngineSDK/Model/AddressToValidate.cs | 185 +++ ShipEngineSDK/Model/AddressValidationCode.cs | 143 ++ .../Model/AddressValidationDetailCode.cs | 413 ++++++ .../Model/AddressValidationMessageType.cs | 83 ++ .../Model/AddressValidationResult.cs | 89 ++ .../Model/AddressValidationStatus.cs | 89 ++ .../Model/AdvancedShipmentOptions.cs | 236 +++ ...cedShipmentOptionsDangerousGoodsContact.cs | 69 + .../AdvancedShipmentOptionsFedexFreight.cs | 67 + ShipEngineSDK/Model/AllowedIncoterms.cs | 154 ++ ShipEngineSDK/Model/AlternativeIdentifier.cs | 75 + ShipEngineSDK/Model/AlternativeIdentifiers.cs | 61 + .../Model/AncillaryServiceEndorsement.cs | 101 ++ ShipEngineSDK/Model/BatchResponseError.cs | 83 ++ ShipEngineSDK/Model/BatchStatus.cs | 113 ++ ShipEngineSDK/Model/BatchesSortBy.cs | 83 ++ ShipEngineSDK/Model/BillToParty.cs | 77 + .../Model/CalculateRatesRequestBody.cs | 274 ++++ ShipEngineSDK/Model/Carrier.cs | 183 +++ ShipEngineSDK/Model/CarrierAdvancedOption.cs | 83 ++ ShipEngineSDK/Model/CarrierName.cs | 233 +++ .../Model/CarrierNameWithSettings.cs | 89 ++ ShipEngineSDK/Model/CollectOnDelivery.cs | 66 + .../Model/CollectOnDeliveryPaymentType.cs | 89 ++ .../Model/CompareBulkRatesRequestBody.cs | 275 ++++ .../ConnectAccessWorldwideRequestBody.cs | 83 ++ .../ConnectAmazonBuyShippingRequestBody.cs | 93 ++ .../Model/ConnectAmazonShippingUk.cs | 74 + ShipEngineSDK/Model/ConnectApcRequestBody.cs | 89 ++ .../Model/ConnectAsendiaRequestBody.cs | 92 ++ .../Model/ConnectAustraliaPostRequestBody.cs | 89 ++ .../Model/ConnectCanadaPostRequestBody.cs | 98 ++ .../Model/ConnectCarrierRequestBody.cs | 1276 +++++++++++++++++ .../Model/ConnectCarrierResponseBody.cs | 65 + .../Model/ConnectDhlEcommerceRequestBody.cs | 178 +++ .../Model/ConnectDhlExpressAuRequestBody.cs | 71 + .../Model/ConnectDhlExpressCaRequestBody.cs | 71 + .../Model/ConnectDhlExpressRequestBody.cs | 98 ++ .../Model/ConnectDhlExpressUkRequestBody.cs | 92 ++ ShipEngineSDK/Model/ConnectDpdRequestBody.cs | 80 ++ .../Model/ConnectEndiciaRequestBody.cs | 80 ++ .../Model/ConnectFedexRequestBody.cs | 188 +++ .../Model/ConnectFedexUkRequestBody.cs | 188 +++ .../Model/ConnectFirstmileRequestBody.cs | 91 ++ ShipEngineSDK/Model/ConnectImexRequestBody.cs | 80 ++ .../Model/ConnectInsurerRequestBody.cs | 73 + .../Model/ConnectLasershipRequestBody.cs | 271 ++++ .../Model/ConnectNewgisticsRequestBody.cs | 87 ++ .../Model/ConnectOntracRequestBody.cs | 80 ++ .../Model/ConnectPurolatorRequestBody.cs | 80 ++ .../Model/ConnectRoyalMailRequestBody.cs | 160 +++ .../Model/ConnectRrDonnelleyRequestBody.cs | 80 ++ ShipEngineSDK/Model/ConnectSekoRequestBody.cs | 71 + .../Model/ConnectSendleRequestBody.cs | 83 ++ .../Model/ConnectStampsRequestBody.cs | 80 ++ ShipEngineSDK/Model/ConnectUpsRequestBody.cs | 71 + ShipEngineSDK/Model/ContactDetails.cs | 82 ++ .../Model/CreateAndProcessBatchRequestBody.cs | 98 ++ ShipEngineSDK/Model/CreateBatchRequest.cs | 262 ++++ ShipEngineSDK/Model/CreateBatchRequestBody.cs | 91 ++ .../Model/CreateLabelFromRateRequestBody.cs | 84 ++ .../CreateLabelFromShipmentRequestBody.cs | 84 ++ .../CreateManifestLabelIdsRequestBody.cs | 62 + .../Model/CreateManifestRequestBody.cs | 262 ++++ .../Model/CreatePackageTypeRequestBody.cs | 106 ++ .../Model/CreatePackageTypeResponseBody.cs | 106 ++ .../Model/CreateReturnLabelRequestBody.cs | 98 ++ .../Model/CreateShipmentResponseBodyFields.cs | 70 + .../Model/CreateShipmentsRequestBody.cs | 62 + .../Model/CreateShipmentsResponseBody.cs | 71 + ShipEngineSDK/Model/CreateTagResponseBody.cs | 65 + .../Model/CreateWebhookRequestBody.cs | 82 ++ .../Model/CreateWebhookResponseBody.cs | 94 ++ ShipEngineSDK/Model/CustomsItem.cs | 150 ++ ShipEngineSDK/Model/DangerousAmount.cs | 69 + ShipEngineSDK/Model/DangerousGoods.cs | 203 +++ ShipEngineSDK/Model/DefaultLabelLayout.cs | 77 + .../Model/DeletePickupByIdResponseBody.cs | 86 ++ .../DeleteScheduledPickupResponseBody.cs | 65 + ShipEngineSDK/Model/DeliveryConfirmation.cs | 107 ++ .../Model/DhlExpressAccountSettings.cs | 77 + .../Model/DhlExpressSettingsResponseBody.cs | 77 + ShipEngineSDK/Model/DimensionUnit.cs | 77 + ShipEngineSDK/Model/Dimensions.cs | 89 ++ ShipEngineSDK/Model/DisplayScheme.cs | 95 ++ ShipEngineSDK/Model/Error.cs | 92 ++ ShipEngineSDK/Model/ErrorCode.cs | 323 +++++ ShipEngineSDK/Model/ErrorResponseBody.cs | 74 + ShipEngineSDK/Model/ErrorSource.cs | 83 ++ ShipEngineSDK/Model/ErrorType.cs | 101 ++ .../Model/ErrorWithLabelIdResponseBody.cs | 74 + ShipEngineSDK/Model/FedexAccountSettings.cs | 100 ++ .../Model/FedexAccountSettingsRequestBody.cs | 100 ++ ShipEngineSDK/Model/FedexPickupType.cs | 101 ++ .../Model/FedexSettingsResponseBody.cs | 100 ++ .../Model/GetAccountSettingsResponseBody.cs | 59 + .../Model/GetCarrierByIdResponseBody.cs | 183 +++ .../Model/GetCarrierOptionsResponseBody.cs | 61 + .../Model/GetCarrierSettingsResponseBody.cs | 301 ++++ .../Model/GetCarriersResponseBody.cs | 83 ++ .../Model/GetInsuranceBalanceResponseBody.cs | 71 + .../Model/GetPackageTypeByIdResponseBody.cs | 106 ++ ShipEngineSDK/Model/GetPickupsResponseBody.cs | 128 ++ .../Model/GetServicePointByIdResponseBody.cs | 60 + ...ervicePointByIdResponseBodyServicePoint.cs | 312 ++++ .../Model/GetServicePointsRequest.cs | 223 +++ .../Model/GetServicePointsRequestBody.cs | 131 ++ .../GetServicePointsRequestBodyAddress.cs | 117 ++ ...tServicePointsRequestBodyProvidersInner.cs | 71 + .../GetServicePointsRequestBodyShipment.cs | 61 + .../Model/GetWebhookByIdResponseBody.cs | 94 ++ ShipEngineSDK/Model/IdentifierType.cs | 137 ++ ShipEngineSDK/Model/ImporterOfRecords.cs | 179 +++ ShipEngineSDK/Model/InsuranceProvider.cs | 89 ++ .../Model/InternationalShipmentOptions.cs | 119 ++ .../Model/InvoiceAdditionalDetails.cs | 93 ++ ShipEngineSDK/Model/LabelChargeEvent.cs | 83 ++ ShipEngineSDK/Model/LabelDownload.cs | 97 ++ ShipEngineSDK/Model/LabelDownloadType.cs | 77 + ShipEngineSDK/Model/LabelFormat.cs | 83 ++ ShipEngineSDK/Model/LabelLayout.cs | 77 + ShipEngineSDK/Model/LabelMessages.cs | 80 ++ ShipEngineSDK/Model/LabelPackagesInner.cs | 185 +++ ShipEngineSDK/Model/LabelStatus.cs | 89 ++ ShipEngineSDK/Model/Link.cs | 73 + .../Model/ListAccountSettingsBody.cs | 59 + .../Model/ListBatchErrorsResponseBody.cs | 70 + .../Model/ListBatchesResponseBody.cs | 106 ++ .../ListCarrierPackageTypesResponseBody.cs | 61 + .../Model/ListCarrierServicesResponseBody.cs | 61 + .../Model/ListCarriersResponseBody.cs | 62 + .../Model/ListManifestsResponseBody.cs | 107 ++ .../Model/ListPackageTypesResponseBody.cs | 61 + ShipEngineSDK/Model/ListPickupResponseBody.cs | 107 ++ .../Model/ListServicePointsResponseBody.cs | 90 ++ ...icePointsResponseBodyServicePointsInner.cs | 323 +++++ ...eBodyServicePointsInnerHoursOfOperation.cs | 102 ++ ...ePointsInnerHoursOfOperationMondayInner.cs | 75 + .../Model/ListShipmentRatesResponseBody.cs | 124 ++ .../Model/ListShipmentsResponseBody.cs | 98 ++ ShipEngineSDK/Model/ListTagsResponseBody.cs | 61 + .../Model/ListWarehousesResponseBody.cs | 62 + ShipEngineSDK/Model/ManifestDownload.cs | 64 + ShipEngineSDK/Model/ManifestRequest.cs | 70 + ShipEngineSDK/Model/ManifestRequestStatus.cs | 77 + ShipEngineSDK/Model/Manifests.cs | 61 + ShipEngineSDK/Model/ManifestsRequests.cs | 61 + ShipEngineSDK/Model/ModifyBatch.cs | 69 + ShipEngineSDK/Model/MonetaryValue.cs | 71 + ShipEngineSDK/Model/NonDelivery.cs | 77 + ShipEngineSDK/Model/OptionalLink.cs | 72 + ShipEngineSDK/Model/OrderSourceName.cs | 185 +++ ShipEngineSDK/Model/OriginType.cs | 77 + ShipEngineSDK/Model/Package.cs | 177 +++ ShipEngineSDK/Model/PackageContents.cs | 101 ++ ShipEngineSDK/Model/PackageType.cs | 106 ++ ShipEngineSDK/Model/PackagingGroup.cs | 82 ++ .../Model/PackagingInstructionSection.cs | 88 ++ ShipEngineSDK/Model/PagedListResponseBody.cs | 104 ++ ShipEngineSDK/Model/PaginationLink.cs | 89 ++ ShipEngineSDK/Model/PaperlessDownload.cs | 80 ++ .../Model/ParseAddressRequestBody.cs | 73 + .../Model/ParseAddressResponseBody.cs | 80 ++ .../Model/ParseShipmentRequestBody.cs | 74 + .../Model/ParseShipmentResponseBody.cs | 80 ++ ShipEngineSDK/Model/PartialAddress.cs | 181 +++ ShipEngineSDK/Model/PartialShippingAddress.cs | 61 + .../Model/PartialShippingAddressTo.cs | 68 + ...artialShippingAddressToGeolocationInner.cs | 114 ++ ShipEngineSDK/Model/PaymentAmount.cs | 68 + ShipEngineSDK/Model/Products.cs | 165 +++ .../Model/PurchaseLabelWithoutShipment.cs | 84 ++ .../Model/RateEstimateByCarrierId.cs | 65 + .../Model/RateEstimateByCarrierIds.cs | 61 + ShipEngineSDK/Model/RateRequestBody.cs | 100 ++ .../Model/RateRequestByShipmentIds.cs | 62 + ShipEngineSDK/Model/RateRequestByShipments.cs | 62 + ShipEngineSDK/Model/RateRequestOptions.cs | 61 + ShipEngineSDK/Model/RateRequestRateOptions.cs | 61 + ShipEngineSDK/Model/RateResponse.cs | 61 + ShipEngineSDK/Model/RateResponseStatus.cs | 89 ++ ShipEngineSDK/Model/RateType.cs | 77 + ShipEngineSDK/Model/RatesInformation.cs | 115 ++ ShipEngineSDK/Model/ReasonCode.cs | 107 ++ ShipEngineSDK/Model/RecognizedEntity.cs | 106 ++ ShipEngineSDK/Model/Redirect.cs | 71 + ShipEngineSDK/Model/RegulationLevel.cs | 88 ++ .../Model/RemoveFromBatchRequestBody.cs | 69 + ShipEngineSDK/Model/ResponseMessage.cs | 92 ++ ShipEngineSDK/Model/Service.cs | 121 ++ ShipEngineSDK/Model/ShipmentIdRequest.cs | 64 + ShipEngineSDK/Model/ShipmentItem.cs | 126 ++ ShipEngineSDK/Model/ShipmentRequest.cs | 61 + ShipEngineSDK/Model/ShipmentStatus.cs | 89 ++ ShipEngineSDK/Model/ShipmentsSortBy.cs | 77 + ShipEngineSDK/Model/ShippingAddress.cs | 199 +++ ShipEngineSDK/Model/ShippingAddressTo.cs | 206 +++ ShipEngineSDK/Model/SmartPostHub.cs | 269 ++++ ShipEngineSDK/Model/SortDir.cs | 77 + ShipEngineSDK/Model/StatusCode.cs | 107 ++ ShipEngineSDK/Model/Tag.cs | 65 + .../Model/TagShipmentResponseBody.cs | 61 + ShipEngineSDK/Model/TaxIdentifier.cs | 89 ++ ShipEngineSDK/Model/TaxableEntityType.cs | 83 ++ ...TokensGetEphemeralTokenResponseBodyYaml.cs | 69 + ShipEngineSDK/Model/TrackingStatus.cs | 89 ++ ShipEngineSDK/Model/TransportMean.cs | 88 ++ .../UpdateAmazonBuyShippingRequestBody.cs | 61 + .../Model/UpdateCarrierSettingsRequestBody.cs | 379 +++++ .../UpdateDhlExpressSettingsRequestBody.cs | 77 + .../Model/UpdateFedexSettingsRequestBody.cs | 100 ++ .../UpdateNewgisticsSettingsRequestBody.cs | 67 + .../Model/UpdatePackageTypeRequestBody.cs | 106 ++ ShipEngineSDK/Model/UpdateShipmentFields.cs | 59 + ShipEngineSDK/Model/UpdateShipmentsTags.cs | 60 + .../Model/UpdateShipmentsTagsRequestBody.cs | 60 + .../UpdateShipmentsTagsShipmentsTagsInner.cs | 67 + .../Model/UpdateUpsSettingsRequestBody.cs | 145 ++ .../UpdateWarehouseSettingsRequestBody.cs | 64 + .../Model/UpdateWebhookRequestBody.cs | 72 + ShipEngineSDK/Model/UpsAccountSettings.cs | 145 ++ ShipEngineSDK/Model/UpsPickupType.cs | 83 ++ .../Model/UpsSettingsResponseBody.cs | 145 ++ ShipEngineSDK/Model/ValidateAddress.cs | 83 ++ ShipEngineSDK/Model/ValidateShipmentFields.cs | 59 + ShipEngineSDK/Model/ValidationStatus.cs | 89 ++ ShipEngineSDK/Model/VoidLabelResponseBody.cs | 83 ++ ShipEngineSDK/Model/Webhook.cs | 89 ++ ShipEngineSDK/Model/WebhookEvent.cs | 107 ++ ShipEngineSDK/Model/WebhookHeader.cs | 77 + ShipEngineSDK/Model/Weight.cs | 71 + ShipEngineSDK/Model/WeightUnit.cs | 89 ++ 253 files changed, 29795 insertions(+) create mode 100644 ShipEngineSDK/Api/AccountApi.cs create mode 100644 ShipEngineSDK/Api/AddressesApi.cs create mode 100644 ShipEngineSDK/Api/CarrierAccountsApi.cs create mode 100644 ShipEngineSDK/Api/CarriersApi.cs create mode 100644 ShipEngineSDK/Api/InsuranceApi.cs create mode 100644 ShipEngineSDK/Api/PackageTypesApi.cs create mode 100644 ShipEngineSDK/Api/RatesApi.cs create mode 100644 ShipEngineSDK/Api/ServicePointsApi.cs create mode 100644 ShipEngineSDK/Api/TagsApi.cs create mode 100644 ShipEngineSDK/Api/TokensApi.cs create mode 100644 ShipEngineSDK/Api/WarehousesApi.cs create mode 100644 ShipEngineSDK/Api/WebhooksApi.cs create mode 100644 ShipEngineSDK/Model/AbstractOpenAPISchema.cs create mode 100644 ShipEngineSDK/Model/AccountSettings.cs create mode 100644 ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs create mode 100644 ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs create mode 100644 ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs create mode 100644 ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs create mode 100644 ShipEngineSDK/Model/AddToBatchRequestBody.cs create mode 100644 ShipEngineSDK/Model/Address.cs create mode 100644 ShipEngineSDK/Model/AddressResidentialIndicator.cs create mode 100644 ShipEngineSDK/Model/AddressToValidate.cs create mode 100644 ShipEngineSDK/Model/AddressValidationCode.cs create mode 100644 ShipEngineSDK/Model/AddressValidationDetailCode.cs create mode 100644 ShipEngineSDK/Model/AddressValidationMessageType.cs create mode 100644 ShipEngineSDK/Model/AddressValidationResult.cs create mode 100644 ShipEngineSDK/Model/AddressValidationStatus.cs create mode 100644 ShipEngineSDK/Model/AdvancedShipmentOptions.cs create mode 100644 ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs create mode 100644 ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs create mode 100644 ShipEngineSDK/Model/AllowedIncoterms.cs create mode 100644 ShipEngineSDK/Model/AlternativeIdentifier.cs create mode 100644 ShipEngineSDK/Model/AlternativeIdentifiers.cs create mode 100644 ShipEngineSDK/Model/AncillaryServiceEndorsement.cs create mode 100644 ShipEngineSDK/Model/BatchResponseError.cs create mode 100644 ShipEngineSDK/Model/BatchStatus.cs create mode 100644 ShipEngineSDK/Model/BatchesSortBy.cs create mode 100644 ShipEngineSDK/Model/BillToParty.cs create mode 100644 ShipEngineSDK/Model/CalculateRatesRequestBody.cs create mode 100644 ShipEngineSDK/Model/Carrier.cs create mode 100644 ShipEngineSDK/Model/CarrierAdvancedOption.cs create mode 100644 ShipEngineSDK/Model/CarrierName.cs create mode 100644 ShipEngineSDK/Model/CarrierNameWithSettings.cs create mode 100644 ShipEngineSDK/Model/CollectOnDelivery.cs create mode 100644 ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs create mode 100644 ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectAmazonShippingUk.cs create mode 100644 ShipEngineSDK/Model/ConnectApcRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectCarrierRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectCarrierResponseBody.cs create mode 100644 ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectDpdRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectFedexRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectImexRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectInsurerRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectLasershipRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectOntracRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectSekoRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectSendleRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectStampsRequestBody.cs create mode 100644 ShipEngineSDK/Model/ConnectUpsRequestBody.cs create mode 100644 ShipEngineSDK/Model/ContactDetails.cs create mode 100644 ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs create mode 100644 ShipEngineSDK/Model/CreateBatchRequest.cs create mode 100644 ShipEngineSDK/Model/CreateBatchRequestBody.cs create mode 100644 ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs create mode 100644 ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs create mode 100644 ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs create mode 100644 ShipEngineSDK/Model/CreateManifestRequestBody.cs create mode 100644 ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs create mode 100644 ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs create mode 100644 ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs create mode 100644 ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs create mode 100644 ShipEngineSDK/Model/CreateShipmentsRequestBody.cs create mode 100644 ShipEngineSDK/Model/CreateShipmentsResponseBody.cs create mode 100644 ShipEngineSDK/Model/CreateTagResponseBody.cs create mode 100644 ShipEngineSDK/Model/CreateWebhookRequestBody.cs create mode 100644 ShipEngineSDK/Model/CreateWebhookResponseBody.cs create mode 100644 ShipEngineSDK/Model/CustomsItem.cs create mode 100644 ShipEngineSDK/Model/DangerousAmount.cs create mode 100644 ShipEngineSDK/Model/DangerousGoods.cs create mode 100644 ShipEngineSDK/Model/DefaultLabelLayout.cs create mode 100644 ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs create mode 100644 ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs create mode 100644 ShipEngineSDK/Model/DeliveryConfirmation.cs create mode 100644 ShipEngineSDK/Model/DhlExpressAccountSettings.cs create mode 100644 ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs create mode 100644 ShipEngineSDK/Model/DimensionUnit.cs create mode 100644 ShipEngineSDK/Model/Dimensions.cs create mode 100644 ShipEngineSDK/Model/DisplayScheme.cs create mode 100644 ShipEngineSDK/Model/Error.cs create mode 100644 ShipEngineSDK/Model/ErrorCode.cs create mode 100644 ShipEngineSDK/Model/ErrorResponseBody.cs create mode 100644 ShipEngineSDK/Model/ErrorSource.cs create mode 100644 ShipEngineSDK/Model/ErrorType.cs create mode 100644 ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs create mode 100644 ShipEngineSDK/Model/FedexAccountSettings.cs create mode 100644 ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs create mode 100644 ShipEngineSDK/Model/FedexPickupType.cs create mode 100644 ShipEngineSDK/Model/FedexSettingsResponseBody.cs create mode 100644 ShipEngineSDK/Model/GetAccountSettingsResponseBody.cs create mode 100644 ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs create mode 100644 ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs create mode 100644 ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs create mode 100644 ShipEngineSDK/Model/GetCarriersResponseBody.cs create mode 100644 ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs create mode 100644 ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs create mode 100644 ShipEngineSDK/Model/GetPickupsResponseBody.cs create mode 100644 ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs create mode 100644 ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs create mode 100644 ShipEngineSDK/Model/GetServicePointsRequest.cs create mode 100644 ShipEngineSDK/Model/GetServicePointsRequestBody.cs create mode 100644 ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs create mode 100644 ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs create mode 100644 ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs create mode 100644 ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs create mode 100644 ShipEngineSDK/Model/IdentifierType.cs create mode 100644 ShipEngineSDK/Model/ImporterOfRecords.cs create mode 100644 ShipEngineSDK/Model/InsuranceProvider.cs create mode 100644 ShipEngineSDK/Model/InternationalShipmentOptions.cs create mode 100644 ShipEngineSDK/Model/InvoiceAdditionalDetails.cs create mode 100644 ShipEngineSDK/Model/LabelChargeEvent.cs create mode 100644 ShipEngineSDK/Model/LabelDownload.cs create mode 100644 ShipEngineSDK/Model/LabelDownloadType.cs create mode 100644 ShipEngineSDK/Model/LabelFormat.cs create mode 100644 ShipEngineSDK/Model/LabelLayout.cs create mode 100644 ShipEngineSDK/Model/LabelMessages.cs create mode 100644 ShipEngineSDK/Model/LabelPackagesInner.cs create mode 100644 ShipEngineSDK/Model/LabelStatus.cs create mode 100644 ShipEngineSDK/Model/Link.cs create mode 100644 ShipEngineSDK/Model/ListAccountSettingsBody.cs create mode 100644 ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs create mode 100644 ShipEngineSDK/Model/ListBatchesResponseBody.cs create mode 100644 ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs create mode 100644 ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs create mode 100644 ShipEngineSDK/Model/ListCarriersResponseBody.cs create mode 100644 ShipEngineSDK/Model/ListManifestsResponseBody.cs create mode 100644 ShipEngineSDK/Model/ListPackageTypesResponseBody.cs create mode 100644 ShipEngineSDK/Model/ListPickupResponseBody.cs create mode 100644 ShipEngineSDK/Model/ListServicePointsResponseBody.cs create mode 100644 ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs create mode 100644 ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs create mode 100644 ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs create mode 100644 ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs create mode 100644 ShipEngineSDK/Model/ListShipmentsResponseBody.cs create mode 100644 ShipEngineSDK/Model/ListTagsResponseBody.cs create mode 100644 ShipEngineSDK/Model/ListWarehousesResponseBody.cs create mode 100644 ShipEngineSDK/Model/ManifestDownload.cs create mode 100644 ShipEngineSDK/Model/ManifestRequest.cs create mode 100644 ShipEngineSDK/Model/ManifestRequestStatus.cs create mode 100644 ShipEngineSDK/Model/Manifests.cs create mode 100644 ShipEngineSDK/Model/ManifestsRequests.cs create mode 100644 ShipEngineSDK/Model/ModifyBatch.cs create mode 100644 ShipEngineSDK/Model/MonetaryValue.cs create mode 100644 ShipEngineSDK/Model/NonDelivery.cs create mode 100644 ShipEngineSDK/Model/OptionalLink.cs create mode 100644 ShipEngineSDK/Model/OrderSourceName.cs create mode 100644 ShipEngineSDK/Model/OriginType.cs create mode 100644 ShipEngineSDK/Model/Package.cs create mode 100644 ShipEngineSDK/Model/PackageContents.cs create mode 100644 ShipEngineSDK/Model/PackageType.cs create mode 100644 ShipEngineSDK/Model/PackagingGroup.cs create mode 100644 ShipEngineSDK/Model/PackagingInstructionSection.cs create mode 100644 ShipEngineSDK/Model/PagedListResponseBody.cs create mode 100644 ShipEngineSDK/Model/PaginationLink.cs create mode 100644 ShipEngineSDK/Model/PaperlessDownload.cs create mode 100644 ShipEngineSDK/Model/ParseAddressRequestBody.cs create mode 100644 ShipEngineSDK/Model/ParseAddressResponseBody.cs create mode 100644 ShipEngineSDK/Model/ParseShipmentRequestBody.cs create mode 100644 ShipEngineSDK/Model/ParseShipmentResponseBody.cs create mode 100644 ShipEngineSDK/Model/PartialAddress.cs create mode 100644 ShipEngineSDK/Model/PartialShippingAddress.cs create mode 100644 ShipEngineSDK/Model/PartialShippingAddressTo.cs create mode 100644 ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs create mode 100644 ShipEngineSDK/Model/PaymentAmount.cs create mode 100644 ShipEngineSDK/Model/Products.cs create mode 100644 ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs create mode 100644 ShipEngineSDK/Model/RateEstimateByCarrierId.cs create mode 100644 ShipEngineSDK/Model/RateEstimateByCarrierIds.cs create mode 100644 ShipEngineSDK/Model/RateRequestBody.cs create mode 100644 ShipEngineSDK/Model/RateRequestByShipmentIds.cs create mode 100644 ShipEngineSDK/Model/RateRequestByShipments.cs create mode 100644 ShipEngineSDK/Model/RateRequestOptions.cs create mode 100644 ShipEngineSDK/Model/RateRequestRateOptions.cs create mode 100644 ShipEngineSDK/Model/RateResponse.cs create mode 100644 ShipEngineSDK/Model/RateResponseStatus.cs create mode 100644 ShipEngineSDK/Model/RateType.cs create mode 100644 ShipEngineSDK/Model/RatesInformation.cs create mode 100644 ShipEngineSDK/Model/ReasonCode.cs create mode 100644 ShipEngineSDK/Model/RecognizedEntity.cs create mode 100644 ShipEngineSDK/Model/Redirect.cs create mode 100644 ShipEngineSDK/Model/RegulationLevel.cs create mode 100644 ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs create mode 100644 ShipEngineSDK/Model/ResponseMessage.cs create mode 100644 ShipEngineSDK/Model/Service.cs create mode 100644 ShipEngineSDK/Model/ShipmentIdRequest.cs create mode 100644 ShipEngineSDK/Model/ShipmentItem.cs create mode 100644 ShipEngineSDK/Model/ShipmentRequest.cs create mode 100644 ShipEngineSDK/Model/ShipmentStatus.cs create mode 100644 ShipEngineSDK/Model/ShipmentsSortBy.cs create mode 100644 ShipEngineSDK/Model/ShippingAddress.cs create mode 100644 ShipEngineSDK/Model/ShippingAddressTo.cs create mode 100644 ShipEngineSDK/Model/SmartPostHub.cs create mode 100644 ShipEngineSDK/Model/SortDir.cs create mode 100644 ShipEngineSDK/Model/StatusCode.cs create mode 100644 ShipEngineSDK/Model/Tag.cs create mode 100644 ShipEngineSDK/Model/TagShipmentResponseBody.cs create mode 100644 ShipEngineSDK/Model/TaxIdentifier.cs create mode 100644 ShipEngineSDK/Model/TaxableEntityType.cs create mode 100644 ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs create mode 100644 ShipEngineSDK/Model/TrackingStatus.cs create mode 100644 ShipEngineSDK/Model/TransportMean.cs create mode 100644 ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs create mode 100644 ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs create mode 100644 ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs create mode 100644 ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs create mode 100644 ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs create mode 100644 ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs create mode 100644 ShipEngineSDK/Model/UpdateShipmentFields.cs create mode 100644 ShipEngineSDK/Model/UpdateShipmentsTags.cs create mode 100644 ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs create mode 100644 ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs create mode 100644 ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs create mode 100644 ShipEngineSDK/Model/UpdateWarehouseSettingsRequestBody.cs create mode 100644 ShipEngineSDK/Model/UpdateWebhookRequestBody.cs create mode 100644 ShipEngineSDK/Model/UpsAccountSettings.cs create mode 100644 ShipEngineSDK/Model/UpsPickupType.cs create mode 100644 ShipEngineSDK/Model/UpsSettingsResponseBody.cs create mode 100644 ShipEngineSDK/Model/ValidateAddress.cs create mode 100644 ShipEngineSDK/Model/ValidateShipmentFields.cs create mode 100644 ShipEngineSDK/Model/ValidationStatus.cs create mode 100644 ShipEngineSDK/Model/VoidLabelResponseBody.cs create mode 100644 ShipEngineSDK/Model/Webhook.cs create mode 100644 ShipEngineSDK/Model/WebhookEvent.cs create mode 100644 ShipEngineSDK/Model/WebhookHeader.cs create mode 100644 ShipEngineSDK/Model/Weight.cs create mode 100644 ShipEngineSDK/Model/WeightUnit.cs diff --git a/ShipEngineSDK/Api/AccountApi.cs b/ShipEngineSDK/Api/AccountApi.cs new file mode 100644 index 00000000..82029f36 --- /dev/null +++ b/ShipEngineSDK/Api/AccountApi.cs @@ -0,0 +1,403 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using ShipEngineSDK.Model; +using System; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Net; +using System.Net.Http; +using System.Net.Mime; +using System.Text.Json; +using System.Threading; +using System.Threading.Tasks; + +namespace ShipEngineSDK; + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial interface IShipEngine +{ + /// + /// Create an Account Image Create an Account Image + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetAccountSettingsImagesResponseBody) + Task CreateAccountImage(CreateAccountSettingsImageRequestBody createAccountSettingsImageRequestBody, CancellationToken cancellationToken = default); + + /// + /// Create an Account Image Create an Account Image + /// + /// 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 (GetAccountSettingsImagesResponseBody) + Task CreateAccountImage(HttpClient methodClient, CreateAccountSettingsImageRequestBody createAccountSettingsImageRequestBody, CancellationToken cancellationToken = default); + + /// + /// Delete Account Image By Id Delete Account Image By Id + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Label Image Id + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task DeleteAccountImageById(string labelImageId, CancellationToken cancellationToken = default); + + /// + /// Delete Account Image By Id Delete Account Image By Id + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Label Image Id + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task DeleteAccountImageById(HttpClient methodClient, string labelImageId, CancellationToken cancellationToken = default); + + /// + /// Get Account Image By ID Retrieve information for an account image. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Label Image Id + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetAccountSettingsImagesResponseBody) + Task GetAccountSettingsImagesById(string labelImageId, CancellationToken cancellationToken = default); + + /// + /// Get Account Image By ID Retrieve information for an account image. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Label Image Id + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetAccountSettingsImagesResponseBody) + Task GetAccountSettingsImagesById(HttpClient methodClient, string labelImageId, CancellationToken cancellationToken = default); + + /// + /// List Account Images List all account images for the ShipEngine account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ListAccountSettingsImagesResponseBody) + Task ListAccountImages(CancellationToken cancellationToken = default); + + /// + /// List Account Images List all account images for the ShipEngine account + /// + /// 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 (ListAccountSettingsImagesResponseBody) + Task ListAccountImages(HttpClient methodClient, CancellationToken cancellationToken = default); + + /// + /// List Account Settings List all account settings for the ShipEngine account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetAccountSettingsResponseBody) + Task ListAccountSettings(CancellationToken cancellationToken = default); + + /// + /// List Account Settings List all account settings for the ShipEngine account + /// + /// 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 (GetAccountSettingsResponseBody) + Task ListAccountSettings(HttpClient methodClient, CancellationToken cancellationToken = default); + + /// + /// Update Account Image By ID Update information for an account image. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Label Image Id + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task UpdateAccountSettingsImagesById(string labelImageId, UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, CancellationToken cancellationToken = default); + + /// + /// Update Account Image By ID Update information for an account image. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Label Image Id + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task UpdateAccountSettingsImagesById(HttpClient methodClient, string labelImageId, UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, CancellationToken cancellationToken = default); + +} + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial class ShipEngine +{ + /// + /// Create an Account Image Create an Account Image + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetAccountSettingsImagesResponseBody) + public Task CreateAccountImage(CreateAccountSettingsImageRequestBody createAccountSettingsImageRequestBody, CancellationToken cancellationToken = default) + { + return CreateAccountImage(_client, createAccountSettingsImageRequestBody, cancellationToken); + } + + /// + /// Create an Account Image Create an Account Image + /// + /// 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 (GetAccountSettingsImagesResponseBody) + public async Task CreateAccountImage(HttpClient methodClient, CreateAccountSettingsImageRequestBody createAccountSettingsImageRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'createAccountSettingsImageRequestBody' is set + if (createAccountSettingsImageRequestBody == null) + { + throw new ArgumentNullException(nameof(createAccountSettingsImageRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/account/settings/images"); + + requestOptions.Data = JsonSerializer.Serialize(createAccountSettingsImageRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "AccountApi.CreateAccountImage"; + + var result = await SendHttpRequestAsync(HttpMethods.Post, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Delete Account Image By Id Delete Account Image By Id + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Label Image Id + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public Task DeleteAccountImageById(string labelImageId, CancellationToken cancellationToken = default) + { + return DeleteAccountImageById(_client, labelImageId, cancellationToken); + } + + /// + /// Delete Account Image By Id Delete Account Image By Id + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Label Image Id + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public async Task DeleteAccountImageById(HttpClient methodClient, string labelImageId, CancellationToken cancellationToken = default) + { + // verify the required parameter 'labelImageId' is set + if (labelImageId == null) + { + throw new ArgumentNullException(nameof(labelImageId)); + } + + + RequestOptions requestOptions = new("/v1/account/settings/images/{label_image_id}"); + + requestOptions.PathParameters.Add("label_image_id", ShipEngineSDK.ClientUtils.ParameterToString(labelImageId)); // path parameter + + requestOptions.Operation = "AccountApi.DeleteAccountImageById"; + + var result = await SendHttpRequestAsync(HttpMethods.Delete, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Get Account Image By ID Retrieve information for an account image. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Label Image Id + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetAccountSettingsImagesResponseBody) + public Task GetAccountSettingsImagesById(string labelImageId, CancellationToken cancellationToken = default) + { + return GetAccountSettingsImagesById(_client, labelImageId, cancellationToken); + } + + /// + /// Get Account Image By ID Retrieve information for an account image. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Label Image Id + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetAccountSettingsImagesResponseBody) + public async Task GetAccountSettingsImagesById(HttpClient methodClient, string labelImageId, CancellationToken cancellationToken = default) + { + // verify the required parameter 'labelImageId' is set + if (labelImageId == null) + { + throw new ArgumentNullException(nameof(labelImageId)); + } + + + RequestOptions requestOptions = new("/v1/account/settings/images/{label_image_id}"); + + requestOptions.PathParameters.Add("label_image_id", ShipEngineSDK.ClientUtils.ParameterToString(labelImageId)); // path parameter + + requestOptions.Operation = "AccountApi.GetAccountSettingsImagesById"; + + var result = await SendHttpRequestAsync(HttpMethods.Get, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// List Account Images List all account images for the ShipEngine account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ListAccountSettingsImagesResponseBody) + public Task ListAccountImages(CancellationToken cancellationToken = default) + { + return ListAccountImages(_client, cancellationToken); + } + + /// + /// List Account Images List all account images for the ShipEngine account + /// + /// 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 (ListAccountSettingsImagesResponseBody) + public async Task ListAccountImages(HttpClient methodClient, CancellationToken cancellationToken = default) + { + + RequestOptions requestOptions = new("/v1/account/settings/images"); + + + requestOptions.Operation = "AccountApi.ListAccountImages"; + + var result = await SendHttpRequestAsync(HttpMethods.Get, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// List Account Settings List all account settings for the ShipEngine account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetAccountSettingsResponseBody) + public Task ListAccountSettings(CancellationToken cancellationToken = default) + { + return ListAccountSettings(_client, cancellationToken); + } + + /// + /// List Account Settings List all account settings for the ShipEngine account + /// + /// 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 (GetAccountSettingsResponseBody) + public async Task ListAccountSettings(HttpClient methodClient, CancellationToken cancellationToken = default) + { + + RequestOptions requestOptions = new("/v1/account/settings"); + + + requestOptions.Operation = "AccountApi.ListAccountSettings"; + + var result = await SendHttpRequestAsync(HttpMethods.Get, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Update Account Image By ID Update information for an account image. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Label Image Id + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public Task UpdateAccountSettingsImagesById(string labelImageId, UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, CancellationToken cancellationToken = default) + { + return UpdateAccountSettingsImagesById(_client, labelImageId, updateAccountSettingsImageRequestBody, cancellationToken); + } + + /// + /// Update Account Image By ID Update information for an account image. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Label Image Id + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public async Task UpdateAccountSettingsImagesById(HttpClient methodClient, string labelImageId, UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'labelImageId' is set + if (labelImageId == null) + { + throw new ArgumentNullException(nameof(labelImageId)); + } + + // verify the required parameter 'updateAccountSettingsImageRequestBody' is set + if (updateAccountSettingsImageRequestBody == null) + { + throw new ArgumentNullException(nameof(updateAccountSettingsImageRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/account/settings/images/{label_image_id}"); + + requestOptions.PathParameters.Add("label_image_id", ShipEngineSDK.ClientUtils.ParameterToString(labelImageId)); // path parameter + requestOptions.Data = JsonSerializer.Serialize(updateAccountSettingsImageRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "AccountApi.UpdateAccountSettingsImagesById"; + + var result = await SendHttpRequestAsync(HttpMethods.Put, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + +} \ No newline at end of file diff --git a/ShipEngineSDK/Api/AddressesApi.cs b/ShipEngineSDK/Api/AddressesApi.cs new file mode 100644 index 00000000..385afd1c --- /dev/null +++ b/ShipEngineSDK/Api/AddressesApi.cs @@ -0,0 +1,162 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using ShipEngineSDK.Model; +using System; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Net; +using System.Net.Http; +using System.Net.Mime; +using System.Text.Json; +using System.Threading; +using System.Threading.Tasks; + +namespace ShipEngineSDK; + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial interface IShipEngine +{ + /// + /// Parse an address The address-recognition API makes it easy for you to extract address data from unstructured text, including the recipient name, line 1, line 2, city, postal code, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's address-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed address data is returned in the same structure that's used for other ShipEngine APIs, such as address validation, rate quotes, and shipping labels. > **Note:** Address recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// 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. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ParseAddressResponseBody) + Task ParseAddress(ParseAddressRequestBody parseAddressRequestBody, CancellationToken cancellationToken = default); + + /// + /// Parse an address The address-recognition API makes it easy for you to extract address data from unstructured text, including the recipient name, line 1, line 2, city, postal code, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's address-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed address data is returned in the same structure that's used for other ShipEngine APIs, such as address validation, rate quotes, and shipping labels. > **Note:** Address recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// 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. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ParseAddressResponseBody) + Task ParseAddress(HttpClient methodClient, ParseAddressRequestBody parseAddressRequestBody, CancellationToken cancellationToken = default); + + /// + /// Validate An Address Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. ShipEngine cross references multiple databases to validate addresses and identify potential deliverability issues. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (List<AddressValidationResult>) + Task> ValidateAddress(List addressToValidate, CancellationToken cancellationToken = default); + + /// + /// Validate An Address Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. ShipEngine cross references multiple databases to validate addresses and identify potential deliverability issues. + /// + /// 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 (List<AddressValidationResult>) + Task> ValidateAddress(HttpClient methodClient, List addressToValidate, CancellationToken cancellationToken = default); + +} + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial class ShipEngine +{ + /// + /// Parse an address The address-recognition API makes it easy for you to extract address data from unstructured text, including the recipient name, line 1, line 2, city, postal code, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's address-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed address data is returned in the same structure that's used for other ShipEngine APIs, such as address validation, rate quotes, and shipping labels. > **Note:** Address recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// 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. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ParseAddressResponseBody) + public Task ParseAddress(ParseAddressRequestBody parseAddressRequestBody, CancellationToken cancellationToken = default) + { + return ParseAddress(_client, parseAddressRequestBody, cancellationToken); + } + + /// + /// Parse an address The address-recognition API makes it easy for you to extract address data from unstructured text, including the recipient name, line 1, line 2, city, postal code, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's address-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed address data is returned in the same structure that's used for other ShipEngine APIs, such as address validation, rate quotes, and shipping labels. > **Note:** Address recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// 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. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ParseAddressResponseBody) + public async Task ParseAddress(HttpClient methodClient, ParseAddressRequestBody parseAddressRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'parseAddressRequestBody' is set + if (parseAddressRequestBody == null) + { + throw new ArgumentNullException(nameof(parseAddressRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/addresses/recognize"); + + requestOptions.Data = JsonSerializer.Serialize(parseAddressRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "AddressesApi.ParseAddress"; + + var result = await SendHttpRequestAsync(HttpMethods.Put, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Validate An Address Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. ShipEngine cross references multiple databases to validate addresses and identify potential deliverability issues. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (List<AddressValidationResult>) + public Task> ValidateAddress(List addressToValidate, CancellationToken cancellationToken = default) + { + return ValidateAddress(_client, addressToValidate, cancellationToken); + } + + /// + /// Validate An Address Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. ShipEngine cross references multiple databases to validate addresses and identify potential deliverability issues. + /// + /// 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 (List<AddressValidationResult>) + public async Task> ValidateAddress(HttpClient methodClient, List addressToValidate, CancellationToken cancellationToken = default) + { + // verify the required parameter 'addressToValidate' is set + if (addressToValidate == null) + { + throw new ArgumentNullException(nameof(addressToValidate)); + } + + + RequestOptions requestOptions = new("/v1/addresses/validate"); + + requestOptions.Data = JsonSerializer.Serialize(addressToValidate, JsonSerializerOptions); + + requestOptions.Operation = "AddressesApi.ValidateAddress"; + + var result = await SendHttpRequestAsync>(HttpMethods.Post, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + +} \ No newline at end of file diff --git a/ShipEngineSDK/Api/CarrierAccountsApi.cs b/ShipEngineSDK/Api/CarrierAccountsApi.cs new file mode 100644 index 00000000..b3dcd874 --- /dev/null +++ b/ShipEngineSDK/Api/CarrierAccountsApi.cs @@ -0,0 +1,319 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using ShipEngineSDK.Model; +using System; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Net; +using System.Net.Http; +using System.Net.Mime; +using System.Text.Json; +using System.Threading; +using System.Threading.Tasks; + +namespace ShipEngineSDK; + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial interface IShipEngine +{ + /// + /// Connect a carrier account Connect a carrier account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ConnectCarrierResponseBody) + Task ConnectCarrier(CarrierName carrierName, ConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default); + + /// + /// Connect a carrier account Connect a carrier account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ConnectCarrierResponseBody) + Task ConnectCarrier(HttpClient methodClient, CarrierName carrierName, ConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default); + + /// + /// Disconnect a carrier Disconnect a carrier + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task DisconnectCarrier(CarrierName carrierName, string carrierId, CancellationToken cancellationToken = default); + + /// + /// Disconnect a carrier Disconnect a carrier + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task DisconnectCarrier(HttpClient methodClient, CarrierName carrierName, string carrierId, CancellationToken cancellationToken = default); + + /// + /// Get carrier settings Get carrier settings + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// The carrier name, such as `ups`, `fedex`, or `dhl_express`. + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetCarrierSettingsResponseBody) + Task GetCarrierSettings(CarrierNameWithSettings carrierName, string carrierId, CancellationToken cancellationToken = default); + + /// + /// Get carrier settings Get carrier settings + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// The carrier name, such as `ups`, `fedex`, or `dhl_express`. + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetCarrierSettingsResponseBody) + Task GetCarrierSettings(HttpClient methodClient, CarrierNameWithSettings carrierName, string carrierId, CancellationToken cancellationToken = default); + + /// + /// Update carrier settings Update carrier settings + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// The carrier name, such as `ups`, `fedex`, or `dhl_express`. + /// Carrier ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task UpdateCarrierSettings(CarrierNameWithSettings carrierName, string carrierId, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, CancellationToken cancellationToken = default); + + /// + /// Update carrier settings Update carrier settings + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// The carrier name, such as `ups`, `fedex`, or `dhl_express`. + /// Carrier ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task UpdateCarrierSettings(HttpClient methodClient, CarrierNameWithSettings carrierName, string carrierId, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, CancellationToken cancellationToken = default); + +} + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial class ShipEngine +{ + /// + /// Connect a carrier account Connect a carrier account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ConnectCarrierResponseBody) + public Task ConnectCarrier(CarrierName carrierName, ConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default) + { + return ConnectCarrier(_client, carrierName, connectCarrierRequestBody, cancellationToken); + } + + /// + /// Connect a carrier account Connect a carrier account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ConnectCarrierResponseBody) + public async Task ConnectCarrier(HttpClient methodClient, CarrierName carrierName, ConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'connectCarrierRequestBody' is set + if (connectCarrierRequestBody == null) + { + throw new ArgumentNullException(nameof(connectCarrierRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/connections/carriers/{carrier_name}"); + + requestOptions.PathParameters.Add("carrier_name", ShipEngineSDK.ClientUtils.ParameterToString(carrierName)); // path parameter + requestOptions.Data = JsonSerializer.Serialize(connectCarrierRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "CarrierAccountsApi.ConnectCarrier"; + + var result = await SendHttpRequestAsync(HttpMethods.Post, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Disconnect a carrier Disconnect a carrier + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public Task DisconnectCarrier(CarrierName carrierName, string carrierId, CancellationToken cancellationToken = default) + { + return DisconnectCarrier(_client, carrierName, carrierId, cancellationToken); + } + + /// + /// Disconnect a carrier Disconnect a carrier + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public async Task DisconnectCarrier(HttpClient methodClient, CarrierName carrierName, string carrierId, CancellationToken cancellationToken = default) + { + // verify the required parameter 'carrierId' is set + if (carrierId == null) + { + throw new ArgumentNullException(nameof(carrierId)); + } + + + RequestOptions requestOptions = new("/v1/connections/carriers/{carrier_name}/{carrier_id}"); + + requestOptions.PathParameters.Add("carrier_name", ShipEngineSDK.ClientUtils.ParameterToString(carrierName)); // path parameter + requestOptions.PathParameters.Add("carrier_id", ShipEngineSDK.ClientUtils.ParameterToString(carrierId)); // path parameter + + requestOptions.Operation = "CarrierAccountsApi.DisconnectCarrier"; + + var result = await SendHttpRequestAsync(HttpMethods.Delete, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Get carrier settings Get carrier settings + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// The carrier name, such as `ups`, `fedex`, or `dhl_express`. + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetCarrierSettingsResponseBody) + public Task GetCarrierSettings(CarrierNameWithSettings carrierName, string carrierId, CancellationToken cancellationToken = default) + { + return GetCarrierSettings(_client, carrierName, carrierId, cancellationToken); + } + + /// + /// Get carrier settings Get carrier settings + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// The carrier name, such as `ups`, `fedex`, or `dhl_express`. + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetCarrierSettingsResponseBody) + public async Task GetCarrierSettings(HttpClient methodClient, CarrierNameWithSettings carrierName, string carrierId, CancellationToken cancellationToken = default) + { + // verify the required parameter 'carrierId' is set + if (carrierId == null) + { + throw new ArgumentNullException(nameof(carrierId)); + } + + + RequestOptions requestOptions = new("/v1/connections/carriers/{carrier_name}/{carrier_id}/settings"); + + requestOptions.PathParameters.Add("carrier_name", ShipEngineSDK.ClientUtils.ParameterToString(carrierName)); // path parameter + requestOptions.PathParameters.Add("carrier_id", ShipEngineSDK.ClientUtils.ParameterToString(carrierId)); // path parameter + + requestOptions.Operation = "CarrierAccountsApi.GetCarrierSettings"; + + var result = await SendHttpRequestAsync(HttpMethods.Get, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Update carrier settings Update carrier settings + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// The carrier name, such as `ups`, `fedex`, or `dhl_express`. + /// Carrier ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public Task UpdateCarrierSettings(CarrierNameWithSettings carrierName, string carrierId, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, CancellationToken cancellationToken = default) + { + return UpdateCarrierSettings(_client, carrierName, carrierId, updateCarrierSettingsRequestBody, cancellationToken); + } + + /// + /// Update carrier settings Update carrier settings + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// The carrier name, such as `ups`, `fedex`, or `dhl_express`. + /// Carrier ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public async Task UpdateCarrierSettings(HttpClient methodClient, CarrierNameWithSettings carrierName, string carrierId, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'carrierId' is set + if (carrierId == null) + { + throw new ArgumentNullException(nameof(carrierId)); + } + + // verify the required parameter 'updateCarrierSettingsRequestBody' is set + if (updateCarrierSettingsRequestBody == null) + { + throw new ArgumentNullException(nameof(updateCarrierSettingsRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/connections/carriers/{carrier_name}/{carrier_id}/settings"); + + requestOptions.PathParameters.Add("carrier_name", ShipEngineSDK.ClientUtils.ParameterToString(carrierName)); // path parameter + requestOptions.PathParameters.Add("carrier_id", ShipEngineSDK.ClientUtils.ParameterToString(carrierId)); // path parameter + requestOptions.Data = JsonSerializer.Serialize(updateCarrierSettingsRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "CarrierAccountsApi.UpdateCarrierSettings"; + + var result = await SendHttpRequestAsync(HttpMethods.Put, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + +} \ No newline at end of file diff --git a/ShipEngineSDK/Api/CarriersApi.cs b/ShipEngineSDK/Api/CarriersApi.cs new file mode 100644 index 00000000..b1bdd096 --- /dev/null +++ b/ShipEngineSDK/Api/CarriersApi.cs @@ -0,0 +1,477 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using ShipEngineSDK.Model; +using System; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Net; +using System.Net.Http; +using System.Net.Mime; +using System.Text.Json; +using System.Threading; +using System.Threading.Tasks; + +namespace ShipEngineSDK; + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial interface IShipEngine +{ + /// + /// Add Funds To Carrier Add Funds To A Carrier + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Carrier ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (AddFundsToCarrierResponseBody) + Task AddFundsToCarrier(string carrierId, AddFundsToCarrierRequestBody addFundsToCarrierRequestBody, CancellationToken cancellationToken = default); + + /// + /// Add Funds To Carrier Add Funds To A Carrier + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Carrier ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (AddFundsToCarrierResponseBody) + Task AddFundsToCarrier(HttpClient methodClient, string carrierId, AddFundsToCarrierRequestBody addFundsToCarrierRequestBody, CancellationToken cancellationToken = default); + + /// + /// Disconnect Carrier by ID Disconnect a Carrier of the given ID from the account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task DisconnectCarrierById(string carrierId, CancellationToken cancellationToken = default); + + /// + /// Disconnect Carrier by ID Disconnect a Carrier of the given ID from the account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task DisconnectCarrierById(HttpClient methodClient, string carrierId, CancellationToken cancellationToken = default); + + /// + /// Get Carrier By ID Retrive carrier info by ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetCarrierByIdResponseBody) + Task GetCarrierById(string carrierId, CancellationToken cancellationToken = default); + + /// + /// Get Carrier By ID Retrive carrier info by ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetCarrierByIdResponseBody) + Task GetCarrierById(HttpClient methodClient, string carrierId, CancellationToken cancellationToken = default); + + /// + /// Get Carrier Options Get a list of the options available for the carrier + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetCarrierOptionsResponseBody) + Task GetCarrierOptions(string carrierId, CancellationToken cancellationToken = default); + + /// + /// Get Carrier Options Get a list of the options available for the carrier + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetCarrierOptionsResponseBody) + Task GetCarrierOptions(HttpClient methodClient, string carrierId, CancellationToken cancellationToken = default); + + /// + /// List Carrier Package Types List the package types associated with the carrier + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ListCarrierPackageTypesResponseBody) + Task ListCarrierPackageTypes(string carrierId, CancellationToken cancellationToken = default); + + /// + /// List Carrier Package Types List the package types associated with the carrier + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ListCarrierPackageTypesResponseBody) + Task ListCarrierPackageTypes(HttpClient methodClient, string carrierId, CancellationToken cancellationToken = default); + + /// + /// List Carrier Services List the services associated with the carrier ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ListCarrierServicesResponseBody) + Task ListCarrierServices(string carrierId, CancellationToken cancellationToken = default); + + /// + /// List Carrier Services List the services associated with the carrier ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ListCarrierServicesResponseBody) + Task ListCarrierServices(HttpClient methodClient, string carrierId, CancellationToken cancellationToken = default); + + /// + /// List Carriers List all carriers that have been added to this account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetCarriersResponseBody) + Task ListCarriers(CancellationToken cancellationToken = default); + + /// + /// List Carriers List all carriers that have been added to this account + /// + /// 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 (GetCarriersResponseBody) + Task ListCarriers(HttpClient methodClient, CancellationToken cancellationToken = default); + +} + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial class ShipEngine +{ + /// + /// Add Funds To Carrier Add Funds To A Carrier + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Carrier ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (AddFundsToCarrierResponseBody) + public Task AddFundsToCarrier(string carrierId, AddFundsToCarrierRequestBody addFundsToCarrierRequestBody, CancellationToken cancellationToken = default) + { + return AddFundsToCarrier(_client, carrierId, addFundsToCarrierRequestBody, cancellationToken); + } + + /// + /// Add Funds To Carrier Add Funds To A Carrier + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Carrier ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (AddFundsToCarrierResponseBody) + public async Task AddFundsToCarrier(HttpClient methodClient, string carrierId, AddFundsToCarrierRequestBody addFundsToCarrierRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'carrierId' is set + if (carrierId == null) + { + throw new ArgumentNullException(nameof(carrierId)); + } + + // verify the required parameter 'addFundsToCarrierRequestBody' is set + if (addFundsToCarrierRequestBody == null) + { + throw new ArgumentNullException(nameof(addFundsToCarrierRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/carriers/{carrier_id}/add_funds"); + + requestOptions.PathParameters.Add("carrier_id", ShipEngineSDK.ClientUtils.ParameterToString(carrierId)); // path parameter + requestOptions.Data = JsonSerializer.Serialize(addFundsToCarrierRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "CarriersApi.AddFundsToCarrier"; + + var result = await SendHttpRequestAsync(HttpMethods.Put, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Disconnect Carrier by ID Disconnect a Carrier of the given ID from the account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public Task DisconnectCarrierById(string carrierId, CancellationToken cancellationToken = default) + { + return DisconnectCarrierById(_client, carrierId, cancellationToken); + } + + /// + /// Disconnect Carrier by ID Disconnect a Carrier of the given ID from the account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public async Task DisconnectCarrierById(HttpClient methodClient, string carrierId, CancellationToken cancellationToken = default) + { + // verify the required parameter 'carrierId' is set + if (carrierId == null) + { + throw new ArgumentNullException(nameof(carrierId)); + } + + + RequestOptions requestOptions = new("/v1/carriers/{carrier_id}"); + + requestOptions.PathParameters.Add("carrier_id", ShipEngineSDK.ClientUtils.ParameterToString(carrierId)); // path parameter + + requestOptions.Operation = "CarriersApi.DisconnectCarrierById"; + + var result = await SendHttpRequestAsync(HttpMethods.Delete, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Get Carrier By ID Retrive carrier info by ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetCarrierByIdResponseBody) + public Task GetCarrierById(string carrierId, CancellationToken cancellationToken = default) + { + return GetCarrierById(_client, carrierId, cancellationToken); + } + + /// + /// Get Carrier By ID Retrive carrier info by ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetCarrierByIdResponseBody) + public async Task GetCarrierById(HttpClient methodClient, string carrierId, CancellationToken cancellationToken = default) + { + // verify the required parameter 'carrierId' is set + if (carrierId == null) + { + throw new ArgumentNullException(nameof(carrierId)); + } + + + RequestOptions requestOptions = new("/v1/carriers/{carrier_id}"); + + requestOptions.PathParameters.Add("carrier_id", ShipEngineSDK.ClientUtils.ParameterToString(carrierId)); // path parameter + + requestOptions.Operation = "CarriersApi.GetCarrierById"; + + var result = await SendHttpRequestAsync(HttpMethods.Get, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Get Carrier Options Get a list of the options available for the carrier + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetCarrierOptionsResponseBody) + public Task GetCarrierOptions(string carrierId, CancellationToken cancellationToken = default) + { + return GetCarrierOptions(_client, carrierId, cancellationToken); + } + + /// + /// Get Carrier Options Get a list of the options available for the carrier + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetCarrierOptionsResponseBody) + public async Task GetCarrierOptions(HttpClient methodClient, string carrierId, CancellationToken cancellationToken = default) + { + // verify the required parameter 'carrierId' is set + if (carrierId == null) + { + throw new ArgumentNullException(nameof(carrierId)); + } + + + RequestOptions requestOptions = new("/v1/carriers/{carrier_id}/options"); + + requestOptions.PathParameters.Add("carrier_id", ShipEngineSDK.ClientUtils.ParameterToString(carrierId)); // path parameter + + requestOptions.Operation = "CarriersApi.GetCarrierOptions"; + + var result = await SendHttpRequestAsync(HttpMethods.Get, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// List Carrier Package Types List the package types associated with the carrier + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ListCarrierPackageTypesResponseBody) + public Task ListCarrierPackageTypes(string carrierId, CancellationToken cancellationToken = default) + { + return ListCarrierPackageTypes(_client, carrierId, cancellationToken); + } + + /// + /// List Carrier Package Types List the package types associated with the carrier + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ListCarrierPackageTypesResponseBody) + public async Task ListCarrierPackageTypes(HttpClient methodClient, string carrierId, CancellationToken cancellationToken = default) + { + // verify the required parameter 'carrierId' is set + if (carrierId == null) + { + throw new ArgumentNullException(nameof(carrierId)); + } + + + RequestOptions requestOptions = new("/v1/carriers/{carrier_id}/packages"); + + requestOptions.PathParameters.Add("carrier_id", ShipEngineSDK.ClientUtils.ParameterToString(carrierId)); // path parameter + + requestOptions.Operation = "CarriersApi.ListCarrierPackageTypes"; + + var result = await SendHttpRequestAsync(HttpMethods.Get, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// List Carrier Services List the services associated with the carrier ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ListCarrierServicesResponseBody) + public Task ListCarrierServices(string carrierId, CancellationToken cancellationToken = default) + { + return ListCarrierServices(_client, carrierId, cancellationToken); + } + + /// + /// List Carrier Services List the services associated with the carrier ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Carrier ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ListCarrierServicesResponseBody) + public async Task ListCarrierServices(HttpClient methodClient, string carrierId, CancellationToken cancellationToken = default) + { + // verify the required parameter 'carrierId' is set + if (carrierId == null) + { + throw new ArgumentNullException(nameof(carrierId)); + } + + + RequestOptions requestOptions = new("/v1/carriers/{carrier_id}/services"); + + requestOptions.PathParameters.Add("carrier_id", ShipEngineSDK.ClientUtils.ParameterToString(carrierId)); // path parameter + + requestOptions.Operation = "CarriersApi.ListCarrierServices"; + + var result = await SendHttpRequestAsync(HttpMethods.Get, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// List Carriers List all carriers that have been added to this account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetCarriersResponseBody) + public Task ListCarriers(CancellationToken cancellationToken = default) + { + return ListCarriers(_client, cancellationToken); + } + + /// + /// List Carriers List all carriers that have been added to this account + /// + /// 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 (GetCarriersResponseBody) + public async Task ListCarriers(HttpClient methodClient, CancellationToken cancellationToken = default) + { + + RequestOptions requestOptions = new("/v1/carriers"); + + + requestOptions.Operation = "CarriersApi.ListCarriers"; + + var result = await SendHttpRequestAsync(HttpMethods.Get, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + +} \ No newline at end of file diff --git a/ShipEngineSDK/Api/InsuranceApi.cs b/ShipEngineSDK/Api/InsuranceApi.cs new file mode 100644 index 00000000..482f3360 --- /dev/null +++ b/ShipEngineSDK/Api/InsuranceApi.cs @@ -0,0 +1,266 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using ShipEngineSDK.Model; +using System; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Net; +using System.Net.Http; +using System.Net.Mime; +using System.Text.Json; +using System.Threading; +using System.Threading.Tasks; + +namespace ShipEngineSDK; + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial interface IShipEngine +{ + /// + /// Add Funds To Insurance You may need to auto fund your account from time to time. For example, if you don't normally ship items over $100, and may want to add funds to insurance rather than keeping the account funded. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (AddFundsToInsuranceResponseBody) + Task AddFundsToInsurance(AddFundsToInsuranceRequestBody addFundsToInsuranceRequestBody, CancellationToken cancellationToken = default); + + /// + /// Add Funds To Insurance You may need to auto fund your account from time to time. For example, if you don't normally ship items over $100, and may want to add funds to insurance rather than keeping the account funded. + /// + /// 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 (AddFundsToInsuranceResponseBody) + Task AddFundsToInsurance(HttpClient methodClient, AddFundsToInsuranceRequestBody addFundsToInsuranceRequestBody, CancellationToken cancellationToken = default); + + /// + /// Connect a Shipsurance Account Connect a Shipsurance Account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (Object) + Task ConnectInsurer(ConnectInsurerRequestBody connectInsurerRequestBody, CancellationToken cancellationToken = default); + + /// + /// Connect a Shipsurance Account Connect a Shipsurance Account + /// + /// 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 (Object) + Task ConnectInsurer(HttpClient methodClient, ConnectInsurerRequestBody connectInsurerRequestBody, CancellationToken cancellationToken = default); + + /// + /// Disconnect a Shipsurance Account Disconnect a Shipsurance Account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (Object) + Task DisconnectInsurer(CancellationToken cancellationToken = default); + + /// + /// Disconnect a Shipsurance Account Disconnect a Shipsurance Account + /// + /// 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 (Object) + Task DisconnectInsurer(HttpClient methodClient, CancellationToken cancellationToken = default); + + /// + /// Get Insurance Funds Balance Retrieve the balance of your Shipsurance account. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetInsuranceBalanceResponseBody) + Task GetInsuranceBalance(CancellationToken cancellationToken = default); + + /// + /// Get Insurance Funds Balance Retrieve the balance of your Shipsurance account. + /// + /// 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 (GetInsuranceBalanceResponseBody) + Task GetInsuranceBalance(HttpClient methodClient, CancellationToken cancellationToken = default); + +} + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial class ShipEngine +{ + /// + /// Add Funds To Insurance You may need to auto fund your account from time to time. For example, if you don't normally ship items over $100, and may want to add funds to insurance rather than keeping the account funded. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (AddFundsToInsuranceResponseBody) + public Task AddFundsToInsurance(AddFundsToInsuranceRequestBody addFundsToInsuranceRequestBody, CancellationToken cancellationToken = default) + { + return AddFundsToInsurance(_client, addFundsToInsuranceRequestBody, cancellationToken); + } + + /// + /// Add Funds To Insurance You may need to auto fund your account from time to time. For example, if you don't normally ship items over $100, and may want to add funds to insurance rather than keeping the account funded. + /// + /// 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 (AddFundsToInsuranceResponseBody) + public async Task AddFundsToInsurance(HttpClient methodClient, AddFundsToInsuranceRequestBody addFundsToInsuranceRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'addFundsToInsuranceRequestBody' is set + if (addFundsToInsuranceRequestBody == null) + { + throw new ArgumentNullException(nameof(addFundsToInsuranceRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/insurance/shipsurance/add_funds"); + + requestOptions.Data = JsonSerializer.Serialize(addFundsToInsuranceRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "InsuranceApi.AddFundsToInsurance"; + + var result = await SendHttpRequestAsync(HttpMethods.Patch, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Connect a Shipsurance Account Connect a Shipsurance Account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (Object) + public Task ConnectInsurer(ConnectInsurerRequestBody connectInsurerRequestBody, CancellationToken cancellationToken = default) + { + return ConnectInsurer(_client, connectInsurerRequestBody, cancellationToken); + } + + /// + /// Connect a Shipsurance Account Connect a Shipsurance Account + /// + /// 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 (Object) + public async Task ConnectInsurer(HttpClient methodClient, ConnectInsurerRequestBody connectInsurerRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'connectInsurerRequestBody' is set + if (connectInsurerRequestBody == null) + { + throw new ArgumentNullException(nameof(connectInsurerRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/connections/insurance/shipsurance"); + + requestOptions.Data = JsonSerializer.Serialize(connectInsurerRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "InsuranceApi.ConnectInsurer"; + + var result = await SendHttpRequestAsync(HttpMethods.Post, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Disconnect a Shipsurance Account Disconnect a Shipsurance Account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (Object) + public Task DisconnectInsurer(CancellationToken cancellationToken = default) + { + return DisconnectInsurer(_client, cancellationToken); + } + + /// + /// Disconnect a Shipsurance Account Disconnect a Shipsurance Account + /// + /// 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 (Object) + public async Task DisconnectInsurer(HttpClient methodClient, CancellationToken cancellationToken = default) + { + + RequestOptions requestOptions = new("/v1/connections/insurance/shipsurance"); + + + requestOptions.Operation = "InsuranceApi.DisconnectInsurer"; + + var result = await SendHttpRequestAsync(HttpMethods.Delete, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Get Insurance Funds Balance Retrieve the balance of your Shipsurance account. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetInsuranceBalanceResponseBody) + public Task GetInsuranceBalance(CancellationToken cancellationToken = default) + { + return GetInsuranceBalance(_client, cancellationToken); + } + + /// + /// Get Insurance Funds Balance Retrieve the balance of your Shipsurance account. + /// + /// 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 (GetInsuranceBalanceResponseBody) + public async Task GetInsuranceBalance(HttpClient methodClient, CancellationToken cancellationToken = default) + { + + RequestOptions requestOptions = new("/v1/insurance/shipsurance/balance"); + + + requestOptions.Operation = "InsuranceApi.GetInsuranceBalance"; + + var result = await SendHttpRequestAsync(HttpMethods.Get, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + +} \ No newline at end of file diff --git a/ShipEngineSDK/Api/PackageTypesApi.cs b/ShipEngineSDK/Api/PackageTypesApi.cs new file mode 100644 index 00000000..c39c0d96 --- /dev/null +++ b/ShipEngineSDK/Api/PackageTypesApi.cs @@ -0,0 +1,351 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using ShipEngineSDK.Model; +using System; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Net; +using System.Net.Http; +using System.Net.Mime; +using System.Text.Json; +using System.Threading; +using System.Threading.Tasks; + +namespace ShipEngineSDK; + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial interface IShipEngine +{ + /// + /// Create Custom Package Type Create a custom package type to better assist in getting accurate rate estimates + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (CreatePackageTypeResponseBody) + Task CreatePackageType(CreatePackageTypeRequestBody createPackageTypeRequestBody, CancellationToken cancellationToken = default); + + /// + /// Create Custom Package Type Create a custom package type to better assist in getting accurate rate estimates + /// + /// 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 (CreatePackageTypeResponseBody) + Task CreatePackageType(HttpClient methodClient, CreatePackageTypeRequestBody createPackageTypeRequestBody, CancellationToken cancellationToken = default); + + /// + /// Delete A Custom Package By ID Delete a custom package using the ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Package ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task DeletePackageType(string packageId, CancellationToken cancellationToken = default); + + /// + /// Delete A Custom Package By ID Delete a custom package using the ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Package ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task DeletePackageType(HttpClient methodClient, string packageId, CancellationToken cancellationToken = default); + + /// + /// Get Custom Package Type By ID Get Custom Package Type by ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Package ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetPackageTypeByIdResponseBody) + Task GetPackageTypeById(string packageId, CancellationToken cancellationToken = default); + + /// + /// Get Custom Package Type By ID Get Custom Package Type by ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Package ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetPackageTypeByIdResponseBody) + Task GetPackageTypeById(HttpClient methodClient, string packageId, CancellationToken cancellationToken = default); + + /// + /// List Custom Package Types List the custom package types associated with the account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ListPackageTypesResponseBody) + Task ListPackageTypes(CancellationToken cancellationToken = default); + + /// + /// List Custom Package Types List the custom package types associated with the account + /// + /// 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 (ListPackageTypesResponseBody) + Task ListPackageTypes(HttpClient methodClient, CancellationToken cancellationToken = default); + + /// + /// Update Custom Package Type By ID Update the custom package type object by ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Package ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task UpdatePackageType(string packageId, UpdatePackageTypeRequestBody updatePackageTypeRequestBody, CancellationToken cancellationToken = default); + + /// + /// Update Custom Package Type By ID Update the custom package type object by ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Package ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task UpdatePackageType(HttpClient methodClient, string packageId, UpdatePackageTypeRequestBody updatePackageTypeRequestBody, CancellationToken cancellationToken = default); + +} + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial class ShipEngine +{ + /// + /// Create Custom Package Type Create a custom package type to better assist in getting accurate rate estimates + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (CreatePackageTypeResponseBody) + public Task CreatePackageType(CreatePackageTypeRequestBody createPackageTypeRequestBody, CancellationToken cancellationToken = default) + { + return CreatePackageType(_client, createPackageTypeRequestBody, cancellationToken); + } + + /// + /// Create Custom Package Type Create a custom package type to better assist in getting accurate rate estimates + /// + /// 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 (CreatePackageTypeResponseBody) + public async Task CreatePackageType(HttpClient methodClient, CreatePackageTypeRequestBody createPackageTypeRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'createPackageTypeRequestBody' is set + if (createPackageTypeRequestBody == null) + { + throw new ArgumentNullException(nameof(createPackageTypeRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/packages"); + + requestOptions.Data = JsonSerializer.Serialize(createPackageTypeRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "PackageTypesApi.CreatePackageType"; + + var result = await SendHttpRequestAsync(HttpMethods.Post, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Delete A Custom Package By ID Delete a custom package using the ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Package ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public Task DeletePackageType(string packageId, CancellationToken cancellationToken = default) + { + return DeletePackageType(_client, packageId, cancellationToken); + } + + /// + /// Delete A Custom Package By ID Delete a custom package using the ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Package ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public async Task DeletePackageType(HttpClient methodClient, string packageId, CancellationToken cancellationToken = default) + { + // verify the required parameter 'packageId' is set + if (packageId == null) + { + throw new ArgumentNullException(nameof(packageId)); + } + + + RequestOptions requestOptions = new("/v1/packages/{package_id}"); + + requestOptions.PathParameters.Add("package_id", ShipEngineSDK.ClientUtils.ParameterToString(packageId)); // path parameter + + requestOptions.Operation = "PackageTypesApi.DeletePackageType"; + + var result = await SendHttpRequestAsync(HttpMethods.Delete, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Get Custom Package Type By ID Get Custom Package Type by ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Package ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetPackageTypeByIdResponseBody) + public Task GetPackageTypeById(string packageId, CancellationToken cancellationToken = default) + { + return GetPackageTypeById(_client, packageId, cancellationToken); + } + + /// + /// Get Custom Package Type By ID Get Custom Package Type by ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Package ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetPackageTypeByIdResponseBody) + public async Task GetPackageTypeById(HttpClient methodClient, string packageId, CancellationToken cancellationToken = default) + { + // verify the required parameter 'packageId' is set + if (packageId == null) + { + throw new ArgumentNullException(nameof(packageId)); + } + + + RequestOptions requestOptions = new("/v1/packages/{package_id}"); + + requestOptions.PathParameters.Add("package_id", ShipEngineSDK.ClientUtils.ParameterToString(packageId)); // path parameter + + requestOptions.Operation = "PackageTypesApi.GetPackageTypeById"; + + var result = await SendHttpRequestAsync(HttpMethods.Get, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// List Custom Package Types List the custom package types associated with the account + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ListPackageTypesResponseBody) + public Task ListPackageTypes(CancellationToken cancellationToken = default) + { + return ListPackageTypes(_client, cancellationToken); + } + + /// + /// List Custom Package Types List the custom package types associated with the account + /// + /// 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 (ListPackageTypesResponseBody) + public async Task ListPackageTypes(HttpClient methodClient, CancellationToken cancellationToken = default) + { + + RequestOptions requestOptions = new("/v1/packages"); + + + requestOptions.Operation = "PackageTypesApi.ListPackageTypes"; + + var result = await SendHttpRequestAsync(HttpMethods.Get, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Update Custom Package Type By ID Update the custom package type object by ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Package ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public Task UpdatePackageType(string packageId, UpdatePackageTypeRequestBody updatePackageTypeRequestBody, CancellationToken cancellationToken = default) + { + return UpdatePackageType(_client, packageId, updatePackageTypeRequestBody, cancellationToken); + } + + /// + /// Update Custom Package Type By ID Update the custom package type object by ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Package ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public async Task UpdatePackageType(HttpClient methodClient, string packageId, UpdatePackageTypeRequestBody updatePackageTypeRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'packageId' is set + if (packageId == null) + { + throw new ArgumentNullException(nameof(packageId)); + } + + // verify the required parameter 'updatePackageTypeRequestBody' is set + if (updatePackageTypeRequestBody == null) + { + throw new ArgumentNullException(nameof(updatePackageTypeRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/packages/{package_id}"); + + requestOptions.PathParameters.Add("package_id", ShipEngineSDK.ClientUtils.ParameterToString(packageId)); // path parameter + requestOptions.Data = JsonSerializer.Serialize(updatePackageTypeRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "PackageTypesApi.UpdatePackageType"; + + var result = await SendHttpRequestAsync(HttpMethods.Put, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + +} \ No newline at end of file diff --git a/ShipEngineSDK/Api/RatesApi.cs b/ShipEngineSDK/Api/RatesApi.cs new file mode 100644 index 00000000..1e5d2c64 --- /dev/null +++ b/ShipEngineSDK/Api/RatesApi.cs @@ -0,0 +1,288 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using ShipEngineSDK.Model; +using System; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Net; +using System.Net.Http; +using System.Net.Mime; +using System.Text.Json; +using System.Threading; +using System.Threading.Tasks; + +namespace ShipEngineSDK; + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial interface IShipEngine +{ + /// + /// Get Shipping Rates It's not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don't solely ship things using a single shipping option; so we provide functionality to show you all your options! + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (CalculateRatesResponseBody) + Task CalculateRates(CalculateRatesRequestBody calculateRatesRequestBody, CancellationToken cancellationToken = default); + + /// + /// Get Shipping Rates It's not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don't solely ship things using a single shipping option; so we provide functionality to show you all your options! + /// + /// 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 (CalculateRatesResponseBody) + Task CalculateRates(HttpClient methodClient, CalculateRatesRequestBody calculateRatesRequestBody, CancellationToken cancellationToken = default); + + /// + /// Get Bulk Rates Get Bulk Shipment Rates + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (List<BulkRate>) + Task> CompareBulkRates(CompareBulkRatesRequestBody compareBulkRatesRequestBody, CancellationToken cancellationToken = default); + + /// + /// Get Bulk Rates Get Bulk Shipment Rates + /// + /// 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 (List<BulkRate>) + Task> CompareBulkRates(HttpClient methodClient, CompareBulkRatesRequestBody compareBulkRatesRequestBody, CancellationToken cancellationToken = default); + + /// + /// Estimate Rates Get Rate Estimates + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (List<RateEstimate>) + Task> EstimateRates(EstimateRatesRequestBody estimateRatesRequestBody, CancellationToken cancellationToken = default); + + /// + /// Estimate Rates Get Rate Estimates + /// + /// 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 (List<RateEstimate>) + Task> EstimateRates(HttpClient methodClient, EstimateRatesRequestBody estimateRatesRequestBody, CancellationToken cancellationToken = default); + + /// + /// Get Rate By ID Retrieve a previously queried rate by its ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Rate ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetRateByIdResponseBody) + Task GetRateById(string rateId, CancellationToken cancellationToken = default); + + /// + /// Get Rate By ID Retrieve a previously queried rate by its ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Rate ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetRateByIdResponseBody) + Task GetRateById(HttpClient methodClient, string rateId, CancellationToken cancellationToken = default); + +} + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial class ShipEngine +{ + /// + /// Get Shipping Rates It's not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don't solely ship things using a single shipping option; so we provide functionality to show you all your options! + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (CalculateRatesResponseBody) + public Task CalculateRates(CalculateRatesRequestBody calculateRatesRequestBody, CancellationToken cancellationToken = default) + { + return CalculateRates(_client, calculateRatesRequestBody, cancellationToken); + } + + /// + /// Get Shipping Rates It's not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don't solely ship things using a single shipping option; so we provide functionality to show you all your options! + /// + /// 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 (CalculateRatesResponseBody) + public async Task CalculateRates(HttpClient methodClient, CalculateRatesRequestBody calculateRatesRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'calculateRatesRequestBody' is set + if (calculateRatesRequestBody == null) + { + throw new ArgumentNullException(nameof(calculateRatesRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/rates"); + + requestOptions.Data = JsonSerializer.Serialize(calculateRatesRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "RatesApi.CalculateRates"; + + var result = await SendHttpRequestAsync(HttpMethods.Post, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Get Bulk Rates Get Bulk Shipment Rates + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (List<BulkRate>) + public Task> CompareBulkRates(CompareBulkRatesRequestBody compareBulkRatesRequestBody, CancellationToken cancellationToken = default) + { + return CompareBulkRates(_client, compareBulkRatesRequestBody, cancellationToken); + } + + /// + /// Get Bulk Rates Get Bulk Shipment Rates + /// + /// 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 (List<BulkRate>) + public async Task> CompareBulkRates(HttpClient methodClient, CompareBulkRatesRequestBody compareBulkRatesRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'compareBulkRatesRequestBody' is set + if (compareBulkRatesRequestBody == null) + { + throw new ArgumentNullException(nameof(compareBulkRatesRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/rates/bulk"); + + requestOptions.Data = JsonSerializer.Serialize(compareBulkRatesRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "RatesApi.CompareBulkRates"; + + var result = await SendHttpRequestAsync>(HttpMethods.Post, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Estimate Rates Get Rate Estimates + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (List<RateEstimate>) + public Task> EstimateRates(EstimateRatesRequestBody estimateRatesRequestBody, CancellationToken cancellationToken = default) + { + return EstimateRates(_client, estimateRatesRequestBody, cancellationToken); + } + + /// + /// Estimate Rates Get Rate Estimates + /// + /// 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 (List<RateEstimate>) + public async Task> EstimateRates(HttpClient methodClient, EstimateRatesRequestBody estimateRatesRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'estimateRatesRequestBody' is set + if (estimateRatesRequestBody == null) + { + throw new ArgumentNullException(nameof(estimateRatesRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/rates/estimate"); + + requestOptions.Data = JsonSerializer.Serialize(estimateRatesRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "RatesApi.EstimateRates"; + + var result = await SendHttpRequestAsync>(HttpMethods.Post, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Get Rate By ID Retrieve a previously queried rate by its ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Rate ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetRateByIdResponseBody) + public Task GetRateById(string rateId, CancellationToken cancellationToken = default) + { + return GetRateById(_client, rateId, cancellationToken); + } + + /// + /// Get Rate By ID Retrieve a previously queried rate by its ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Rate ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetRateByIdResponseBody) + public async Task GetRateById(HttpClient methodClient, string rateId, CancellationToken cancellationToken = default) + { + // verify the required parameter 'rateId' is set + if (rateId == null) + { + throw new ArgumentNullException(nameof(rateId)); + } + + + RequestOptions requestOptions = new("/v1/rates/{rate_id}"); + + requestOptions.PathParameters.Add("rate_id", ShipEngineSDK.ClientUtils.ParameterToString(rateId)); // path parameter + + requestOptions.Operation = "RatesApi.GetRateById"; + + var result = await SendHttpRequestAsync(HttpMethods.Get, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + +} \ No newline at end of file diff --git a/ShipEngineSDK/Api/ServicePointsApi.cs b/ShipEngineSDK/Api/ServicePointsApi.cs new file mode 100644 index 00000000..f23c48af --- /dev/null +++ b/ShipEngineSDK/Api/ServicePointsApi.cs @@ -0,0 +1,184 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using ShipEngineSDK.Model; +using System; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Net; +using System.Net.Http; +using System.Net.Mime; +using System.Text.Json; +using System.Threading; +using System.Threading.Tasks; + +namespace ShipEngineSDK; + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial interface IShipEngine +{ + /// + /// Get Service Point By ID Returns a carrier service point by using the service_point_id + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Carrier code + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetServicePointByIdResponseBody) + Task ServicePointsGetById(string carrierCode, string countryCode, string servicePointId, CancellationToken cancellationToken = default); + + /// + /// Get Service Point By ID Returns a carrier service point by using the service_point_id + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Carrier code + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetServicePointByIdResponseBody) + Task ServicePointsGetById(HttpClient methodClient, string carrierCode, string countryCode, string servicePointId, CancellationToken cancellationToken = default); + + /// + /// List Service Points List carrier service points by location + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ListServicePointsResponseBody) + Task ServicePointsList(GetServicePointsRequest getServicePointsRequest, CancellationToken cancellationToken = default); + + /// + /// List Service Points List carrier service points by location + /// + /// 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 (ListServicePointsResponseBody) + Task ServicePointsList(HttpClient methodClient, GetServicePointsRequest getServicePointsRequest, CancellationToken cancellationToken = default); + +} + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial class ShipEngine +{ + /// + /// Get Service Point By ID Returns a carrier service point by using the service_point_id + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Carrier code + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetServicePointByIdResponseBody) + public Task ServicePointsGetById(string carrierCode, string countryCode, string servicePointId, CancellationToken cancellationToken = default) + { + return ServicePointsGetById(_client, carrierCode, countryCode, servicePointId, cancellationToken); + } + + /// + /// Get Service Point By ID Returns a carrier service point by using the service_point_id + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Carrier code + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetServicePointByIdResponseBody) + public async Task ServicePointsGetById(HttpClient methodClient, string carrierCode, string countryCode, string servicePointId, CancellationToken cancellationToken = default) + { + // verify the required parameter 'carrierCode' is set + if (carrierCode == null) + { + throw new ArgumentNullException(nameof(carrierCode)); + } + + // verify the required parameter 'countryCode' is set + if (countryCode == null) + { + throw new ArgumentNullException(nameof(countryCode)); + } + + // verify the required parameter 'servicePointId' is set + if (servicePointId == null) + { + throw new ArgumentNullException(nameof(servicePointId)); + } + + + RequestOptions requestOptions = new("/v1/service_points/{carrier_code}/{country_code}/{service_point_id}"); + + requestOptions.PathParameters.Add("carrier_code", ShipEngineSDK.ClientUtils.ParameterToString(carrierCode)); // path parameter + requestOptions.PathParameters.Add("country_code", ShipEngineSDK.ClientUtils.ParameterToString(countryCode)); // path parameter + requestOptions.PathParameters.Add("service_point_id", ShipEngineSDK.ClientUtils.ParameterToString(servicePointId)); // path parameter + + requestOptions.Operation = "ServicePointsApi.ServicePointsGetById"; + + var result = await SendHttpRequestAsync(HttpMethods.Get, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// List Service Points List carrier service points by location + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ListServicePointsResponseBody) + public Task ServicePointsList(GetServicePointsRequest getServicePointsRequest, CancellationToken cancellationToken = default) + { + return ServicePointsList(_client, getServicePointsRequest, cancellationToken); + } + + /// + /// List Service Points List carrier service points by location + /// + /// 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 (ListServicePointsResponseBody) + public async Task ServicePointsList(HttpClient methodClient, GetServicePointsRequest getServicePointsRequest, CancellationToken cancellationToken = default) + { + // verify the required parameter 'getServicePointsRequest' is set + if (getServicePointsRequest == null) + { + throw new ArgumentNullException(nameof(getServicePointsRequest)); + } + + + RequestOptions requestOptions = new("/v1/service_points/list"); + + requestOptions.Data = JsonSerializer.Serialize(getServicePointsRequest, JsonSerializerOptions); + + requestOptions.Operation = "ServicePointsApi.ServicePointsList"; + + var result = await SendHttpRequestAsync(HttpMethods.Post, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + +} \ No newline at end of file diff --git a/ShipEngineSDK/Api/TagsApi.cs b/ShipEngineSDK/Api/TagsApi.cs new file mode 100644 index 00000000..c1144fd7 --- /dev/null +++ b/ShipEngineSDK/Api/TagsApi.cs @@ -0,0 +1,288 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using ShipEngineSDK.Model; +using System; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Net; +using System.Net.Http; +using System.Net.Mime; +using System.Text.Json; +using System.Threading; +using System.Threading.Tasks; + +namespace ShipEngineSDK; + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial interface IShipEngine +{ + /// + /// 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(string tagName, 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, string tagName, CancellationToken cancellationToken = default); + + /// + /// Delete Tag Delete a tag that is no longer needed + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task DeleteTag(string tagName, CancellationToken cancellationToken = default); + + /// + /// Delete Tag Delete a tag that is no longer needed + /// + /// 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 (string) + Task DeleteTag(HttpClient methodClient, string tagName, CancellationToken cancellationToken = default); + + /// + /// Get Tags Get a list of all tags associated with an account. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ListTagsResponseBody) + Task ListTags(CancellationToken cancellationToken = default); + + /// + /// Get Tags Get a list of all tags associated with an account. + /// + /// 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 (ListTagsResponseBody) + Task ListTags(HttpClient methodClient, CancellationToken cancellationToken = default); + + /// + /// Update Tag Name Change a tag name while still keeping the relevant shipments attached to it + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task RenameTag(string tagName, string newTagName, CancellationToken cancellationToken = default); + + /// + /// Update Tag Name Change a tag name while still keeping the relevant shipments attached to it + /// + /// 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 (string) + Task RenameTag(HttpClient methodClient, string tagName, string newTagName, CancellationToken cancellationToken = default); + +} + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial class ShipEngine +{ + /// + /// 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(string tagName, CancellationToken cancellationToken = default) + { + return CreateTag(_client, tagName, 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, string tagName, CancellationToken cancellationToken = default) + { + // verify the required parameter 'tagName' is set + if (tagName == null) + { + throw new ArgumentNullException(nameof(tagName)); + } + + + RequestOptions requestOptions = new("/v1/tags/{tag_name}"); + + requestOptions.PathParameters.Add("tag_name", ShipEngineSDK.ClientUtils.ParameterToString(tagName)); // path parameter + + requestOptions.Operation = "TagsApi.CreateTag"; + + var result = await SendHttpRequestAsync(HttpMethods.Post, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Delete Tag Delete a tag that is no longer needed + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public Task DeleteTag(string tagName, CancellationToken cancellationToken = default) + { + return DeleteTag(_client, tagName, cancellationToken); + } + + /// + /// Delete Tag Delete a tag that is no longer needed + /// + /// 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 (string) + public async Task DeleteTag(HttpClient methodClient, string tagName, CancellationToken cancellationToken = default) + { + // verify the required parameter 'tagName' is set + if (tagName == null) + { + throw new ArgumentNullException(nameof(tagName)); + } + + + RequestOptions requestOptions = new("/v1/tags/{tag_name}"); + + requestOptions.PathParameters.Add("tag_name", ShipEngineSDK.ClientUtils.ParameterToString(tagName)); // path parameter + + requestOptions.Operation = "TagsApi.DeleteTag"; + + var result = await SendHttpRequestAsync(HttpMethods.Delete, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Get Tags Get a list of all tags associated with an account. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ListTagsResponseBody) + public Task ListTags(CancellationToken cancellationToken = default) + { + return ListTags(_client, cancellationToken); + } + + /// + /// Get Tags Get a list of all tags associated with an account. + /// + /// 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 (ListTagsResponseBody) + public async Task ListTags(HttpClient methodClient, CancellationToken cancellationToken = default) + { + + RequestOptions requestOptions = new("/v1/tags"); + + + requestOptions.Operation = "TagsApi.ListTags"; + + var result = await SendHttpRequestAsync(HttpMethods.Get, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Update Tag Name Change a tag name while still keeping the relevant shipments attached to it + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public Task RenameTag(string tagName, string newTagName, CancellationToken cancellationToken = default) + { + return RenameTag(_client, tagName, newTagName, cancellationToken); + } + + /// + /// Update Tag Name Change a tag name while still keeping the relevant shipments attached to it + /// + /// 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 (string) + public async Task RenameTag(HttpClient methodClient, string tagName, string newTagName, CancellationToken cancellationToken = default) + { + // verify the required parameter 'tagName' is set + if (tagName == null) + { + throw new ArgumentNullException(nameof(tagName)); + } + + // verify the required parameter 'newTagName' is set + if (newTagName == null) + { + throw new ArgumentNullException(nameof(newTagName)); + } + + + RequestOptions requestOptions = new("/v1/tags/{tag_name}/{new_tag_name}"); + + requestOptions.PathParameters.Add("tag_name", ShipEngineSDK.ClientUtils.ParameterToString(tagName)); // path parameter + requestOptions.PathParameters.Add("new_tag_name", ShipEngineSDK.ClientUtils.ParameterToString(newTagName)); // path parameter + + requestOptions.Operation = "TagsApi.RenameTag"; + + var result = await SendHttpRequestAsync(HttpMethods.Put, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + +} \ No newline at end of file diff --git a/ShipEngineSDK/Api/TokensApi.cs b/ShipEngineSDK/Api/TokensApi.cs new file mode 100644 index 00000000..0a3c3bfa --- /dev/null +++ b/ShipEngineSDK/Api/TokensApi.cs @@ -0,0 +1,96 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using ShipEngineSDK.Model; +using System; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Net; +using System.Net.Http; +using System.Net.Mime; +using System.Text.Json; +using System.Threading; +using System.Threading.Tasks; + +namespace ShipEngineSDK; + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial interface IShipEngine +{ + /// + /// Get Ephemeral Token This endpoint returns a token that can be passed to an application for authorized access. The lifetime of this token is 10 seconds. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Include a redirect url to the application formatted with the ephemeral token. (optional) + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (TokensGetEphemeralTokenResponseBodyYaml) + Task TokensGetEphemeralToken(Redirect? redirect, CancellationToken cancellationToken = default); + + /// + /// Get Ephemeral Token This endpoint returns a token that can be passed to an application for authorized access. The lifetime of this token is 10 seconds. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Include a redirect url to the application formatted with the ephemeral token. (optional) + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (TokensGetEphemeralTokenResponseBodyYaml) + Task TokensGetEphemeralToken(HttpClient methodClient, Redirect? redirect, CancellationToken cancellationToken = default); + +} + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial class ShipEngine +{ + /// + /// Get Ephemeral Token This endpoint returns a token that can be passed to an application for authorized access. The lifetime of this token is 10 seconds. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Include a redirect url to the application formatted with the ephemeral token. (optional) + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (TokensGetEphemeralTokenResponseBodyYaml) + public Task TokensGetEphemeralToken(Redirect? redirect = default, CancellationToken cancellationToken = default) + { + return TokensGetEphemeralToken(_client, redirect, cancellationToken); + } + + /// + /// Get Ephemeral Token This endpoint returns a token that can be passed to an application for authorized access. The lifetime of this token is 10 seconds. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Include a redirect url to the application formatted with the ephemeral token. (optional) + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (TokensGetEphemeralTokenResponseBodyYaml) + public async Task TokensGetEphemeralToken(HttpClient methodClient, Redirect? redirect = default, CancellationToken cancellationToken = default) + { + + RequestOptions requestOptions = new("/v1/tokens/ephemeral"); + + if (redirect != null) + { + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "redirect", redirect)); + } + + requestOptions.Operation = "TokensApi.TokensGetEphemeralToken"; + + var result = await SendHttpRequestAsync(HttpMethods.Post, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + +} \ No newline at end of file diff --git a/ShipEngineSDK/Api/WarehousesApi.cs b/ShipEngineSDK/Api/WarehousesApi.cs new file mode 100644 index 00000000..efde33f2 --- /dev/null +++ b/ShipEngineSDK/Api/WarehousesApi.cs @@ -0,0 +1,425 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using ShipEngineSDK.Model; +using System; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Net; +using System.Net.Http; +using System.Net.Mime; +using System.Text.Json; +using System.Threading; +using System.Threading.Tasks; + +namespace ShipEngineSDK; + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial interface IShipEngine +{ + /// + /// Create Warehouse Create a warehouse location that you can use to create shipping items by simply passing in the generated warehouse id. If the return address is not supplied in the request body then it is assumed that the origin address is the return address as well + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (CreateWarehouseResponseBody) + Task CreateWarehouse(CreateWarehouseRequestBody createWarehouseRequestBody, CancellationToken cancellationToken = default); + + /// + /// Create Warehouse Create a warehouse location that you can use to create shipping items by simply passing in the generated warehouse id. If the return address is not supplied in the request body then it is assumed that the origin address is the return address as well + /// + /// 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 (CreateWarehouseResponseBody) + Task CreateWarehouse(HttpClient methodClient, CreateWarehouseRequestBody createWarehouseRequestBody, CancellationToken cancellationToken = default); + + /// + /// Delete Warehouse By ID Delete a warehouse by ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Warehouse ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task DeleteWarehouse(string warehouseId, CancellationToken cancellationToken = default); + + /// + /// Delete Warehouse By ID Delete a warehouse by ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Warehouse ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task DeleteWarehouse(HttpClient methodClient, string warehouseId, CancellationToken cancellationToken = default); + + /// + /// Get Warehouse By Id Retrieve warehouse data based on the warehouse ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Warehouse ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetWarehouseByIdResponseBody) + Task GetWarehouseById(string warehouseId, CancellationToken cancellationToken = default); + + /// + /// Get Warehouse By Id Retrieve warehouse data based on the warehouse ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Warehouse ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetWarehouseByIdResponseBody) + Task GetWarehouseById(HttpClient methodClient, string warehouseId, CancellationToken cancellationToken = default); + + /// + /// List Warehouses Retrieve a list of warehouses associated with this account. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ListWarehousesResponseBody) + Task ListWarehouses(CancellationToken cancellationToken = default); + + /// + /// List Warehouses Retrieve a list of warehouses associated with this account. + /// + /// 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 (ListWarehousesResponseBody) + Task ListWarehouses(HttpClient methodClient, CancellationToken cancellationToken = default); + + /// + /// Update Warehouse By Id Update Warehouse object information + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Warehouse ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task UpdateWarehouse(string warehouseId, UpdateWarehouseRequestBody updateWarehouseRequestBody, CancellationToken cancellationToken = default); + + /// + /// Update Warehouse By Id Update Warehouse object information + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Warehouse ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task UpdateWarehouse(HttpClient methodClient, string warehouseId, UpdateWarehouseRequestBody updateWarehouseRequestBody, CancellationToken cancellationToken = default); + + /// + /// Update Warehouse Settings Update Warehouse settings object information + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Warehouse ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task UpdateWarehouseSettings(string warehouseId, UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBody, CancellationToken cancellationToken = default); + + /// + /// Update Warehouse Settings Update Warehouse settings object information + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Warehouse ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task UpdateWarehouseSettings(HttpClient methodClient, string warehouseId, UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBody, CancellationToken cancellationToken = default); + +} + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial class ShipEngine +{ + /// + /// Create Warehouse Create a warehouse location that you can use to create shipping items by simply passing in the generated warehouse id. If the return address is not supplied in the request body then it is assumed that the origin address is the return address as well + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (CreateWarehouseResponseBody) + public Task CreateWarehouse(CreateWarehouseRequestBody createWarehouseRequestBody, CancellationToken cancellationToken = default) + { + return CreateWarehouse(_client, createWarehouseRequestBody, cancellationToken); + } + + /// + /// Create Warehouse Create a warehouse location that you can use to create shipping items by simply passing in the generated warehouse id. If the return address is not supplied in the request body then it is assumed that the origin address is the return address as well + /// + /// 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 (CreateWarehouseResponseBody) + public async Task CreateWarehouse(HttpClient methodClient, CreateWarehouseRequestBody createWarehouseRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'createWarehouseRequestBody' is set + if (createWarehouseRequestBody == null) + { + throw new ArgumentNullException(nameof(createWarehouseRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/warehouses"); + + requestOptions.Data = JsonSerializer.Serialize(createWarehouseRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "WarehousesApi.CreateWarehouse"; + + var result = await SendHttpRequestAsync(HttpMethods.Post, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Delete Warehouse By ID Delete a warehouse by ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Warehouse ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public Task DeleteWarehouse(string warehouseId, CancellationToken cancellationToken = default) + { + return DeleteWarehouse(_client, warehouseId, cancellationToken); + } + + /// + /// Delete Warehouse By ID Delete a warehouse by ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Warehouse ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public async Task DeleteWarehouse(HttpClient methodClient, string warehouseId, CancellationToken cancellationToken = default) + { + // verify the required parameter 'warehouseId' is set + if (warehouseId == null) + { + throw new ArgumentNullException(nameof(warehouseId)); + } + + + RequestOptions requestOptions = new("/v1/warehouses/{warehouse_id}"); + + requestOptions.PathParameters.Add("warehouse_id", ShipEngineSDK.ClientUtils.ParameterToString(warehouseId)); // path parameter + + requestOptions.Operation = "WarehousesApi.DeleteWarehouse"; + + var result = await SendHttpRequestAsync(HttpMethods.Delete, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Get Warehouse By Id Retrieve warehouse data based on the warehouse ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Warehouse ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetWarehouseByIdResponseBody) + public Task GetWarehouseById(string warehouseId, CancellationToken cancellationToken = default) + { + return GetWarehouseById(_client, warehouseId, cancellationToken); + } + + /// + /// Get Warehouse By Id Retrieve warehouse data based on the warehouse ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Warehouse ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetWarehouseByIdResponseBody) + public async Task GetWarehouseById(HttpClient methodClient, string warehouseId, CancellationToken cancellationToken = default) + { + // verify the required parameter 'warehouseId' is set + if (warehouseId == null) + { + throw new ArgumentNullException(nameof(warehouseId)); + } + + + RequestOptions requestOptions = new("/v1/warehouses/{warehouse_id}"); + + requestOptions.PathParameters.Add("warehouse_id", ShipEngineSDK.ClientUtils.ParameterToString(warehouseId)); // path parameter + + requestOptions.Operation = "WarehousesApi.GetWarehouseById"; + + var result = await SendHttpRequestAsync(HttpMethods.Get, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// List Warehouses Retrieve a list of warehouses associated with this account. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (ListWarehousesResponseBody) + public Task ListWarehouses(CancellationToken cancellationToken = default) + { + return ListWarehouses(_client, cancellationToken); + } + + /// + /// List Warehouses Retrieve a list of warehouses associated with this account. + /// + /// 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 (ListWarehousesResponseBody) + public async Task ListWarehouses(HttpClient methodClient, CancellationToken cancellationToken = default) + { + + RequestOptions requestOptions = new("/v1/warehouses"); + + + requestOptions.Operation = "WarehousesApi.ListWarehouses"; + + var result = await SendHttpRequestAsync(HttpMethods.Get, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Update Warehouse By Id Update Warehouse object information + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Warehouse ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public Task UpdateWarehouse(string warehouseId, UpdateWarehouseRequestBody updateWarehouseRequestBody, CancellationToken cancellationToken = default) + { + return UpdateWarehouse(_client, warehouseId, updateWarehouseRequestBody, cancellationToken); + } + + /// + /// Update Warehouse By Id Update Warehouse object information + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Warehouse ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public async Task UpdateWarehouse(HttpClient methodClient, string warehouseId, UpdateWarehouseRequestBody updateWarehouseRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'warehouseId' is set + if (warehouseId == null) + { + throw new ArgumentNullException(nameof(warehouseId)); + } + + // verify the required parameter 'updateWarehouseRequestBody' is set + if (updateWarehouseRequestBody == null) + { + throw new ArgumentNullException(nameof(updateWarehouseRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/warehouses/{warehouse_id}"); + + requestOptions.PathParameters.Add("warehouse_id", ShipEngineSDK.ClientUtils.ParameterToString(warehouseId)); // path parameter + requestOptions.Data = JsonSerializer.Serialize(updateWarehouseRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "WarehousesApi.UpdateWarehouse"; + + var result = await SendHttpRequestAsync(HttpMethods.Put, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Update Warehouse Settings Update Warehouse settings object information + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Warehouse ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public Task UpdateWarehouseSettings(string warehouseId, UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBody, CancellationToken cancellationToken = default) + { + return UpdateWarehouseSettings(_client, warehouseId, updateWarehouseSettingsRequestBody, cancellationToken); + } + + /// + /// Update Warehouse Settings Update Warehouse settings object information + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Warehouse ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public async Task UpdateWarehouseSettings(HttpClient methodClient, string warehouseId, UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'warehouseId' is set + if (warehouseId == null) + { + throw new ArgumentNullException(nameof(warehouseId)); + } + + // verify the required parameter 'updateWarehouseSettingsRequestBody' is set + if (updateWarehouseSettingsRequestBody == null) + { + throw new ArgumentNullException(nameof(updateWarehouseSettingsRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/warehouses/{warehouse_id}/settings"); + + requestOptions.PathParameters.Add("warehouse_id", ShipEngineSDK.ClientUtils.ParameterToString(warehouseId)); // path parameter + requestOptions.Data = JsonSerializer.Serialize(updateWarehouseSettingsRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "WarehousesApi.UpdateWarehouseSettings"; + + var result = await SendHttpRequestAsync(HttpMethods.Put, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + +} \ No newline at end of file diff --git a/ShipEngineSDK/Api/WebhooksApi.cs b/ShipEngineSDK/Api/WebhooksApi.cs new file mode 100644 index 00000000..501a06e6 --- /dev/null +++ b/ShipEngineSDK/Api/WebhooksApi.cs @@ -0,0 +1,351 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using ShipEngineSDK.Model; +using System; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Net; +using System.Net.Http; +using System.Net.Mime; +using System.Text.Json; +using System.Threading; +using System.Threading.Tasks; + +namespace ShipEngineSDK; + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial interface IShipEngine +{ + /// + /// Create a Webhook Create a webook for specific events in the environment. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (CreateWebhookResponseBody) + Task CreateWebhook(CreateWebhookRequestBody createWebhookRequestBody, CancellationToken cancellationToken = default); + + /// + /// Create a Webhook Create a webook for specific events in the environment. + /// + /// 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 (CreateWebhookResponseBody) + Task CreateWebhook(HttpClient methodClient, CreateWebhookRequestBody createWebhookRequestBody, CancellationToken cancellationToken = default); + + /// + /// Delete Webhook By ID Delete a webhook + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Webhook ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task DeleteWebhook(string webhookId, CancellationToken cancellationToken = default); + + /// + /// Delete Webhook By ID Delete a webhook + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Webhook ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task DeleteWebhook(HttpClient methodClient, string webhookId, CancellationToken cancellationToken = default); + + /// + /// Get Webhook By ID Retrieve individual webhook by an ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Webhook ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetWebhookByIdResponseBody) + Task GetWebhookById(string webhookId, CancellationToken cancellationToken = default); + + /// + /// Get Webhook By ID Retrieve individual webhook by an ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Webhook ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetWebhookByIdResponseBody) + Task GetWebhookById(HttpClient methodClient, string webhookId, CancellationToken cancellationToken = default); + + /// + /// List Webhooks List all webhooks currently enabled for the account. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (List<Webhook>) + Task> ListWebhooks(CancellationToken cancellationToken = default); + + /// + /// List Webhooks List all webhooks currently enabled for the account. + /// + /// 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 (List<Webhook>) + Task> ListWebhooks(HttpClient methodClient, CancellationToken cancellationToken = default); + + /// + /// Update a Webhook Update the webhook url property + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Webhook ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task UpdateWebhook(string webhookId, UpdateWebhookRequestBody updateWebhookRequestBody, CancellationToken cancellationToken = default); + + /// + /// Update a Webhook Update the webhook url property + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Webhook ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + Task UpdateWebhook(HttpClient methodClient, string webhookId, UpdateWebhookRequestBody updateWebhookRequestBody, CancellationToken cancellationToken = default); + +} + +/// +/// Represents a collection of functions to interact with the API endpoints +/// +public partial class ShipEngine +{ + /// + /// Create a Webhook Create a webook for specific events in the environment. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (CreateWebhookResponseBody) + public Task CreateWebhook(CreateWebhookRequestBody createWebhookRequestBody, CancellationToken cancellationToken = default) + { + return CreateWebhook(_client, createWebhookRequestBody, cancellationToken); + } + + /// + /// Create a Webhook Create a webook for specific events in the environment. + /// + /// 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 (CreateWebhookResponseBody) + public async Task CreateWebhook(HttpClient methodClient, CreateWebhookRequestBody createWebhookRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'createWebhookRequestBody' is set + if (createWebhookRequestBody == null) + { + throw new ArgumentNullException(nameof(createWebhookRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/environment/webhooks"); + + requestOptions.Data = JsonSerializer.Serialize(createWebhookRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "WebhooksApi.CreateWebhook"; + + var result = await SendHttpRequestAsync(HttpMethods.Post, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Delete Webhook By ID Delete a webhook + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Webhook ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public Task DeleteWebhook(string webhookId, CancellationToken cancellationToken = default) + { + return DeleteWebhook(_client, webhookId, cancellationToken); + } + + /// + /// Delete Webhook By ID Delete a webhook + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Webhook ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public async Task DeleteWebhook(HttpClient methodClient, string webhookId, CancellationToken cancellationToken = default) + { + // verify the required parameter 'webhookId' is set + if (webhookId == null) + { + throw new ArgumentNullException(nameof(webhookId)); + } + + + RequestOptions requestOptions = new("/v1/environment/webhooks/{webhook_id}"); + + requestOptions.PathParameters.Add("webhook_id", ShipEngineSDK.ClientUtils.ParameterToString(webhookId)); // path parameter + + requestOptions.Operation = "WebhooksApi.DeleteWebhook"; + + var result = await SendHttpRequestAsync(HttpMethods.Delete, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Get Webhook By ID Retrieve individual webhook by an ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Webhook ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetWebhookByIdResponseBody) + public Task GetWebhookById(string webhookId, CancellationToken cancellationToken = default) + { + return GetWebhookById(_client, webhookId, cancellationToken); + } + + /// + /// Get Webhook By ID Retrieve individual webhook by an ID + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Webhook ID + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (GetWebhookByIdResponseBody) + public async Task GetWebhookById(HttpClient methodClient, string webhookId, CancellationToken cancellationToken = default) + { + // verify the required parameter 'webhookId' is set + if (webhookId == null) + { + throw new ArgumentNullException(nameof(webhookId)); + } + + + RequestOptions requestOptions = new("/v1/environment/webhooks/{webhook_id}"); + + requestOptions.PathParameters.Add("webhook_id", ShipEngineSDK.ClientUtils.ParameterToString(webhookId)); // path parameter + + requestOptions.Operation = "WebhooksApi.GetWebhookById"; + + var result = await SendHttpRequestAsync(HttpMethods.Get, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// List Webhooks List all webhooks currently enabled for the account. + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (List<Webhook>) + public Task> ListWebhooks(CancellationToken cancellationToken = default) + { + return ListWebhooks(_client, cancellationToken); + } + + /// + /// List Webhooks List all webhooks currently enabled for the account. + /// + /// 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 (List<Webhook>) + public async Task> ListWebhooks(HttpClient methodClient, CancellationToken cancellationToken = default) + { + + RequestOptions requestOptions = new("/v1/environment/webhooks"); + + + requestOptions.Operation = "WebhooksApi.ListWebhooks"; + + var result = await SendHttpRequestAsync>(HttpMethods.Get, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + + /// + /// Update a Webhook Update the webhook url property + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// Webhook ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public Task UpdateWebhook(string webhookId, UpdateWebhookRequestBody updateWebhookRequestBody, CancellationToken cancellationToken = default) + { + return UpdateWebhook(_client, webhookId, updateWebhookRequestBody, cancellationToken); + } + + /// + /// Update a Webhook Update the webhook url property + /// + /// Thrown when required argument is null + /// Thrown when fails to make API call + /// HttpClient to use for the request + /// Webhook ID + /// + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (string) + public async Task UpdateWebhook(HttpClient methodClient, string webhookId, UpdateWebhookRequestBody updateWebhookRequestBody, CancellationToken cancellationToken = default) + { + // verify the required parameter 'webhookId' is set + if (webhookId == null) + { + throw new ArgumentNullException(nameof(webhookId)); + } + + // verify the required parameter 'updateWebhookRequestBody' is set + if (updateWebhookRequestBody == null) + { + throw new ArgumentNullException(nameof(updateWebhookRequestBody)); + } + + + RequestOptions requestOptions = new("/v1/environment/webhooks/{webhook_id}"); + + requestOptions.PathParameters.Add("webhook_id", ShipEngineSDK.ClientUtils.ParameterToString(webhookId)); // path parameter + requestOptions.Data = JsonSerializer.Serialize(updateWebhookRequestBody, JsonSerializerOptions); + + requestOptions.Operation = "WebhooksApi.UpdateWebhook"; + + var result = await SendHttpRequestAsync(HttpMethods.Put, requestOptions, methodClient, _config, cancellationToken); + + return result; + } + +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/AbstractOpenAPISchema.cs b/ShipEngineSDK/Model/AbstractOpenAPISchema.cs new file mode 100644 index 00000000..9371f286 --- /dev/null +++ b/ShipEngineSDK/Model/AbstractOpenAPISchema.cs @@ -0,0 +1,50 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace ShipEngineSDK.Model; + +/// +/// Abstract base class for oneOf, anyOf schemas in the OpenAPI specification +/// +public abstract partial class AbstractOpenAPISchema +{ + /// + /// Custom JSON serializer + /// + static public readonly JsonSerializerOptions SerializerSettings = new JsonSerializerOptions + { + // OpenAPI generated types generally hide default constructors. + PropertyNamingPolicy = JsonNamingPolicy.SnakeCaseLower, + DictionaryKeyPolicy = JsonNamingPolicy.SnakeCaseLower + }; + + /// + /// Gets or Sets the actual instance + /// + public abstract Object ActualInstance { get; set; } + + /// + /// Gets or Sets IsNullable to indicate whether the instance is nullable + /// + public bool IsNullable { get; protected set; } + + /// + /// Gets or Sets the schema type, which can be either `oneOf` or `anyOf` + /// + public string SchemaType { get; protected set; } + + /// + /// Converts the instance into JSON string. + /// + public abstract string ToJson(); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/AccountSettings.cs b/ShipEngineSDK/Model/AccountSettings.cs new file mode 100644 index 00000000..7d0adfe6 --- /dev/null +++ b/ShipEngineSDK/Model/AccountSettings.cs @@ -0,0 +1,59 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 ShipEngine account settings response body +/// +public partial class AccountSettings +{ + + /// + /// Gets or Sets DefaultLabelLayout CLOVUS + /// + [JsonPropertyName("default_label_layout")] + public DefaultLabelLayout? DefaultLabelLayout { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class AccountSettings {\n"); + sb.Append(" DefaultLabelLayout: ").Append(DefaultLabelLayout).Append("\n"); + 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/AddFundsToCarrierRequestBody.cs b/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs new file mode 100644 index 00000000..ac8c4218 --- /dev/null +++ b/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs @@ -0,0 +1,71 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An add funds to carrier request body +/// +public partial class AddFundsToCarrierRequestBody +{ + + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + [JsonPropertyName("currency")] + [JsonRequired] + public string Currency { get; set; } + + /// + /// The monetary amount, in the specified currency. + /// + /// The monetary amount, in the specified currency. + [JsonPropertyName("amount")] + [JsonRequired] + public double Amount { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class AddFundsToCarrierRequestBody {\n"); + sb.Append(" Currency: ").Append(Currency).Append("\n"); + sb.Append(" Amount: ").Append(Amount).Append("\n"); + 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/AddFundsToCarrierResponseBody.cs b/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs new file mode 100644 index 00000000..2c73a767 --- /dev/null +++ b/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs @@ -0,0 +1,62 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The current balance of the requested carrier account +/// +public partial class AddFundsToCarrierResponseBody +{ + + /// + /// The current balance of the account + /// + /// The current balance of the account + [JsonPropertyName("balance")] + [JsonRequired] + public MonetaryValue Balance { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class AddFundsToCarrierResponseBody {\n"); + sb.Append(" Balance: ").Append(Balance).Append("\n"); + 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/AddFundsToInsuranceRequestBody.cs b/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs new file mode 100644 index 00000000..b5ab318c --- /dev/null +++ b/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs @@ -0,0 +1,71 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An add funds to insurance request body +/// +public partial class AddFundsToInsuranceRequestBody +{ + + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + [JsonPropertyName("currency")] + [JsonRequired] + public string Currency { get; set; } + + /// + /// The monetary amount, in the specified currency. + /// + /// The monetary amount, in the specified currency. + [JsonPropertyName("amount")] + [JsonRequired] + public double Amount { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class AddFundsToInsuranceRequestBody {\n"); + sb.Append(" Currency: ").Append(Currency).Append("\n"); + sb.Append(" Amount: ").Append(Amount).Append("\n"); + 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/AddFundsToInsuranceResponseBody.cs b/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs new file mode 100644 index 00000000..61b77b06 --- /dev/null +++ b/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs @@ -0,0 +1,71 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Add funds to insurance response body +/// +public partial class AddFundsToInsuranceResponseBody +{ + + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + [JsonPropertyName("currency")] + [JsonRequired] + public string Currency { get; set; } + + /// + /// The monetary amount, in the specified currency. + /// + /// The monetary amount, in the specified currency. + [JsonPropertyName("amount")] + [JsonRequired] + public double Amount { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class AddFundsToInsuranceResponseBody {\n"); + sb.Append(" Currency: ").Append(Currency).Append("\n"); + sb.Append(" Amount: ").Append(Amount).Append("\n"); + 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/AddToBatchRequestBody.cs b/ShipEngineSDK/Model/AddToBatchRequestBody.cs new file mode 100644 index 00000000..ac178568 --- /dev/null +++ b/ShipEngineSDK/Model/AddToBatchRequestBody.cs @@ -0,0 +1,69 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An add to batch request body +/// +public partial class AddToBatchRequestBody +{ + + /// + /// The Shipment Ids to be modified on the batch + /// + /// The Shipment Ids to be modified on the batch + [JsonPropertyName("shipment_ids")] + public List ShipmentIds { get; set; } + + /// + /// Array of Rate IDs to be modifed on the batch + /// + /// Array of Rate IDs to be modifed on the batch + [JsonPropertyName("rate_ids")] + public List RateIds { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class AddToBatchRequestBody {\n"); + sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); + sb.Append(" RateIds: ").Append(RateIds).Append("\n"); + 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/Address.cs b/ShipEngineSDK/Model/Address.cs new file mode 100644 index 00000000..7fbe8d11 --- /dev/null +++ b/ShipEngineSDK/Model/Address.cs @@ -0,0 +1,191 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Any residential or business mailing address, anywhere in the world. > **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant. +/// +public partial class Address +{ + + /// + /// Indicates whether this is a residential address. CLOVUS + /// + /// Indicates whether this is a residential address. + [JsonPropertyName("address_residential_indicator")] + [JsonRequired] + public AddressResidentialIndicator AddressResidentialIndicator { get; set; } = new(); + + + /// + /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. + /// + /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. + /// + /// John Doe + /// + [JsonPropertyName("name")] + [JsonRequired] + public string Name { get; set; } + + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// +1 204-253-9411 ext. 123 + /// + [JsonPropertyName("phone")] + [JsonRequired] + public string Phone { get; set; } + + /// + /// Email for the address owner. + /// + /// Email for the address owner. + /// + /// example@example.com + /// + [JsonPropertyName("email")] + public string Email { get; set; } + + /// + /// If this is a business address, then the company name should be specified here. + /// + /// If this is a business address, then the company name should be specified here. + /// + /// The Home Depot + /// + [JsonPropertyName("company_name")] + public string CompanyName { get; set; } + + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// 1999 Bishop Grandin Blvd. + /// + [JsonPropertyName("address_line1")] + [JsonRequired] + public string AddressLine1 { get; set; } + + /// + /// The second line of the street address. For some addresses, this line may not be needed. + /// + /// The second line of the street address. For some addresses, this line may not be needed. + /// + /// Unit 408 + /// + [JsonPropertyName("address_line2")] + public string AddressLine2 { get; set; } + + /// + /// The third line of the street address. For some addresses, this line may not be needed. + /// + /// The third line of the street address. For some addresses, this line may not be needed. + /// + /// Building #7 + /// + [JsonPropertyName("address_line3")] + public string AddressLine3 { get; set; } + + /// + /// The name of the city or locality + /// + /// The name of the city or locality + /// + /// Winnipeg + /// + [JsonPropertyName("city_locality")] + [JsonRequired] + public string CityLocality { get; set; } + + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// Manitoba + /// + [JsonPropertyName("state_province")] + [JsonRequired] + public string StateProvince { get; set; } + + /// + /// postal code + /// + /// postal code + /// + /// 78756-3717 + /// + [JsonPropertyName("postal_code")] + [JsonRequired] + public string PostalCode { get; set; } + + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// CA + /// + [JsonPropertyName("country_code")] + [JsonRequired] + public string CountryCode { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class Address {\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); + sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); + sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); + sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); + sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); + sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); + 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/AddressResidentialIndicator.cs b/ShipEngineSDK/Model/AddressResidentialIndicator.cs new file mode 100644 index 00000000..bcc94090 --- /dev/null +++ b/ShipEngineSDK/Model/AddressResidentialIndicator.cs @@ -0,0 +1,83 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Indicates whether an address is residential. +/// +/// Indicates whether an address is residential. +[JsonConverter(typeof(AddressResidentialIndicatorJsonConverter))] +public class AddressResidentialIndicator +{ + private string _value; + + internal AddressResidentialIndicator() + { + _value = "unknown"; + } + + /// + /// Create a new instance of AddressResidentialIndicator with a custom value. + /// + /// The value of the AddressResidentialIndicator + /// + /// 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 AddressResidentialIndicator(string value) + { + _value = value; + } + + /// + /// Enum Unknown for value: unknown + /// + public static AddressResidentialIndicator Unknown { get; } = new("unknown"); + + + /// + /// Enum Yes for value: yes + /// + public static AddressResidentialIndicator Yes { get; } = new("yes"); + + + /// + /// Enum No for value: no + /// + public static AddressResidentialIndicator No { get; } = new("no"); + + + public override string ToString() => _value; +} + +internal class AddressResidentialIndicatorJsonConverter : JsonConverter +{ + public override AddressResidentialIndicator? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new AddressResidentialIndicator(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, AddressResidentialIndicator value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(AddressResidentialIndicator); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/AddressToValidate.cs b/ShipEngineSDK/Model/AddressToValidate.cs new file mode 100644 index 00000000..3fdd775a --- /dev/null +++ b/ShipEngineSDK/Model/AddressToValidate.cs @@ -0,0 +1,185 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Any residential or business mailing address, anywhere in the world. +/// +public partial class AddressToValidate +{ + + /// + /// Indicates whether this is a residential address. CLOVUS + /// + /// Indicates whether this is a residential address. + [JsonPropertyName("address_residential_indicator")] + public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } + /// + /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. + /// + /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. + /// + /// John Doe + /// + [JsonPropertyName("name")] + public string Name { get; set; } + + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// +1 204-253-9411 ext. 123 + /// + [JsonPropertyName("phone")] + public string Phone { get; set; } + + /// + /// Email for the address owner. + /// + /// Email for the address owner. + /// + /// example@example.com + /// + [JsonPropertyName("email")] + public string Email { get; set; } + + /// + /// If this is a business address, then the company name should be specified here. + /// + /// If this is a business address, then the company name should be specified here. + /// + /// The Home Depot + /// + [JsonPropertyName("company_name")] + public string CompanyName { get; set; } + + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// 1999 Bishop Grandin Blvd. + /// + [JsonPropertyName("address_line1")] + [JsonRequired] + public string AddressLine1 { get; set; } + + /// + /// The second line of the street address. For some addresses, this line may not be needed. + /// + /// The second line of the street address. For some addresses, this line may not be needed. + /// + /// Unit 408 + /// + [JsonPropertyName("address_line2")] + public string AddressLine2 { get; set; } + + /// + /// The third line of the street address. For some addresses, this line may not be needed. + /// + /// The third line of the street address. For some addresses, this line may not be needed. + /// + /// Building #7 + /// + [JsonPropertyName("address_line3")] + public string AddressLine3 { get; set; } + + /// + /// The name of the city or locality + /// + /// The name of the city or locality + /// + /// Winnipeg + /// + [JsonPropertyName("city_locality")] + [JsonRequired] + public string CityLocality { get; set; } + + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// Manitoba + /// + [JsonPropertyName("state_province")] + [JsonRequired] + public string StateProvince { get; set; } + + /// + /// postal code + /// + /// postal code + /// + /// 78756-3717 + /// + [JsonPropertyName("postal_code")] + public string PostalCode { get; set; } + + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// CA + /// + [JsonPropertyName("country_code")] + [JsonRequired] + public string CountryCode { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class AddressToValidate {\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); + sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); + sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); + sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); + sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); + sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); + 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/AddressValidationCode.cs b/ShipEngineSDK/Model/AddressValidationCode.cs new file mode 100644 index 00000000..6d67ec18 --- /dev/null +++ b/ShipEngineSDK/Model/AddressValidationCode.cs @@ -0,0 +1,143 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The error codes that can be returned by the address validation API +/// +/// The error codes that can be returned by the address validation API +[JsonConverter(typeof(AddressValidationCodeJsonConverter))] +public class AddressValidationCode +{ + private string _value; + + internal AddressValidationCode() + { + _value = "a1000"; + } + + /// + /// Create a new instance of AddressValidationCode with a custom value. + /// + /// The value of the AddressValidationCode + /// + /// 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 AddressValidationCode(string value) + { + _value = value; + } + + /// + /// Enum A1000 for value: a1000 + /// + public static AddressValidationCode A1000 { get; } = new("a1000"); + + + /// + /// Enum A1001 for value: a1001 + /// + public static AddressValidationCode A1001 { get; } = new("a1001"); + + + /// + /// Enum A1002 for value: a1002 + /// + public static AddressValidationCode A1002 { get; } = new("a1002"); + + + /// + /// Enum A1003 for value: a1003 + /// + public static AddressValidationCode A1003 { get; } = new("a1003"); + + + /// + /// Enum A1004 for value: a1004 + /// + public static AddressValidationCode A1004 { get; } = new("a1004"); + + + /// + /// Enum A1005 for value: a1005 + /// + public static AddressValidationCode A1005 { get; } = new("a1005"); + + + /// + /// Enum A1006 for value: a1006 + /// + public static AddressValidationCode A1006 { get; } = new("a1006"); + + + /// + /// Enum A1007 for value: a1007 + /// + public static AddressValidationCode A1007 { get; } = new("a1007"); + + + /// + /// Enum A1008 for value: a1008 + /// + public static AddressValidationCode A1008 { get; } = new("a1008"); + + + /// + /// Enum R1000 for value: r1000 + /// + public static AddressValidationCode R1000 { get; } = new("r1000"); + + + /// + /// Enum R1001 for value: r1001 + /// + public static AddressValidationCode R1001 { get; } = new("r1001"); + + + /// + /// Enum R1002 for value: r1002 + /// + public static AddressValidationCode R1002 { get; } = new("r1002"); + + + /// + /// Enum R1003 for value: r1003 + /// + public static AddressValidationCode R1003 { get; } = new("r1003"); + + + public override string ToString() => _value; +} + +internal class AddressValidationCodeJsonConverter : JsonConverter +{ + public override AddressValidationCode? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new AddressValidationCode(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, AddressValidationCode value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(AddressValidationCode); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/AddressValidationDetailCode.cs b/ShipEngineSDK/Model/AddressValidationDetailCode.cs new file mode 100644 index 00000000..a3546b44 --- /dev/null +++ b/ShipEngineSDK/Model/AddressValidationDetailCode.cs @@ -0,0 +1,413 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The detailed error codes that can be returned by the address validation API +/// +/// The detailed error codes that can be returned by the address validation API +[JsonConverter(typeof(AddressValidationDetailCodeJsonConverter))] +public class AddressValidationDetailCode +{ + private string _value; + + internal AddressValidationDetailCode() + { + _value = "unsupported_country"; + } + + /// + /// Create a new instance of AddressValidationDetailCode with a custom value. + /// + /// The value of the AddressValidationDetailCode + /// + /// 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 AddressValidationDetailCode(string value) + { + _value = value; + } + + /// + /// Enum UnsupportedCountry for value: unsupported_country + /// + public static AddressValidationDetailCode UnsupportedCountry { get; } = new("unsupported_country"); + + + /// + /// Enum NonSupportedCountry for value: non_supported_country + /// + public static AddressValidationDetailCode NonSupportedCountry { get; } = new("non_supported_country"); + + + /// + /// Enum MinimumPostalCodeVerificationFailed for value: minimum_postal_code_verification_failed + /// + public static AddressValidationDetailCode MinimumPostalCodeVerificationFailed { get; } = new("minimum_postal_code_verification_failed"); + + + /// + /// Enum StreetDoesNotMatchUniqueStreetName for value: street_does_not_match_unique_street_name + /// + public static AddressValidationDetailCode StreetDoesNotMatchUniqueStreetName { get; } = new("street_does_not_match_unique_street_name"); + + + /// + /// Enum MultipleDirectionals for value: multiple_directionals + /// + public static AddressValidationDetailCode MultipleDirectionals { get; } = new("multiple_directionals"); + + + /// + /// Enum MultipleMatches for value: multiple_matches + /// + public static AddressValidationDetailCode MultipleMatches { get; } = new("multiple_matches"); + + + /// + /// Enum SuiteNotValid for value: suite_not_valid + /// + public static AddressValidationDetailCode SuiteNotValid { get; } = new("suite_not_valid"); + + + /// + /// Enum SuiteMissing for value: suite_missing + /// + public static AddressValidationDetailCode SuiteMissing { get; } = new("suite_missing"); + + + /// + /// Enum IncompatiblePairedLabels for value: incompatible_paired_labels + /// + public static AddressValidationDetailCode IncompatiblePairedLabels { get; } = new("incompatible_paired_labels"); + + + /// + /// Enum InvalidHouseNumber for value: invalid_house_number + /// + public static AddressValidationDetailCode InvalidHouseNumber { get; } = new("invalid_house_number"); + + + /// + /// Enum MissingHouseNumber for value: missing_house_number + /// + public static AddressValidationDetailCode MissingHouseNumber { get; } = new("missing_house_number"); + + + /// + /// Enum InvalidBoxNumber for value: invalid_box_number + /// + public static AddressValidationDetailCode InvalidBoxNumber { get; } = new("invalid_box_number"); + + + /// + /// Enum InvalidChargeEvent for value: invalid_charge_event + /// + public static AddressValidationDetailCode InvalidChargeEvent { get; } = new("invalid_charge_event"); + + + /// + /// Enum MissingBoxNumber for value: missing_box_number + /// + public static AddressValidationDetailCode MissingBoxNumber { get; } = new("missing_box_number"); + + + /// + /// Enum MissingCmraOrPrivateMailBoxNumber for value: missing_cmra_or_private_mail_box_number + /// + public static AddressValidationDetailCode MissingCmraOrPrivateMailBoxNumber { get; } = new("missing_cmra_or_private_mail_box_number"); + + + /// + /// Enum SuiteHasNoSecondaries for value: suite_has_no_secondaries + /// + public static AddressValidationDetailCode SuiteHasNoSecondaries { get; } = new("suite_has_no_secondaries"); + + + /// + /// Enum PostalCodeChangedOrAdded for value: postal_code_changed_or_added + /// + public static AddressValidationDetailCode PostalCodeChangedOrAdded { get; } = new("postal_code_changed_or_added"); + + + /// + /// Enum StateProvinceChangedOrAdded for value: state_province_changed_or_added + /// + public static AddressValidationDetailCode StateProvinceChangedOrAdded { get; } = new("state_province_changed_or_added"); + + + /// + /// Enum CityLocalityChangedOrAdded for value: city_locality_changed_or_added + /// + public static AddressValidationDetailCode CityLocalityChangedOrAdded { get; } = new("city_locality_changed_or_added"); + + + /// + /// Enum UrbanizationChanged for value: urbanization_changed + /// + public static AddressValidationDetailCode UrbanizationChanged { get; } = new("urbanization_changed"); + + + /// + /// Enum StreetNameSpellingChangedOrAdded for value: street_name_spelling_changed_or_added + /// + public static AddressValidationDetailCode StreetNameSpellingChangedOrAdded { get; } = new("street_name_spelling_changed_or_added"); + + + /// + /// Enum StreetNameTypeChangedOrAdded for value: street_name_type_changed_or_added + /// + public static AddressValidationDetailCode StreetNameTypeChangedOrAdded { get; } = new("street_name_type_changed_or_added"); + + + /// + /// Enum StreetDirectionChangedOrAdded for value: street_direction_changed_or_added + /// + public static AddressValidationDetailCode StreetDirectionChangedOrAdded { get; } = new("street_direction_changed_or_added"); + + + /// + /// Enum SuiteTypeChangedOrAdded for value: suite_type_changed_or_added + /// + public static AddressValidationDetailCode SuiteTypeChangedOrAdded { get; } = new("suite_type_changed_or_added"); + + + /// + /// Enum SuiteUnitNumberChangedOrAdded for value: suite_unit_number_changed_or_added + /// + public static AddressValidationDetailCode SuiteUnitNumberChangedOrAdded { get; } = new("suite_unit_number_changed_or_added"); + + + /// + /// Enum DoubleDependentLocalityChangedOrAdded for value: double_dependent_locality_changed_or_added + /// + public static AddressValidationDetailCode DoubleDependentLocalityChangedOrAdded { get; } = new("double_dependent_locality_changed_or_added"); + + + /// + /// Enum SubadministrativeAreaChangedOrAdded for value: subadministrative_area_changed_or_added + /// + public static AddressValidationDetailCode SubadministrativeAreaChangedOrAdded { get; } = new("subadministrative_area_changed_or_added"); + + + /// + /// Enum SubnationalAreaChangedOrAdded for value: subnational_area_changed_or_added + /// + public static AddressValidationDetailCode SubnationalAreaChangedOrAdded { get; } = new("subnational_area_changed_or_added"); + + + /// + /// Enum PoBoxChangedOrAdded for value: po_box_changed_or_added + /// + public static AddressValidationDetailCode PoBoxChangedOrAdded { get; } = new("po_box_changed_or_added"); + + + /// + /// Enum PremiseTypeChangedOrAdded for value: premise_type_changed_or_added + /// + public static AddressValidationDetailCode PremiseTypeChangedOrAdded { get; } = new("premise_type_changed_or_added"); + + + /// + /// Enum HouseNumberChanged for value: house_number_changed + /// + public static AddressValidationDetailCode HouseNumberChanged { get; } = new("house_number_changed"); + + + /// + /// Enum OrganizationChangedOrAdded for value: organization_changed_or_added + /// + public static AddressValidationDetailCode OrganizationChangedOrAdded { get; } = new("organization_changed_or_added"); + + + /// + /// Enum PartiallyVerifiedToStateLevel for value: partially_verified_to_state_level + /// + public static AddressValidationDetailCode PartiallyVerifiedToStateLevel { get; } = new("partially_verified_to_state_level"); + + + /// + /// Enum PartiallyVerifiedToCityLevel for value: partially_verified_to_city_level + /// + public static AddressValidationDetailCode PartiallyVerifiedToCityLevel { get; } = new("partially_verified_to_city_level"); + + + /// + /// Enum PartiallyVerifiedToStreetLevel for value: partially_verified_to_street_level + /// + public static AddressValidationDetailCode PartiallyVerifiedToStreetLevel { get; } = new("partially_verified_to_street_level"); + + + /// + /// Enum PartiallyVerifiedToPremiseLevel for value: partially_verified_to_premise_level + /// + public static AddressValidationDetailCode PartiallyVerifiedToPremiseLevel { get; } = new("partially_verified_to_premise_level"); + + + /// + /// Enum VerifiedToStateLevel for value: verified_to_state_level + /// + public static AddressValidationDetailCode VerifiedToStateLevel { get; } = new("verified_to_state_level"); + + + /// + /// Enum VerifiedToCityLevel for value: verified_to_city_level + /// + public static AddressValidationDetailCode VerifiedToCityLevel { get; } = new("verified_to_city_level"); + + + /// + /// Enum VerifiedToStreetLevel for value: verified_to_street_level + /// + public static AddressValidationDetailCode VerifiedToStreetLevel { get; } = new("verified_to_street_level"); + + + /// + /// Enum VerifiedToPremiseLevel for value: verified_to_premise_level + /// + public static AddressValidationDetailCode VerifiedToPremiseLevel { get; } = new("verified_to_premise_level"); + + + /// + /// Enum VerifiedToSuiteLevel for value: verified_to_suite_level + /// + public static AddressValidationDetailCode VerifiedToSuiteLevel { get; } = new("verified_to_suite_level"); + + + /// + /// Enum CodedToStreetLavel for value: coded_to_street_lavel + /// + public static AddressValidationDetailCode CodedToStreetLavel { get; } = new("coded_to_street_lavel"); + + + /// + /// Enum CodedToNeighborhoodLevel for value: coded_to_neighborhood_level + /// + public static AddressValidationDetailCode CodedToNeighborhoodLevel { get; } = new("coded_to_neighborhood_level"); + + + /// + /// Enum CodedToCommunityLevel for value: coded_to_community_level + /// + public static AddressValidationDetailCode CodedToCommunityLevel { get; } = new("coded_to_community_level"); + + + /// + /// Enum CodedToStateLevel for value: coded_to_state_level + /// + public static AddressValidationDetailCode CodedToStateLevel { get; } = new("coded_to_state_level"); + + + /// + /// Enum CodedToRooftopLevel for value: coded_to_rooftop_level + /// + public static AddressValidationDetailCode CodedToRooftopLevel { get; } = new("coded_to_rooftop_level"); + + + /// + /// Enum CodedToRooftopInterpolationLevel for value: coded_to_rooftop_interpolation_level + /// + public static AddressValidationDetailCode CodedToRooftopInterpolationLevel { get; } = new("coded_to_rooftop_interpolation_level"); + + + /// + /// Enum NameMaxLengthExceeded for value: name_max_length_exceeded + /// + public static AddressValidationDetailCode NameMaxLengthExceeded { get; } = new("name_max_length_exceeded"); + + + /// + /// Enum PhoneMaxLengthExceeded for value: phone_max_length_exceeded + /// + public static AddressValidationDetailCode PhoneMaxLengthExceeded { get; } = new("phone_max_length_exceeded"); + + + /// + /// Enum CompanyNameMaxLengthExceeded for value: company_name_max_length_exceeded + /// + public static AddressValidationDetailCode CompanyNameMaxLengthExceeded { get; } = new("company_name_max_length_exceeded"); + + + /// + /// Enum Line1MinMaxLength for value: line1_min_max_length + /// + public static AddressValidationDetailCode Line1MinMaxLength { get; } = new("line1_min_max_length"); + + + /// + /// Enum Line2MaxLengthExceeded for value: line2_max_length_exceeded + /// + public static AddressValidationDetailCode Line2MaxLengthExceeded { get; } = new("line2_max_length_exceeded"); + + + /// + /// Enum Line3MaxLengthExceeded for value: line3_max_length_exceeded + /// + public static AddressValidationDetailCode Line3MaxLengthExceeded { get; } = new("line3_max_length_exceeded"); + + + /// + /// Enum CityLocalityMaxLengthExceeded for value: city_locality_max_length_exceeded + /// + public static AddressValidationDetailCode CityLocalityMaxLengthExceeded { get; } = new("city_locality_max_length_exceeded"); + + + /// + /// Enum StateProvinceMaxLengthExceeded for value: state_province_max_length_exceeded + /// + public static AddressValidationDetailCode StateProvinceMaxLengthExceeded { get; } = new("state_province_max_length_exceeded"); + + + /// + /// Enum InvalidPostalCode for value: invalid_postal_code + /// + public static AddressValidationDetailCode InvalidPostalCode { get; } = new("invalid_postal_code"); + + + /// + /// Enum CountryInvalidLength for value: country_invalid_length + /// + public static AddressValidationDetailCode CountryInvalidLength { get; } = new("country_invalid_length"); + + + /// + /// Enum AddressNotFound for value: address_not_found + /// + public static AddressValidationDetailCode AddressNotFound { get; } = new("address_not_found"); + + + public override string ToString() => _value; +} + +internal class AddressValidationDetailCodeJsonConverter : JsonConverter +{ + public override AddressValidationDetailCode? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new AddressValidationDetailCode(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, AddressValidationDetailCode value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(AddressValidationDetailCode); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/AddressValidationMessageType.cs b/ShipEngineSDK/Model/AddressValidationMessageType.cs new file mode 100644 index 00000000..ac59692d --- /dev/null +++ b/ShipEngineSDK/Model/AddressValidationMessageType.cs @@ -0,0 +1,83 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The different types of messages that can be returned by the address validation API +/// +/// The different types of messages that can be returned by the address validation API +[JsonConverter(typeof(AddressValidationMessageTypeJsonConverter))] +public class AddressValidationMessageType +{ + private string _value; + + internal AddressValidationMessageType() + { + _value = "error"; + } + + /// + /// Create a new instance of AddressValidationMessageType with a custom value. + /// + /// The value of the AddressValidationMessageType + /// + /// 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 AddressValidationMessageType(string value) + { + _value = value; + } + + /// + /// Enum Error for value: error + /// + public static AddressValidationMessageType Error { get; } = new("error"); + + + /// + /// Enum Warning for value: warning + /// + public static AddressValidationMessageType Warning { get; } = new("warning"); + + + /// + /// Enum Info for value: info + /// + public static AddressValidationMessageType Info { get; } = new("info"); + + + public override string ToString() => _value; +} + +internal class AddressValidationMessageTypeJsonConverter : JsonConverter +{ + public override AddressValidationMessageType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new AddressValidationMessageType(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, AddressValidationMessageType value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(AddressValidationMessageType); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/AddressValidationResult.cs b/ShipEngineSDK/Model/AddressValidationResult.cs new file mode 100644 index 00000000..db456746 --- /dev/null +++ b/ShipEngineSDK/Model/AddressValidationResult.cs @@ -0,0 +1,89 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An address validation result +/// +public partial class AddressValidationResult +{ + + /// + /// Gets or Sets Status CLOVUS + /// + [JsonPropertyName("status")] + [JsonRequired] + public AddressValidationStatus Status { get; set; } = new(); + + + /// + /// The original address that was sent for validation + /// + /// The original address that was sent for validation + [JsonPropertyName("original_address")] + [JsonRequired] + public Address OriginalAddress { get; set; } + + /// + /// The matched address found by the Shipengine API + /// + /// The matched address found by the Shipengine API + [JsonPropertyName("matched_address")] + [JsonRequired] + public Address MatchedAddress { get; set; } + + /// + /// The list of messages that were generated during the address validation request. + /// + /// The list of messages that were generated during the address validation request. + [JsonPropertyName("messages")] + [JsonRequired] + public List Messages { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class AddressValidationResult {\n"); + sb.Append(" Status: ").Append(Status).Append("\n"); + sb.Append(" OriginalAddress: ").Append(OriginalAddress).Append("\n"); + sb.Append(" MatchedAddress: ").Append(MatchedAddress).Append("\n"); + sb.Append(" Messages: ").Append(Messages).Append("\n"); + 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/AddressValidationStatus.cs b/ShipEngineSDK/Model/AddressValidationStatus.cs new file mode 100644 index 00000000..737ac040 --- /dev/null +++ b/ShipEngineSDK/Model/AddressValidationStatus.cs @@ -0,0 +1,89 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible address validation status values +/// +/// The possible address validation status values +[JsonConverter(typeof(AddressValidationStatusJsonConverter))] +public class AddressValidationStatus +{ + private string _value; + + internal AddressValidationStatus() + { + _value = "unverified"; + } + + /// + /// Create a new instance of AddressValidationStatus with a custom value. + /// + /// The value of the AddressValidationStatus + /// + /// 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 AddressValidationStatus(string value) + { + _value = value; + } + + /// + /// Enum Unverified for value: unverified + /// + public static AddressValidationStatus Unverified { get; } = new("unverified"); + + + /// + /// Enum Verified for value: verified + /// + public static AddressValidationStatus Verified { get; } = new("verified"); + + + /// + /// Enum Warning for value: warning + /// + public static AddressValidationStatus Warning { get; } = new("warning"); + + + /// + /// Enum Error for value: error + /// + public static AddressValidationStatus Error { get; } = new("error"); + + + public override string ToString() => _value; +} + +internal class AddressValidationStatusJsonConverter : JsonConverter +{ + public override AddressValidationStatus? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new AddressValidationStatus(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, AddressValidationStatus value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(AddressValidationStatus); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptions.cs b/ShipEngineSDK/Model/AdvancedShipmentOptions.cs new file mode 100644 index 00000000..cebb43be --- /dev/null +++ b/ShipEngineSDK/Model/AdvancedShipmentOptions.cs @@ -0,0 +1,236 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Advanced shipment options +/// +public partial class AdvancedShipmentOptions +{ + + /// + /// Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set. CLOVUS + /// + /// Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set. + [JsonPropertyName("bill_to_party")] + public BillToParty? BillToParty { get; set; } + /// + /// Gets or Sets OriginType CLOVUS + /// + [JsonPropertyName("origin_type")] + public OriginType? OriginType { get; set; } + /// + /// This field is used to [bill shipping costs to a third party](https://www.shipengine.com/docs/shipping/bill-to-third-party/). This field must be used in conjunction with the `bill_to_country_code`, `bill_to_party`, and `bill_to_postal_code` fields. + /// + /// This field is used to [bill shipping costs to a third party](https://www.shipengine.com/docs/shipping/bill-to-third-party/). This field must be used in conjunction with the `bill_to_country_code`, `bill_to_party`, and `bill_to_postal_code` fields. + [JsonPropertyName("bill_to_account")] + public string BillToAccount { get; set; } + + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the third-party that is responsible for shipping costs. + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the third-party that is responsible for shipping costs. + /// + /// CA + /// + [JsonPropertyName("bill_to_country_code")] + public string BillToCountryCode { get; set; } + + /// + /// The postal code of the third-party that is responsible for shipping costs. + /// + /// The postal code of the third-party that is responsible for shipping costs. + [JsonPropertyName("bill_to_postal_code")] + public string BillToPostalCode { get; set; } + + /// + /// Indicates that the shipment contains alcohol. + /// + /// Indicates that the shipment contains alcohol. + [JsonPropertyName("contains_alcohol")] + public bool ContainsAlcohol { get; set; } + + /// + /// Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express. + /// + /// Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express. + [JsonPropertyName("delivered_duty_paid")] + public bool DeliveredDutyPaid { get; set; } + + /// + /// Indicates if the shipment contain dry ice + /// + /// Indicates if the shipment contain dry ice + [JsonPropertyName("dry_ice")] + public bool DryIce { get; set; } + + /// + /// The weight of the dry ice in the shipment + /// + /// The weight of the dry ice in the shipment + [JsonPropertyName("dry_ice_weight")] + public Weight DryIceWeight { get; set; } + + /// + /// Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details. + /// + /// Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details. + [JsonPropertyName("non_machinable")] + public bool NonMachinable { get; set; } + + /// + /// Enables Saturday delivery, if supported by the carrier. + /// + /// Enables Saturday delivery, if supported by the carrier. + [JsonPropertyName("saturday_delivery")] + public bool SaturdayDelivery { get; set; } + + /// + /// Gets or Sets FedexFreight + /// + [JsonPropertyName("fedex_freight")] + public AdvancedShipmentOptionsFedexFreight FedexFreight { get; set; } + + /// + /// Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified. + /// + /// Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified. + [JsonPropertyName("use_ups_ground_freight_pricing")] + public bool? UseUpsGroundFreightPricing { get; set; } + + /// + /// The National Motor Freight Traffic Association [freight class](http://www.nmfta.org/pages/nmfc?AspxAutoDetectCookieSupport=1), such as \"77.5\", \"110\", or \"250\". + /// + /// The National Motor Freight Traffic Association [freight class](http://www.nmfta.org/pages/nmfc?AspxAutoDetectCookieSupport=1), such as \"77.5\", \"110\", or \"250\". + /// + /// 77.5 + /// + [JsonPropertyName("freight_class")] + public string FreightClass { get; set; } + + /// + /// An arbitrary field that can be used to store information about the shipment. + /// + /// An arbitrary field that can be used to store information about the shipment. + [JsonPropertyName("custom_field1")] + public string CustomField1 { get; set; } + + /// + /// An arbitrary field that can be used to store information about the shipment. + /// + /// An arbitrary field that can be used to store information about the shipment. + [JsonPropertyName("custom_field2")] + public string CustomField2 { get; set; } + + /// + /// An arbitrary field that can be used to store information about the shipment. + /// + /// An arbitrary field that can be used to store information about the shipment. + [JsonPropertyName("custom_field3")] + public string CustomField3 { get; set; } + + /// + /// Indicate to the carrier that this shipment requires additional handling. + /// + /// Indicate to the carrier that this shipment requires additional handling. + [JsonPropertyName("additional_handling")] + public bool? AdditionalHandling { get; set; } + + /// + /// Gets or Sets ShipperRelease + /// + [JsonPropertyName("shipper_release")] + public bool? ShipperRelease { get; set; } + + /// + /// Gets or Sets CollectOnDelivery + /// + [JsonPropertyName("collect_on_delivery")] + public CollectOnDelivery CollectOnDelivery { get; set; } + + /// + /// Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached + /// + /// Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached + [JsonPropertyName("third_party_consignee")] + public bool ThirdPartyConsignee { get; set; } + + /// + /// Indicates if the Dangerous goods are present in the shipment + /// + /// Indicates if the Dangerous goods are present in the shipment + [JsonPropertyName("dangerous_goods")] + public bool DangerousGoods { get; set; } + + /// + /// Gets or Sets DangerousGoodsContact + /// + [JsonPropertyName("dangerous_goods_contact")] + public AdvancedShipmentOptionsDangerousGoodsContact DangerousGoodsContact { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class AdvancedShipmentOptions {\n"); + sb.Append(" BillToAccount: ").Append(BillToAccount).Append("\n"); + sb.Append(" BillToCountryCode: ").Append(BillToCountryCode).Append("\n"); + sb.Append(" BillToParty: ").Append(BillToParty).Append("\n"); + sb.Append(" BillToPostalCode: ").Append(BillToPostalCode).Append("\n"); + sb.Append(" ContainsAlcohol: ").Append(ContainsAlcohol).Append("\n"); + sb.Append(" DeliveredDutyPaid: ").Append(DeliveredDutyPaid).Append("\n"); + sb.Append(" DryIce: ").Append(DryIce).Append("\n"); + sb.Append(" DryIceWeight: ").Append(DryIceWeight).Append("\n"); + sb.Append(" NonMachinable: ").Append(NonMachinable).Append("\n"); + sb.Append(" SaturdayDelivery: ").Append(SaturdayDelivery).Append("\n"); + sb.Append(" FedexFreight: ").Append(FedexFreight).Append("\n"); + sb.Append(" UseUpsGroundFreightPricing: ").Append(UseUpsGroundFreightPricing).Append("\n"); + sb.Append(" FreightClass: ").Append(FreightClass).Append("\n"); + sb.Append(" CustomField1: ").Append(CustomField1).Append("\n"); + sb.Append(" CustomField2: ").Append(CustomField2).Append("\n"); + sb.Append(" CustomField3: ").Append(CustomField3).Append("\n"); + sb.Append(" OriginType: ").Append(OriginType).Append("\n"); + sb.Append(" AdditionalHandling: ").Append(AdditionalHandling).Append("\n"); + sb.Append(" ShipperRelease: ").Append(ShipperRelease).Append("\n"); + sb.Append(" CollectOnDelivery: ").Append(CollectOnDelivery).Append("\n"); + sb.Append(" ThirdPartyConsignee: ").Append(ThirdPartyConsignee).Append("\n"); + sb.Append(" DangerousGoods: ").Append(DangerousGoods).Append("\n"); + sb.Append(" DangerousGoodsContact: ").Append(DangerousGoodsContact).Append("\n"); + 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/AdvancedShipmentOptionsDangerousGoodsContact.cs b/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs new file mode 100644 index 00000000..ceb9922b --- /dev/null +++ b/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs @@ -0,0 +1,69 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Contact information for Dangerous goods +/// +public partial class AdvancedShipmentOptionsDangerousGoodsContact +{ + + /// + /// Name of the contact + /// + /// Name of the contact + [JsonPropertyName("name")] + public string Name { get; set; } + + /// + /// Phone number of the contact + /// + /// Phone number of the contact + [JsonPropertyName("phone")] + public string Phone { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class AdvancedShipmentOptionsDangerousGoodsContact {\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); + 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/AdvancedShipmentOptionsFedexFreight.cs b/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs new file mode 100644 index 00000000..6ee2545d --- /dev/null +++ b/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs @@ -0,0 +1,67 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Provide details for the Fedex freight service +/// +public partial class AdvancedShipmentOptionsFedexFreight +{ + + /// + /// Gets or Sets ShipperLoadAndCount + /// + [JsonPropertyName("shipper_load_and_count")] + public string ShipperLoadAndCount { get; set; } + + /// + /// Gets or Sets BookingConfirmation + /// + [JsonPropertyName("booking_confirmation")] + public string BookingConfirmation { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class AdvancedShipmentOptionsFedexFreight {\n"); + sb.Append(" ShipperLoadAndCount: ").Append(ShipperLoadAndCount).Append("\n"); + sb.Append(" BookingConfirmation: ").Append(BookingConfirmation).Append("\n"); + 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/AllowedIncoterms.cs b/ShipEngineSDK/Model/AllowedIncoterms.cs new file mode 100644 index 00000000..a8bd17b2 --- /dev/null +++ b/ShipEngineSDK/Model/AllowedIncoterms.cs @@ -0,0 +1,154 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Defines Allowed incoterms +/// +[JsonConverter(typeof(AllowedIncotermsJsonConverter))] +public class AllowedIncoterms +{ + private string _value; + + internal AllowedIncoterms() + { + _value = "exw"; + } + + /// + /// Create a new instance of AllowedIncoterms with a custom value. + /// + /// The value of the AllowedIncoterms + /// + /// 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 AllowedIncoterms(string value) + { + _value = value; + } + + /// + /// Enum Exw for value: exw + /// + public static AllowedIncoterms Exw { get; } = new("exw"); + + + /// + /// Enum Fca for value: fca + /// + public static AllowedIncoterms Fca { get; } = new("fca"); + + + /// + /// Enum Cpt for value: cpt + /// + public static AllowedIncoterms Cpt { get; } = new("cpt"); + + + /// + /// Enum Cip for value: cip + /// + public static AllowedIncoterms Cip { get; } = new("cip"); + + + /// + /// Enum Dpu for value: dpu + /// + public static AllowedIncoterms Dpu { get; } = new("dpu"); + + + /// + /// Enum Dap for value: dap + /// + public static AllowedIncoterms Dap { get; } = new("dap"); + + + /// + /// Enum Ddp for value: ddp + /// + public static AllowedIncoterms Ddp { get; } = new("ddp"); + + + /// + /// Enum Fas for value: fas + /// + public static AllowedIncoterms Fas { get; } = new("fas"); + + + /// + /// Enum Fob for value: fob + /// + public static AllowedIncoterms Fob { get; } = new("fob"); + + + /// + /// Enum Cfr for value: cfr + /// + public static AllowedIncoterms Cfr { get; } = new("cfr"); + + + /// + /// Enum Cif for value: cif + /// + public static AllowedIncoterms Cif { get; } = new("cif"); + + + /// + /// Enum Ddu for value: ddu + /// + public static AllowedIncoterms Ddu { get; } = new("ddu"); + + + /// + /// Enum Daf for value: daf + /// + public static AllowedIncoterms Daf { get; } = new("daf"); + + + /// + /// Enum Deq for value: deq + /// + public static AllowedIncoterms Deq { get; } = new("deq"); + + + /// + /// Enum Des for value: des + /// + public static AllowedIncoterms Des { get; } = new("des"); + + + public override string ToString() => _value; +} + +internal class AllowedIncotermsJsonConverter : JsonConverter +{ + public override AllowedIncoterms? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new AllowedIncoterms(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, AllowedIncoterms value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(AllowedIncoterms); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/AlternativeIdentifier.cs b/ShipEngineSDK/Model/AlternativeIdentifier.cs new file mode 100644 index 00000000..a5cfb608 --- /dev/null +++ b/ShipEngineSDK/Model/AlternativeIdentifier.cs @@ -0,0 +1,75 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Additional information some carriers may provide by which to identify a given label in their system. +/// +public partial class AlternativeIdentifier +{ + + /// + /// The type of alternative_identifier that corresponds to the value. + /// + /// The type of alternative_identifier that corresponds to the value. + /// + /// last_mile_tracking_number + /// + [JsonPropertyName("type")] + public string Type { get; set; } + + /// + /// The value of the alternative_identifier. + /// + /// The value of the alternative_identifier. + /// + /// 12345678912345678912 + /// + [JsonPropertyName("value")] + public string Value { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class AlternativeIdentifier {\n"); + sb.Append(" Type: ").Append(Type).Append("\n"); + sb.Append(" Value: ").Append(Value).Append("\n"); + 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/AlternativeIdentifiers.cs b/ShipEngineSDK/Model/AlternativeIdentifiers.cs new file mode 100644 index 00000000..39751e11 --- /dev/null +++ b/ShipEngineSDK/Model/AlternativeIdentifiers.cs @@ -0,0 +1,61 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// AlternativeIdentifiers +/// +public partial class AlternativeIdentifiers +{ + + /// + /// Alternative identifiers associated with this package. + /// + /// Alternative identifiers associated with this package. + [JsonPropertyName("alternative_identifiers")] + public List VarAlternativeIdentifiers { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class AlternativeIdentifiers {\n"); + sb.Append(" VarAlternativeIdentifiers: ").Append(VarAlternativeIdentifiers).Append("\n"); + 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/AncillaryServiceEndorsement.cs b/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs new file mode 100644 index 00000000..6dfa711e --- /dev/null +++ b/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs @@ -0,0 +1,101 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// [Ancillary service endorsements](https://pe.usps.com/text/qsg300/Q507.htm) are used by mailers to request an addressee's new address and to provide the carrier with instructions on how to handle packages that are undeliverable as addressed. | Ancillary Service Endorsement | Description |- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- | `none` | No ancillary service is requested. Depending on the carrier servive, the package may be forwarded, returned, or discarded. | `return_service_requested` | The package is returned to the sender. If possible, notification of the new address is is included with the returned package. | `forwarding_service_requested` | Forward the package to the new address, if possible; otherwise, return it to the sender. | `address_service_requested` | Forward the package to the new address, if possible; otherwise, return it to the sender. This is similar to `forwarding_service_requested`, but different restrictions and charges may apply. | `change_service_requested` | The package is discarded. If possible, notification of the new address is sent to the sender. | `leave_if_no_response` | +/// +/// [Ancillary service endorsements](https://pe.usps.com/text/qsg300/Q507.htm) are used by mailers to request an addressee's new address and to provide the carrier with instructions on how to handle packages that are undeliverable as addressed. | Ancillary Service Endorsement | Description |- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- | `none` | No ancillary service is requested. Depending on the carrier servive, the package may be forwarded, returned, or discarded. | `return_service_requested` | The package is returned to the sender. If possible, notification of the new address is is included with the returned package. | `forwarding_service_requested` | Forward the package to the new address, if possible; otherwise, return it to the sender. | `address_service_requested` | Forward the package to the new address, if possible; otherwise, return it to the sender. This is similar to `forwarding_service_requested`, but different restrictions and charges may apply. | `change_service_requested` | The package is discarded. If possible, notification of the new address is sent to the sender. | `leave_if_no_response` | +[JsonConverter(typeof(AncillaryServiceEndorsementJsonConverter))] +public class AncillaryServiceEndorsement +{ + private string _value; + + internal AncillaryServiceEndorsement() + { + _value = "none"; + } + + /// + /// Create a new instance of AncillaryServiceEndorsement with a custom value. + /// + /// The value of the AncillaryServiceEndorsement + /// + /// 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 AncillaryServiceEndorsement(string value) + { + _value = value; + } + + /// + /// Enum None for value: none + /// + public static AncillaryServiceEndorsement None { get; } = new("none"); + + + /// + /// Enum ReturnServiceRequested for value: return_service_requested + /// + public static AncillaryServiceEndorsement ReturnServiceRequested { get; } = new("return_service_requested"); + + + /// + /// Enum ForwardingServiceRequested for value: forwarding_service_requested + /// + public static AncillaryServiceEndorsement ForwardingServiceRequested { get; } = new("forwarding_service_requested"); + + + /// + /// Enum AddressServiceRequested for value: address_service_requested + /// + public static AncillaryServiceEndorsement AddressServiceRequested { get; } = new("address_service_requested"); + + + /// + /// Enum ChangeServiceRequested for value: change_service_requested + /// + public static AncillaryServiceEndorsement ChangeServiceRequested { get; } = new("change_service_requested"); + + + /// + /// Enum LeaveIfNoResponse for value: leave_if_no_response + /// + public static AncillaryServiceEndorsement LeaveIfNoResponse { get; } = new("leave_if_no_response"); + + + public override string ToString() => _value; +} + +internal class AncillaryServiceEndorsementJsonConverter : JsonConverter +{ + public override AncillaryServiceEndorsement? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new AncillaryServiceEndorsement(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, AncillaryServiceEndorsement value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(AncillaryServiceEndorsement); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/BatchResponseError.cs b/ShipEngineSDK/Model/BatchResponseError.cs new file mode 100644 index 00000000..49fc0641 --- /dev/null +++ b/ShipEngineSDK/Model/BatchResponseError.cs @@ -0,0 +1,83 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 batch response error +/// +public partial class BatchResponseError +{ + + /// + /// Error message associated with the shipment. + /// + /// Error message associated with the shipment. + /// + /// Recipient address has not been verified. + /// + [JsonPropertyName("error")] + public string Error { get; set; } + + /// + /// A string that uniquely identifies the shipment + /// + /// A string that uniquely identifies the shipment + /// + /// se-28529731 + /// + [JsonPropertyName("shipment_id")] + public string ShipmentId { get; set; } + + /// + /// An external shipment id associated with the shipment + /// + /// An external shipment id associated with the shipment + [JsonPropertyName("external_shipment_id")] + public string ExternalShipmentId { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class BatchResponseError {\n"); + sb.Append(" Error: ").Append(Error).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); + 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/BatchStatus.cs b/ShipEngineSDK/Model/BatchStatus.cs new file mode 100644 index 00000000..3ea0b579 --- /dev/null +++ b/ShipEngineSDK/Model/BatchStatus.cs @@ -0,0 +1,113 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible batch status values +/// +/// The possible batch status values +[JsonConverter(typeof(BatchStatusJsonConverter))] +public class BatchStatus +{ + private string _value; + + internal BatchStatus() + { + _value = "open"; + } + + /// + /// Create a new instance of BatchStatus with a custom value. + /// + /// The value of the BatchStatus + /// + /// 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 BatchStatus(string value) + { + _value = value; + } + + /// + /// Enum Open for value: open + /// + public static BatchStatus Open { get; } = new("open"); + + + /// + /// Enum Queued for value: queued + /// + public static BatchStatus Queued { get; } = new("queued"); + + + /// + /// Enum Processing for value: processing + /// + public static BatchStatus Processing { get; } = new("processing"); + + + /// + /// Enum Completed for value: completed + /// + public static BatchStatus Completed { get; } = new("completed"); + + + /// + /// Enum CompletedWithErrors for value: completed_with_errors + /// + public static BatchStatus CompletedWithErrors { get; } = new("completed_with_errors"); + + + /// + /// Enum Archived for value: archived + /// + public static BatchStatus Archived { get; } = new("archived"); + + + /// + /// Enum Notifying for value: notifying + /// + public static BatchStatus Notifying { get; } = new("notifying"); + + + /// + /// Enum Invalid for value: invalid + /// + public static BatchStatus Invalid { get; } = new("invalid"); + + + public override string ToString() => _value; +} + +internal class BatchStatusJsonConverter : JsonConverter +{ + public override BatchStatus? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new BatchStatus(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, BatchStatus value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(BatchStatus); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/BatchesSortBy.cs b/ShipEngineSDK/Model/BatchesSortBy.cs new file mode 100644 index 00000000..2dc236c7 --- /dev/null +++ b/ShipEngineSDK/Model/BatchesSortBy.cs @@ -0,0 +1,83 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible batches sort by values +/// +/// The possible batches sort by values +[JsonConverter(typeof(BatchesSortByJsonConverter))] +public class BatchesSortBy +{ + private string _value; + + internal BatchesSortBy() + { + _value = "ship_date"; + } + + /// + /// Create a new instance of BatchesSortBy with a custom value. + /// + /// The value of the BatchesSortBy + /// + /// 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 BatchesSortBy(string value) + { + _value = value; + } + + /// + /// Enum ShipDate for value: ship_date + /// + public static BatchesSortBy ShipDate { get; } = new("ship_date"); + + + /// + /// Enum ProcessedAt for value: processed_at + /// + public static BatchesSortBy ProcessedAt { get; } = new("processed_at"); + + + /// + /// Enum CreatedAt for value: created_at + /// + public static BatchesSortBy CreatedAt { get; } = new("created_at"); + + + public override string ToString() => _value; +} + +internal class BatchesSortByJsonConverter : JsonConverter +{ + public override BatchesSortBy? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new BatchesSortBy(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, BatchesSortBy value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(BatchesSortBy); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/BillToParty.cs b/ShipEngineSDK/Model/BillToParty.cs new file mode 100644 index 00000000..67fd5fd5 --- /dev/null +++ b/ShipEngineSDK/Model/BillToParty.cs @@ -0,0 +1,77 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible bill to party values +/// +/// The possible bill to party values +[JsonConverter(typeof(BillToPartyJsonConverter))] +public class BillToParty +{ + private string _value; + + internal BillToParty() + { + _value = "recipient"; + } + + /// + /// Create a new instance of BillToParty with a custom value. + /// + /// The value of the BillToParty + /// + /// 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 BillToParty(string value) + { + _value = value; + } + + /// + /// Enum Recipient for value: recipient + /// + public static BillToParty Recipient { get; } = new("recipient"); + + + /// + /// Enum ThirdParty for value: third_party + /// + public static BillToParty ThirdParty { get; } = new("third_party"); + + + public override string ToString() => _value; +} + +internal class BillToPartyJsonConverter : JsonConverter +{ + public override BillToParty? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new BillToParty(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, BillToParty value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(BillToParty); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/CalculateRatesRequestBody.cs b/ShipEngineSDK/Model/CalculateRatesRequestBody.cs new file mode 100644 index 00000000..e848a3f1 --- /dev/null +++ b/ShipEngineSDK/Model/CalculateRatesRequestBody.cs @@ -0,0 +1,274 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.IO; +using System.Linq; +using System.Reflection; +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 rate shipment request body +/// +[JsonConverter(typeof(CalculateRatesRequestBodyJsonConverter))] +//[DataContract(Name = "calculate_rates_request_body")] +public partial class CalculateRatesRequestBody : AbstractOpenAPISchema +{ + + /// + /// The rate options + /// + /// The rate options + [JsonPropertyName("rate_options")] + public RateRequestBody RateOptions { get; set; } + + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ShipmentIdRequest. + public CalculateRatesRequestBody(ShipmentIdRequest actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ShipmentRequest. + public CalculateRatesRequestBody(ShipmentRequest actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + + private Object _actualInstance; + + /// + /// Gets or Sets ActualInstance + /// + public override Object ActualInstance + { + get + { + return _actualInstance; + } + set + { + if (value.GetType() == typeof(ShipmentIdRequest)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ShipmentRequest)) + { + this._actualInstance = value; + } + else + { + throw new ArgumentException("Invalid instance found. Must be the following types: ShipmentIdRequest, ShipmentRequest"); + } + } + } + + /// + /// Get the actual instance of `ShipmentIdRequest`. If the actual instance is not `ShipmentIdRequest`, + /// the InvalidClassException will be thrown + /// + /// An instance of ShipmentIdRequest + public ShipmentIdRequest GetShipmentIdRequest() + { + return (ShipmentIdRequest)this.ActualInstance; + } + + /// + /// Get the actual instance of `ShipmentRequest`. If the actual instance is not `ShipmentRequest`, + /// the InvalidClassException will be thrown + /// + /// An instance of ShipmentRequest + public ShipmentRequest GetShipmentRequest() + { + return (ShipmentRequest)this.ActualInstance; + } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class CalculateRatesRequestBody {\n"); + sb.Append(" ActualInstance: ").Append(this.ActualInstance).Append("\n"); + + sb.Append(" RateOptions: ").Append(this.RateOptions).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public override string ToJson() + { + return JsonSerializer.Serialize(this.ActualInstance, CalculateRatesRequestBody.SerializerSettings); + } + +} + +/// +/// Custom JSON converter for CalculateRatesRequestBody +/// +public class CalculateRatesRequestBodyJsonConverter : JsonConverter +{ + private static HashSet OneOfTypes = [typeof(ShipmentIdRequest), typeof(ShipmentRequest)]; + private static HashSet MandatoryFields = ["Shipment", "ShipmentId"]; + private static JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) + { + TypeInfoResolver = new DefaultJsonTypeInfoResolver + { + Modifiers = + { + static typeInfo => + { + if (typeInfo.Kind != JsonTypeInfoKind.Object) + return; + + foreach (JsonPropertyInfo propertyInfo in typeInfo.Properties) + { + // Strip IsRequired constraint from every property except those which define the underlying type + if (OneOfTypes.Contains(typeInfo.Type)) + { + var underlyingPropertyName = (propertyInfo.AttributeProvider as MemberInfo)?.Name; + propertyInfo.IsRequired = underlyingPropertyName != null && MandatoryFields.Contains(underlyingPropertyName); + } + else + { + propertyInfo.IsRequired = false; + } + } + } + } + } + }; + + /// + /// To write the JSON string + /// + /// JSON writer + /// Object to be converted into a JSON string + /// Serializer options + public override void Write(Utf8JsonWriter writer, CalculateRatesRequestBody value, JsonSerializerOptions options) + { + writer.WriteStartObject(); + + writer.WritePropertyName("rate_options"); + JsonSerializer.Serialize(writer, value.RateOptions, options); + + var node = JsonSerializer.SerializeToNode(value.ActualInstance, options); + foreach (var prop in node?.AsObject() ?? []) + { + if (prop.Value != null) + { + writer.WritePropertyName(prop.Key); + prop.Value.WriteTo(writer, options); + } + } + + writer.WriteEndObject(); + } + + /// + /// To convert a JSON string into an object + /// + /// JSON reader + /// Object type to convert + /// Serializer options + /// The object converted from the JSON string + public override CalculateRatesRequestBody Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + if (reader.TokenType == JsonTokenType.Null) + { + return null; + } + + var jsonDoc = JsonDocument.ParseValue(ref reader); + CalculateRatesRequestBody newCalculateRatesRequestBody = null; + + int match = 0; + var matchedTypes = new List(); + + try + { + newCalculateRatesRequestBody = new CalculateRatesRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ShipmentIdRequest"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ShipmentIdRequest: {1}", jsonDoc, exception.ToString())); + } + + try + { + newCalculateRatesRequestBody = new CalculateRatesRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ShipmentRequest"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ShipmentRequest: {1}", jsonDoc, exception.ToString())); + } + + if (match == 0) + { + throw new InvalidDataException("The JSON string `" + jsonDoc + "` cannot be deserialized into any schema defined."); + } + + if (match > 1) + { + throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); + } + + newCalculateRatesRequestBody.RateOptions = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("rate_options"), DeserializingOptions); + + // deserialization is considered successful at this point if no exception has been thrown. + return newCalculateRatesRequestBody; + } + + /// + /// Check if the object can be converted + /// + /// Object type + /// True if the object can be converted + public override bool CanConvert(Type objectType) + { + return typeof(CalculateRatesRequestBody).IsAssignableFrom(objectType); + } +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/Carrier.cs b/ShipEngineSDK/Model/Carrier.cs new file mode 100644 index 00000000..3836f301 --- /dev/null +++ b/ShipEngineSDK/Model/Carrier.cs @@ -0,0 +1,183 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 carrier object that represents a provider such as UPS, USPS, DHL, etc that has been tied to the current account. +/// +public partial class Carrier +{ + + /// + /// A string that uniquely identifies the carrier. + /// + /// A string that uniquely identifies the carrier. + /// + /// se-28529731 + /// + [JsonPropertyName("carrier_id")] + public string CarrierId { get; set; } + + /// + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// dhl_express + /// + [JsonPropertyName("carrier_code")] + public string CarrierCode { get; set; } + + /// + /// The account number that the carrier is connected to. + /// + /// The account number that the carrier is connected to. + /// + /// account_570827 + /// + [JsonPropertyName("account_number")] + public string AccountNumber { get; set; } + + /// + /// Indicates whether the carrier requires funding to use its services + /// + /// Indicates whether the carrier requires funding to use its services + [JsonPropertyName("requires_funded_amount")] + public bool RequiresFundedAmount { get; set; } + + /// + /// Current available balance + /// + /// Current available balance + /// + /// 3799.52 + /// + [JsonPropertyName("balance")] + public double Balance { get; set; } + + /// + /// Nickname given to the account when initially setting up the carrier. + /// + /// Nickname given to the account when initially setting up the carrier. + /// + /// ShipEngine Account - Stamps.com + /// + [JsonPropertyName("nickname")] + public string Nickname { get; set; } + + /// + /// Screen readable name + /// + /// Screen readable name + /// + /// Stamps.com + /// + [JsonPropertyName("friendly_name")] + public string FriendlyName { get; set; } + + /// + /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation + /// + /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation + [JsonPropertyName("primary")] + public bool Primary { get; set; } + + /// + /// Carrier supports multiple packages per shipment + /// + /// Carrier supports multiple packages per shipment + [JsonPropertyName("has_multi_package_supporting_services")] + public bool HasMultiPackageSupportingServices { get; set; } + + /// + /// The carrier supports adding custom label messages to an order. + /// + /// The carrier supports adding custom label messages to an order. + [JsonPropertyName("supports_label_messages")] + public bool SupportsLabelMessages { get; set; } + + /// + /// The carrier is disabled by the current ShipEngine account's billing plan. + /// + /// The carrier is disabled by the current ShipEngine account's billing plan. + [JsonPropertyName("disabled_by_billing_plan")] + public bool DisabledByBillingPlan { get; set; } + + /// + /// A list of services that are offered by the carrier + /// + /// A list of services that are offered by the carrier + [JsonPropertyName("services")] + public List Services { get; set; } + + /// + /// A list of package types that are supported by the carrier + /// + /// A list of package types that are supported by the carrier + [JsonPropertyName("packages")] + public List Packages { get; set; } + + /// + /// A list of options that are available to that carrier + /// + /// A list of options that are available to that carrier + [JsonPropertyName("options")] + public List Options { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class Carrier {\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" RequiresFundedAmount: ").Append(RequiresFundedAmount).Append("\n"); + sb.Append(" Balance: ").Append(Balance).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" FriendlyName: ").Append(FriendlyName).Append("\n"); + sb.Append(" Primary: ").Append(Primary).Append("\n"); + sb.Append(" HasMultiPackageSupportingServices: ").Append(HasMultiPackageSupportingServices).Append("\n"); + sb.Append(" SupportsLabelMessages: ").Append(SupportsLabelMessages).Append("\n"); + sb.Append(" DisabledByBillingPlan: ").Append(DisabledByBillingPlan).Append("\n"); + sb.Append(" Services: ").Append(Services).Append("\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" Options: ").Append(Options).Append("\n"); + 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/CarrierAdvancedOption.cs b/ShipEngineSDK/Model/CarrierAdvancedOption.cs new file mode 100644 index 00000000..40017ad6 --- /dev/null +++ b/ShipEngineSDK/Model/CarrierAdvancedOption.cs @@ -0,0 +1,83 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Advanced options that are specific to the carrier +/// +public partial class CarrierAdvancedOption +{ + + /// + /// Name of advanced option + /// + /// Name of advanced option + /// + /// contains_alcohol + /// + [JsonPropertyName("name")] + public string Name { get; set; } + + /// + /// Default value of option + /// + /// Default value of option + /// + /// false + /// + [JsonPropertyName("default_value")] + public string DefaultValue { get; set; } + + /// + /// Description of option + /// + /// Description of option + [JsonPropertyName("description")] + public string Description { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class CarrierAdvancedOption {\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" DefaultValue: ").Append(DefaultValue).Append("\n"); + sb.Append(" Description: ").Append(Description).Append("\n"); + 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/CarrierName.cs b/ShipEngineSDK/Model/CarrierName.cs new file mode 100644 index 00000000..27b09555 --- /dev/null +++ b/ShipEngineSDK/Model/CarrierName.cs @@ -0,0 +1,233 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The shipping carriers that are supported by ShipEngine +/// +/// The shipping carriers that are supported by ShipEngine +[JsonConverter(typeof(CarrierNameJsonConverter))] +public class CarrierName +{ + private string _value; + + internal CarrierName() + { + _value = "access_worldwide"; + } + + /// + /// Create a new instance of CarrierName with a custom value. + /// + /// The value of the CarrierName + /// + /// 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 CarrierName(string value) + { + _value = value; + } + + /// + /// Enum AccessWorldwide for value: access_worldwide + /// + public static CarrierName AccessWorldwide { get; } = new("access_worldwide"); + + + /// + /// Enum AmazonBuyShipping for value: amazon_buy_shipping + /// + public static CarrierName AmazonBuyShipping { get; } = new("amazon_buy_shipping"); + + + /// + /// Enum AmazonShippingUk for value: amazon_shipping_uk + /// + public static CarrierName AmazonShippingUk { get; } = new("amazon_shipping_uk"); + + + /// + /// Enum Apc for value: apc + /// + public static CarrierName Apc { get; } = new("apc"); + + + /// + /// Enum Asendia for value: asendia + /// + public static CarrierName Asendia { get; } = new("asendia"); + + + /// + /// Enum AustraliaPost for value: australia_post + /// + public static CarrierName AustraliaPost { get; } = new("australia_post"); + + + /// + /// Enum CanadaPost for value: canada_post + /// + public static CarrierName CanadaPost { get; } = new("canada_post"); + + + /// + /// Enum DhlEcommerce for value: dhl_ecommerce + /// + public static CarrierName DhlEcommerce { get; } = new("dhl_ecommerce"); + + + /// + /// Enum DhlExpress for value: dhl_express + /// + public static CarrierName DhlExpress { get; } = new("dhl_express"); + + + /// + /// Enum DhlExpressAu for value: dhl_express_au + /// + public static CarrierName DhlExpressAu { get; } = new("dhl_express_au"); + + + /// + /// Enum DhlExpressCa for value: dhl_express_ca + /// + public static CarrierName DhlExpressCa { get; } = new("dhl_express_ca"); + + + /// + /// Enum DhlExpressUk for value: dhl_express_uk + /// + public static CarrierName DhlExpressUk { get; } = new("dhl_express_uk"); + + + /// + /// Enum Dpd for value: dpd + /// + public static CarrierName Dpd { get; } = new("dpd"); + + + /// + /// Enum Endicia for value: endicia + /// + public static CarrierName Endicia { get; } = new("endicia"); + + + /// + /// Enum Fedex for value: fedex + /// + public static CarrierName Fedex { get; } = new("fedex"); + + + /// + /// Enum FedexUk for value: fedex_uk + /// + public static CarrierName FedexUk { get; } = new("fedex_uk"); + + + /// + /// Enum Firstmile for value: firstmile + /// + public static CarrierName Firstmile { get; } = new("firstmile"); + + + /// + /// Enum Imex for value: imex + /// + public static CarrierName Imex { get; } = new("imex"); + + + /// + /// Enum Newgistics for value: newgistics + /// + public static CarrierName Newgistics { get; } = new("newgistics"); + + + /// + /// Enum Ontrac for value: ontrac + /// + public static CarrierName Ontrac { get; } = new("ontrac"); + + + /// + /// Enum PurolatorCanada for value: purolator_canada + /// + public static CarrierName PurolatorCanada { get; } = new("purolator_canada"); + + + /// + /// Enum RoyalMail for value: royal_mail + /// + public static CarrierName RoyalMail { get; } = new("royal_mail"); + + + /// + /// Enum RrDonnelley for value: rr_donnelley + /// + public static CarrierName RrDonnelley { get; } = new("rr_donnelley"); + + + /// + /// Enum Seko for value: seko + /// + public static CarrierName Seko { get; } = new("seko"); + + + /// + /// Enum Sendle for value: sendle + /// + public static CarrierName Sendle { get; } = new("sendle"); + + + /// + /// Enum StampsCom for value: stamps_com + /// + public static CarrierName StampsCom { get; } = new("stamps_com"); + + + /// + /// Enum Ups for value: ups + /// + public static CarrierName Ups { get; } = new("ups"); + + + /// + /// Enum Lasership for value: lasership + /// + public static CarrierName Lasership { get; } = new("lasership"); + + + public override string ToString() => _value; +} + +internal class CarrierNameJsonConverter : JsonConverter +{ + public override CarrierName? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new CarrierName(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, CarrierName value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(CarrierName); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/CarrierNameWithSettings.cs b/ShipEngineSDK/Model/CarrierNameWithSettings.cs new file mode 100644 index 00000000..fe9dce94 --- /dev/null +++ b/ShipEngineSDK/Model/CarrierNameWithSettings.cs @@ -0,0 +1,89 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The shipping carriers for which ShipEngine supports carrier settings +/// +/// The shipping carriers for which ShipEngine supports carrier settings +[JsonConverter(typeof(CarrierNameWithSettingsJsonConverter))] +public class CarrierNameWithSettings +{ + private string _value; + + internal CarrierNameWithSettings() + { + _value = "dhl_express"; + } + + /// + /// Create a new instance of CarrierNameWithSettings with a custom value. + /// + /// The value of the CarrierNameWithSettings + /// + /// 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 CarrierNameWithSettings(string value) + { + _value = value; + } + + /// + /// Enum DhlExpress for value: dhl_express + /// + public static CarrierNameWithSettings DhlExpress { get; } = new("dhl_express"); + + + /// + /// Enum Fedex for value: fedex + /// + public static CarrierNameWithSettings Fedex { get; } = new("fedex"); + + + /// + /// Enum Newgistics for value: newgistics + /// + public static CarrierNameWithSettings Newgistics { get; } = new("newgistics"); + + + /// + /// Enum Ups for value: ups + /// + public static CarrierNameWithSettings Ups { get; } = new("ups"); + + + public override string ToString() => _value; +} + +internal class CarrierNameWithSettingsJsonConverter : JsonConverter +{ + public override CarrierNameWithSettings? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new CarrierNameWithSettings(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, CarrierNameWithSettings value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(CarrierNameWithSettings); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/CollectOnDelivery.cs b/ShipEngineSDK/Model/CollectOnDelivery.cs new file mode 100644 index 00000000..49446865 --- /dev/null +++ b/ShipEngineSDK/Model/CollectOnDelivery.cs @@ -0,0 +1,66 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Defer payment until package is delivered, instead of when it is ordered. +/// +public partial class CollectOnDelivery +{ + + /// + /// Gets or Sets PaymentType CLOVUS + /// + [JsonPropertyName("payment_type")] + public CollectOnDeliveryPaymentType? PaymentType { get; set; } + /// + /// Gets or Sets PaymentAmount + /// + [JsonPropertyName("payment_amount")] + public PaymentAmount PaymentAmount { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class CollectOnDelivery {\n"); + sb.Append(" PaymentType: ").Append(PaymentType).Append("\n"); + sb.Append(" PaymentAmount: ").Append(PaymentAmount).Append("\n"); + 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/CollectOnDeliveryPaymentType.cs b/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs new file mode 100644 index 00000000..9929b535 --- /dev/null +++ b/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs @@ -0,0 +1,89 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Types of payment that are supported +/// +/// Types of payment that are supported +[JsonConverter(typeof(CollectOnDeliveryPaymentTypeJsonConverter))] +public class CollectOnDeliveryPaymentType +{ + private string _value; + + internal CollectOnDeliveryPaymentType() + { + _value = "any"; + } + + /// + /// Create a new instance of CollectOnDeliveryPaymentType with a custom value. + /// + /// The value of the CollectOnDeliveryPaymentType + /// + /// 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 CollectOnDeliveryPaymentType(string value) + { + _value = value; + } + + /// + /// Enum Any for value: any + /// + public static CollectOnDeliveryPaymentType Any { get; } = new("any"); + + + /// + /// Enum Cash for value: cash + /// + public static CollectOnDeliveryPaymentType Cash { get; } = new("cash"); + + + /// + /// Enum CashEquivalent for value: cash_equivalent + /// + public static CollectOnDeliveryPaymentType CashEquivalent { get; } = new("cash_equivalent"); + + + /// + /// Enum None for value: none + /// + public static CollectOnDeliveryPaymentType None { get; } = new("none"); + + + public override string ToString() => _value; +} + +internal class CollectOnDeliveryPaymentTypeJsonConverter : JsonConverter +{ + public override CollectOnDeliveryPaymentType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new CollectOnDeliveryPaymentType(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, CollectOnDeliveryPaymentType value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(CollectOnDeliveryPaymentType); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs b/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs new file mode 100644 index 00000000..bb2913cd --- /dev/null +++ b/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs @@ -0,0 +1,275 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.IO; +using System.Linq; +using System.Reflection; +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 rate shipments request body +/// +[JsonConverter(typeof(CompareBulkRatesRequestBodyJsonConverter))] +//[DataContract(Name = "compare_bulk_rates_request_body")] +public partial class CompareBulkRatesRequestBody : AbstractOpenAPISchema +{ + + /// + /// The rate options + /// + /// The rate options + [JsonPropertyName("rate_options")] + [JsonRequired] + public RateRequestBody RateOptions { get; set; } + + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of RateRequestByShipmentIds. + public CompareBulkRatesRequestBody(RateRequestByShipmentIds actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of RateRequestByShipments. + public CompareBulkRatesRequestBody(RateRequestByShipments actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + + private Object _actualInstance; + + /// + /// Gets or Sets ActualInstance + /// + public override Object ActualInstance + { + get + { + return _actualInstance; + } + set + { + if (value.GetType() == typeof(RateRequestByShipmentIds)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(RateRequestByShipments)) + { + this._actualInstance = value; + } + else + { + throw new ArgumentException("Invalid instance found. Must be the following types: RateRequestByShipmentIds, RateRequestByShipments"); + } + } + } + + /// + /// Get the actual instance of `RateRequestByShipmentIds`. If the actual instance is not `RateRequestByShipmentIds`, + /// the InvalidClassException will be thrown + /// + /// An instance of RateRequestByShipmentIds + public RateRequestByShipmentIds GetRateRequestByShipmentIds() + { + return (RateRequestByShipmentIds)this.ActualInstance; + } + + /// + /// Get the actual instance of `RateRequestByShipments`. If the actual instance is not `RateRequestByShipments`, + /// the InvalidClassException will be thrown + /// + /// An instance of RateRequestByShipments + public RateRequestByShipments GetRateRequestByShipments() + { + return (RateRequestByShipments)this.ActualInstance; + } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class CompareBulkRatesRequestBody {\n"); + sb.Append(" ActualInstance: ").Append(this.ActualInstance).Append("\n"); + + sb.Append(" RateOptions: ").Append(this.RateOptions).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public override string ToJson() + { + return JsonSerializer.Serialize(this.ActualInstance, CompareBulkRatesRequestBody.SerializerSettings); + } + +} + +/// +/// Custom JSON converter for CompareBulkRatesRequestBody +/// +public class CompareBulkRatesRequestBodyJsonConverter : JsonConverter +{ + private static HashSet OneOfTypes = [typeof(RateRequestByShipmentIds), typeof(RateRequestByShipments)]; + private static HashSet MandatoryFields = ["RateOptions"]; + private static JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) + { + TypeInfoResolver = new DefaultJsonTypeInfoResolver + { + Modifiers = + { + static typeInfo => + { + if (typeInfo.Kind != JsonTypeInfoKind.Object) + return; + + foreach (JsonPropertyInfo propertyInfo in typeInfo.Properties) + { + // Strip IsRequired constraint from every property except those which define the underlying type + if (OneOfTypes.Contains(typeInfo.Type)) + { + var underlyingPropertyName = (propertyInfo.AttributeProvider as MemberInfo)?.Name; + propertyInfo.IsRequired = underlyingPropertyName != null && MandatoryFields.Contains(underlyingPropertyName); + } + else + { + propertyInfo.IsRequired = false; + } + } + } + } + } + }; + + /// + /// To write the JSON string + /// + /// JSON writer + /// Object to be converted into a JSON string + /// Serializer options + public override void Write(Utf8JsonWriter writer, CompareBulkRatesRequestBody value, JsonSerializerOptions options) + { + writer.WriteStartObject(); + + writer.WritePropertyName("rate_options"); + JsonSerializer.Serialize(writer, value.RateOptions, options); + + var node = JsonSerializer.SerializeToNode(value.ActualInstance, options); + foreach (var prop in node?.AsObject() ?? []) + { + if (prop.Value != null) + { + writer.WritePropertyName(prop.Key); + prop.Value.WriteTo(writer, options); + } + } + + writer.WriteEndObject(); + } + + /// + /// To convert a JSON string into an object + /// + /// JSON reader + /// Object type to convert + /// Serializer options + /// The object converted from the JSON string + public override CompareBulkRatesRequestBody Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + if (reader.TokenType == JsonTokenType.Null) + { + return null; + } + + var jsonDoc = JsonDocument.ParseValue(ref reader); + CompareBulkRatesRequestBody newCompareBulkRatesRequestBody = null; + + int match = 0; + var matchedTypes = new List(); + + try + { + newCompareBulkRatesRequestBody = new CompareBulkRatesRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("RateRequestByShipmentIds"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into RateRequestByShipmentIds: {1}", jsonDoc, exception.ToString())); + } + + try + { + newCompareBulkRatesRequestBody = new CompareBulkRatesRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("RateRequestByShipments"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into RateRequestByShipments: {1}", jsonDoc, exception.ToString())); + } + + if (match == 0) + { + throw new InvalidDataException("The JSON string `" + jsonDoc + "` cannot be deserialized into any schema defined."); + } + + if (match > 1) + { + throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); + } + + newCompareBulkRatesRequestBody.RateOptions = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("rate_options"), DeserializingOptions); + + // deserialization is considered successful at this point if no exception has been thrown. + return newCompareBulkRatesRequestBody; + } + + /// + /// Check if the object can be converted + /// + /// Object type + /// True if the object can be converted + public override bool CanConvert(Type objectType) + { + return typeof(CompareBulkRatesRequestBody).IsAssignableFrom(objectType); + } +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs b/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs new file mode 100644 index 00000000..d7109fa1 --- /dev/null +++ b/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs @@ -0,0 +1,83 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An Access Worldwide account information request body +/// +public partial class ConnectAccessWorldwideRequestBody +{ + + /// + /// The nickname associated with the carrier connection + /// + /// The nickname associated with the carrier connection + /// + /// Stamps.com + /// + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// Access Worldwide Username + /// + /// Access Worldwide Username + [JsonPropertyName("username")] + [JsonRequired] + public string Username { get; set; } + + /// + /// Access Worldwide Password + /// + /// Access Worldwide Password + [JsonPropertyName("password")] + [JsonRequired] + public string Password { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectAccessWorldwideRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" Username: ").Append(Username).Append("\n"); + sb.Append(" Password: ").Append(Password).Append("\n"); + 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/ConnectAmazonBuyShippingRequestBody.cs b/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs new file mode 100644 index 00000000..e452c93b --- /dev/null +++ b/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs @@ -0,0 +1,93 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An Amazon account information request body +/// +public partial class ConnectAmazonBuyShippingRequestBody +{ + + /// + /// Nickname to be associated with the account connection + /// + /// Nickname to be associated with the account connection + /// + /// Test Amazon Buy Shipping + /// + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// Gets or Sets MerchantSellerId + /// + [JsonPropertyName("merchant_seller_id")] + [JsonRequired] + public string MerchantSellerId { get; set; } + + /// + /// Gets or Sets MwsAuthToken + /// + [JsonPropertyName("mws_auth_token")] + [JsonRequired] + public string MwsAuthToken { get; set; } + + /// + /// An email address. + /// + /// An email address. + /// + /// john.doe@example.com + /// + [JsonPropertyName("email")] + [JsonRequired] + public string Email { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectAmazonBuyShippingRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" MerchantSellerId: ").Append(MerchantSellerId).Append("\n"); + sb.Append(" MwsAuthToken: ").Append(MwsAuthToken).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + 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/ConnectAmazonShippingUk.cs b/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs new file mode 100644 index 00000000..04879a9f --- /dev/null +++ b/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs @@ -0,0 +1,74 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An Amazon Shipping UK account information request body +/// +public partial class ConnectAmazonShippingUk +{ + + /// + /// The nickname associated with the carrier connection + /// + /// The nickname associated with the carrier connection + /// + /// Stamps.com + /// + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// Amazon UK Shipping auth code. + /// + /// Amazon UK Shipping auth code. + [JsonPropertyName("auth_code")] + [JsonRequired] + public string AuthCode { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectAmazonShippingUk {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" AuthCode: ").Append(AuthCode).Append("\n"); + 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/ConnectApcRequestBody.cs b/ShipEngineSDK/Model/ConnectApcRequestBody.cs new file mode 100644 index 00000000..71eef843 --- /dev/null +++ b/ShipEngineSDK/Model/ConnectApcRequestBody.cs @@ -0,0 +1,89 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An APC account information request body +/// +public partial class ConnectApcRequestBody +{ + + /// + /// The nickname for the APC account + /// + /// The nickname for the APC account + /// + /// APC carrier account + /// + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// The username for the APC account + /// + /// The username for the APC account + /// + /// john_doe + /// + [JsonPropertyName("username")] + [JsonRequired] + public string Username { get; set; } + + /// + /// The password for the APC account + /// + /// The password for the APC account + /// + /// 12345 + /// + [JsonPropertyName("password")] + [JsonRequired] + public string Password { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectApcRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" Username: ").Append(Username).Append("\n"); + sb.Append(" Password: ").Append(Password).Append("\n"); + 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/ConnectAsendiaRequestBody.cs b/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs new file mode 100644 index 00000000..d53c35a6 --- /dev/null +++ b/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs @@ -0,0 +1,92 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An Asendia account information request body +/// +public partial class ConnectAsendiaRequestBody +{ + + /// + /// The nickname of the Asendia account + /// + /// The nickname of the Asendia account + /// + /// Asendia account + /// + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// Asendia account number + /// + /// Asendia account number + [JsonPropertyName("account_number")] + [JsonRequired] + public string AccountNumber { get; set; } + + /// + /// FTP username + /// + /// FTP username + [JsonPropertyName("ftp_username")] + [JsonRequired] + public string FtpUsername { get; set; } + + /// + /// FTP password + /// + /// FTP password + [JsonPropertyName("ftp_password")] + [JsonRequired] + public string FtpPassword { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectAsendiaRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" FtpUsername: ").Append(FtpUsername).Append("\n"); + sb.Append(" FtpPassword: ").Append(FtpPassword).Append("\n"); + 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/ConnectAustraliaPostRequestBody.cs b/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs new file mode 100644 index 00000000..d82798e8 --- /dev/null +++ b/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs @@ -0,0 +1,89 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An Australia Post account information request body +/// +public partial class ConnectAustraliaPostRequestBody +{ + + /// + /// Account number + /// + /// Account number + [JsonPropertyName("account_number")] + [JsonRequired] + public string AccountNumber { get; set; } + + /// + /// API key + /// + /// API key + [JsonPropertyName("api_key")] + [JsonRequired] + public string ApiKey { get; set; } + + /// + /// API secret + /// + /// API secret + [JsonPropertyName("api_secret")] + [JsonRequired] + public string ApiSecret { get; set; } + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectAustraliaPostRequestBody {\n"); + sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" ApiKey: ").Append(ApiKey).Append("\n"); + sb.Append(" ApiSecret: ").Append(ApiSecret).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + 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/ConnectCanadaPostRequestBody.cs b/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs new file mode 100644 index 00000000..3dfa58fe --- /dev/null +++ b/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs @@ -0,0 +1,98 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 Canada Post account information request body +/// +public partial class ConnectCanadaPostRequestBody +{ + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// Canada Post Account API Key + /// + /// Canada Post Account API Key + [JsonPropertyName("api_key")] + [JsonRequired] + public string ApiKey { get; set; } + + /// + /// Canada Post Account API Secret + /// + /// Canada Post Account API Secret + [JsonPropertyName("api_secret")] + [JsonRequired] + public string ApiSecret { get; set; } + + /// + /// Canada Post Account Number + /// + /// Canada Post Account Number + [JsonPropertyName("account_number")] + [JsonRequired] + public string AccountNumber { get; set; } + + /// + /// Canada Post Account Contract ID + /// + /// Canada Post Account Contract ID + [JsonPropertyName("contract_id")] + [JsonRequired] + public string ContractId { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectCanadaPostRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" ApiKey: ").Append(ApiKey).Append("\n"); + sb.Append(" ApiSecret: ").Append(ApiSecret).Append("\n"); + sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" ContractId: ").Append(ContractId).Append("\n"); + 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/ConnectCarrierRequestBody.cs b/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs new file mode 100644 index 00000000..2c7822ce --- /dev/null +++ b/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs @@ -0,0 +1,1276 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.IO; +using System.Linq; +using System.Reflection; +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; + +/// +/// ConnectCarrierRequestBody +/// +[JsonConverter(typeof(ConnectCarrierRequestBodyJsonConverter))] +//[DataContract(Name = "connect_carrier_request_body")] +public partial class ConnectCarrierRequestBody : AbstractOpenAPISchema +{ + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectAccessWorldwideRequestBody. + public ConnectCarrierRequestBody(ConnectAccessWorldwideRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectAmazonBuyShippingRequestBody. + public ConnectCarrierRequestBody(ConnectAmazonBuyShippingRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectAmazonShippingUk. + public ConnectCarrierRequestBody(ConnectAmazonShippingUk actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectApcRequestBody. + public ConnectCarrierRequestBody(ConnectApcRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectAsendiaRequestBody. + public ConnectCarrierRequestBody(ConnectAsendiaRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectAustraliaPostRequestBody. + public ConnectCarrierRequestBody(ConnectAustraliaPostRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectCanadaPostRequestBody. + public ConnectCarrierRequestBody(ConnectCanadaPostRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectDhlEcommerceRequestBody. + public ConnectCarrierRequestBody(ConnectDhlEcommerceRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectDhlExpressRequestBody. + public ConnectCarrierRequestBody(ConnectDhlExpressRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectDhlExpressAuRequestBody. + public ConnectCarrierRequestBody(ConnectDhlExpressAuRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectDhlExpressCaRequestBody. + public ConnectCarrierRequestBody(ConnectDhlExpressCaRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectDhlExpressUkRequestBody. + public ConnectCarrierRequestBody(ConnectDhlExpressUkRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectDpdRequestBody. + public ConnectCarrierRequestBody(ConnectDpdRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectEndiciaRequestBody. + public ConnectCarrierRequestBody(ConnectEndiciaRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectFedexRequestBody. + public ConnectCarrierRequestBody(ConnectFedexRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectFedexUkRequestBody. + public ConnectCarrierRequestBody(ConnectFedexUkRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectFirstmileRequestBody. + public ConnectCarrierRequestBody(ConnectFirstmileRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectImexRequestBody. + public ConnectCarrierRequestBody(ConnectImexRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectLasershipRequestBody. + public ConnectCarrierRequestBody(ConnectLasershipRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectNewgisticsRequestBody. + public ConnectCarrierRequestBody(ConnectNewgisticsRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectOntracRequestBody. + public ConnectCarrierRequestBody(ConnectOntracRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectPurolatorRequestBody. + public ConnectCarrierRequestBody(ConnectPurolatorRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectRoyalMailRequestBody. + public ConnectCarrierRequestBody(ConnectRoyalMailRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectRrDonnelleyRequestBody. + public ConnectCarrierRequestBody(ConnectRrDonnelleyRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectSekoRequestBody. + public ConnectCarrierRequestBody(ConnectSekoRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectSendleRequestBody. + public ConnectCarrierRequestBody(ConnectSendleRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectStampsRequestBody. + public ConnectCarrierRequestBody(ConnectStampsRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of ConnectUpsRequestBody. + public ConnectCarrierRequestBody(ConnectUpsRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + + private Object _actualInstance; + + /// + /// Gets or Sets ActualInstance + /// + public override Object ActualInstance + { + get + { + return _actualInstance; + } + set + { + if (value.GetType() == typeof(ConnectAccessWorldwideRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectAmazonBuyShippingRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectAmazonShippingUk)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectApcRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectAsendiaRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectAustraliaPostRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectCanadaPostRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectDhlEcommerceRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectDhlExpressRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectDhlExpressAuRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectDhlExpressCaRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectDhlExpressUkRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectDpdRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectEndiciaRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectFedexRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectFedexUkRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectFirstmileRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectImexRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectLasershipRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectNewgisticsRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectOntracRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectPurolatorRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectRoyalMailRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectRrDonnelleyRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectSekoRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectSendleRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectStampsRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(ConnectUpsRequestBody)) + { + this._actualInstance = value; + } + else + { + throw new ArgumentException("Invalid instance found. Must be the following types: ConnectAccessWorldwideRequestBody, ConnectAmazonBuyShippingRequestBody, ConnectAmazonShippingUk, ConnectApcRequestBody, ConnectAsendiaRequestBody, ConnectAustraliaPostRequestBody, ConnectCanadaPostRequestBody, ConnectDhlEcommerceRequestBody, ConnectDhlExpressRequestBody, ConnectDhlExpressAuRequestBody, ConnectDhlExpressCaRequestBody, ConnectDhlExpressUkRequestBody, ConnectDpdRequestBody, ConnectEndiciaRequestBody, ConnectFedexRequestBody, ConnectFedexUkRequestBody, ConnectFirstmileRequestBody, ConnectImexRequestBody, ConnectLasershipRequestBody, ConnectNewgisticsRequestBody, ConnectOntracRequestBody, ConnectPurolatorRequestBody, ConnectRoyalMailRequestBody, ConnectRrDonnelleyRequestBody, ConnectSekoRequestBody, ConnectSendleRequestBody, ConnectStampsRequestBody, ConnectUpsRequestBody"); + } + } + } + + /// + /// Get the actual instance of `ConnectAccessWorldwideRequestBody`. If the actual instance is not `ConnectAccessWorldwideRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectAccessWorldwideRequestBody + public ConnectAccessWorldwideRequestBody GetConnectAccessWorldwideRequestBody() + { + return (ConnectAccessWorldwideRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectAmazonBuyShippingRequestBody`. If the actual instance is not `ConnectAmazonBuyShippingRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectAmazonBuyShippingRequestBody + public ConnectAmazonBuyShippingRequestBody GetConnectAmazonBuyShippingRequestBody() + { + return (ConnectAmazonBuyShippingRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectAmazonShippingUk`. If the actual instance is not `ConnectAmazonShippingUk`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectAmazonShippingUk + public ConnectAmazonShippingUk GetConnectAmazonShippingUk() + { + return (ConnectAmazonShippingUk)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectApcRequestBody`. If the actual instance is not `ConnectApcRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectApcRequestBody + public ConnectApcRequestBody GetConnectApcRequestBody() + { + return (ConnectApcRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectAsendiaRequestBody`. If the actual instance is not `ConnectAsendiaRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectAsendiaRequestBody + public ConnectAsendiaRequestBody GetConnectAsendiaRequestBody() + { + return (ConnectAsendiaRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectAustraliaPostRequestBody`. If the actual instance is not `ConnectAustraliaPostRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectAustraliaPostRequestBody + public ConnectAustraliaPostRequestBody GetConnectAustraliaPostRequestBody() + { + return (ConnectAustraliaPostRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectCanadaPostRequestBody`. If the actual instance is not `ConnectCanadaPostRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectCanadaPostRequestBody + public ConnectCanadaPostRequestBody GetConnectCanadaPostRequestBody() + { + return (ConnectCanadaPostRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectDhlEcommerceRequestBody`. If the actual instance is not `ConnectDhlEcommerceRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectDhlEcommerceRequestBody + public ConnectDhlEcommerceRequestBody GetConnectDhlEcommerceRequestBody() + { + return (ConnectDhlEcommerceRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectDhlExpressRequestBody`. If the actual instance is not `ConnectDhlExpressRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectDhlExpressRequestBody + public ConnectDhlExpressRequestBody GetConnectDhlExpressRequestBody() + { + return (ConnectDhlExpressRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectDhlExpressAuRequestBody`. If the actual instance is not `ConnectDhlExpressAuRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectDhlExpressAuRequestBody + public ConnectDhlExpressAuRequestBody GetConnectDhlExpressAuRequestBody() + { + return (ConnectDhlExpressAuRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectDhlExpressCaRequestBody`. If the actual instance is not `ConnectDhlExpressCaRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectDhlExpressCaRequestBody + public ConnectDhlExpressCaRequestBody GetConnectDhlExpressCaRequestBody() + { + return (ConnectDhlExpressCaRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectDhlExpressUkRequestBody`. If the actual instance is not `ConnectDhlExpressUkRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectDhlExpressUkRequestBody + public ConnectDhlExpressUkRequestBody GetConnectDhlExpressUkRequestBody() + { + return (ConnectDhlExpressUkRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectDpdRequestBody`. If the actual instance is not `ConnectDpdRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectDpdRequestBody + public ConnectDpdRequestBody GetConnectDpdRequestBody() + { + return (ConnectDpdRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectEndiciaRequestBody`. If the actual instance is not `ConnectEndiciaRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectEndiciaRequestBody + public ConnectEndiciaRequestBody GetConnectEndiciaRequestBody() + { + return (ConnectEndiciaRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectFedexRequestBody`. If the actual instance is not `ConnectFedexRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectFedexRequestBody + public ConnectFedexRequestBody GetConnectFedexRequestBody() + { + return (ConnectFedexRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectFedexUkRequestBody`. If the actual instance is not `ConnectFedexUkRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectFedexUkRequestBody + public ConnectFedexUkRequestBody GetConnectFedexUkRequestBody() + { + return (ConnectFedexUkRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectFirstmileRequestBody`. If the actual instance is not `ConnectFirstmileRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectFirstmileRequestBody + public ConnectFirstmileRequestBody GetConnectFirstmileRequestBody() + { + return (ConnectFirstmileRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectImexRequestBody`. If the actual instance is not `ConnectImexRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectImexRequestBody + public ConnectImexRequestBody GetConnectImexRequestBody() + { + return (ConnectImexRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectLasershipRequestBody`. If the actual instance is not `ConnectLasershipRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectLasershipRequestBody + public ConnectLasershipRequestBody GetConnectLasershipRequestBody() + { + return (ConnectLasershipRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectNewgisticsRequestBody`. If the actual instance is not `ConnectNewgisticsRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectNewgisticsRequestBody + public ConnectNewgisticsRequestBody GetConnectNewgisticsRequestBody() + { + return (ConnectNewgisticsRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectOntracRequestBody`. If the actual instance is not `ConnectOntracRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectOntracRequestBody + public ConnectOntracRequestBody GetConnectOntracRequestBody() + { + return (ConnectOntracRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectPurolatorRequestBody`. If the actual instance is not `ConnectPurolatorRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectPurolatorRequestBody + public ConnectPurolatorRequestBody GetConnectPurolatorRequestBody() + { + return (ConnectPurolatorRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectRoyalMailRequestBody`. If the actual instance is not `ConnectRoyalMailRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectRoyalMailRequestBody + public ConnectRoyalMailRequestBody GetConnectRoyalMailRequestBody() + { + return (ConnectRoyalMailRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectRrDonnelleyRequestBody`. If the actual instance is not `ConnectRrDonnelleyRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectRrDonnelleyRequestBody + public ConnectRrDonnelleyRequestBody GetConnectRrDonnelleyRequestBody() + { + return (ConnectRrDonnelleyRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectSekoRequestBody`. If the actual instance is not `ConnectSekoRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectSekoRequestBody + public ConnectSekoRequestBody GetConnectSekoRequestBody() + { + return (ConnectSekoRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectSendleRequestBody`. If the actual instance is not `ConnectSendleRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectSendleRequestBody + public ConnectSendleRequestBody GetConnectSendleRequestBody() + { + return (ConnectSendleRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectStampsRequestBody`. If the actual instance is not `ConnectStampsRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectStampsRequestBody + public ConnectStampsRequestBody GetConnectStampsRequestBody() + { + return (ConnectStampsRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `ConnectUpsRequestBody`. If the actual instance is not `ConnectUpsRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of ConnectUpsRequestBody + public ConnectUpsRequestBody GetConnectUpsRequestBody() + { + return (ConnectUpsRequestBody)this.ActualInstance; + } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class ConnectCarrierRequestBody {\n"); + sb.Append(" ActualInstance: ").Append(this.ActualInstance).Append("\n"); + + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public override string ToJson() + { + return JsonSerializer.Serialize(this.ActualInstance, ConnectCarrierRequestBody.SerializerSettings); + } + +} + +/// +/// Custom JSON converter for ConnectCarrierRequestBody +/// +public class ConnectCarrierRequestBodyJsonConverter : JsonConverter +{ + private static HashSet OneOfTypes = [typeof(ConnectAccessWorldwideRequestBody), typeof(ConnectAmazonBuyShippingRequestBody), typeof(ConnectAmazonShippingUk), typeof(ConnectApcRequestBody), typeof(ConnectAsendiaRequestBody), typeof(ConnectAustraliaPostRequestBody), typeof(ConnectCanadaPostRequestBody), typeof(ConnectDhlEcommerceRequestBody), typeof(ConnectDhlExpressRequestBody), typeof(ConnectDhlExpressAuRequestBody), typeof(ConnectDhlExpressCaRequestBody), typeof(ConnectDhlExpressUkRequestBody), typeof(ConnectDpdRequestBody), typeof(ConnectEndiciaRequestBody), typeof(ConnectFedexRequestBody), typeof(ConnectFedexUkRequestBody), typeof(ConnectFirstmileRequestBody), typeof(ConnectImexRequestBody), typeof(ConnectLasershipRequestBody), typeof(ConnectNewgisticsRequestBody), typeof(ConnectOntracRequestBody), typeof(ConnectPurolatorRequestBody), typeof(ConnectRoyalMailRequestBody), typeof(ConnectRrDonnelleyRequestBody), typeof(ConnectSekoRequestBody), typeof(ConnectSendleRequestBody), typeof(ConnectStampsRequestBody), typeof(ConnectUpsRequestBody)]; + private static HashSet MandatoryFields = ["AccessKey", "Account", "AccountNumber", "ActivationKey", "Address", "Address1", "AgreeToEula", "ApiKey", "ApiSecret", "AuthCode", "City", "ClientId", "ContactName", "ContractId", "CountryCode", "CustomerBranch", "DistributionCenter", "Email", "FirstName", "FtpPassword", "FtpUsername", "InductionSite", "LasershipCriticalEntryTime", "LasershipCriticalPullTime", "LastName", "MailerId", "MerchantSellerId", "MwsAuthToken", "Nickname", "Passphrase", "Password", "Phone", "PickupNumber", "PostalCode", "SendleId", "SiteId", "State", "Username", "WebServicesId", "WebServicesKey"]; + private static JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) + { + TypeInfoResolver = new DefaultJsonTypeInfoResolver + { + Modifiers = + { + static typeInfo => + { + if (typeInfo.Kind != JsonTypeInfoKind.Object) + return; + + foreach (JsonPropertyInfo propertyInfo in typeInfo.Properties) + { + // Strip IsRequired constraint from every property except those which define the underlying type + if (OneOfTypes.Contains(typeInfo.Type)) + { + var underlyingPropertyName = (propertyInfo.AttributeProvider as MemberInfo)?.Name; + propertyInfo.IsRequired = underlyingPropertyName != null && MandatoryFields.Contains(underlyingPropertyName); + } + else + { + propertyInfo.IsRequired = false; + } + } + } + } + } + }; + + /// + /// To write the JSON string + /// + /// JSON writer + /// Object to be converted into a JSON string + /// Serializer options + public override void Write(Utf8JsonWriter writer, ConnectCarrierRequestBody value, JsonSerializerOptions options) + { + writer.WriteStartObject(); + + + var node = JsonSerializer.SerializeToNode(value.ActualInstance, options); + foreach (var prop in node?.AsObject() ?? []) + { + if (prop.Value != null) + { + writer.WritePropertyName(prop.Key); + prop.Value.WriteTo(writer, options); + } + } + + writer.WriteEndObject(); + } + + /// + /// To convert a JSON string into an object + /// + /// JSON reader + /// Object type to convert + /// Serializer options + /// The object converted from the JSON string + public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + if (reader.TokenType == JsonTokenType.Null) + { + return null; + } + + var jsonDoc = JsonDocument.ParseValue(ref reader); + ConnectCarrierRequestBody newConnectCarrierRequestBody = null; + + int match = 0; + var matchedTypes = new List(); + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectAccessWorldwideRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectAccessWorldwideRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectAmazonBuyShippingRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectAmazonBuyShippingRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectAmazonShippingUk"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectAmazonShippingUk: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectApcRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectApcRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectAsendiaRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectAsendiaRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectAustraliaPostRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectAustraliaPostRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectCanadaPostRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectCanadaPostRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectDhlEcommerceRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectDhlEcommerceRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectDhlExpressRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectDhlExpressRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectDhlExpressAuRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectDhlExpressAuRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectDhlExpressCaRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectDhlExpressCaRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectDhlExpressUkRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectDhlExpressUkRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectDpdRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectDpdRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectEndiciaRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectEndiciaRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectFedexRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectFedexRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectFedexUkRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectFedexUkRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectFirstmileRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectFirstmileRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectImexRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectImexRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectLasershipRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectLasershipRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectNewgisticsRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectNewgisticsRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectOntracRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectOntracRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectPurolatorRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectPurolatorRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectRoyalMailRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectRoyalMailRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectRrDonnelleyRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectRrDonnelleyRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectSekoRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectSekoRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectSendleRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectSendleRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectStampsRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectStampsRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("ConnectUpsRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectUpsRequestBody: {1}", jsonDoc, exception.ToString())); + } + + if (match == 0) + { + throw new InvalidDataException("The JSON string `" + jsonDoc + "` cannot be deserialized into any schema defined."); + } + + if (match > 1) + { + throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); + } + + + // deserialization is considered successful at this point if no exception has been thrown. + return newConnectCarrierRequestBody; + } + + /// + /// Check if the object can be converted + /// + /// Object type + /// True if the object can be converted + public override bool CanConvert(Type objectType) + { + return typeof(ConnectCarrierRequestBody).IsAssignableFrom(objectType); + } +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs b/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs new file mode 100644 index 00000000..969f66e6 --- /dev/null +++ b/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs @@ -0,0 +1,65 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 connect account response body +/// +public partial class ConnectCarrierResponseBody +{ + + /// + /// A string that uniquely identifies the carrier + /// + /// A string that uniquely identifies the carrier + /// + /// se-28529731 + /// + [JsonPropertyName("carrier_id")] + [JsonRequired] + public string CarrierId { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectCarrierResponseBody {\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); + 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/ConnectDhlEcommerceRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs new file mode 100644 index 00000000..917dea6e --- /dev/null +++ b/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs @@ -0,0 +1,178 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 DHL Ecommerce account information request body +/// +public partial class ConnectDhlEcommerceRequestBody +{ + + /// + /// Gets or Sets AncillaryEndorsement CLOVUS + /// + [JsonPropertyName("ancillary_endorsement")] + public AncillaryServiceEndorsement? AncillaryEndorsement { get; set; } + /// + /// A nickname to help you identify this account + /// + /// A nickname to help you identify this account + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// The client id + /// + /// The client id + [JsonPropertyName("client_id")] + [JsonRequired] + public string ClientId { get; set; } + + /// + /// The account username + /// + /// The account username + [JsonPropertyName("username")] + [JsonRequired] + public string Username { get; set; } + + /// + /// The account password + /// + /// The account password + [JsonPropertyName("password")] + [JsonRequired] + public string Password { get; set; } + + /// + /// The pickup number + /// + /// The pickup number + [JsonPropertyName("pickup_number")] + [JsonRequired] + public string PickupNumber { get; set; } + + /// + /// The distribution center + /// + /// The distribution center + [JsonPropertyName("distribution_center")] + [JsonRequired] + public string DistributionCenter { get; set; } + + /// + /// The DHL E-Commerce API key. This field is optional, but if not set you will not be able to get rates for this account. + /// + /// The DHL E-Commerce API key. This field is optional, but if not set you will not be able to get rates for this account. + [JsonPropertyName("api_key")] + public string ApiKey { get; set; } + + /// + /// The DHL E-Commerce API secret. This field is optional, but if not set you will not be able to get rates for this account. + /// + /// The DHL E-Commerce API secret. This field is optional, but if not set you will not be able to get rates for this account. + [JsonPropertyName("api_secret")] + public string ApiSecret { get; set; } + + /// + /// Account number + /// + /// Account number + [JsonPropertyName("account_number")] + [Obsolete] + public string AccountNumber { get; set; } + + /// + /// FTP username + /// + /// FTP username + [JsonPropertyName("ftp_username")] + [Obsolete] + public string FtpUsername { get; set; } + + /// + /// FTP password + /// + /// FTP password + [JsonPropertyName("ftp_password")] + [Obsolete] + public string FtpPassword { get; set; } + + /// + /// Sold To field + /// + /// Sold To field + [JsonPropertyName("sold_to")] + public string SoldTo { get; set; } + + /// + /// Gets or Sets RegistrationId + /// + [JsonPropertyName("registration_id")] + public string RegistrationId { get; set; } + + /// + /// Gets or Sets SoftwareName + /// + [JsonPropertyName("software_name")] + public string SoftwareName { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectDhlEcommerceRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" ClientId: ").Append(ClientId).Append("\n"); + sb.Append(" Username: ").Append(Username).Append("\n"); + sb.Append(" Password: ").Append(Password).Append("\n"); + sb.Append(" PickupNumber: ").Append(PickupNumber).Append("\n"); + sb.Append(" DistributionCenter: ").Append(DistributionCenter).Append("\n"); + sb.Append(" ApiKey: ").Append(ApiKey).Append("\n"); + sb.Append(" ApiSecret: ").Append(ApiSecret).Append("\n"); + sb.Append(" AncillaryEndorsement: ").Append(AncillaryEndorsement).Append("\n"); + sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" FtpUsername: ").Append(FtpUsername).Append("\n"); + sb.Append(" FtpPassword: ").Append(FtpPassword).Append("\n"); + sb.Append(" SoldTo: ").Append(SoldTo).Append("\n"); + sb.Append(" RegistrationId: ").Append(RegistrationId).Append("\n"); + sb.Append(" SoftwareName: ").Append(SoftwareName).Append("\n"); + 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/ConnectDhlExpressAuRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs new file mode 100644 index 00000000..a5317c02 --- /dev/null +++ b/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs @@ -0,0 +1,71 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 DHL Express AU account information request body +/// +public partial class ConnectDhlExpressAuRequestBody +{ + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// Account number + /// + /// Account number + [JsonPropertyName("account_number")] + [JsonRequired] + public string AccountNumber { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectDhlExpressAuRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + 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/ConnectDhlExpressCaRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs new file mode 100644 index 00000000..5a09aee5 --- /dev/null +++ b/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs @@ -0,0 +1,71 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 DHL Express CA account information request body +/// +public partial class ConnectDhlExpressCaRequestBody +{ + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// Account number + /// + /// Account number + [JsonPropertyName("account_number")] + [JsonRequired] + public string AccountNumber { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectDhlExpressCaRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + 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/ConnectDhlExpressRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs new file mode 100644 index 00000000..2519b0ec --- /dev/null +++ b/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs @@ -0,0 +1,98 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 DHL express account information request body +/// +public partial class ConnectDhlExpressRequestBody +{ + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// Account number + /// + /// Account number + [JsonPropertyName("account_number")] + [JsonRequired] + public string AccountNumber { get; set; } + + /// + /// Required if password is provided + /// + /// Required if password is provided + [JsonPropertyName("site_id")] + public string SiteId { get; set; } + + /// + /// Required if site id is provided + /// + /// Required if site id is provided + [JsonPropertyName("password")] + public string Password { get; set; } + + /// + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// CA + /// + [JsonPropertyName("country_code")] + public string CountryCode { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectDhlExpressRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" SiteId: ").Append(SiteId).Append("\n"); + sb.Append(" Password: ").Append(Password).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); + 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/ConnectDhlExpressUkRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs new file mode 100644 index 00000000..952f9674 --- /dev/null +++ b/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs @@ -0,0 +1,92 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 DHL Express UK account information request body +/// +public partial class ConnectDhlExpressUkRequestBody +{ + + /// + /// Account number + /// + /// Account number + [JsonPropertyName("account_number")] + [JsonRequired] + public string AccountNumber { get; set; } + + /// + /// A string that uniquely identifies the site + /// + /// A string that uniquely identifies the site + /// + /// se-28529731 + /// + [JsonPropertyName("site_id")] + [JsonRequired] + public string SiteId { get; set; } + + /// + /// Password + /// + /// Password + [JsonPropertyName("password")] + [JsonRequired] + public string Password { get; set; } + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectDhlExpressUkRequestBody {\n"); + sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" SiteId: ").Append(SiteId).Append("\n"); + sb.Append(" Password: ").Append(Password).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + 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/ConnectDpdRequestBody.cs b/ShipEngineSDK/Model/ConnectDpdRequestBody.cs new file mode 100644 index 00000000..ed9b15a1 --- /dev/null +++ b/ShipEngineSDK/Model/ConnectDpdRequestBody.cs @@ -0,0 +1,80 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 DPD account information request body +/// +public partial class ConnectDpdRequestBody +{ + + /// + /// Account number + /// + /// Account number + [JsonPropertyName("account_number")] + [JsonRequired] + public string AccountNumber { get; set; } + + /// + /// Password + /// + /// Password + [JsonPropertyName("password")] + [JsonRequired] + public string Password { get; set; } + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectDpdRequestBody {\n"); + sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" Password: ").Append(Password).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + 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/ConnectEndiciaRequestBody.cs b/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs new file mode 100644 index 00000000..8c2ab8ce --- /dev/null +++ b/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs @@ -0,0 +1,80 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An Endicia account information request body +/// +public partial class ConnectEndiciaRequestBody +{ + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// Account + /// + /// Account + [JsonPropertyName("account")] + [JsonRequired] + public string Account { get; set; } + + /// + /// Passphrase + /// + /// Passphrase + [JsonPropertyName("passphrase")] + [JsonRequired] + public string Passphrase { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectEndiciaRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" Account: ").Append(Account).Append("\n"); + sb.Append(" Passphrase: ").Append(Passphrase).Append("\n"); + 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/ConnectFedexRequestBody.cs b/ShipEngineSDK/Model/ConnectFedexRequestBody.cs new file mode 100644 index 00000000..386b69db --- /dev/null +++ b/ShipEngineSDK/Model/ConnectFedexRequestBody.cs @@ -0,0 +1,188 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 Fedex account information request body +/// +public partial class ConnectFedexRequestBody +{ + + /// + /// Account number + /// + /// Account number + [JsonPropertyName("account_number")] + [JsonRequired] + public string AccountNumber { get; set; } + + /// + /// Address + /// + /// Address + [JsonPropertyName("address1")] + [JsonRequired] + public string Address1 { get; set; } + + /// + /// Address + /// + /// Address + [JsonPropertyName("address2")] + public string Address2 { get; set; } + + /// + /// The city + /// + /// The city + [JsonPropertyName("city")] + [JsonRequired] + public string City { get; set; } + + /// + /// The company + /// + /// The company + [JsonPropertyName("company")] + public string Company { get; set; } + + /// + /// Country code + /// + /// Country code + [JsonPropertyName("country_code")] + [JsonRequired] + public string CountryCode { get; set; } + + /// + /// The email address + /// + /// The email address + /// + /// john.doe@example.com + /// + [JsonPropertyName("email")] + [JsonRequired] + public string Email { get; set; } + + /// + /// First name + /// + /// First name + [JsonPropertyName("first_name")] + [JsonRequired] + public string FirstName { get; set; } + + /// + /// Last name + /// + /// Last name + [JsonPropertyName("last_name")] + [JsonRequired] + public string LastName { get; set; } + + /// + /// Phone number + /// + /// Phone number + [JsonPropertyName("phone")] + [JsonRequired] + public string Phone { get; set; } + + /// + /// Postal Code + /// + /// Postal Code + [JsonPropertyName("postal_code")] + [JsonRequired] + public string PostalCode { get; set; } + + /// + /// State + /// + /// State + [JsonPropertyName("state")] + [JsonRequired] + public string State { get; set; } + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// Boolean signaling agreement to the Fedex End User License Agreement + /// + /// Boolean signaling agreement to the Fedex End User License Agreement + [JsonPropertyName("agree_to_eula")] + [JsonRequired] + public bool AgreeToEula { get; set; } + + /// + /// Meter number + /// + /// Meter number + [JsonPropertyName("meter_number")] + public string MeterNumber { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectFedexRequestBody {\n"); + sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" Address1: ").Append(Address1).Append("\n"); + sb.Append(" Address2: ").Append(Address2).Append("\n"); + sb.Append(" City: ").Append(City).Append("\n"); + sb.Append(" Company: ").Append(Company).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" FirstName: ").Append(FirstName).Append("\n"); + sb.Append(" LastName: ").Append(LastName).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" State: ").Append(State).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" AgreeToEula: ").Append(AgreeToEula).Append("\n"); + sb.Append(" MeterNumber: ").Append(MeterNumber).Append("\n"); + 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/ConnectFedexUkRequestBody.cs b/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs new file mode 100644 index 00000000..b2921853 --- /dev/null +++ b/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs @@ -0,0 +1,188 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 Fedex UK account information request body +/// +public partial class ConnectFedexUkRequestBody +{ + + /// + /// Account number + /// + /// Account number + [JsonPropertyName("account_number")] + [JsonRequired] + public string AccountNumber { get; set; } + + /// + /// Address + /// + /// Address + [JsonPropertyName("address1")] + [JsonRequired] + public string Address1 { get; set; } + + /// + /// Address + /// + /// Address + [JsonPropertyName("address2")] + public string Address2 { get; set; } + + /// + /// The city + /// + /// The city + [JsonPropertyName("city")] + [JsonRequired] + public string City { get; set; } + + /// + /// The company + /// + /// The company + [JsonPropertyName("company")] + public string Company { get; set; } + + /// + /// Country code + /// + /// Country code + [JsonPropertyName("country_code")] + [JsonRequired] + public string CountryCode { get; set; } + + /// + /// The email address + /// + /// The email address + /// + /// john.doe@example.com + /// + [JsonPropertyName("email")] + [JsonRequired] + public string Email { get; set; } + + /// + /// First name + /// + /// First name + [JsonPropertyName("first_name")] + [JsonRequired] + public string FirstName { get; set; } + + /// + /// Last name + /// + /// Last name + [JsonPropertyName("last_name")] + [JsonRequired] + public string LastName { get; set; } + + /// + /// Phone number + /// + /// Phone number + [JsonPropertyName("phone")] + [JsonRequired] + public string Phone { get; set; } + + /// + /// Postal Code + /// + /// Postal Code + [JsonPropertyName("postal_code")] + [JsonRequired] + public string PostalCode { get; set; } + + /// + /// State + /// + /// State + [JsonPropertyName("state")] + [JsonRequired] + public string State { get; set; } + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// Boolean signaling agreement to the Fedex End User License Agreement + /// + /// Boolean signaling agreement to the Fedex End User License Agreement + [JsonPropertyName("agree_to_eula")] + [JsonRequired] + public bool AgreeToEula { get; set; } + + /// + /// Meter number + /// + /// Meter number + [JsonPropertyName("meter_number")] + public string MeterNumber { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectFedexUkRequestBody {\n"); + sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" Address1: ").Append(Address1).Append("\n"); + sb.Append(" Address2: ").Append(Address2).Append("\n"); + sb.Append(" City: ").Append(City).Append("\n"); + sb.Append(" Company: ").Append(Company).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" FirstName: ").Append(FirstName).Append("\n"); + sb.Append(" LastName: ").Append(LastName).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" State: ").Append(State).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" AgreeToEula: ").Append(AgreeToEula).Append("\n"); + sb.Append(" MeterNumber: ").Append(MeterNumber).Append("\n"); + 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/ConnectFirstmileRequestBody.cs b/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs new file mode 100644 index 00000000..f16eb45b --- /dev/null +++ b/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs @@ -0,0 +1,91 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 First Mile account information request body +/// +public partial class ConnectFirstmileRequestBody +{ + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// A string that uniquely identifies the mailer + /// + /// A string that uniquely identifies the mailer + /// + /// se-28529731 + /// + [JsonPropertyName("mailer_id")] + [JsonRequired] + public string MailerId { get; set; } + + /// + /// Profile name + /// + /// Profile name + [JsonPropertyName("profile_name")] + public string ProfileName { get; set; } + + /// + /// Password + /// + /// Password + [JsonPropertyName("password")] + [JsonRequired] + public string Password { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectFirstmileRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" MailerId: ").Append(MailerId).Append("\n"); + sb.Append(" ProfileName: ").Append(ProfileName).Append("\n"); + sb.Append(" Password: ").Append(Password).Append("\n"); + 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/ConnectImexRequestBody.cs b/ShipEngineSDK/Model/ConnectImexRequestBody.cs new file mode 100644 index 00000000..1d1c1d22 --- /dev/null +++ b/ShipEngineSDK/Model/ConnectImexRequestBody.cs @@ -0,0 +1,80 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An Imex account information request body +/// +public partial class ConnectImexRequestBody +{ + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// Username + /// + /// Username + [JsonPropertyName("username")] + [JsonRequired] + public string Username { get; set; } + + /// + /// Password + /// + /// Password + [JsonPropertyName("password")] + [JsonRequired] + public string Password { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectImexRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" Username: ").Append(Username).Append("\n"); + sb.Append(" Password: ").Append(Password).Append("\n"); + 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/ConnectInsurerRequestBody.cs b/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs new file mode 100644 index 00000000..a00ca969 --- /dev/null +++ b/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs @@ -0,0 +1,73 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 shipsurance connection request body +/// +public partial class ConnectInsurerRequestBody +{ + + /// + /// An email address. + /// + /// An email address. + /// + /// john.doe@example.com + /// + [JsonPropertyName("email")] + [JsonRequired] + public string Email { get; set; } + + /// + /// Gets or Sets PolicyId + /// + [JsonPropertyName("policy_id")] + [JsonRequired] + public string PolicyId { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectInsurerRequestBody {\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" PolicyId: ").Append(PolicyId).Append("\n"); + 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/ConnectLasershipRequestBody.cs b/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs new file mode 100644 index 00000000..0936bf68 --- /dev/null +++ b/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs @@ -0,0 +1,271 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 Lasership account information request body +/// +public partial class ConnectLasershipRequestBody +{ + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// Web Service ID (WSID) + /// + /// Web Service ID (WSID) + [JsonPropertyName("web_services_id")] + [JsonRequired] + public string WebServicesId { get; set; } + + /// + /// Web Service Key (WSKey) + /// + /// Web Service Key (WSKey) + [JsonPropertyName("web_services_key")] + [JsonRequired] + public string WebServicesKey { get; set; } + + /// + /// Customer Branch + /// + /// Customer Branch + [JsonPropertyName("customer_branch")] + [JsonRequired] + public string CustomerBranch { get; set; } + + /// + /// Address + /// + /// Address + [JsonPropertyName("Address")] + [JsonRequired] + public String Address { get; set; } + + /// + /// Address2 + /// + /// Address2 + [JsonPropertyName("Address2")] + public String Address2 { get; set; } + + /// + /// PostalCode + /// + /// PostalCode + [JsonPropertyName("PostalCode")] + [JsonRequired] + public String PostalCode { get; set; } + + /// + /// City + /// + /// City + [JsonPropertyName("City")] + [JsonRequired] + public String City { get; set; } + + /// + /// State + /// + /// State + [JsonPropertyName("State")] + [JsonRequired] + public String State { get; set; } + + /// + /// Country + /// + /// Country + [JsonPropertyName("country")] + public String Country { get; set; } + + /// + /// Phone + /// + /// Phone + [JsonPropertyName("Phone")] + public String Phone { get; set; } + + /// + /// Email + /// + /// Email + [JsonPropertyName("Email")] + public String Email { get; set; } + + /// + /// Instructions + /// + /// Instructions + [JsonPropertyName("instructions")] + public String Instructions { get; set; } + + /// + /// Facility Code + /// + /// Facility Code + [JsonPropertyName("facility_code")] + public String FacilityCode { get; set; } + + /// + /// Critical Pull Time (local time) + /// + /// Critical Pull Time (local time) + [JsonPropertyName("lasership_critical_pull_time")] + [JsonRequired] + public String LasershipCriticalPullTime { get; set; } + + /// + /// Critical Entry Time (local time) + /// + /// Critical Entry Time (local time) + [JsonPropertyName("lasership_critical_entry_time")] + [JsonRequired] + public String LasershipCriticalEntryTime { get; set; } + + /// + /// Declare piece attributes separately for every shipment, overrides individual attribute below. + /// + /// Declare piece attributes separately for every shipment, overrides individual attribute below. + [JsonPropertyName("declare_piece_attributes_separately_for_every_shipment")] + public Boolean DeclarePieceAttributesSeparatelyForEveryShipment { get; set; } + + /// + /// Set this to true if your shipments will always contain Alcohol + /// + /// Set this to true if your shipments will always contain Alcohol + [JsonPropertyName("AttrAlcohol")] + public Boolean AttrAlcohol { get; set; } + + /// + /// Set this to true if your shipments will always contain DryIce + /// + /// Set this to true if your shipments will always contain DryIce + [JsonPropertyName("AttrDryIce")] + public Boolean AttrDryIce { get; set; } + + /// + /// Set this to true if your shipments will always contain Hazmat + /// + /// Set this to true if your shipments will always contain Hazmat + [JsonPropertyName("AttrHazmat")] + public Boolean AttrHazmat { get; set; } + + /// + /// Set this to true if your shipments will always require Two Persons + /// + /// Set this to true if your shipments will always require Two Persons + [JsonPropertyName("AttrTwoPersons")] + public Boolean AttrTwoPersons { get; set; } + + /// + /// Set this to true if your shipments will always contain Explosives + /// + /// Set this to true if your shipments will always contain Explosives + [JsonPropertyName("AttrExplosive")] + public Boolean AttrExplosive { get; set; } + + /// + /// Set this to true if your shipments will always contain Controlled Substances + /// + /// Set this to true if your shipments will always contain Controlled Substances + [JsonPropertyName("AttrControlledSubstance")] + public Boolean AttrControlledSubstance { get; set; } + + /// + /// Set this to true if your shipments will always require Refrigeration + /// + /// Set this to true if your shipments will always require Refrigeration + [JsonPropertyName("AttrRefrigerated")] + public Boolean AttrRefrigerated { get; set; } + + /// + /// Set this to true if your shipments will always be Perishable + /// + /// Set this to true if your shipments will always be Perishable + [JsonPropertyName("AttrPerishable")] + public Boolean AttrPerishable { get; set; } + + /// + /// Set this to true if your shipments will always use \"No Return To Sender\" + /// + /// Set this to true if your shipments will always use \"No Return To Sender\" + [JsonPropertyName("AttrNoRTS")] + public Boolean AttrNoRTS { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectLasershipRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" WebServicesId: ").Append(WebServicesId).Append("\n"); + sb.Append(" WebServicesKey: ").Append(WebServicesKey).Append("\n"); + sb.Append(" CustomerBranch: ").Append(CustomerBranch).Append("\n"); + sb.Append(" Address: ").Append(Address).Append("\n"); + sb.Append(" Address2: ").Append(Address2).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" City: ").Append(City).Append("\n"); + sb.Append(" State: ").Append(State).Append("\n"); + sb.Append(" Country: ").Append(Country).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" Instructions: ").Append(Instructions).Append("\n"); + sb.Append(" FacilityCode: ").Append(FacilityCode).Append("\n"); + sb.Append(" LasershipCriticalPullTime: ").Append(LasershipCriticalPullTime).Append("\n"); + sb.Append(" LasershipCriticalEntryTime: ").Append(LasershipCriticalEntryTime).Append("\n"); + sb.Append(" DeclarePieceAttributesSeparatelyForEveryShipment: ").Append(DeclarePieceAttributesSeparatelyForEveryShipment).Append("\n"); + sb.Append(" AttrAlcohol: ").Append(AttrAlcohol).Append("\n"); + sb.Append(" AttrDryIce: ").Append(AttrDryIce).Append("\n"); + sb.Append(" AttrHazmat: ").Append(AttrHazmat).Append("\n"); + sb.Append(" AttrTwoPersons: ").Append(AttrTwoPersons).Append("\n"); + sb.Append(" AttrExplosive: ").Append(AttrExplosive).Append("\n"); + sb.Append(" AttrControlledSubstance: ").Append(AttrControlledSubstance).Append("\n"); + sb.Append(" AttrRefrigerated: ").Append(AttrRefrigerated).Append("\n"); + sb.Append(" AttrPerishable: ").Append(AttrPerishable).Append("\n"); + sb.Append(" AttrNoRTS: ").Append(AttrNoRTS).Append("\n"); + 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/ConnectNewgisticsRequestBody.cs b/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs new file mode 100644 index 00000000..74d361a9 --- /dev/null +++ b/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs @@ -0,0 +1,87 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 Newgistics account information request body +/// +public partial class ConnectNewgisticsRequestBody +{ + + /// + /// Merchant id + /// + /// Merchant id + [JsonPropertyName("merchant_id")] + public int MerchantId { get; set; } + + /// + /// Mailer id + /// + /// Mailer id + [JsonPropertyName("mailer_id")] + public int MailerId { get; set; } + + /// + /// Induction site + /// + /// Induction site + [JsonPropertyName("induction_site")] + [JsonRequired] + public string InductionSite { get; set; } + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectNewgisticsRequestBody {\n"); + sb.Append(" MerchantId: ").Append(MerchantId).Append("\n"); + sb.Append(" MailerId: ").Append(MailerId).Append("\n"); + sb.Append(" InductionSite: ").Append(InductionSite).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + 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/ConnectOntracRequestBody.cs b/ShipEngineSDK/Model/ConnectOntracRequestBody.cs new file mode 100644 index 00000000..1af2af35 --- /dev/null +++ b/ShipEngineSDK/Model/ConnectOntracRequestBody.cs @@ -0,0 +1,80 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An Ontrac account information request body +/// +public partial class ConnectOntracRequestBody +{ + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// Account number + /// + /// Account number + [JsonPropertyName("account_number")] + [JsonRequired] + public string AccountNumber { get; set; } + + /// + /// Password + /// + /// Password + [JsonPropertyName("password")] + [JsonRequired] + public string Password { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectOntracRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" Password: ").Append(Password).Append("\n"); + 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/ConnectPurolatorRequestBody.cs b/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs new file mode 100644 index 00000000..bf27967b --- /dev/null +++ b/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs @@ -0,0 +1,80 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 Purolator account information request body +/// +public partial class ConnectPurolatorRequestBody +{ + + /// + /// Account number + /// + /// Account number + [JsonPropertyName("account_number")] + [JsonRequired] + public string AccountNumber { get; set; } + + /// + /// Activation key + /// + /// Activation key + [JsonPropertyName("activation_key")] + [JsonRequired] + public string ActivationKey { get; set; } + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectPurolatorRequestBody {\n"); + sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" ActivationKey: ").Append(ActivationKey).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + 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/ConnectRoyalMailRequestBody.cs b/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs new file mode 100644 index 00000000..789a2a10 --- /dev/null +++ b/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs @@ -0,0 +1,160 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 Royal Mail account information request body +/// +public partial class ConnectRoyalMailRequestBody +{ + + /// + /// Account number + /// + /// Account number + [JsonPropertyName("account_number")] + [JsonRequired] + public string AccountNumber { get; set; } + + /// + /// The oba email address + /// + /// The oba email address + /// + /// john.doe@example.com + /// + [JsonPropertyName("oba_email")] + public string ObaEmail { get; set; } + + /// + /// Contact name + /// + /// Contact name + [JsonPropertyName("contact_name")] + [JsonRequired] + public string ContactName { get; set; } + + /// + /// The email address + /// + /// The email address + /// + /// john.doe@example.com + /// + [JsonPropertyName("email")] + public string Email { get; set; } + + /// + /// Company name + /// + /// Company name + [JsonPropertyName("company_name")] + public string CompanyName { get; set; } + + /// + /// Street line1 + /// + /// Street line1 + [JsonPropertyName("street_line1")] + public string StreetLine1 { get; set; } + + /// + /// Street line2 + /// + /// Street line2 + [JsonPropertyName("street_line2")] + public string StreetLine2 { get; set; } + + /// + /// Street line3 + /// + /// Street line3 + [JsonPropertyName("street_line3")] + public string StreetLine3 { get; set; } + + /// + /// City + /// + /// City + [JsonPropertyName("city")] + [JsonRequired] + public string City { get; set; } + + /// + /// Postal code + /// + /// Postal code + [JsonPropertyName("postal_code")] + [JsonRequired] + public string PostalCode { get; set; } + + /// + /// Phone + /// + /// Phone + [JsonPropertyName("phone")] + public string Phone { get; set; } + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectRoyalMailRequestBody {\n"); + sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" ObaEmail: ").Append(ObaEmail).Append("\n"); + sb.Append(" ContactName: ").Append(ContactName).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" StreetLine1: ").Append(StreetLine1).Append("\n"); + sb.Append(" StreetLine2: ").Append(StreetLine2).Append("\n"); + sb.Append(" StreetLine3: ").Append(StreetLine3).Append("\n"); + sb.Append(" City: ").Append(City).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + 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/ConnectRrDonnelleyRequestBody.cs b/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs new file mode 100644 index 00000000..7d07dddd --- /dev/null +++ b/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs @@ -0,0 +1,80 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 RR Donnelley account information request body +/// +public partial class ConnectRrDonnelleyRequestBody +{ + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// Username + /// + /// Username + [JsonPropertyName("username")] + [JsonRequired] + public string Username { get; set; } + + /// + /// Password + /// + /// Password + [JsonPropertyName("password")] + [JsonRequired] + public string Password { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectRrDonnelleyRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" Username: ").Append(Username).Append("\n"); + sb.Append(" Password: ").Append(Password).Append("\n"); + 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/ConnectSekoRequestBody.cs b/ShipEngineSDK/Model/ConnectSekoRequestBody.cs new file mode 100644 index 00000000..7c5aa65a --- /dev/null +++ b/ShipEngineSDK/Model/ConnectSekoRequestBody.cs @@ -0,0 +1,71 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 SEKO account information request body +/// +public partial class ConnectSekoRequestBody +{ + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// Seko Account Access Key + /// + /// Seko Account Access Key + [JsonPropertyName("access_key")] + [JsonRequired] + public string AccessKey { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectSekoRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" AccessKey: ").Append(AccessKey).Append("\n"); + 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/ConnectSendleRequestBody.cs b/ShipEngineSDK/Model/ConnectSendleRequestBody.cs new file mode 100644 index 00000000..b69ed9df --- /dev/null +++ b/ShipEngineSDK/Model/ConnectSendleRequestBody.cs @@ -0,0 +1,83 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 Sendle account information request body +/// +public partial class ConnectSendleRequestBody +{ + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// A string that uniquely identifies the sendle + /// + /// A string that uniquely identifies the sendle + /// + /// se-28529731 + /// + [JsonPropertyName("sendle_id")] + [JsonRequired] + public string SendleId { get; set; } + + /// + /// API key + /// + /// API key + [JsonPropertyName("api_key")] + [JsonRequired] + public string ApiKey { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectSendleRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" SendleId: ").Append(SendleId).Append("\n"); + sb.Append(" ApiKey: ").Append(ApiKey).Append("\n"); + 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/ConnectStampsRequestBody.cs b/ShipEngineSDK/Model/ConnectStampsRequestBody.cs new file mode 100644 index 00000000..b08c3f1d --- /dev/null +++ b/ShipEngineSDK/Model/ConnectStampsRequestBody.cs @@ -0,0 +1,80 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 Stamps account information request body +/// +public partial class ConnectStampsRequestBody +{ + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// Username + /// + /// Username + [JsonPropertyName("username")] + [JsonRequired] + public string Username { get; set; } + + /// + /// Password + /// + /// Password + [JsonPropertyName("password")] + [JsonRequired] + public string Password { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectStampsRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" Username: ").Append(Username).Append("\n"); + sb.Append(" Password: ").Append(Password).Append("\n"); + 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/ConnectUpsRequestBody.cs b/ShipEngineSDK/Model/ConnectUpsRequestBody.cs new file mode 100644 index 00000000..b38c9957 --- /dev/null +++ b/ShipEngineSDK/Model/ConnectUpsRequestBody.cs @@ -0,0 +1,71 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 UPS account information request body. The location header from this call should be used to redirect to UPS for sign in. +/// +public partial class ConnectUpsRequestBody +{ + + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// Account number + /// + /// Account number + [JsonPropertyName("account_number")] + [JsonRequired] + public string AccountNumber { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ConnectUpsRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + 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/ContactDetails.cs b/ShipEngineSDK/Model/ContactDetails.cs new file mode 100644 index 00000000..753f58a9 --- /dev/null +++ b/ShipEngineSDK/Model/ContactDetails.cs @@ -0,0 +1,82 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// ContactDetails +/// +public partial class ContactDetails +{ + + /// + /// Gets or Sets Name + /// + [JsonPropertyName("name")] + [JsonRequired] + public string Name { get; set; } + + /// + /// An email address. + /// + /// An email address. + /// + /// john.doe@example.com + /// + [JsonPropertyName("email")] + [JsonRequired] + public string Email { get; set; } + + /// + /// Phone number associated + /// + /// Phone number associated + [JsonPropertyName("phone")] + [JsonRequired] + public string Phone { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ContactDetails {\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); + 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/CreateAndProcessBatchRequestBody.cs b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs new file mode 100644 index 00000000..b3686ccd --- /dev/null +++ b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs @@ -0,0 +1,98 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 and process batch request body +/// +public partial class CreateAndProcessBatchRequestBody +{ + + /// + /// A string that uniquely identifies the external batch + /// + /// A string that uniquely identifies the external batch + /// + /// se-28529731 + /// + [JsonPropertyName("external_batch_id")] + public string ExternalBatchId { get; set; } + + /// + /// Add custom messages for a particular batch + /// + /// Add custom messages for a particular batch + /// + /// This is my batch + /// + [JsonPropertyName("batch_notes")] + public string BatchNotes { get; set; } + + /// + /// Array of shipment IDs used in the batch + /// + /// Array of shipment IDs used in the batch + [JsonPropertyName("shipment_ids")] + public List ShipmentIds { get; set; } + + /// + /// Array of rate IDs used in the batch + /// + /// Array of rate IDs used in the batch + [JsonPropertyName("rate_ids")] + public List RateIds { get; set; } + + /// + /// Gets or Sets ProcessLabels + /// + [JsonPropertyName("process_labels")] + public CreateAndProcessBatchRequestBodyProcessLabels ProcessLabels { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class CreateAndProcessBatchRequestBody {\n"); + sb.Append(" ExternalBatchId: ").Append(ExternalBatchId).Append("\n"); + sb.Append(" BatchNotes: ").Append(BatchNotes).Append("\n"); + sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); + sb.Append(" RateIds: ").Append(RateIds).Append("\n"); + sb.Append(" ProcessLabels: ").Append(ProcessLabels).Append("\n"); + 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/CreateBatchRequest.cs b/ShipEngineSDK/Model/CreateBatchRequest.cs new file mode 100644 index 00000000..0627a2b6 --- /dev/null +++ b/ShipEngineSDK/Model/CreateBatchRequest.cs @@ -0,0 +1,262 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.IO; +using System.Linq; +using System.Reflection; +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; + +/// +/// CreateBatchRequest +/// +[JsonConverter(typeof(CreateBatchRequestJsonConverter))] +//[DataContract(Name = "create_batch_request")] +public partial class CreateBatchRequest : AbstractOpenAPISchema +{ + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of CreateBatchRequestBody. + public CreateBatchRequest(CreateBatchRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of CreateAndProcessBatchRequestBody. + public CreateBatchRequest(CreateAndProcessBatchRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + + private Object _actualInstance; + + /// + /// Gets or Sets ActualInstance + /// + public override Object ActualInstance + { + get + { + return _actualInstance; + } + set + { + if (value.GetType() == typeof(CreateBatchRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(CreateAndProcessBatchRequestBody)) + { + this._actualInstance = value; + } + else + { + throw new ArgumentException("Invalid instance found. Must be the following types: CreateBatchRequestBody, CreateAndProcessBatchRequestBody"); + } + } + } + + /// + /// Get the actual instance of `CreateBatchRequestBody`. If the actual instance is not `CreateBatchRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of CreateBatchRequestBody + public CreateBatchRequestBody GetCreateBatchRequestBody() + { + return (CreateBatchRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `CreateAndProcessBatchRequestBody`. If the actual instance is not `CreateAndProcessBatchRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of CreateAndProcessBatchRequestBody + public CreateAndProcessBatchRequestBody GetCreateAndProcessBatchRequestBody() + { + return (CreateAndProcessBatchRequestBody)this.ActualInstance; + } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class CreateBatchRequest {\n"); + sb.Append(" ActualInstance: ").Append(this.ActualInstance).Append("\n"); + + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public override string ToJson() + { + return JsonSerializer.Serialize(this.ActualInstance, CreateBatchRequest.SerializerSettings); + } + +} + +/// +/// Custom JSON converter for CreateBatchRequest +/// +public class CreateBatchRequestJsonConverter : JsonConverter +{ + private static HashSet OneOfTypes = [typeof(CreateBatchRequestBody), typeof(CreateAndProcessBatchRequestBody)]; + private static HashSet MandatoryFields = []; + private static JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) + { + TypeInfoResolver = new DefaultJsonTypeInfoResolver + { + Modifiers = + { + static typeInfo => + { + if (typeInfo.Kind != JsonTypeInfoKind.Object) + return; + + foreach (JsonPropertyInfo propertyInfo in typeInfo.Properties) + { + // Strip IsRequired constraint from every property except those which define the underlying type + if (OneOfTypes.Contains(typeInfo.Type)) + { + var underlyingPropertyName = (propertyInfo.AttributeProvider as MemberInfo)?.Name; + propertyInfo.IsRequired = underlyingPropertyName != null && MandatoryFields.Contains(underlyingPropertyName); + } + else + { + propertyInfo.IsRequired = false; + } + } + } + } + } + }; + + /// + /// To write the JSON string + /// + /// JSON writer + /// Object to be converted into a JSON string + /// Serializer options + public override void Write(Utf8JsonWriter writer, CreateBatchRequest value, JsonSerializerOptions options) + { + writer.WriteStartObject(); + + + var node = JsonSerializer.SerializeToNode(value.ActualInstance, options); + foreach (var prop in node?.AsObject() ?? []) + { + if (prop.Value != null) + { + writer.WritePropertyName(prop.Key); + prop.Value.WriteTo(writer, options); + } + } + + writer.WriteEndObject(); + } + + /// + /// To convert a JSON string into an object + /// + /// JSON reader + /// Object type to convert + /// Serializer options + /// The object converted from the JSON string + public override CreateBatchRequest Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + if (reader.TokenType == JsonTokenType.Null) + { + return null; + } + + var jsonDoc = JsonDocument.ParseValue(ref reader); + CreateBatchRequest newCreateBatchRequest = null; + + int match = 0; + var matchedTypes = new List(); + + try + { + newCreateBatchRequest = new CreateBatchRequest(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("CreateBatchRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into CreateBatchRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newCreateBatchRequest = new CreateBatchRequest(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("CreateAndProcessBatchRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into CreateAndProcessBatchRequestBody: {1}", jsonDoc, exception.ToString())); + } + + if (match == 0) + { + throw new InvalidDataException("The JSON string `" + jsonDoc + "` cannot be deserialized into any schema defined."); + } + + if (match > 1) + { + throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); + } + + + // deserialization is considered successful at this point if no exception has been thrown. + return newCreateBatchRequest; + } + + /// + /// Check if the object can be converted + /// + /// Object type + /// True if the object can be converted + public override bool CanConvert(Type objectType) + { + return typeof(CreateBatchRequest).IsAssignableFrom(objectType); + } +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/CreateBatchRequestBody.cs b/ShipEngineSDK/Model/CreateBatchRequestBody.cs new file mode 100644 index 00000000..8666c921 --- /dev/null +++ b/ShipEngineSDK/Model/CreateBatchRequestBody.cs @@ -0,0 +1,91 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 batch request body +/// +public partial class CreateBatchRequestBody +{ + + /// + /// A string that uniquely identifies the external batch + /// + /// A string that uniquely identifies the external batch + /// + /// se-28529731 + /// + [JsonPropertyName("external_batch_id")] + public string ExternalBatchId { get; set; } + + /// + /// Add custom messages for a particular batch + /// + /// Add custom messages for a particular batch + /// + /// This is my batch + /// + [JsonPropertyName("batch_notes")] + public string BatchNotes { get; set; } + + /// + /// Array of shipment IDs used in the batch + /// + /// Array of shipment IDs used in the batch + [JsonPropertyName("shipment_ids")] + public List ShipmentIds { get; set; } + + /// + /// Array of rate IDs used in the batch + /// + /// Array of rate IDs used in the batch + [JsonPropertyName("rate_ids")] + public List RateIds { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class CreateBatchRequestBody {\n"); + sb.Append(" ExternalBatchId: ").Append(ExternalBatchId).Append("\n"); + sb.Append(" BatchNotes: ").Append(BatchNotes).Append("\n"); + sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); + sb.Append(" RateIds: ").Append(RateIds).Append("\n"); + 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/CreateLabelFromRateRequestBody.cs b/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs new file mode 100644 index 00000000..c3a10a36 --- /dev/null +++ b/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs @@ -0,0 +1,84 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 purchase label without shipment request body +/// +public partial class CreateLabelFromRateRequestBody +{ + + /// + /// Gets or Sets ValidateAddress CLOVUS + /// + [JsonPropertyName("validate_address")] + public ValidateAddress? ValidateAddress { get; set; } + /// + /// Gets or Sets LabelLayout CLOVUS + /// + [JsonPropertyName("label_layout")] + public LabelLayout? LabelLayout { get; set; } + /// + /// Gets or Sets LabelFormat CLOVUS + /// + [JsonPropertyName("label_format")] + public LabelFormat? LabelFormat { get; set; } + /// + /// Gets or Sets LabelDownloadType CLOVUS + /// + [JsonPropertyName("label_download_type")] + public LabelDownloadType? LabelDownloadType { get; set; } + /// + /// The display format that the label should be shown in. CLOVUS + /// + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme")] + public DisplayScheme? DisplayScheme { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class CreateLabelFromRateRequestBody {\n"); + sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); + sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); + sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); + sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + 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/CreateLabelFromShipmentRequestBody.cs b/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs new file mode 100644 index 00000000..e0716539 --- /dev/null +++ b/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs @@ -0,0 +1,84 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 purchase label without shipment request body +/// +public partial class CreateLabelFromShipmentRequestBody +{ + + /// + /// Gets or Sets ValidateAddress CLOVUS + /// + [JsonPropertyName("validate_address")] + public ValidateAddress? ValidateAddress { get; set; } + /// + /// Gets or Sets LabelLayout CLOVUS + /// + [JsonPropertyName("label_layout")] + public LabelLayout? LabelLayout { get; set; } + /// + /// Gets or Sets LabelFormat CLOVUS + /// + [JsonPropertyName("label_format")] + public LabelFormat? LabelFormat { get; set; } + /// + /// Gets or Sets LabelDownloadType CLOVUS + /// + [JsonPropertyName("label_download_type")] + public LabelDownloadType? LabelDownloadType { get; set; } + /// + /// The display format that the label should be shown in. CLOVUS + /// + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme")] + public DisplayScheme? DisplayScheme { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class CreateLabelFromShipmentRequestBody {\n"); + sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); + sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); + sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); + sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + 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/CreateManifestLabelIdsRequestBody.cs b/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs new file mode 100644 index 00000000..216c891c --- /dev/null +++ b/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs @@ -0,0 +1,62 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 manifest request body +/// +public partial class CreateManifestLabelIdsRequestBody +{ + + /// + /// The list of label ids to include in the manifest + /// + /// The list of label ids to include in the manifest + [JsonPropertyName("label_ids")] + [JsonRequired] + public List LabelIds { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class CreateManifestLabelIdsRequestBody {\n"); + sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); + 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/CreateManifestRequestBody.cs b/ShipEngineSDK/Model/CreateManifestRequestBody.cs new file mode 100644 index 00000000..35217d49 --- /dev/null +++ b/ShipEngineSDK/Model/CreateManifestRequestBody.cs @@ -0,0 +1,262 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.IO; +using System.Linq; +using System.Reflection; +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; + +/// +/// CreateManifestRequestBody +/// +[JsonConverter(typeof(CreateManifestRequestBodyJsonConverter))] +//[DataContract(Name = "create_manifest_request_body")] +public partial class CreateManifestRequestBody : AbstractOpenAPISchema +{ + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of CreateManifestByObjectRequestBody. + public CreateManifestRequestBody(CreateManifestByObjectRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of CreateManifestLabelIdsRequestBody. + public CreateManifestRequestBody(CreateManifestLabelIdsRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + + private Object _actualInstance; + + /// + /// Gets or Sets ActualInstance + /// + public override Object ActualInstance + { + get + { + return _actualInstance; + } + set + { + if (value.GetType() == typeof(CreateManifestByObjectRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(CreateManifestLabelIdsRequestBody)) + { + this._actualInstance = value; + } + else + { + throw new ArgumentException("Invalid instance found. Must be the following types: CreateManifestByObjectRequestBody, CreateManifestLabelIdsRequestBody"); + } + } + } + + /// + /// Get the actual instance of `CreateManifestByObjectRequestBody`. If the actual instance is not `CreateManifestByObjectRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of CreateManifestByObjectRequestBody + public CreateManifestByObjectRequestBody GetCreateManifestByObjectRequestBody() + { + return (CreateManifestByObjectRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `CreateManifestLabelIdsRequestBody`. If the actual instance is not `CreateManifestLabelIdsRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of CreateManifestLabelIdsRequestBody + public CreateManifestLabelIdsRequestBody GetCreateManifestLabelIdsRequestBody() + { + return (CreateManifestLabelIdsRequestBody)this.ActualInstance; + } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class CreateManifestRequestBody {\n"); + sb.Append(" ActualInstance: ").Append(this.ActualInstance).Append("\n"); + + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public override string ToJson() + { + return JsonSerializer.Serialize(this.ActualInstance, CreateManifestRequestBody.SerializerSettings); + } + +} + +/// +/// Custom JSON converter for CreateManifestRequestBody +/// +public class CreateManifestRequestBodyJsonConverter : JsonConverter +{ + private static HashSet OneOfTypes = [typeof(CreateManifestByObjectRequestBody), typeof(CreateManifestLabelIdsRequestBody)]; + private static HashSet MandatoryFields = ["CarrierId", "LabelIds", "ShipDate", "WarehouseId"]; + private static JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) + { + TypeInfoResolver = new DefaultJsonTypeInfoResolver + { + Modifiers = + { + static typeInfo => + { + if (typeInfo.Kind != JsonTypeInfoKind.Object) + return; + + foreach (JsonPropertyInfo propertyInfo in typeInfo.Properties) + { + // Strip IsRequired constraint from every property except those which define the underlying type + if (OneOfTypes.Contains(typeInfo.Type)) + { + var underlyingPropertyName = (propertyInfo.AttributeProvider as MemberInfo)?.Name; + propertyInfo.IsRequired = underlyingPropertyName != null && MandatoryFields.Contains(underlyingPropertyName); + } + else + { + propertyInfo.IsRequired = false; + } + } + } + } + } + }; + + /// + /// To write the JSON string + /// + /// JSON writer + /// Object to be converted into a JSON string + /// Serializer options + public override void Write(Utf8JsonWriter writer, CreateManifestRequestBody value, JsonSerializerOptions options) + { + writer.WriteStartObject(); + + + var node = JsonSerializer.SerializeToNode(value.ActualInstance, options); + foreach (var prop in node?.AsObject() ?? []) + { + if (prop.Value != null) + { + writer.WritePropertyName(prop.Key); + prop.Value.WriteTo(writer, options); + } + } + + writer.WriteEndObject(); + } + + /// + /// To convert a JSON string into an object + /// + /// JSON reader + /// Object type to convert + /// Serializer options + /// The object converted from the JSON string + public override CreateManifestRequestBody Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + if (reader.TokenType == JsonTokenType.Null) + { + return null; + } + + var jsonDoc = JsonDocument.ParseValue(ref reader); + CreateManifestRequestBody newCreateManifestRequestBody = null; + + int match = 0; + var matchedTypes = new List(); + + try + { + newCreateManifestRequestBody = new CreateManifestRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("CreateManifestByObjectRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into CreateManifestByObjectRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newCreateManifestRequestBody = new CreateManifestRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("CreateManifestLabelIdsRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into CreateManifestLabelIdsRequestBody: {1}", jsonDoc, exception.ToString())); + } + + if (match == 0) + { + throw new InvalidDataException("The JSON string `" + jsonDoc + "` cannot be deserialized into any schema defined."); + } + + if (match > 1) + { + throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); + } + + + // deserialization is considered successful at this point if no exception has been thrown. + return newCreateManifestRequestBody; + } + + /// + /// Check if the object can be converted + /// + /// Object type + /// True if the object can be converted + public override bool CanConvert(Type objectType) + { + return typeof(CreateManifestRequestBody).IsAssignableFrom(objectType); + } +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs b/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs new file mode 100644 index 00000000..e5c364cd --- /dev/null +++ b/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs @@ -0,0 +1,106 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 package type request body +/// +public partial class CreatePackageTypeRequestBody +{ + + /// + /// A string that uniquely identifies the package. + /// + /// A string that uniquely identifies the package. + /// + /// se-28529731 + /// + [JsonPropertyName("package_id")] + public string PackageId { get; set; } + + /// + /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. + /// + /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. + /// + /// small_flat_rate_box + /// + [JsonPropertyName("package_code")] + [JsonRequired] + public string PackageCode { get; set; } + + /// + /// Gets or Sets Name + /// + /// + /// laptop_box + /// + [JsonPropertyName("name")] + [JsonRequired] + public string Name { get; set; } + + /// + /// The custom dimensions for the package. + /// + /// The custom dimensions for the package. + [JsonPropertyName("dimensions")] + public Dimensions Dimensions { get; set; } + + /// + /// Provides a helpful description for the custom package. + /// + /// Provides a helpful description for the custom package. + /// + /// Packaging for laptops + /// + [JsonPropertyName("description")] + public string Description { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class CreatePackageTypeRequestBody {\n"); + sb.Append(" PackageId: ").Append(PackageId).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); + sb.Append(" Description: ").Append(Description).Append("\n"); + 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/CreatePackageTypeResponseBody.cs b/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs new file mode 100644 index 00000000..10903c4b --- /dev/null +++ b/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs @@ -0,0 +1,106 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 package type response body +/// +public partial class CreatePackageTypeResponseBody +{ + + /// + /// A string that uniquely identifies the package. + /// + /// A string that uniquely identifies the package. + /// + /// se-28529731 + /// + [JsonPropertyName("package_id")] + public string PackageId { get; set; } + + /// + /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. + /// + /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. + /// + /// small_flat_rate_box + /// + [JsonPropertyName("package_code")] + [JsonRequired] + public string PackageCode { get; set; } + + /// + /// Gets or Sets Name + /// + /// + /// laptop_box + /// + [JsonPropertyName("name")] + [JsonRequired] + public string Name { get; set; } + + /// + /// The custom dimensions for the package. + /// + /// The custom dimensions for the package. + [JsonPropertyName("dimensions")] + public Dimensions Dimensions { get; set; } + + /// + /// Provides a helpful description for the custom package. + /// + /// Provides a helpful description for the custom package. + /// + /// Packaging for laptops + /// + [JsonPropertyName("description")] + public string Description { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class CreatePackageTypeResponseBody {\n"); + sb.Append(" PackageId: ").Append(PackageId).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); + sb.Append(" Description: ").Append(Description).Append("\n"); + 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/CreateReturnLabelRequestBody.cs b/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs new file mode 100644 index 00000000..fe82fe62 --- /dev/null +++ b/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs @@ -0,0 +1,98 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 return label request body +/// +public partial class CreateReturnLabelRequestBody +{ + + /// + /// The label charge event. CLOVUS + /// + /// The label charge event. + [JsonPropertyName("charge_event")] + public LabelChargeEvent? ChargeEvent { 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. CLOVUS + /// + /// 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")] + public LabelLayout? LabelLayout { 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. CLOVUS + /// + /// 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")] + public LabelFormat? LabelFormat { get; set; } + /// + /// Gets or Sets LabelDownloadType CLOVUS + /// + [JsonPropertyName("label_download_type")] + public LabelDownloadType? LabelDownloadType { get; set; } + /// + /// The display format that the label should be shown in. CLOVUS + /// + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme")] + public DisplayScheme? DisplayScheme { get; set; } + /// + /// The label image resource that was used to create a custom label image. + /// + /// The label image resource that was used to create a custom label image. + /// + /// img_DtBXupDBxREpHnwEXhTfgK + /// + [JsonPropertyName("label_image_id")] + public string LabelImageId { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class CreateReturnLabelRequestBody {\n"); + sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); + sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); + sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); + sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); + 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/CreateShipmentResponseBodyFields.cs b/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs new file mode 100644 index 00000000..be8e0e11 --- /dev/null +++ b/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs @@ -0,0 +1,70 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// CreateShipmentResponseBodyFields +/// +public partial class CreateShipmentResponseBodyFields +{ + + /// + /// An array of errors that occurred while creating shipment. + /// + /// An array of errors that occurred while creating shipment. + [JsonPropertyName("errors")] + [Obsolete] + public List Errors { get; set; } + + /// + /// The address validation + /// + /// The address validation + [JsonPropertyName("address_validation")] + public AddressValidationResult AddressValidation { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class CreateShipmentResponseBodyFields {\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); + sb.Append(" AddressValidation: ").Append(AddressValidation).Append("\n"); + 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/CreateShipmentsRequestBody.cs b/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs new file mode 100644 index 00000000..1395787e --- /dev/null +++ b/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs @@ -0,0 +1,62 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 shipments request body +/// +public partial class CreateShipmentsRequestBody +{ + + /// + /// An array of shipments to be created. + /// + /// An array of shipments to be created. + [JsonPropertyName("shipments")] + [JsonRequired] + public List Shipments { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class CreateShipmentsRequestBody {\n"); + sb.Append(" Shipments: ").Append(Shipments).Append("\n"); + 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/CreateShipmentsResponseBody.cs b/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs new file mode 100644 index 00000000..e50461ec --- /dev/null +++ b/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs @@ -0,0 +1,71 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 shipments response body +/// +public partial class CreateShipmentsResponseBody +{ + + /// + /// Indicates if errors occured while creating the shipments + /// + /// Indicates if errors occured while creating the shipments + [JsonPropertyName("has_errors")] + [JsonRequired] + public bool HasErrors { get; set; } + + /// + /// An array of shipments that were created. + /// + /// An array of shipments that were created. + [JsonPropertyName("shipments")] + [JsonRequired] + public List Shipments { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class CreateShipmentsResponseBody {\n"); + sb.Append(" HasErrors: ").Append(HasErrors).Append("\n"); + sb.Append(" Shipments: ").Append(Shipments).Append("\n"); + 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 new file mode 100644 index 00000000..434126da --- /dev/null +++ b/ShipEngineSDK/Model/CreateTagResponseBody.cs @@ -0,0 +1,65 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Response body for creating tags +/// +public partial class CreateTagResponseBody +{ + + /// + /// The tag name. + /// + /// The tag name. + /// + /// Fragile + /// + [JsonPropertyName("name")] + [JsonRequired] + public string Name { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class CreateTagResponseBody {\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + 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/CreateWebhookRequestBody.cs b/ShipEngineSDK/Model/CreateWebhookRequestBody.cs new file mode 100644 index 00000000..fe892be2 --- /dev/null +++ b/ShipEngineSDK/Model/CreateWebhookRequestBody.cs @@ -0,0 +1,82 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 webhook request body +/// +public partial class CreateWebhookRequestBody +{ + + /// + /// Gets or Sets Event CLOVUS + /// + [JsonPropertyName("event")] + [JsonRequired] + public WebhookEvent Event { get; set; } = new(); + + + /// + /// The url that the webhook sends the request to + /// + /// The url that the webhook sends the request to + /// + /// http://api.shipengine.com/v1/labels/se-28529731 + /// + [JsonPropertyName("url")] + [JsonRequired] + public string Url { get; set; } + + /// + /// Array of custom webhook headers + /// + /// Array of custom webhook headers + [JsonPropertyName("headers")] + public List Headers { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class CreateWebhookRequestBody {\n"); + sb.Append(" Event: ").Append(Event).Append("\n"); + sb.Append(" Url: ").Append(Url).Append("\n"); + sb.Append(" Headers: ").Append(Headers).Append("\n"); + 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/CreateWebhookResponseBody.cs b/ShipEngineSDK/Model/CreateWebhookResponseBody.cs new file mode 100644 index 00000000..77fb2977 --- /dev/null +++ b/ShipEngineSDK/Model/CreateWebhookResponseBody.cs @@ -0,0 +1,94 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 webhook response body +/// +public partial class CreateWebhookResponseBody +{ + + /// + /// Gets or Sets Event CLOVUS + /// + [JsonPropertyName("event")] + [JsonRequired] + public WebhookEvent Event { get; set; } = new(); + + + /// + /// A string that uniquely identifies the webhook + /// + /// A string that uniquely identifies the webhook + /// + /// se-28529731 + /// + [JsonPropertyName("webhook_id")] + [JsonRequired] + public string WebhookId { get; set; } + + /// + /// The url that the webhook sends the request to + /// + /// The url that the webhook sends the request to + /// + /// http://api.shipengine.com/v1/labels/se-28529731 + /// + [JsonPropertyName("url")] + [JsonRequired] + public string Url { get; set; } + + /// + /// Array of custom webhook headers + /// + /// Array of custom webhook headers + [JsonPropertyName("headers")] + public List Headers { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class CreateWebhookResponseBody {\n"); + sb.Append(" WebhookId: ").Append(WebhookId).Append("\n"); + sb.Append(" Url: ").Append(Url).Append("\n"); + sb.Append(" Event: ").Append(Event).Append("\n"); + sb.Append(" Headers: ").Append(Headers).Append("\n"); + 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/CustomsItem.cs b/ShipEngineSDK/Model/CustomsItem.cs new file mode 100644 index 00000000..433e90a0 --- /dev/null +++ b/ShipEngineSDK/Model/CustomsItem.cs @@ -0,0 +1,150 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The customs declaration for a single item in the shipment. +/// +public partial class CustomsItem +{ + + /// + /// A string that uniquely identifies the customs item + /// + /// A string that uniquely identifies the customs item + /// + /// se-28529731 + /// + [JsonPropertyName("customs_item_id")] + [JsonRequired] + public string CustomsItemId { get; set; } + + /// + /// A description of the item + /// + /// A description of the item + [JsonPropertyName("description")] + public string Description { get; set; } + + /// + /// The quantity of this item in the shipment. + /// + /// The quantity of this item in the shipment. + [JsonPropertyName("quantity")] + public int Quantity { get; set; } + + /// + /// The monetary amount, in the specified currency. + /// + /// The monetary amount, in the specified currency. + [JsonPropertyName("value")] + public double Value { get; set; } + + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + [JsonPropertyName("value_currency")] + public string ValueCurrency { get; set; } + + /// + /// The item weight + /// + /// The item weight + [JsonPropertyName("weight")] + public Weight Weight { get; set; } + + /// + /// The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item. + /// + /// The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item. + /// + /// 3926.1 + /// + [JsonPropertyName("harmonized_tariff_code")] + public string HarmonizedTariffCode { get; set; } + + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated + /// + /// CA + /// + [JsonPropertyName("country_of_origin")] + public string CountryOfOrigin { get; set; } + + /// + /// Gets or Sets UnitOfMeasure + /// + [JsonPropertyName("unit_of_measure")] + public string UnitOfMeasure { get; set; } + + /// + /// The SKU (Stock Keeping Unit) of the customs item + /// + /// The SKU (Stock Keeping Unit) of the customs item + [JsonPropertyName("sku")] + public string Sku { get; set; } + + /// + /// Description of the Custom Item's SKU + /// + /// Description of the Custom Item's SKU + [JsonPropertyName("sku_description")] + public string SkuDescription { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class CustomsItem {\n"); + sb.Append(" CustomsItemId: ").Append(CustomsItemId).Append("\n"); + sb.Append(" Description: ").Append(Description).Append("\n"); + sb.Append(" Quantity: ").Append(Quantity).Append("\n"); + sb.Append(" Value: ").Append(Value).Append("\n"); + sb.Append(" ValueCurrency: ").Append(ValueCurrency).Append("\n"); + sb.Append(" Weight: ").Append(Weight).Append("\n"); + sb.Append(" HarmonizedTariffCode: ").Append(HarmonizedTariffCode).Append("\n"); + sb.Append(" CountryOfOrigin: ").Append(CountryOfOrigin).Append("\n"); + sb.Append(" UnitOfMeasure: ").Append(UnitOfMeasure).Append("\n"); + sb.Append(" Sku: ").Append(Sku).Append("\n"); + sb.Append(" SkuDescription: ").Append(SkuDescription).Append("\n"); + 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/DangerousAmount.cs b/ShipEngineSDK/Model/DangerousAmount.cs new file mode 100644 index 00000000..6ae8fba1 --- /dev/null +++ b/ShipEngineSDK/Model/DangerousAmount.cs @@ -0,0 +1,69 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// This model represents the amount of the dangerous goods.. +/// +public partial class DangerousAmount +{ + + /// + /// The amount of dangerous goods. + /// + /// The amount of dangerous goods. + [JsonPropertyName("amount")] + public double Amount { get; set; } + + /// + /// The unit of dangerous goods. + /// + /// The unit of dangerous goods. + [JsonPropertyName("unit")] + public string Unit { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class DangerousAmount {\n"); + sb.Append(" Amount: ").Append(Amount).Append("\n"); + sb.Append(" Unit: ").Append(Unit).Append("\n"); + 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/DangerousGoods.cs b/ShipEngineSDK/Model/DangerousGoods.cs new file mode 100644 index 00000000..4f5cb43e --- /dev/null +++ b/ShipEngineSDK/Model/DangerousGoods.cs @@ -0,0 +1,203 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Dangerous goods attribute associated with the product +/// +public partial class DangerousGoods +{ + + /// + /// Gets or Sets PackagingGroup CLOVUS + /// + [JsonPropertyName("packaging_group")] + public PackagingGroup? PackagingGroup { get; set; } + /// + /// Gets or Sets PackagingInstructionSection CLOVUS + /// + [JsonPropertyName("packaging_instruction_section")] + public PackagingInstructionSection? PackagingInstructionSection { get; set; } + /// + /// Gets or Sets TransportMean CLOVUS + /// + [JsonPropertyName("transport_mean")] + public TransportMean? TransportMean { get; set; } + /// + /// Gets or Sets RegulationLevel CLOVUS + /// + [JsonPropertyName("regulation_level")] + public RegulationLevel? RegulationLevel { get; set; } + /// + /// UN number to identify the dangerous goods. + /// + /// UN number to identify the dangerous goods. + [JsonPropertyName("id_number")] + public string IdNumber { get; set; } + + /// + /// Trade description of the dangerous goods. + /// + /// Trade description of the dangerous goods. + [JsonPropertyName("shipping_name")] + public string ShippingName { get; set; } + + /// + /// Recognized Technical or chemical name of dangerous goods. + /// + /// Recognized Technical or chemical name of dangerous goods. + [JsonPropertyName("technical_name")] + public string TechnicalName { get; set; } + + /// + /// Dangerous goods product class based on regulation. + /// + /// Dangerous goods product class based on regulation. + [JsonPropertyName("product_class")] + public string ProductClass { get; set; } + + /// + /// A secondary of product class for substances presenting more than one particular hazard + /// + /// A secondary of product class for substances presenting more than one particular hazard + [JsonPropertyName("product_class_subsidiary")] + public string ProductClassSubsidiary { get; set; } + + /// + /// This model represents the amount of the dangerous goods. + /// + /// This model represents the amount of the dangerous goods. + [JsonPropertyName("dangerous_amount")] + public DangerousAmount DangerousAmount { get; set; } + + /// + /// Quantity of dangerous goods. + /// + /// Quantity of dangerous goods. + [JsonPropertyName("quantity")] + public int Quantity { get; set; } + + /// + /// The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container. + /// + /// The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container. + [JsonPropertyName("packaging_instruction")] + public string PackagingInstruction { get; set; } + + /// + /// The type of exterior packaging used to contain the dangerous good. + /// + /// The type of exterior packaging used to contain the dangerous good. + [JsonPropertyName("packaging_type")] + public string PackagingType { get; set; } + + /// + /// Transport category assign to dangerous goods for the transport purpose. + /// + /// Transport category assign to dangerous goods for the transport purpose. + [JsonPropertyName("transport_category")] + public string TransportCategory { get; set; } + + /// + /// Name of the regulatory authority. + /// + /// Name of the regulatory authority. + [JsonPropertyName("regulation_authority")] + public string RegulationAuthority { get; set; } + + /// + /// Indication if the substance is radioactive. + /// + /// Indication if the substance is radioactive. + /// + /// false + /// + [JsonPropertyName("radioactive")] + public bool? Radioactive { get; set; } + + /// + /// Indication if the substance needs to be reported to regulatory authority based on the quantity. + /// + /// Indication if the substance needs to be reported to regulatory authority based on the quantity. + /// + /// false + /// + [JsonPropertyName("reportable_quantity")] + public bool? ReportableQuantity { get; set; } + + /// + /// Defines which types of tunnels the shipment is allowed to go through + /// + /// Defines which types of tunnels the shipment is allowed to go through + [JsonPropertyName("tunnel_code")] + public string TunnelCode { get; set; } + + /// + /// Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier + /// + /// Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier + [JsonPropertyName("additional_description")] + public string AdditionalDescription { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class DangerousGoods {\n"); + sb.Append(" IdNumber: ").Append(IdNumber).Append("\n"); + sb.Append(" ShippingName: ").Append(ShippingName).Append("\n"); + sb.Append(" TechnicalName: ").Append(TechnicalName).Append("\n"); + sb.Append(" ProductClass: ").Append(ProductClass).Append("\n"); + sb.Append(" ProductClassSubsidiary: ").Append(ProductClassSubsidiary).Append("\n"); + sb.Append(" PackagingGroup: ").Append(PackagingGroup).Append("\n"); + sb.Append(" DangerousAmount: ").Append(DangerousAmount).Append("\n"); + sb.Append(" Quantity: ").Append(Quantity).Append("\n"); + sb.Append(" PackagingInstruction: ").Append(PackagingInstruction).Append("\n"); + sb.Append(" PackagingInstructionSection: ").Append(PackagingInstructionSection).Append("\n"); + sb.Append(" PackagingType: ").Append(PackagingType).Append("\n"); + sb.Append(" TransportMean: ").Append(TransportMean).Append("\n"); + sb.Append(" TransportCategory: ").Append(TransportCategory).Append("\n"); + sb.Append(" RegulationAuthority: ").Append(RegulationAuthority).Append("\n"); + sb.Append(" RegulationLevel: ").Append(RegulationLevel).Append("\n"); + sb.Append(" Radioactive: ").Append(Radioactive).Append("\n"); + sb.Append(" ReportableQuantity: ").Append(ReportableQuantity).Append("\n"); + sb.Append(" TunnelCode: ").Append(TunnelCode).Append("\n"); + sb.Append(" AdditionalDescription: ").Append(AdditionalDescription).Append("\n"); + 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/DefaultLabelLayout.cs b/ShipEngineSDK/Model/DefaultLabelLayout.cs new file mode 100644 index 00000000..75c76b12 --- /dev/null +++ b/ShipEngineSDK/Model/DefaultLabelLayout.cs @@ -0,0 +1,77 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible default label layout values +/// +/// The possible default label layout values +[JsonConverter(typeof(DefaultLabelLayoutJsonConverter))] +public class DefaultLabelLayout +{ + private string _value; + + internal DefaultLabelLayout() + { + _value = "4x6"; + } + + /// + /// Create a new instance of DefaultLabelLayout with a custom value. + /// + /// The value of the DefaultLabelLayout + /// + /// 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 DefaultLabelLayout(string value) + { + _value = value; + } + + /// + /// Enum _4x6 for value: 4x6 + /// + public static DefaultLabelLayout _4x6 { get; } = new("4x6"); + + + /// + /// Enum Letter for value: Letter + /// + public static DefaultLabelLayout Letter { get; } = new("Letter"); + + + public override string ToString() => _value; +} + +internal class DefaultLabelLayoutJsonConverter : JsonConverter +{ + public override DefaultLabelLayout? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new DefaultLabelLayout(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, DefaultLabelLayout value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(DefaultLabelLayout); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs b/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs new file mode 100644 index 00000000..e9190dd9 --- /dev/null +++ b/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs @@ -0,0 +1,86 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// DeletePickupByIdResponseBody +/// +public partial class DeletePickupByIdResponseBody +{ + + /// + /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur + /// + /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur + /// + /// aa3d8e8e-462b-4476-9618-72db7f7b7009 + /// + [JsonPropertyName("request_id")] + [JsonRequired] + public Guid RequestId { get; set; } + + /// + /// The errors associated with the failed API call + /// + /// The errors associated with the failed API call + [JsonPropertyName("errors")] + [JsonRequired] + public List Errors { get; set; } + + /// + /// Pickup Resource ID + /// + /// Pickup Resource ID + /// + /// pik_3YcKU5zdtJuCqoeNwyqqbW + /// + [JsonPropertyName("pickup_id")] + [JsonRequired] + public string PickupId { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class DeletePickupByIdResponseBody {\n"); + sb.Append(" RequestId: ").Append(RequestId).Append("\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); + sb.Append(" PickupId: ").Append(PickupId).Append("\n"); + 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/DeleteScheduledPickupResponseBody.cs b/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs new file mode 100644 index 00000000..13cb20e2 --- /dev/null +++ b/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs @@ -0,0 +1,65 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 delete scheduled pickup response body +/// +public partial class DeleteScheduledPickupResponseBody +{ + + /// + /// Pickup Resource ID + /// + /// Pickup Resource ID + /// + /// pik_3YcKU5zdtJuCqoeNwyqqbW + /// + [JsonPropertyName("pickup_id")] + [JsonRequired] + public string PickupId { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class DeleteScheduledPickupResponseBody {\n"); + sb.Append(" PickupId: ").Append(PickupId).Append("\n"); + 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/DeliveryConfirmation.cs b/ShipEngineSDK/Model/DeliveryConfirmation.cs new file mode 100644 index 00000000..6e792775 --- /dev/null +++ b/ShipEngineSDK/Model/DeliveryConfirmation.cs @@ -0,0 +1,107 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible delivery confirmation values +/// +/// The possible delivery confirmation values +[JsonConverter(typeof(DeliveryConfirmationJsonConverter))] +public class DeliveryConfirmation +{ + private string _value; + + internal DeliveryConfirmation() + { + _value = "none"; + } + + /// + /// Create a new instance of DeliveryConfirmation with a custom value. + /// + /// The value of the DeliveryConfirmation + /// + /// 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 DeliveryConfirmation(string value) + { + _value = value; + } + + /// + /// Enum None for value: none + /// + public static DeliveryConfirmation None { get; } = new("none"); + + + /// + /// Enum Delivery for value: delivery + /// + public static DeliveryConfirmation Delivery { get; } = new("delivery"); + + + /// + /// Enum Signature for value: signature + /// + public static DeliveryConfirmation Signature { get; } = new("signature"); + + + /// + /// Enum AdultSignature for value: adult_signature + /// + public static DeliveryConfirmation AdultSignature { get; } = new("adult_signature"); + + + /// + /// Enum DirectSignature for value: direct_signature + /// + public static DeliveryConfirmation DirectSignature { get; } = new("direct_signature"); + + + /// + /// Enum DeliveryMailed for value: delivery_mailed + /// + public static DeliveryConfirmation DeliveryMailed { get; } = new("delivery_mailed"); + + + /// + /// Enum VerbalConfirmation for value: verbal_confirmation + /// + public static DeliveryConfirmation VerbalConfirmation { get; } = new("verbal_confirmation"); + + + public override string ToString() => _value; +} + +internal class DeliveryConfirmationJsonConverter : JsonConverter +{ + public override DeliveryConfirmation? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new DeliveryConfirmation(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, DeliveryConfirmation value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(DeliveryConfirmation); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/DhlExpressAccountSettings.cs b/ShipEngineSDK/Model/DhlExpressAccountSettings.cs new file mode 100644 index 00000000..46b44b6b --- /dev/null +++ b/ShipEngineSDK/Model/DhlExpressAccountSettings.cs @@ -0,0 +1,77 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 DHL Express account settings +/// +public partial class DhlExpressAccountSettings +{ + + /// + /// Account nickname + /// + /// Account nickname + [JsonPropertyName("nickname")] + public string Nickname { get; set; } + + /// + /// Indicates if the account number should be hidden on the archive documentation + /// + /// Indicates if the account number should be hidden on the archive documentation + [JsonPropertyName("should_hide_account_number_on_archive_doc")] + public bool ShouldHideAccountNumberOnArchiveDoc { get; set; } + + /// + /// Indicates if this is primary account + /// + /// Indicates if this is primary account + [JsonPropertyName("is_primary_account")] + public bool IsPrimaryAccount { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class DhlExpressAccountSettings {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" ShouldHideAccountNumberOnArchiveDoc: ").Append(ShouldHideAccountNumberOnArchiveDoc).Append("\n"); + sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); + 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/DhlExpressSettingsResponseBody.cs b/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs new file mode 100644 index 00000000..cf01ffcb --- /dev/null +++ b/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs @@ -0,0 +1,77 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 DHL Express response body +/// +public partial class DhlExpressSettingsResponseBody +{ + + /// + /// Account nickname + /// + /// Account nickname + [JsonPropertyName("nickname")] + public string Nickname { get; set; } + + /// + /// Indicates if the account number should be hidden on the archive documentation + /// + /// Indicates if the account number should be hidden on the archive documentation + [JsonPropertyName("should_hide_account_number_on_archive_doc")] + public bool ShouldHideAccountNumberOnArchiveDoc { get; set; } + + /// + /// Indicates if this is primary account + /// + /// Indicates if this is primary account + [JsonPropertyName("is_primary_account")] + public bool IsPrimaryAccount { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class DhlExpressSettingsResponseBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" ShouldHideAccountNumberOnArchiveDoc: ").Append(ShouldHideAccountNumberOnArchiveDoc).Append("\n"); + sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); + 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/DimensionUnit.cs b/ShipEngineSDK/Model/DimensionUnit.cs new file mode 100644 index 00000000..96b980bf --- /dev/null +++ b/ShipEngineSDK/Model/DimensionUnit.cs @@ -0,0 +1,77 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The dimension units that are supported by ShipEngine. +/// +/// The dimension units that are supported by ShipEngine. +[JsonConverter(typeof(DimensionUnitJsonConverter))] +public class DimensionUnit +{ + private string _value; + + internal DimensionUnit() + { + _value = "inch"; + } + + /// + /// Create a new instance of DimensionUnit with a custom value. + /// + /// The value of the DimensionUnit + /// + /// 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 DimensionUnit(string value) + { + _value = value; + } + + /// + /// Enum Inch for value: inch + /// + public static DimensionUnit Inch { get; } = new("inch"); + + + /// + /// Enum Centimeter for value: centimeter + /// + public static DimensionUnit Centimeter { get; } = new("centimeter"); + + + public override string ToString() => _value; +} + +internal class DimensionUnitJsonConverter : JsonConverter +{ + public override DimensionUnit? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new DimensionUnit(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, DimensionUnit value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(DimensionUnit); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/Dimensions.cs b/ShipEngineSDK/Model/Dimensions.cs new file mode 100644 index 00000000..976b74c2 --- /dev/null +++ b/ShipEngineSDK/Model/Dimensions.cs @@ -0,0 +1,89 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The dimensions of a package +/// +public partial class Dimensions +{ + + /// + /// Gets or Sets Unit CLOVUS + /// + [JsonPropertyName("unit")] + [JsonRequired] + public DimensionUnit Unit { get; set; } = new(); + + + /// + /// The length of the package, in the specified unit + /// + /// The length of the package, in the specified unit + [JsonPropertyName("length")] + [JsonRequired] + public double Length { get; set; } + + /// + /// The width of the package, in the specified unit + /// + /// The width of the package, in the specified unit + [JsonPropertyName("width")] + [JsonRequired] + public double Width { get; set; } + + /// + /// The height of the package, in the specified unit + /// + /// The height of the package, in the specified unit + [JsonPropertyName("height")] + [JsonRequired] + public double Height { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class Dimensions {\n"); + sb.Append(" Unit: ").Append(Unit).Append("\n"); + sb.Append(" Length: ").Append(Length).Append("\n"); + sb.Append(" Width: ").Append(Width).Append("\n"); + sb.Append(" Height: ").Append(Height).Append("\n"); + 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/DisplayScheme.cs b/ShipEngineSDK/Model/DisplayScheme.cs new file mode 100644 index 00000000..6023a0f0 --- /dev/null +++ b/ShipEngineSDK/Model/DisplayScheme.cs @@ -0,0 +1,95 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The display format that the label should be shown in. +/// +/// The display format that the label should be shown in. +[JsonConverter(typeof(DisplaySchemeJsonConverter))] +public class DisplayScheme +{ + private string _value; + + internal DisplayScheme() + { + _value = "label"; + } + + /// + /// Create a new instance of DisplayScheme with a custom value. + /// + /// The value of the DisplayScheme + /// + /// 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 DisplayScheme(string value) + { + _value = value; + } + + /// + /// Enum Label for value: label + /// + public static DisplayScheme Label { get; } = new("label"); + + + /// + /// Enum QrCode for value: qr_code + /// + public static DisplayScheme QrCode { get; } = new("qr_code"); + + + /// + /// Enum LabelAndQrCode for value: label_and_qr_code + /// + public static DisplayScheme LabelAndQrCode { get; } = new("label_and_qr_code"); + + + /// + /// Enum Paperless for value: paperless + /// + public static DisplayScheme Paperless { get; } = new("paperless"); + + + /// + /// Enum LabelAndPaperless for value: label_and_paperless + /// + public static DisplayScheme LabelAndPaperless { get; } = new("label_and_paperless"); + + + public override string ToString() => _value; +} + +internal class DisplaySchemeJsonConverter : JsonConverter +{ + public override DisplayScheme? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new DisplayScheme(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, DisplayScheme value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(DisplayScheme); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/Error.cs b/ShipEngineSDK/Model/Error.cs new file mode 100644 index 00000000..c1906b9d --- /dev/null +++ b/ShipEngineSDK/Model/Error.cs @@ -0,0 +1,92 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The error structure that gets returned with almost all failed API calls +/// +public partial class Error +{ + + /// + /// Gets or Sets ErrorSource CLOVUS + /// + [JsonPropertyName("error_source")] + [JsonRequired] + public ErrorSource ErrorSource { get; set; } = new(); + + + /// + /// Gets or Sets ErrorType CLOVUS + /// + [JsonPropertyName("error_type")] + [JsonRequired] + public ErrorType ErrorType { get; set; } = new(); + + + /// + /// Gets or Sets ErrorCode CLOVUS + /// + [JsonPropertyName("error_code")] + [JsonRequired] + public ErrorCode ErrorCode { get; set; } = new(); + + + /// + /// An error message associated with the failed API call + /// + /// An error message associated with the failed API call + /// + /// Body of request cannot be null. + /// + [JsonPropertyName("message")] + [JsonRequired] + public string Message { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class Error {\n"); + sb.Append(" ErrorSource: ").Append(ErrorSource).Append("\n"); + sb.Append(" ErrorType: ").Append(ErrorType).Append("\n"); + sb.Append(" ErrorCode: ").Append(ErrorCode).Append("\n"); + sb.Append(" Message: ").Append(Message).Append("\n"); + 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/ErrorCode.cs b/ShipEngineSDK/Model/ErrorCode.cs new file mode 100644 index 00000000..25c8b99b --- /dev/null +++ b/ShipEngineSDK/Model/ErrorCode.cs @@ -0,0 +1,323 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The error code specified for the failed API Call +/// +/// The error code specified for the failed API Call +[JsonConverter(typeof(ErrorCodeJsonConverter))] +public class ErrorCode +{ + private string _value; + + internal ErrorCode() + { + _value = "auto_fund_not_supported"; + } + + /// + /// Create a new instance of ErrorCode with a custom value. + /// + /// The value of the ErrorCode + /// + /// 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 ErrorCode(string value) + { + _value = value; + } + + /// + /// Enum AutoFundNotSupported for value: auto_fund_not_supported + /// + public static ErrorCode AutoFundNotSupported { get; } = new("auto_fund_not_supported"); + + + /// + /// Enum BatchCannotBeModified for value: batch_cannot_be_modified + /// + public static ErrorCode BatchCannotBeModified { get; } = new("batch_cannot_be_modified"); + + + /// + /// Enum CarrierConflict for value: carrier_conflict + /// + public static ErrorCode CarrierConflict { get; } = new("carrier_conflict"); + + + /// + /// Enum CarrierDisconnected for value: carrier_disconnected + /// + public static ErrorCode CarrierDisconnected { get; } = new("carrier_disconnected"); + + + /// + /// Enum CarrierNotConnected for value: carrier_not_connected + /// + public static ErrorCode CarrierNotConnected { get; } = new("carrier_not_connected"); + + + /// + /// Enum CarrierNotSupported for value: carrier_not_supported + /// + public static ErrorCode CarrierNotSupported { get; } = new("carrier_not_supported"); + + + /// + /// Enum ConfirmationNotSupported for value: confirmation_not_supported + /// + public static ErrorCode ConfirmationNotSupported { get; } = new("confirmation_not_supported"); + + + /// + /// Enum DefaultWarehouseCannotBeDeleted for value: default_warehouse_cannot_be_deleted + /// + public static ErrorCode DefaultWarehouseCannotBeDeleted { get; } = new("default_warehouse_cannot_be_deleted"); + + + /// + /// Enum FieldConflict for value: field_conflict + /// + public static ErrorCode FieldConflict { get; } = new("field_conflict"); + + + /// + /// Enum FieldValueRequired for value: field_value_required + /// + public static ErrorCode FieldValueRequired { get; } = new("field_value_required"); + + + /// + /// Enum Forbidden for value: forbidden + /// + public static ErrorCode Forbidden { get; } = new("forbidden"); + + + /// + /// Enum IdentifierConflict for value: identifier_conflict + /// + public static ErrorCode IdentifierConflict { get; } = new("identifier_conflict"); + + + /// + /// Enum IdentifiersMustMatch for value: identifiers_must_match + /// + public static ErrorCode IdentifiersMustMatch { get; } = new("identifiers_must_match"); + + + /// + /// Enum InsufficientFunds for value: insufficient_funds + /// + public static ErrorCode InsufficientFunds { get; } = new("insufficient_funds"); + + + /// + /// Enum InvalidAddress for value: invalid_address + /// + public static ErrorCode InvalidAddress { get; } = new("invalid_address"); + + + /// + /// Enum InvalidBillingPlan for value: invalid_billing_plan + /// + public static ErrorCode InvalidBillingPlan { get; } = new("invalid_billing_plan"); + + + /// + /// Enum InvalidFieldValue for value: invalid_field_value + /// + public static ErrorCode InvalidFieldValue { get; } = new("invalid_field_value"); + + + /// + /// Enum InvalidIdentifier for value: invalid_identifier + /// + public static ErrorCode InvalidIdentifier { get; } = new("invalid_identifier"); + + + /// + /// Enum InvalidStatus for value: invalid_status + /// + public static ErrorCode InvalidStatus { get; } = new("invalid_status"); + + + /// + /// Enum InvalidStringLength for value: invalid_string_length + /// + public static ErrorCode InvalidStringLength { get; } = new("invalid_string_length"); + + + /// + /// Enum LabelImagesNotSupported for value: label_images_not_supported + /// + public static ErrorCode LabelImagesNotSupported { get; } = new("label_images_not_supported"); + + + /// + /// Enum MeterFailure for value: meter_failure + /// + public static ErrorCode MeterFailure { get; } = new("meter_failure"); + + + /// + /// Enum OrderSourceNotActive for value: order_source_not_active + /// + public static ErrorCode OrderSourceNotActive { get; } = new("order_source_not_active"); + + + /// + /// Enum RateLimitExceeded for value: rate_limit_exceeded + /// + public static ErrorCode RateLimitExceeded { get; } = new("rate_limit_exceeded"); + + + /// + /// Enum RefreshNotSupported for value: refresh_not_supported + /// + public static ErrorCode RefreshNotSupported { get; } = new("refresh_not_supported"); + + + /// + /// Enum RequestBodyRequired for value: request_body_required + /// + public static ErrorCode RequestBodyRequired { get; } = new("request_body_required"); + + + /// + /// Enum ReturnLabelNotSupported for value: return_label_not_supported + /// + public static ErrorCode ReturnLabelNotSupported { get; } = new("return_label_not_supported"); + + + /// + /// Enum SettingsNotSupported for value: settings_not_supported + /// + public static ErrorCode SettingsNotSupported { get; } = new("settings_not_supported"); + + + /// + /// Enum SubscriptionInactive for value: subscription_inactive + /// + public static ErrorCode SubscriptionInactive { get; } = new("subscription_inactive"); + + + /// + /// Enum TermsNotAccepted for value: terms_not_accepted + /// + public static ErrorCode TermsNotAccepted { get; } = new("terms_not_accepted"); + + + /// + /// Enum TrackingNotSupported for value: tracking_not_supported + /// + public static ErrorCode TrackingNotSupported { get; } = new("tracking_not_supported"); + + + /// + /// Enum TrialExpired for value: trial_expired + /// + public static ErrorCode TrialExpired { get; } = new("trial_expired"); + + + /// + /// Enum Unauthorized for value: unauthorized + /// + public static ErrorCode Unauthorized { get; } = new("unauthorized"); + + + /// + /// Enum Unknown for value: unknown + /// + public static ErrorCode Unknown { get; } = new("unknown"); + + + /// + /// Enum Unspecified for value: unspecified + /// + public static ErrorCode Unspecified { get; } = new("unspecified"); + + + /// + /// Enum VerificationFailure for value: verification_failure + /// + public static ErrorCode VerificationFailure { get; } = new("verification_failure"); + + + /// + /// Enum WarehouseConflict for value: warehouse_conflict + /// + public static ErrorCode WarehouseConflict { get; } = new("warehouse_conflict"); + + + /// + /// Enum WebhookEventTypeConflict for value: webhook_event_type_conflict + /// + public static ErrorCode WebhookEventTypeConflict { get; } = new("webhook_event_type_conflict"); + + + /// + /// Enum CustomsItemsRequired for value: customs_items_required + /// + public static ErrorCode CustomsItemsRequired { get; } = new("customs_items_required"); + + + /// + /// Enum IncompatiblePairedLabels for value: incompatible_paired_labels + /// + public static ErrorCode IncompatiblePairedLabels { get; } = new("incompatible_paired_labels"); + + + /// + /// Enum InvalidChargeEvent for value: invalid_charge_event + /// + public static ErrorCode InvalidChargeEvent { get; } = new("invalid_charge_event"); + + + /// + /// Enum InvalidObject for value: invalid_object + /// + public static ErrorCode InvalidObject { get; } = new("invalid_object"); + + + /// + /// Enum NoRatesReturned for value: no_rates_returned + /// + public static ErrorCode NoRatesReturned { get; } = new("no_rates_returned"); + + + public override string ToString() => _value; +} + +internal class ErrorCodeJsonConverter : JsonConverter +{ + public override ErrorCode? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new ErrorCode(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, ErrorCode value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(ErrorCode); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/ErrorResponseBody.cs b/ShipEngineSDK/Model/ErrorResponseBody.cs new file mode 100644 index 00000000..b977ffaa --- /dev/null +++ b/ShipEngineSDK/Model/ErrorResponseBody.cs @@ -0,0 +1,74 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An error response body +/// +public partial class ErrorResponseBody +{ + + /// + /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur + /// + /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur + /// + /// aa3d8e8e-462b-4476-9618-72db7f7b7009 + /// + [JsonPropertyName("request_id")] + [JsonRequired] + public Guid RequestId { get; set; } + + /// + /// The errors associated with the failed API call + /// + /// The errors associated with the failed API call + [JsonPropertyName("errors")] + [JsonRequired] + public List Errors { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ErrorResponseBody {\n"); + sb.Append(" RequestId: ").Append(RequestId).Append("\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); + 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/ErrorSource.cs b/ShipEngineSDK/Model/ErrorSource.cs new file mode 100644 index 00000000..ccc68753 --- /dev/null +++ b/ShipEngineSDK/Model/ErrorSource.cs @@ -0,0 +1,83 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The source of the error, as indicated by the name this informs us if the API call failed because of the carrier, the order source, or the ShipEngine API itself. +/// +/// The source of the error, as indicated by the name this informs us if the API call failed because of the carrier, the order source, or the ShipEngine API itself. +[JsonConverter(typeof(ErrorSourceJsonConverter))] +public class ErrorSource +{ + private string _value; + + internal ErrorSource() + { + _value = "carrier"; + } + + /// + /// Create a new instance of ErrorSource with a custom value. + /// + /// The value of the ErrorSource + /// + /// 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 ErrorSource(string value) + { + _value = value; + } + + /// + /// Enum Carrier for value: carrier + /// + public static ErrorSource Carrier { get; } = new("carrier"); + + + /// + /// Enum OrderSource for value: order_source + /// + public static ErrorSource OrderSource { get; } = new("order_source"); + + + /// + /// Enum Shipengine for value: shipengine + /// + public static ErrorSource Shipengine { get; } = new("shipengine"); + + + public override string ToString() => _value; +} + +internal class ErrorSourceJsonConverter : JsonConverter +{ + public override ErrorSource? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new ErrorSource(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, ErrorSource value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(ErrorSource); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/ErrorType.cs b/ShipEngineSDK/Model/ErrorType.cs new file mode 100644 index 00000000..95c47c41 --- /dev/null +++ b/ShipEngineSDK/Model/ErrorType.cs @@ -0,0 +1,101 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The type of error +/// +/// The type of error +[JsonConverter(typeof(ErrorTypeJsonConverter))] +public class ErrorType +{ + private string _value; + + internal ErrorType() + { + _value = "account_status"; + } + + /// + /// Create a new instance of ErrorType with a custom value. + /// + /// The value of the ErrorType + /// + /// 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 ErrorType(string value) + { + _value = value; + } + + /// + /// Enum AccountStatus for value: account_status + /// + public static ErrorType AccountStatus { get; } = new("account_status"); + + + /// + /// Enum BusinessRules for value: business_rules + /// + public static ErrorType BusinessRules { get; } = new("business_rules"); + + + /// + /// Enum Validation for value: validation + /// + public static ErrorType Validation { get; } = new("validation"); + + + /// + /// Enum Security for value: security + /// + public static ErrorType Security { get; } = new("security"); + + + /// + /// Enum System for value: system + /// + public static ErrorType System { get; } = new("system"); + + + /// + /// Enum Integrations for value: integrations + /// + public static ErrorType Integrations { get; } = new("integrations"); + + + public override string ToString() => _value; +} + +internal class ErrorTypeJsonConverter : JsonConverter +{ + public override ErrorType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new ErrorType(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, ErrorType value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(ErrorType); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs b/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs new file mode 100644 index 00000000..5e9bea3f --- /dev/null +++ b/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs @@ -0,0 +1,74 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An error response body +/// +public partial class ErrorWithLabelIdResponseBody +{ + + /// + /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur + /// + /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur + /// + /// aa3d8e8e-462b-4476-9618-72db7f7b7009 + /// + [JsonPropertyName("request_id")] + [JsonRequired] + public Guid RequestId { get; set; } + + /// + /// The errors associated with the failed API call + /// + /// The errors associated with the failed API call + [JsonPropertyName("errors")] + [JsonRequired] + public List Errors { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ErrorWithLabelIdResponseBody {\n"); + sb.Append(" RequestId: ").Append(RequestId).Append("\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); + 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/FedexAccountSettings.cs b/ShipEngineSDK/Model/FedexAccountSettings.cs new file mode 100644 index 00000000..1087fbfc --- /dev/null +++ b/ShipEngineSDK/Model/FedexAccountSettings.cs @@ -0,0 +1,100 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 Fedex account settings request body +/// +public partial class FedexAccountSettings +{ + + /// + /// Gets or Sets PickupType CLOVUS + /// + [JsonPropertyName("pickup_type")] + public FedexPickupType? PickupType { get; set; } + /// + /// Gets or Sets SmartPostHub CLOVUS + /// + [JsonPropertyName("smart_post_hub")] + public SmartPostHub? SmartPostHub { get; set; } + /// + /// Gets or Sets SmartPostEndorsement CLOVUS + /// + [JsonPropertyName("smart_post_endorsement")] + public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } + /// + /// Account nickname + /// + /// Account nickname + [JsonPropertyName("nickname")] + public string Nickname { get; set; } + + /// + /// Gets or Sets IsPrimaryAccount + /// + [JsonPropertyName("is_primary_account")] + public bool IsPrimaryAccount { get; set; } + + /// + /// Gets or Sets SignatureImage + /// + [JsonPropertyName("signature_image")] + public string SignatureImage { get; set; } + + /// + /// Gets or Sets LetterheadImage + /// + [JsonPropertyName("letterhead_image")] + public string LetterheadImage { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class FedexAccountSettings {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" PickupType: ").Append(PickupType).Append("\n"); + sb.Append(" SmartPostHub: ").Append(SmartPostHub).Append("\n"); + sb.Append(" SmartPostEndorsement: ").Append(SmartPostEndorsement).Append("\n"); + sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); + sb.Append(" SignatureImage: ").Append(SignatureImage).Append("\n"); + sb.Append(" LetterheadImage: ").Append(LetterheadImage).Append("\n"); + 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/FedexAccountSettingsRequestBody.cs b/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs new file mode 100644 index 00000000..b8a0eb5a --- /dev/null +++ b/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs @@ -0,0 +1,100 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 Fedex account settings request body +/// +public partial class FedexAccountSettingsRequestBody +{ + + /// + /// Gets or Sets PickupType CLOVUS + /// + [JsonPropertyName("pickup_type")] + public FedexPickupType? PickupType { get; set; } + /// + /// Gets or Sets SmartPostHub CLOVUS + /// + [JsonPropertyName("smart_post_hub")] + public SmartPostHub? SmartPostHub { get; set; } + /// + /// Gets or Sets SmartPostEndorsement CLOVUS + /// + [JsonPropertyName("smart_post_endorsement")] + public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } + /// + /// Account nickname + /// + /// Account nickname + [JsonPropertyName("nickname")] + public string Nickname { get; set; } + + /// + /// Gets or Sets IsPrimaryAccount + /// + [JsonPropertyName("is_primary_account")] + public bool IsPrimaryAccount { get; set; } + + /// + /// Gets or Sets SignatureImage + /// + [JsonPropertyName("signature_image")] + public string SignatureImage { get; set; } + + /// + /// Gets or Sets LetterheadImage + /// + [JsonPropertyName("letterhead_image")] + public string LetterheadImage { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class FedexAccountSettingsRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" PickupType: ").Append(PickupType).Append("\n"); + sb.Append(" SmartPostHub: ").Append(SmartPostHub).Append("\n"); + sb.Append(" SmartPostEndorsement: ").Append(SmartPostEndorsement).Append("\n"); + sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); + sb.Append(" SignatureImage: ").Append(SignatureImage).Append("\n"); + sb.Append(" LetterheadImage: ").Append(LetterheadImage).Append("\n"); + 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/FedexPickupType.cs b/ShipEngineSDK/Model/FedexPickupType.cs new file mode 100644 index 00000000..9eacf38e --- /dev/null +++ b/ShipEngineSDK/Model/FedexPickupType.cs @@ -0,0 +1,101 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Tax identifier type for customs declaration |Pickup Type |Description |- -- -- -- -- -- -- -- -- -- -- -- -- -|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`none` | Not specified |`regular_pickup` | You already have a daily pickup scheduled with FedEx |`request_courier` | You will call FedEx to request a courier |`drop_box` | You will drop-off packages in a FedEx drop box |`business_service_center` | You will drop-off packages at an authorized FedEx business service center |`station` | You will drop-off the package at a FedEx Station +/// +/// Tax identifier type for customs declaration |Pickup Type |Description |- -- -- -- -- -- -- -- -- -- -- -- -- -|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`none` | Not specified |`regular_pickup` | You already have a daily pickup scheduled with FedEx |`request_courier` | You will call FedEx to request a courier |`drop_box` | You will drop-off packages in a FedEx drop box |`business_service_center` | You will drop-off packages at an authorized FedEx business service center |`station` | You will drop-off the package at a FedEx Station +[JsonConverter(typeof(FedexPickupTypeJsonConverter))] +public class FedexPickupType +{ + private string _value; + + internal FedexPickupType() + { + _value = "none"; + } + + /// + /// Create a new instance of FedexPickupType with a custom value. + /// + /// The value of the FedexPickupType + /// + /// 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 FedexPickupType(string value) + { + _value = value; + } + + /// + /// Enum None for value: none + /// + public static FedexPickupType None { get; } = new("none"); + + + /// + /// Enum RegularPickup for value: regular_pickup + /// + public static FedexPickupType RegularPickup { get; } = new("regular_pickup"); + + + /// + /// Enum RequestCourier for value: request_courier + /// + public static FedexPickupType RequestCourier { get; } = new("request_courier"); + + + /// + /// Enum DropBox for value: drop_box + /// + public static FedexPickupType DropBox { get; } = new("drop_box"); + + + /// + /// Enum BusinessServiceCenter for value: business_service_center + /// + public static FedexPickupType BusinessServiceCenter { get; } = new("business_service_center"); + + + /// + /// Enum Station for value: station + /// + public static FedexPickupType Station { get; } = new("station"); + + + public override string ToString() => _value; +} + +internal class FedexPickupTypeJsonConverter : JsonConverter +{ + public override FedexPickupType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new FedexPickupType(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, FedexPickupType value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(FedexPickupType); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/FedexSettingsResponseBody.cs b/ShipEngineSDK/Model/FedexSettingsResponseBody.cs new file mode 100644 index 00000000..299427b2 --- /dev/null +++ b/ShipEngineSDK/Model/FedexSettingsResponseBody.cs @@ -0,0 +1,100 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 Fedex settings response body +/// +public partial class FedexSettingsResponseBody +{ + + /// + /// Gets or Sets PickupType CLOVUS + /// + [JsonPropertyName("pickup_type")] + public FedexPickupType? PickupType { get; set; } + /// + /// Gets or Sets SmartPostHub CLOVUS + /// + [JsonPropertyName("smart_post_hub")] + public SmartPostHub? SmartPostHub { get; set; } + /// + /// Gets or Sets SmartPostEndorsement CLOVUS + /// + [JsonPropertyName("smart_post_endorsement")] + public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } + /// + /// Account nickname + /// + /// Account nickname + [JsonPropertyName("nickname")] + public string Nickname { get; set; } + + /// + /// Gets or Sets IsPrimaryAccount + /// + [JsonPropertyName("is_primary_account")] + public bool IsPrimaryAccount { get; set; } + + /// + /// Gets or Sets SignatureImage + /// + [JsonPropertyName("signature_image")] + public string SignatureImage { get; set; } + + /// + /// Gets or Sets LetterheadImage + /// + [JsonPropertyName("letterhead_image")] + public string LetterheadImage { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class FedexSettingsResponseBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" PickupType: ").Append(PickupType).Append("\n"); + sb.Append(" SmartPostHub: ").Append(SmartPostHub).Append("\n"); + sb.Append(" SmartPostEndorsement: ").Append(SmartPostEndorsement).Append("\n"); + sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); + sb.Append(" SignatureImage: ").Append(SignatureImage).Append("\n"); + sb.Append(" LetterheadImage: ").Append(LetterheadImage).Append("\n"); + 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/GetAccountSettingsResponseBody.cs b/ShipEngineSDK/Model/GetAccountSettingsResponseBody.cs new file mode 100644 index 00000000..61ef35bf --- /dev/null +++ b/ShipEngineSDK/Model/GetAccountSettingsResponseBody.cs @@ -0,0 +1,59 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// GetAccountSettingsResponseBody +/// +public partial class GetAccountSettingsResponseBody +{ + + /// + /// Gets or Sets DefaultLabelLayout CLOVUS + /// + [JsonPropertyName("default_label_layout")] + public DefaultLabelLayout? DefaultLabelLayout { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class GetAccountSettingsResponseBody {\n"); + sb.Append(" DefaultLabelLayout: ").Append(DefaultLabelLayout).Append("\n"); + 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/GetCarrierByIdResponseBody.cs b/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs new file mode 100644 index 00000000..3c26922d --- /dev/null +++ b/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs @@ -0,0 +1,183 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 get carrier by id response body +/// +public partial class GetCarrierByIdResponseBody +{ + + /// + /// A string that uniquely identifies the carrier. + /// + /// A string that uniquely identifies the carrier. + /// + /// se-28529731 + /// + [JsonPropertyName("carrier_id")] + public string CarrierId { get; set; } + + /// + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// dhl_express + /// + [JsonPropertyName("carrier_code")] + public string CarrierCode { get; set; } + + /// + /// The account number that the carrier is connected to. + /// + /// The account number that the carrier is connected to. + /// + /// account_570827 + /// + [JsonPropertyName("account_number")] + public string AccountNumber { get; set; } + + /// + /// Indicates whether the carrier requires funding to use its services + /// + /// Indicates whether the carrier requires funding to use its services + [JsonPropertyName("requires_funded_amount")] + public bool RequiresFundedAmount { get; set; } + + /// + /// Current available balance + /// + /// Current available balance + /// + /// 3799.52 + /// + [JsonPropertyName("balance")] + public double Balance { get; set; } + + /// + /// Nickname given to the account when initially setting up the carrier. + /// + /// Nickname given to the account when initially setting up the carrier. + /// + /// ShipEngine Account - Stamps.com + /// + [JsonPropertyName("nickname")] + public string Nickname { get; set; } + + /// + /// Screen readable name + /// + /// Screen readable name + /// + /// Stamps.com + /// + [JsonPropertyName("friendly_name")] + public string FriendlyName { get; set; } + + /// + /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation + /// + /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation + [JsonPropertyName("primary")] + public bool Primary { get; set; } + + /// + /// Carrier supports multiple packages per shipment + /// + /// Carrier supports multiple packages per shipment + [JsonPropertyName("has_multi_package_supporting_services")] + public bool HasMultiPackageSupportingServices { get; set; } + + /// + /// The carrier supports adding custom label messages to an order. + /// + /// The carrier supports adding custom label messages to an order. + [JsonPropertyName("supports_label_messages")] + public bool SupportsLabelMessages { get; set; } + + /// + /// The carrier is disabled by the current ShipEngine account's billing plan. + /// + /// The carrier is disabled by the current ShipEngine account's billing plan. + [JsonPropertyName("disabled_by_billing_plan")] + public bool DisabledByBillingPlan { get; set; } + + /// + /// A list of services that are offered by the carrier + /// + /// A list of services that are offered by the carrier + [JsonPropertyName("services")] + public List Services { get; set; } + + /// + /// A list of package types that are supported by the carrier + /// + /// A list of package types that are supported by the carrier + [JsonPropertyName("packages")] + public List Packages { get; set; } + + /// + /// A list of options that are available to that carrier + /// + /// A list of options that are available to that carrier + [JsonPropertyName("options")] + public List Options { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class GetCarrierByIdResponseBody {\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" RequiresFundedAmount: ").Append(RequiresFundedAmount).Append("\n"); + sb.Append(" Balance: ").Append(Balance).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" FriendlyName: ").Append(FriendlyName).Append("\n"); + sb.Append(" Primary: ").Append(Primary).Append("\n"); + sb.Append(" HasMultiPackageSupportingServices: ").Append(HasMultiPackageSupportingServices).Append("\n"); + sb.Append(" SupportsLabelMessages: ").Append(SupportsLabelMessages).Append("\n"); + sb.Append(" DisabledByBillingPlan: ").Append(DisabledByBillingPlan).Append("\n"); + sb.Append(" Services: ").Append(Services).Append("\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" Options: ").Append(Options).Append("\n"); + 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/GetCarrierOptionsResponseBody.cs b/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs new file mode 100644 index 00000000..90fd80f2 --- /dev/null +++ b/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs @@ -0,0 +1,61 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 carrier list options response body +/// +public partial class GetCarrierOptionsResponseBody +{ + + /// + /// AN array of carrier options + /// + /// AN array of carrier options + [JsonPropertyName("options")] + public List Options { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class GetCarrierOptionsResponseBody {\n"); + sb.Append(" Options: ").Append(Options).Append("\n"); + 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/GetCarrierSettingsResponseBody.cs b/ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs new file mode 100644 index 00000000..f53a5a7e --- /dev/null +++ b/ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs @@ -0,0 +1,301 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.IO; +using System.Linq; +using System.Reflection; +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; + +/// +/// GetCarrierSettingsResponseBody +/// +[JsonConverter(typeof(GetCarrierSettingsResponseBodyJsonConverter))] +//[DataContract(Name = "get_carrier_settings_response_body")] +public partial class GetCarrierSettingsResponseBody : AbstractOpenAPISchema +{ + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of DhlExpressSettingsResponseBody. + public GetCarrierSettingsResponseBody(DhlExpressSettingsResponseBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of FedexSettingsResponseBody. + public GetCarrierSettingsResponseBody(FedexSettingsResponseBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of UpsSettingsResponseBody. + public GetCarrierSettingsResponseBody(UpsSettingsResponseBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + + private Object _actualInstance; + + /// + /// Gets or Sets ActualInstance + /// + public override Object ActualInstance + { + get + { + return _actualInstance; + } + set + { + if (value.GetType() == typeof(DhlExpressSettingsResponseBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(FedexSettingsResponseBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(UpsSettingsResponseBody)) + { + this._actualInstance = value; + } + else + { + throw new ArgumentException("Invalid instance found. Must be the following types: DhlExpressSettingsResponseBody, FedexSettingsResponseBody, UpsSettingsResponseBody"); + } + } + } + + /// + /// Get the actual instance of `DhlExpressSettingsResponseBody`. If the actual instance is not `DhlExpressSettingsResponseBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of DhlExpressSettingsResponseBody + public DhlExpressSettingsResponseBody GetDhlExpressSettingsResponseBody() + { + return (DhlExpressSettingsResponseBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `FedexSettingsResponseBody`. If the actual instance is not `FedexSettingsResponseBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of FedexSettingsResponseBody + public FedexSettingsResponseBody GetFedexSettingsResponseBody() + { + return (FedexSettingsResponseBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `UpsSettingsResponseBody`. If the actual instance is not `UpsSettingsResponseBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of UpsSettingsResponseBody + public UpsSettingsResponseBody GetUpsSettingsResponseBody() + { + return (UpsSettingsResponseBody)this.ActualInstance; + } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class GetCarrierSettingsResponseBody {\n"); + sb.Append(" ActualInstance: ").Append(this.ActualInstance).Append("\n"); + + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public override string ToJson() + { + return JsonSerializer.Serialize(this.ActualInstance, GetCarrierSettingsResponseBody.SerializerSettings); + } + +} + +/// +/// Custom JSON converter for GetCarrierSettingsResponseBody +/// +public class GetCarrierSettingsResponseBodyJsonConverter : JsonConverter +{ + private static HashSet OneOfTypes = [typeof(DhlExpressSettingsResponseBody), typeof(FedexSettingsResponseBody), typeof(UpsSettingsResponseBody)]; + private static HashSet MandatoryFields = []; + private static JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) + { + TypeInfoResolver = new DefaultJsonTypeInfoResolver + { + Modifiers = + { + static typeInfo => + { + if (typeInfo.Kind != JsonTypeInfoKind.Object) + return; + + foreach (JsonPropertyInfo propertyInfo in typeInfo.Properties) + { + // Strip IsRequired constraint from every property except those which define the underlying type + if (OneOfTypes.Contains(typeInfo.Type)) + { + var underlyingPropertyName = (propertyInfo.AttributeProvider as MemberInfo)?.Name; + propertyInfo.IsRequired = underlyingPropertyName != null && MandatoryFields.Contains(underlyingPropertyName); + } + else + { + propertyInfo.IsRequired = false; + } + } + } + } + } + }; + + /// + /// To write the JSON string + /// + /// JSON writer + /// Object to be converted into a JSON string + /// Serializer options + public override void Write(Utf8JsonWriter writer, GetCarrierSettingsResponseBody value, JsonSerializerOptions options) + { + writer.WriteStartObject(); + + + var node = JsonSerializer.SerializeToNode(value.ActualInstance, options); + foreach (var prop in node?.AsObject() ?? []) + { + if (prop.Value != null) + { + writer.WritePropertyName(prop.Key); + prop.Value.WriteTo(writer, options); + } + } + + writer.WriteEndObject(); + } + + /// + /// To convert a JSON string into an object + /// + /// JSON reader + /// Object type to convert + /// Serializer options + /// The object converted from the JSON string + public override GetCarrierSettingsResponseBody Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + if (reader.TokenType == JsonTokenType.Null) + { + return null; + } + + var jsonDoc = JsonDocument.ParseValue(ref reader); + GetCarrierSettingsResponseBody newGetCarrierSettingsResponseBody = null; + + int match = 0; + var matchedTypes = new List(); + + try + { + newGetCarrierSettingsResponseBody = new GetCarrierSettingsResponseBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("DhlExpressSettingsResponseBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into DhlExpressSettingsResponseBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newGetCarrierSettingsResponseBody = new GetCarrierSettingsResponseBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("FedexSettingsResponseBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into FedexSettingsResponseBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newGetCarrierSettingsResponseBody = new GetCarrierSettingsResponseBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("UpsSettingsResponseBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into UpsSettingsResponseBody: {1}", jsonDoc, exception.ToString())); + } + + if (match == 0) + { + throw new InvalidDataException("The JSON string `" + jsonDoc + "` cannot be deserialized into any schema defined."); + } + + if (match > 1) + { + throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); + } + + + // deserialization is considered successful at this point if no exception has been thrown. + return newGetCarrierSettingsResponseBody; + } + + /// + /// Check if the object can be converted + /// + /// Object type + /// True if the object can be converted + public override bool CanConvert(Type objectType) + { + return typeof(GetCarrierSettingsResponseBody).IsAssignableFrom(objectType); + } +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/GetCarriersResponseBody.cs b/ShipEngineSDK/Model/GetCarriersResponseBody.cs new file mode 100644 index 00000000..10439965 --- /dev/null +++ b/ShipEngineSDK/Model/GetCarriersResponseBody.cs @@ -0,0 +1,83 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// GetCarriersResponseBody +/// +public partial class GetCarriersResponseBody +{ + + /// + /// The carrier response body + /// + /// The carrier response body + [JsonPropertyName("carriers")] + [JsonRequired] + public List Carriers { get; set; } + + /// + /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur + /// + /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur + /// + /// aa3d8e8e-462b-4476-9618-72db7f7b7009 + /// + [JsonPropertyName("request_id")] + [JsonRequired] + public Guid RequestId { get; set; } + + /// + /// The errors associated with the failed API call + /// + /// The errors associated with the failed API call + [JsonPropertyName("errors")] + [JsonRequired] + public List Errors { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class GetCarriersResponseBody {\n"); + sb.Append(" Carriers: ").Append(Carriers).Append("\n"); + sb.Append(" RequestId: ").Append(RequestId).Append("\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); + 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/GetInsuranceBalanceResponseBody.cs b/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs new file mode 100644 index 00000000..d8de398f --- /dev/null +++ b/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs @@ -0,0 +1,71 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 get insurance balance response body +/// +public partial class GetInsuranceBalanceResponseBody +{ + + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + [JsonPropertyName("currency")] + [JsonRequired] + public string Currency { get; set; } + + /// + /// The monetary amount, in the specified currency. + /// + /// The monetary amount, in the specified currency. + [JsonPropertyName("amount")] + [JsonRequired] + public double Amount { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class GetInsuranceBalanceResponseBody {\n"); + sb.Append(" Currency: ").Append(Currency).Append("\n"); + sb.Append(" Amount: ").Append(Amount).Append("\n"); + 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/GetPackageTypeByIdResponseBody.cs b/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs new file mode 100644 index 00000000..a5028ae7 --- /dev/null +++ b/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs @@ -0,0 +1,106 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 get package type by id response body +/// +public partial class GetPackageTypeByIdResponseBody +{ + + /// + /// A string that uniquely identifies the package. + /// + /// A string that uniquely identifies the package. + /// + /// se-28529731 + /// + [JsonPropertyName("package_id")] + public string PackageId { get; set; } + + /// + /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. + /// + /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. + /// + /// small_flat_rate_box + /// + [JsonPropertyName("package_code")] + [JsonRequired] + public string PackageCode { get; set; } + + /// + /// Gets or Sets Name + /// + /// + /// laptop_box + /// + [JsonPropertyName("name")] + [JsonRequired] + public string Name { get; set; } + + /// + /// The custom dimensions for the package. + /// + /// The custom dimensions for the package. + [JsonPropertyName("dimensions")] + public Dimensions Dimensions { get; set; } + + /// + /// Provides a helpful description for the custom package. + /// + /// Provides a helpful description for the custom package. + /// + /// Packaging for laptops + /// + [JsonPropertyName("description")] + public string Description { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class GetPackageTypeByIdResponseBody {\n"); + sb.Append(" PackageId: ").Append(PackageId).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); + sb.Append(" Description: ").Append(Description).Append("\n"); + 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/GetPickupsResponseBody.cs b/ShipEngineSDK/Model/GetPickupsResponseBody.cs new file mode 100644 index 00000000..fee2f236 --- /dev/null +++ b/ShipEngineSDK/Model/GetPickupsResponseBody.cs @@ -0,0 +1,128 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// GetPickupsResponseBody +/// +public partial class GetPickupsResponseBody +{ + + /// + /// An array of pickups associated with the user's account. + /// + /// An array of pickups associated with the user's account. + [JsonPropertyName("pickups")] + [JsonRequired] + public List Pickups { get; set; } + + /// + /// The total number of pickups returned + /// + /// The total number of pickups returned + /// + /// 3 + /// + [JsonPropertyName("total")] + [JsonRequired] + public long Total { get; set; } + + /// + /// Current page of the list pickups results + /// + /// Current page of the list pickups results + /// + /// 3 + /// + [JsonPropertyName("page")] + [JsonRequired] + public int Page { get; set; } + + /// + /// Total number of pages for list pickups results + /// + /// Total number of pages for list pickups results + /// + /// 4 + /// + [JsonPropertyName("pages")] + [JsonRequired] + public int Pages { get; set; } + + /// + /// Helpful links to other pages of results + /// + /// Helpful links to other pages of results + [JsonPropertyName("links")] + [JsonRequired] + public PaginationLink Links { get; set; } + + /// + /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur + /// + /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur + /// + /// aa3d8e8e-462b-4476-9618-72db7f7b7009 + /// + [JsonPropertyName("request_id")] + [JsonRequired] + public Guid RequestId { get; set; } + + /// + /// The errors associated with the failed API call + /// + /// The errors associated with the failed API call + [JsonPropertyName("errors")] + [JsonRequired] + public List Errors { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class GetPickupsResponseBody {\n"); + sb.Append(" Pickups: ").Append(Pickups).Append("\n"); + sb.Append(" Total: ").Append(Total).Append("\n"); + sb.Append(" Page: ").Append(Page).Append("\n"); + sb.Append(" Pages: ").Append(Pages).Append("\n"); + sb.Append(" Links: ").Append(Links).Append("\n"); + sb.Append(" RequestId: ").Append(RequestId).Append("\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); + 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/GetServicePointByIdResponseBody.cs b/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs new file mode 100644 index 00000000..ac1547d4 --- /dev/null +++ b/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs @@ -0,0 +1,60 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 get service point by ID response body +/// +public partial class GetServicePointByIdResponseBody +{ + + /// + /// Gets or Sets ServicePoint + /// + [JsonPropertyName("service_point")] + public GetServicePointByIdResponseBodyServicePoint ServicePoint { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class GetServicePointByIdResponseBody {\n"); + sb.Append(" ServicePoint: ").Append(ServicePoint).Append("\n"); + 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/GetServicePointByIdResponseBodyServicePoint.cs b/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs new file mode 100644 index 00000000..a30bf9c1 --- /dev/null +++ b/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs @@ -0,0 +1,312 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// GetServicePointByIdResponseBodyServicePoint +/// +public partial class GetServicePointByIdResponseBodyServicePoint +{ + /// + /// Defines Features + /// + [JsonConverter(typeof(FeaturesEnumJsonConverter))] + public class FeaturesEnum + { + private string _value; + + internal FeaturesEnum() + { + _value = "drop_off_point"; + } + + public FeaturesEnum(string value) + { + + } + + /// + /// Enum DropOffPoint for value: drop_off_point + /// + public static FeaturesEnum DropOffPoint { get; } = new("drop_off_point"); + + + /// + /// Enum PickupPoint for value: pickup_point + /// + public static FeaturesEnum PickupPoint { get; } = new("pickup_point"); + + + /// + /// Enum PrintServices for value: print_services + /// + public static FeaturesEnum PrintServices { get; } = new("print_services"); + + + /// + /// Enum AfterHoursLocker for value: after_hours_locker + /// + public static FeaturesEnum AfterHoursLocker { get; } = new("after_hours_locker"); + + + /// + /// Enum AfterHoursDropbox for value: after_hours_dropbox + /// + public static FeaturesEnum AfterHoursDropbox { get; } = new("after_hours_dropbox"); + + + public override string ToString() => _value; + } + + internal class FeaturesEnumJsonConverter : JsonConverter + { + public override FeaturesEnum? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new FeaturesEnum(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, FeaturesEnum value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(FeaturesEnum); + } + + /// + /// Service point type + /// + /// Service point type + [JsonConverter(typeof(TypeEnumJsonConverter))] + public class TypeEnum + { + private string _value; + + internal TypeEnum() + { + _value = "pudo"; + } + + public TypeEnum(string value) + { + + } + + /// + /// Enum Pudo for value: pudo + /// + public static TypeEnum Pudo { get; } = new("pudo"); + + + /// + /// Enum Locker for value: locker + /// + public static TypeEnum Locker { get; } = new("locker"); + + + public override string ToString() => _value; + } + + internal class TypeEnumJsonConverter : JsonConverter + { + public override TypeEnum? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new TypeEnum(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, TypeEnum value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(TypeEnum); + } + + + /// + /// Service point type CLOVUS + /// + /// Service point type + [JsonPropertyName("type")] + public TypeEnum? Type { get; set; } + /// + /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// dhl_express + /// + [JsonPropertyName("carrier_code")] + public string CarrierCode { get; set; } + + /// + /// Gets or Sets ServiceCodes + /// + [JsonPropertyName("service_codes")] + public List ServiceCodes { get; set; } + + /// + /// A unique identifier for a carrier drop off point. + /// + /// A unique identifier for a carrier drop off point. + /// + /// 614940 + /// + [JsonPropertyName("service_point_id")] + public string ServicePointId { get; set; } + + /// + /// If this is a business address, then the company name should be specified here. + /// + /// If this is a business address, then the company name should be specified here. + /// + /// My fancy company name + /// + [JsonPropertyName("company_name")] + public string CompanyName { get; set; } + + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// PLACE DU CANADA + /// + [JsonPropertyName("address_line1")] + public string AddressLine1 { get; set; } + + /// + /// The name of the city or locality + /// + /// The name of the city or locality + /// + /// TRUN + /// + [JsonPropertyName("city_locality")] + public string CityLocality { get; set; } + + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// TRUN + /// + [JsonPropertyName("state_province")] + public string StateProvince { get; set; } + + /// + /// postal code + /// + /// postal code + /// + /// 78756-3717 + /// + [JsonPropertyName("postal_code")] + public string PostalCode { get; set; } + + /// + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// CA + /// + [JsonPropertyName("country_code")] + public string CountryCode { get; set; } + + /// + /// Phone number associated + /// + /// Phone number associated + /// + /// 555-555-5555 + /// + [JsonPropertyName("phone_number")] + public string PhoneNumber { get; set; } + + /// + /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html + /// + /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html + /// + /// 48.842608 + /// + [JsonPropertyName("lat")] + public double Lat { get; set; } + + /// + /// The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html + /// + /// The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html + /// + /// 0.032875 + /// + [JsonPropertyName("long")] + public double Long { get; set; } + + /// + /// Gets or Sets HoursOfOperation + /// + [JsonPropertyName("hours_of_operation")] + public ListServicePointsResponseBodyServicePointsInnerHoursOfOperation HoursOfOperation { get; set; } + + /// + /// Service features + /// + /// Service features + [JsonPropertyName("features")] + public List Features { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class GetServicePointByIdResponseBodyServicePoint {\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" ServiceCodes: ").Append(ServiceCodes).Append("\n"); + sb.Append(" ServicePointId: ").Append(ServicePointId).Append("\n"); + sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); + sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); + sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); + sb.Append(" PhoneNumber: ").Append(PhoneNumber).Append("\n"); + sb.Append(" Lat: ").Append(Lat).Append("\n"); + sb.Append(" Long: ").Append(Long).Append("\n"); + sb.Append(" HoursOfOperation: ").Append(HoursOfOperation).Append("\n"); + sb.Append(" Features: ").Append(Features).Append("\n"); + sb.Append(" Type: ").Append(Type).Append("\n"); + 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/GetServicePointsRequest.cs b/ShipEngineSDK/Model/GetServicePointsRequest.cs new file mode 100644 index 00000000..339e5b89 --- /dev/null +++ b/ShipEngineSDK/Model/GetServicePointsRequest.cs @@ -0,0 +1,223 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.IO; +using System.Linq; +using System.Reflection; +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; + +/// +/// GetServicePointsRequest +/// +[JsonConverter(typeof(GetServicePointsRequestJsonConverter))] +//[DataContract(Name = "get_service_points_request")] +public partial class GetServicePointsRequest : AbstractOpenAPISchema +{ + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of GetServicePointsRequestBody. + public GetServicePointsRequest(GetServicePointsRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + + private Object _actualInstance; + + /// + /// Gets or Sets ActualInstance + /// + public override Object ActualInstance + { + get + { + return _actualInstance; + } + set + { + if (value.GetType() == typeof(GetServicePointsRequestBody)) + { + this._actualInstance = value; + } + else + { + throw new ArgumentException("Invalid instance found. Must be the following types: GetServicePointsRequestBody"); + } + } + } + + /// + /// Get the actual instance of `GetServicePointsRequestBody`. If the actual instance is not `GetServicePointsRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of GetServicePointsRequestBody + public GetServicePointsRequestBody GetGetServicePointsRequestBody() + { + return (GetServicePointsRequestBody)this.ActualInstance; + } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class GetServicePointsRequest {\n"); + sb.Append(" ActualInstance: ").Append(this.ActualInstance).Append("\n"); + + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public override string ToJson() + { + return JsonSerializer.Serialize(this.ActualInstance, GetServicePointsRequest.SerializerSettings); + } + +} + +/// +/// Custom JSON converter for GetServicePointsRequest +/// +public class GetServicePointsRequestJsonConverter : JsonConverter +{ + private static HashSet OneOfTypes = [typeof(GetServicePointsRequestBody)]; + private static HashSet MandatoryFields = ["Providers"]; + private static JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) + { + TypeInfoResolver = new DefaultJsonTypeInfoResolver + { + Modifiers = + { + static typeInfo => + { + if (typeInfo.Kind != JsonTypeInfoKind.Object) + return; + + foreach (JsonPropertyInfo propertyInfo in typeInfo.Properties) + { + // Strip IsRequired constraint from every property except those which define the underlying type + if (OneOfTypes.Contains(typeInfo.Type)) + { + var underlyingPropertyName = (propertyInfo.AttributeProvider as MemberInfo)?.Name; + propertyInfo.IsRequired = underlyingPropertyName != null && MandatoryFields.Contains(underlyingPropertyName); + } + else + { + propertyInfo.IsRequired = false; + } + } + } + } + } + }; + + /// + /// To write the JSON string + /// + /// JSON writer + /// Object to be converted into a JSON string + /// Serializer options + public override void Write(Utf8JsonWriter writer, GetServicePointsRequest value, JsonSerializerOptions options) + { + writer.WriteStartObject(); + + + var node = JsonSerializer.SerializeToNode(value.ActualInstance, options); + foreach (var prop in node?.AsObject() ?? []) + { + if (prop.Value != null) + { + writer.WritePropertyName(prop.Key); + prop.Value.WriteTo(writer, options); + } + } + + writer.WriteEndObject(); + } + + /// + /// To convert a JSON string into an object + /// + /// JSON reader + /// Object type to convert + /// Serializer options + /// The object converted from the JSON string + public override GetServicePointsRequest Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + if (reader.TokenType == JsonTokenType.Null) + { + return null; + } + + var jsonDoc = JsonDocument.ParseValue(ref reader); + GetServicePointsRequest newGetServicePointsRequest = null; + + int match = 0; + var matchedTypes = new List(); + + try + { + newGetServicePointsRequest = new GetServicePointsRequest(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("GetServicePointsRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into GetServicePointsRequestBody: {1}", jsonDoc, exception.ToString())); + } + + if (match == 0) + { + throw new InvalidDataException("The JSON string `" + jsonDoc + "` cannot be deserialized into any schema defined."); + } + + if (match > 1) + { + throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); + } + + + // deserialization is considered successful at this point if no exception has been thrown. + return newGetServicePointsRequest; + } + + /// + /// Check if the object can be converted + /// + /// Object type + /// True if the object can be converted + public override bool CanConvert(Type objectType) + { + return typeof(GetServicePointsRequest).IsAssignableFrom(objectType); + } +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBody.cs b/ShipEngineSDK/Model/GetServicePointsRequestBody.cs new file mode 100644 index 00000000..08cc37c3 --- /dev/null +++ b/ShipEngineSDK/Model/GetServicePointsRequestBody.cs @@ -0,0 +1,131 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 get service points request body. Caller must provide exactly one of address_query, address, or lat / long pair. +/// +public partial class GetServicePointsRequestBody +{ + + /// + /// Unstructured text to search for service points by. + /// + /// Unstructured text to search for service points by. + /// + /// 177A Bleecker Street New York + /// + [JsonPropertyName("address_query")] + public string AddressQuery { get; set; } + + /// + /// Gets or Sets Address + /// + [JsonPropertyName("address")] + public GetServicePointsRequestBodyAddress Address { get; set; } + + /// + /// An array of shipping service providers and service codes + /// + /// An array of shipping service providers and service codes + [JsonPropertyName("providers")] + [JsonRequired] + public List Providers { get; set; } + + /// + /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html + /// + /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html + /// + /// 48.874518928233094 + /// + [JsonPropertyName("lat")] + public double Lat { get; set; } + + /// + /// The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html + /// + /// The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html + /// + /// 2.3591775711639404 + /// + [JsonPropertyName("long")] + public double Long { get; set; } + + /// + /// Search radius in kilometers + /// + /// Search radius in kilometers + /// + /// 500 + /// + [JsonPropertyName("radius")] + public int Radius { get; set; } + + /// + /// The maximum number of service points to return + /// + /// The maximum number of service points to return + /// + /// 25 + /// + [JsonPropertyName("max_results")] + public int MaxResults { get; set; } + + /// + /// Gets or Sets Shipment + /// + [JsonPropertyName("shipment")] + public GetServicePointsRequestBodyShipment Shipment { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class GetServicePointsRequestBody {\n"); + sb.Append(" AddressQuery: ").Append(AddressQuery).Append("\n"); + sb.Append(" Address: ").Append(Address).Append("\n"); + sb.Append(" Providers: ").Append(Providers).Append("\n"); + sb.Append(" Lat: ").Append(Lat).Append("\n"); + sb.Append(" Long: ").Append(Long).Append("\n"); + sb.Append(" Radius: ").Append(Radius).Append("\n"); + sb.Append(" MaxResults: ").Append(MaxResults).Append("\n"); + sb.Append(" Shipment: ").Append(Shipment).Append("\n"); + 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/GetServicePointsRequestBodyAddress.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs new file mode 100644 index 00000000..dab65357 --- /dev/null +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs @@ -0,0 +1,117 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Structured address to search by. +/// +public partial class GetServicePointsRequestBodyAddress +{ + + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// 1999 Bishop Grandin Blvd. + /// + [JsonPropertyName("address_line1")] + public string AddressLine1 { get; set; } + + /// + /// Gets or Sets AddressLine2 + /// + [JsonPropertyName("address_line2")] + public string AddressLine2 { get; set; } + + /// + /// Gets or Sets AddressLine3 + /// + [JsonPropertyName("address_line3")] + public string AddressLine3 { get; set; } + + /// + /// The name of the city or locality + /// + /// The name of the city or locality + [JsonPropertyName("city_locality")] + public string CityLocality { get; set; } + + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + [JsonPropertyName("state_province")] + public string StateProvince { get; set; } + + /// + /// postal code + /// + /// postal code + /// + /// 78756-3717 + /// + [JsonPropertyName("postal_code")] + public string PostalCode { get; set; } + + /// + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// CA + /// + [JsonPropertyName("country_code")] + [JsonRequired] + public string CountryCode { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class GetServicePointsRequestBodyAddress {\n"); + sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); + sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); + sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); + sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); + sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); + 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/GetServicePointsRequestBodyProvidersInner.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs new file mode 100644 index 00000000..2ba26e2c --- /dev/null +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs @@ -0,0 +1,71 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// GetServicePointsRequestBodyProvidersInner +/// +public partial class GetServicePointsRequestBodyProvidersInner +{ + + /// + /// Uniquely identifies a carrier connection + /// + /// Uniquely identifies a carrier connection + /// + /// se-123456 + /// + [JsonPropertyName("carrier_id")] + public string CarrierId { get; set; } + + /// + /// Gets or Sets ServiceCode + /// + [JsonPropertyName("service_code")] + public List ServiceCode { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class GetServicePointsRequestBodyProvidersInner {\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); + sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + 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/GetServicePointsRequestBodyShipment.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs new file mode 100644 index 00000000..b042e698 --- /dev/null +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs @@ -0,0 +1,61 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Shipment information to be used for service point selection +/// +public partial class GetServicePointsRequestBodyShipment +{ + + /// + /// Shipment total weight + /// + /// Shipment total weight + [JsonPropertyName("total_weight")] + public Weight TotalWeight { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class GetServicePointsRequestBodyShipment {\n"); + sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); + 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/GetWebhookByIdResponseBody.cs b/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs new file mode 100644 index 00000000..0f81be67 --- /dev/null +++ b/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs @@ -0,0 +1,94 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 get webhook id response body +/// +public partial class GetWebhookByIdResponseBody +{ + + /// + /// Gets or Sets Event CLOVUS + /// + [JsonPropertyName("event")] + [JsonRequired] + public WebhookEvent Event { get; set; } = new(); + + + /// + /// A string that uniquely identifies the webhook + /// + /// A string that uniquely identifies the webhook + /// + /// se-28529731 + /// + [JsonPropertyName("webhook_id")] + [JsonRequired] + public string WebhookId { get; set; } + + /// + /// The url that the webhook sends the request to + /// + /// The url that the webhook sends the request to + /// + /// http://api.shipengine.com/v1/labels/se-28529731 + /// + [JsonPropertyName("url")] + [JsonRequired] + public string Url { get; set; } + + /// + /// Array of custom webhook headers + /// + /// Array of custom webhook headers + [JsonPropertyName("headers")] + public List Headers { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class GetWebhookByIdResponseBody {\n"); + sb.Append(" WebhookId: ").Append(WebhookId).Append("\n"); + sb.Append(" Url: ").Append(Url).Append("\n"); + sb.Append(" Event: ").Append(Event).Append("\n"); + sb.Append(" Headers: ").Append(Headers).Append("\n"); + 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/IdentifierType.cs b/ShipEngineSDK/Model/IdentifierType.cs new file mode 100644 index 00000000..a2d28f19 --- /dev/null +++ b/ShipEngineSDK/Model/IdentifierType.cs @@ -0,0 +1,137 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Tax identifier type for customs declaration |Pickup Type | Description |- -- -- -- -- -- -- --|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`vat` | The tax identifier is a Value Added Tax. |`eori` | The tax identifier is an Economic Operators Registration and Identification Number (EORI). |`ssn` | The tax identifier is a Social Security Number. |`ein` | The tax identifier is an Employer Identification Number (EIN). |`tin` | The tax identifier is a Tax Identification Number (TIN). |`ioss` | The tax identifier is an Import One-Stop Shop (IOSS). |`pan` | The tax identifier is a Permanent Account Number (PAN). |`voec` | The tax identifier is a Norwegian VAT On E-Commerce(VOEC). |`pccc` | The tax identifier is a Personal Customs Clearance Code (PCCC). |`oss` | The tax identifier is an One-Stop Shop (OSS). |`passport` | The tax identifier is a Passport Number. |`abn` | The tax identifier is an Australian Business Number. +/// +/// Tax identifier type for customs declaration |Pickup Type | Description |- -- -- -- -- -- -- --|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`vat` | The tax identifier is a Value Added Tax. |`eori` | The tax identifier is an Economic Operators Registration and Identification Number (EORI). |`ssn` | The tax identifier is a Social Security Number. |`ein` | The tax identifier is an Employer Identification Number (EIN). |`tin` | The tax identifier is a Tax Identification Number (TIN). |`ioss` | The tax identifier is an Import One-Stop Shop (IOSS). |`pan` | The tax identifier is a Permanent Account Number (PAN). |`voec` | The tax identifier is a Norwegian VAT On E-Commerce(VOEC). |`pccc` | The tax identifier is a Personal Customs Clearance Code (PCCC). |`oss` | The tax identifier is an One-Stop Shop (OSS). |`passport` | The tax identifier is a Passport Number. |`abn` | The tax identifier is an Australian Business Number. +[JsonConverter(typeof(IdentifierTypeJsonConverter))] +public class IdentifierType +{ + private string _value; + + internal IdentifierType() + { + _value = "vat"; + } + + /// + /// Create a new instance of IdentifierType with a custom value. + /// + /// The value of the IdentifierType + /// + /// 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 IdentifierType(string value) + { + _value = value; + } + + /// + /// Enum Vat for value: vat + /// + public static IdentifierType Vat { get; } = new("vat"); + + + /// + /// Enum Eori for value: eori + /// + public static IdentifierType Eori { get; } = new("eori"); + + + /// + /// Enum Ssn for value: ssn + /// + public static IdentifierType Ssn { get; } = new("ssn"); + + + /// + /// Enum Ein for value: ein + /// + public static IdentifierType Ein { get; } = new("ein"); + + + /// + /// Enum Tin for value: tin + /// + public static IdentifierType Tin { get; } = new("tin"); + + + /// + /// Enum Ioss for value: ioss + /// + public static IdentifierType Ioss { get; } = new("ioss"); + + + /// + /// Enum Pan for value: pan + /// + public static IdentifierType Pan { get; } = new("pan"); + + + /// + /// Enum Voec for value: voec + /// + public static IdentifierType Voec { get; } = new("voec"); + + + /// + /// Enum Pccc for value: pccc + /// + public static IdentifierType Pccc { get; } = new("pccc"); + + + /// + /// Enum Oss for value: oss + /// + public static IdentifierType Oss { get; } = new("oss"); + + + /// + /// Enum Passport for value: passport + /// + public static IdentifierType Passport { get; } = new("passport"); + + + /// + /// Enum Abn for value: abn + /// + public static IdentifierType Abn { get; } = new("abn"); + + + public override string ToString() => _value; +} + +internal class IdentifierTypeJsonConverter : JsonConverter +{ + public override IdentifierType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new IdentifierType(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, IdentifierType value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(IdentifierType); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/ImporterOfRecords.cs b/ShipEngineSDK/Model/ImporterOfRecords.cs new file mode 100644 index 00000000..59826ed8 --- /dev/null +++ b/ShipEngineSDK/Model/ImporterOfRecords.cs @@ -0,0 +1,179 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// importer of records address, anywhere in the world. +/// +public partial class ImporterOfRecords +{ + + /// + /// The name of a contact person at this address. Either `name` or the `company_name` field should always be set. + /// + /// The name of a contact person at this address. Either `name` or the `company_name` field should always be set. + /// + /// John Doe + /// + [JsonPropertyName("name")] + [JsonRequired] + public string Name { get; set; } + + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// +1 204-253-9411 ext. 123 + /// + [JsonPropertyName("phone")] + public string Phone { get; set; } + + /// + /// Email for the address owner. + /// + /// Email for the address owner. + /// + /// example@example.com + /// + [JsonPropertyName("email")] + public string Email { get; set; } + + /// + /// If this is a business address, then the company name should be specified here. Either `name` or the `company_name` field should always be set. + /// + /// If this is a business address, then the company name should be specified here. Either `name` or the `company_name` field should always be set. + /// + /// The Home Depot + /// + [JsonPropertyName("company_name")] + public string CompanyName { get; set; } + + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// 1999 Bishop Grandin Blvd. + /// + [JsonPropertyName("address_line1")] + [JsonRequired] + public string AddressLine1 { get; set; } + + /// + /// The second line of the street address. For some addresses, this line may not be needed. + /// + /// The second line of the street address. For some addresses, this line may not be needed. + /// + /// Unit 408 + /// + [JsonPropertyName("address_line2")] + public string AddressLine2 { get; set; } + + /// + /// The third line of the street address. For some addresses, this line may not be needed. + /// + /// The third line of the street address. For some addresses, this line may not be needed. + /// + /// Building #7 + /// + [JsonPropertyName("address_line3")] + public string AddressLine3 { get; set; } + + /// + /// The name of the city or locality + /// + /// The name of the city or locality + /// + /// Winnipeg + /// + [JsonPropertyName("city_locality")] + [JsonRequired] + public string CityLocality { get; set; } + + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// Manitoba + /// + [JsonPropertyName("state_province")] + public string StateProvince { get; set; } + + /// + /// postal code + /// + /// postal code + /// + /// 78756-3717 + /// + [JsonPropertyName("postal_code")] + [JsonRequired] + public string PostalCode { get; set; } + + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// CA + /// + [JsonPropertyName("country_code")] + [JsonRequired] + public string CountryCode { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ImporterOfRecords {\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); + sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); + sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); + sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); + sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); + 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/InsuranceProvider.cs b/ShipEngineSDK/Model/InsuranceProvider.cs new file mode 100644 index 00000000..bc84496a --- /dev/null +++ b/ShipEngineSDK/Model/InsuranceProvider.cs @@ -0,0 +1,89 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible insurance provider values +/// +/// The possible insurance provider values +[JsonConverter(typeof(InsuranceProviderJsonConverter))] +public class InsuranceProvider +{ + private string _value; + + internal InsuranceProvider() + { + _value = "none"; + } + + /// + /// Create a new instance of InsuranceProvider with a custom value. + /// + /// The value of the InsuranceProvider + /// + /// 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 InsuranceProvider(string value) + { + _value = value; + } + + /// + /// Enum None for value: none + /// + public static InsuranceProvider None { get; } = new("none"); + + + /// + /// Enum Shipsurance for value: shipsurance + /// + public static InsuranceProvider Shipsurance { get; } = new("shipsurance"); + + + /// + /// Enum Carrier for value: carrier + /// + public static InsuranceProvider Carrier { get; } = new("carrier"); + + + /// + /// Enum ThirdParty for value: third_party + /// + public static InsuranceProvider ThirdParty { get; } = new("third_party"); + + + public override string ToString() => _value; +} + +internal class InsuranceProviderJsonConverter : JsonConverter +{ + public override InsuranceProvider? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new InsuranceProvider(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, InsuranceProvider value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(InsuranceProvider); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/InternationalShipmentOptions.cs b/ShipEngineSDK/Model/InternationalShipmentOptions.cs new file mode 100644 index 00000000..b5693447 --- /dev/null +++ b/ShipEngineSDK/Model/InternationalShipmentOptions.cs @@ -0,0 +1,119 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Options for international shipments, such as customs declarations. +/// +public partial class InternationalShipmentOptions +{ + + /// + /// The type of contents in this shipment. This may impact import duties or customs treatment. CLOVUS + /// + /// The type of contents in this shipment. This may impact import duties or customs treatment. + [JsonPropertyName("contents")] + [JsonRequired] + public PackageContents Contents { get; set; } = new(); + + + /// + /// Indicates what to do if a package is unable to be delivered. CLOVUS + /// + /// Indicates what to do if a package is unable to be delivered. + [JsonPropertyName("non_delivery")] + [JsonRequired] + public NonDelivery NonDelivery { get; set; } = new(); + + + /// + /// Specifies the supported terms of trade code (incoterms) CLOVUS + /// + /// Specifies the supported terms of trade code (incoterms) + [JsonPropertyName("terms_of_trade_code")] + public AllowedIncoterms? TermsOfTradeCode { get; set; } + /// + /// Explanation for contents (required if the `contents` is provided as `other`) + /// + /// Explanation for contents (required if the `contents` is provided as `other`) + [JsonPropertyName("contents_explanation")] + public string ContentsExplanation { get; set; } + + /// + /// Declaration statement to be placed on the commercial invoice + /// + /// Declaration statement to be placed on the commercial invoice + [JsonPropertyName("declaration")] + public string Declaration { get; set; } + + /// + /// Gets or Sets InvoiceAdditionalDetails + /// + [JsonPropertyName("invoice_additional_details")] + public InvoiceAdditionalDetails InvoiceAdditionalDetails { get; set; } + + /// + /// Gets or Sets ImporterOfRecord + /// + [JsonPropertyName("importer_of_record")] + public ImporterOfRecords ImporterOfRecord { get; set; } + + /// + /// Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`) + /// + /// Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`) + [JsonPropertyName("customs_items")] + [Obsolete] + public List CustomsItems { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class InternationalShipmentOptions {\n"); + sb.Append(" Contents: ").Append(Contents).Append("\n"); + sb.Append(" ContentsExplanation: ").Append(ContentsExplanation).Append("\n"); + sb.Append(" NonDelivery: ").Append(NonDelivery).Append("\n"); + sb.Append(" TermsOfTradeCode: ").Append(TermsOfTradeCode).Append("\n"); + sb.Append(" Declaration: ").Append(Declaration).Append("\n"); + sb.Append(" InvoiceAdditionalDetails: ").Append(InvoiceAdditionalDetails).Append("\n"); + sb.Append(" ImporterOfRecord: ").Append(ImporterOfRecord).Append("\n"); + sb.Append(" CustomsItems: ").Append(CustomsItems).Append("\n"); + 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/InvoiceAdditionalDetails.cs b/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs new file mode 100644 index 00000000..8a28d057 --- /dev/null +++ b/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs @@ -0,0 +1,93 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The additional information to put on commercial invoice +/// +public partial class InvoiceAdditionalDetails +{ + + /// + /// Freight Charge for shipment. + /// + /// Freight Charge for shipment. + [JsonPropertyName("freight_charge")] + public MonetaryValue FreightCharge { get; set; } + + /// + /// Insurance Charge for shipment. + /// + /// Insurance Charge for shipment. + [JsonPropertyName("insurance_charge")] + public MonetaryValue InsuranceCharge { get; set; } + + /// + /// Discount for shipment. + /// + /// Discount for shipment. + [JsonPropertyName("discount")] + public MonetaryValue Discount { get; set; } + + /// + /// Other charge for shipment. + /// + /// Other charge for shipment. + [JsonPropertyName("other_charge")] + public MonetaryValue OtherCharge { get; set; } + + /// + /// Description for the other charge (if provided). + /// + /// Description for the other charge (if provided). + [JsonPropertyName("other_charge_description")] + public string OtherChargeDescription { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class InvoiceAdditionalDetails {\n"); + sb.Append(" FreightCharge: ").Append(FreightCharge).Append("\n"); + sb.Append(" InsuranceCharge: ").Append(InsuranceCharge).Append("\n"); + sb.Append(" Discount: ").Append(Discount).Append("\n"); + sb.Append(" OtherCharge: ").Append(OtherCharge).Append("\n"); + sb.Append(" OtherChargeDescription: ").Append(OtherChargeDescription).Append("\n"); + 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/LabelChargeEvent.cs b/ShipEngineSDK/Model/LabelChargeEvent.cs new file mode 100644 index 00000000..91f12aff --- /dev/null +++ b/ShipEngineSDK/Model/LabelChargeEvent.cs @@ -0,0 +1,83 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Determines when the user's account will be charged for the label. +/// +/// Determines when the user's account will be charged for the label. +[JsonConverter(typeof(LabelChargeEventJsonConverter))] +public class LabelChargeEvent +{ + private string _value; + + internal LabelChargeEvent() + { + _value = "carrier_default"; + } + + /// + /// Create a new instance of LabelChargeEvent with a custom value. + /// + /// The value of the LabelChargeEvent + /// + /// 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 LabelChargeEvent(string value) + { + _value = value; + } + + /// + /// Enum CarrierDefault for value: carrier_default + /// + public static LabelChargeEvent CarrierDefault { get; } = new("carrier_default"); + + + /// + /// Enum OnCreation for value: on_creation + /// + public static LabelChargeEvent OnCreation { get; } = new("on_creation"); + + + /// + /// Enum OnCarrierAcceptance for value: on_carrier_acceptance + /// + public static LabelChargeEvent OnCarrierAcceptance { get; } = new("on_carrier_acceptance"); + + + public override string ToString() => _value; +} + +internal class LabelChargeEventJsonConverter : JsonConverter +{ + public override LabelChargeEvent? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new LabelChargeEvent(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, LabelChargeEvent value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(LabelChargeEvent); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/LabelDownload.cs b/ShipEngineSDK/Model/LabelDownload.cs new file mode 100644 index 00000000..e98853c8 --- /dev/null +++ b/ShipEngineSDK/Model/LabelDownload.cs @@ -0,0 +1,97 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Reference to the various downloadable file formats for the generated label +/// +public partial class LabelDownload +{ + + /// + /// The URL of the linked resource, if any + /// + /// The URL of the linked resource, if any + /// + /// http://api.shipengine.com/v1/labels/se-28529731 + /// + [JsonPropertyName("href")] + public string Href { get; set; } + + /// + /// The URL for the pdf generated label + /// + /// The URL for the pdf generated label + /// + /// http://api.shipengine.com/v1/labels/se-28529731 + /// + [JsonPropertyName("pdf")] + public string Pdf { get; set; } + + /// + /// The URL for the png generated label + /// + /// The URL for the png generated label + /// + /// http://api.shipengine.com/v1/labels/se-28529731 + /// + [JsonPropertyName("png")] + public string Png { get; set; } + + /// + /// The URL for the zpl generated label + /// + /// The URL for the zpl generated label + /// + /// http://api.shipengine.com/v1/labels/se-28529731 + /// + [JsonPropertyName("zpl")] + public string Zpl { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class LabelDownload {\n"); + sb.Append(" Href: ").Append(Href).Append("\n"); + sb.Append(" Pdf: ").Append(Pdf).Append("\n"); + sb.Append(" Png: ").Append(Png).Append("\n"); + sb.Append(" Zpl: ").Append(Zpl).Append("\n"); + 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/LabelDownloadType.cs b/ShipEngineSDK/Model/LabelDownloadType.cs new file mode 100644 index 00000000..17108609 --- /dev/null +++ b/ShipEngineSDK/Model/LabelDownloadType.cs @@ -0,0 +1,77 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// There are two different ways to [download a label](https://www.shipengine.com/docs/labels/downloading/): |Label Download Type | Description |- -- -- -- -- -- -- -- -- -- -|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- - |`url` |You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days.<br><br>This is the default if `label_download_type` is unspecified. |`inline` |You will receive the Base64-encoded label as part of the response. No need for a second request to download the label. +/// +/// There are two different ways to [download a label](https://www.shipengine.com/docs/labels/downloading/): |Label Download Type | Description |- -- -- -- -- -- -- -- -- -- -|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- - |`url` |You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days.<br><br>This is the default if `label_download_type` is unspecified. |`inline` |You will receive the Base64-encoded label as part of the response. No need for a second request to download the label. +[JsonConverter(typeof(LabelDownloadTypeJsonConverter))] +public class LabelDownloadType +{ + private string _value; + + internal LabelDownloadType() + { + _value = "url"; + } + + /// + /// Create a new instance of LabelDownloadType with a custom value. + /// + /// The value of the LabelDownloadType + /// + /// 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 LabelDownloadType(string value) + { + _value = value; + } + + /// + /// Enum Url for value: url + /// + public static LabelDownloadType Url { get; } = new("url"); + + + /// + /// Enum Inline for value: inline + /// + public static LabelDownloadType Inline { get; } = new("inline"); + + + public override string ToString() => _value; +} + +internal class LabelDownloadTypeJsonConverter : JsonConverter +{ + public override LabelDownloadType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new LabelDownloadType(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, LabelDownloadType value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(LabelDownloadType); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/LabelFormat.cs b/ShipEngineSDK/Model/LabelFormat.cs new file mode 100644 index 00000000..80868af5 --- /dev/null +++ b/ShipEngineSDK/Model/LabelFormat.cs @@ -0,0 +1,83 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible file formats in which shipping labels can be downloaded. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. |Label Format | Supported Carriers |- -- -- -- -- -- -- -|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`pdf` | All carriers |`png` | `fedex` <br> `stamps_com` <br> `ups` <br> `usps` |`zpl` | `access_worldwide` <br> `apc` <br> `asendia` <br> `dhl_global_mail` <br> `dhl_express` <br> `dhl_express_australia` <br> `dhl_express_canada` <br> `dhl_express_worldwide` <br> `dhl_express_uk` <br> `dpd` <br> `endicia` <br> `fedex` <br> `fedex_uk` <br> `firstmile` <br> `imex` <br> `newgistics` <br> `ontrac` <br> `rr_donnelley` <br> `stamps_com` <br> `ups` <br> `usps` +/// +/// The possible file formats in which shipping labels can be downloaded. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. |Label Format | Supported Carriers |- -- -- -- -- -- -- -|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`pdf` | All carriers |`png` | `fedex` <br> `stamps_com` <br> `ups` <br> `usps` |`zpl` | `access_worldwide` <br> `apc` <br> `asendia` <br> `dhl_global_mail` <br> `dhl_express` <br> `dhl_express_australia` <br> `dhl_express_canada` <br> `dhl_express_worldwide` <br> `dhl_express_uk` <br> `dpd` <br> `endicia` <br> `fedex` <br> `fedex_uk` <br> `firstmile` <br> `imex` <br> `newgistics` <br> `ontrac` <br> `rr_donnelley` <br> `stamps_com` <br> `ups` <br> `usps` +[JsonConverter(typeof(LabelFormatJsonConverter))] +public class LabelFormat +{ + private string _value; + + internal LabelFormat() + { + _value = "pdf"; + } + + /// + /// Create a new instance of LabelFormat with a custom value. + /// + /// The value of the LabelFormat + /// + /// 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 LabelFormat(string value) + { + _value = value; + } + + /// + /// Enum Pdf for value: pdf + /// + public static LabelFormat Pdf { get; } = new("pdf"); + + + /// + /// Enum Png for value: png + /// + public static LabelFormat Png { get; } = new("png"); + + + /// + /// Enum Zpl for value: zpl + /// + public static LabelFormat Zpl { get; } = new("zpl"); + + + public override string ToString() => _value; +} + +internal class LabelFormatJsonConverter : JsonConverter +{ + public override LabelFormat? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new LabelFormat(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, LabelFormat value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(LabelFormat); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/LabelLayout.cs b/ShipEngineSDK/Model/LabelLayout.cs new file mode 100644 index 00000000..d1c51518 --- /dev/null +++ b/ShipEngineSDK/Model/LabelLayout.cs @@ -0,0 +1,77 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format. +/// +/// The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format. +[JsonConverter(typeof(LabelLayoutJsonConverter))] +public class LabelLayout +{ + private string _value; + + internal LabelLayout() + { + _value = "4x6"; + } + + /// + /// Create a new instance of LabelLayout with a custom value. + /// + /// The value of the LabelLayout + /// + /// 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 LabelLayout(string value) + { + _value = value; + } + + /// + /// Enum _4x6 for value: 4x6 + /// + public static LabelLayout _4x6 { get; } = new("4x6"); + + + /// + /// Enum Letter for value: letter + /// + public static LabelLayout Letter { get; } = new("letter"); + + + public override string ToString() => _value; +} + +internal class LabelLayoutJsonConverter : JsonConverter +{ + public override LabelLayout? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new LabelLayout(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, LabelLayout value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(LabelLayout); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/LabelMessages.cs b/ShipEngineSDK/Model/LabelMessages.cs new file mode 100644 index 00000000..fb3dbc19 --- /dev/null +++ b/ShipEngineSDK/Model/LabelMessages.cs @@ -0,0 +1,80 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Custom messages to print on the shipping label for the package. These are typically used to print invoice numbers, product numbers, or other internal reference numbers. Not all carriers support label messages. The number of lines and the maximum length of each line also varies by carrier. |Carrier |Max lines |Max line length |- -- -- -- -- -- -- -- -- --|- -- -- -- -- -|- -- -- -- -- -- -- -- -- -- - |USPS (Stamps.com) |3 |60 |FedEx |3 |35 for the first line. 30 for additional lines. |UPS |2 |35 |OnTrac |2 |25 +/// +public partial class LabelMessages +{ + + /// + /// The first line of the custom label message. Some carriers may prefix this line with something like \"REF\", \"Reference\", \"Trx Ref No.\", etc. + /// + /// The first line of the custom label message. Some carriers may prefix this line with something like \"REF\", \"Reference\", \"Trx Ref No.\", etc. + [JsonPropertyName("reference1")] + [JsonRequired] + public string Reference1 { get; set; } + + /// + /// The second line of the custom label message. Some carriers may prefix this line with something like \"INV\", \"Reference 2\", \"Trx Ref No.\", etc. + /// + /// The second line of the custom label message. Some carriers may prefix this line with something like \"INV\", \"Reference 2\", \"Trx Ref No.\", etc. + [JsonPropertyName("reference2")] + [JsonRequired] + public string Reference2 { get; set; } + + /// + /// The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc. + /// + /// The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc. + [JsonPropertyName("reference3")] + [JsonRequired] + public string Reference3 { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class LabelMessages {\n"); + sb.Append(" Reference1: ").Append(Reference1).Append("\n"); + sb.Append(" Reference2: ").Append(Reference2).Append("\n"); + sb.Append(" Reference3: ").Append(Reference3).Append("\n"); + 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/LabelPackagesInner.cs b/ShipEngineSDK/Model/LabelPackagesInner.cs new file mode 100644 index 00000000..af933312 --- /dev/null +++ b/ShipEngineSDK/Model/LabelPackagesInner.cs @@ -0,0 +1,185 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// LabelPackagesInner +/// +public partial class LabelPackagesInner +{ + + /// + /// A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/) + /// + /// A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/) + /// + /// se-28529731 + /// + [JsonPropertyName("package_id")] + public string PackageId { get; set; } + + /// + /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// + /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// + /// small_flat_rate_box + /// + [JsonPropertyName("package_code")] + public string PackageCode { get; set; } + + /// + /// A short description of the package content. Required for shipments moving to, from, and through Mexico. + /// + /// A short description of the package content. Required for shipments moving to, from, and through Mexico. + /// + /// Hand knitted wool socks + /// + [JsonPropertyName("content_description")] + public string ContentDescription { get; set; } + + /// + /// The package weight + /// + /// The package weight + [JsonPropertyName("weight")] + [JsonRequired] + public Weight Weight { get; set; } + + /// + /// The package dimensions + /// + /// The package dimensions + [JsonPropertyName("dimensions")] + public Dimensions Dimensions { get; set; } + + /// + /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. + /// + /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. + [JsonPropertyName("insured_value")] + public MonetaryValue InsuredValue { get; set; } + + /// + /// The tracking number for the package. The format depends on the carrier. + /// + /// The tracking number for the package. The format depends on the carrier. + /// + /// 1Z932R800392060079 + /// + [JsonPropertyName("tracking_number")] + public string TrackingNumber { get; set; } + + /// + /// Gets or Sets LabelMessages + /// + [JsonPropertyName("label_messages")] + public LabelMessages LabelMessages { get; set; } + + /// + /// An external package id. + /// + /// An external package id. + [JsonPropertyName("external_package_id")] + public string ExternalPackageId { get; set; } + + /// + /// The label download for the package + /// + /// The label download for the package + [JsonPropertyName("label_download")] + public LabelDownload LabelDownload { get; set; } + + /// + /// The form download for any customs that are needed + /// + /// The form download for any customs that are needed + [JsonPropertyName("form_download")] + public OptionalLink FormDownload { get; set; } + + /// + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + [JsonPropertyName("paperless_download")] + public PaperlessDownload PaperlessDownload { get; set; } + + /// + /// Package sequence + /// + /// Package sequence + [JsonPropertyName("sequence")] + public int Sequence { get; set; } + + /// + /// Details about products inside packages (Information provided would be used on custom documentation) + /// + /// Details about products inside packages (Information provided would be used on custom documentation) + [JsonPropertyName("products")] + public List Products { get; set; } + + /// + /// Alternative identifiers associated with this package. + /// + /// Alternative identifiers associated with this package. + [JsonPropertyName("alternative_identifiers")] + public List AlternativeIdentifiers { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class LabelPackagesInner {\n"); + sb.Append(" PackageId: ").Append(PackageId).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); + sb.Append(" ContentDescription: ").Append(ContentDescription).Append("\n"); + sb.Append(" Weight: ").Append(Weight).Append("\n"); + sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); + sb.Append(" InsuredValue: ").Append(InsuredValue).Append("\n"); + sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); + sb.Append(" LabelMessages: ").Append(LabelMessages).Append("\n"); + sb.Append(" ExternalPackageId: ").Append(ExternalPackageId).Append("\n"); + sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); + sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); + sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" Sequence: ").Append(Sequence).Append("\n"); + sb.Append(" Products: ").Append(Products).Append("\n"); + sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); + 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/LabelStatus.cs b/ShipEngineSDK/Model/LabelStatus.cs new file mode 100644 index 00000000..e999ab27 --- /dev/null +++ b/ShipEngineSDK/Model/LabelStatus.cs @@ -0,0 +1,89 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible statuses that a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/) can be in. |Status |Description |:- -- -- -- -- -- -|:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`processing` |When labels are created in a [batch](https://www.shipengine.com/docs/labels/bulk/), it may take a few minutes for all of the labels in the batch to be created. During this period, they will be in `processing` status. |`completed` |The label was successfully created |`error` |The label could not be created due to an error, such as an invalid delivery address |`voided` |The label has been [voided](https://www.shipengine.com/docs/labels/voiding/) +/// +/// The possible statuses that a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/) can be in. |Status |Description |:- -- -- -- -- -- -|:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`processing` |When labels are created in a [batch](https://www.shipengine.com/docs/labels/bulk/), it may take a few minutes for all of the labels in the batch to be created. During this period, they will be in `processing` status. |`completed` |The label was successfully created |`error` |The label could not be created due to an error, such as an invalid delivery address |`voided` |The label has been [voided](https://www.shipengine.com/docs/labels/voiding/) +[JsonConverter(typeof(LabelStatusJsonConverter))] +public class LabelStatus +{ + private string _value; + + internal LabelStatus() + { + _value = "processing"; + } + + /// + /// Create a new instance of LabelStatus with a custom value. + /// + /// The value of the LabelStatus + /// + /// 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 LabelStatus(string value) + { + _value = value; + } + + /// + /// Enum Processing for value: processing + /// + public static LabelStatus Processing { get; } = new("processing"); + + + /// + /// Enum Completed for value: completed + /// + public static LabelStatus Completed { get; } = new("completed"); + + + /// + /// Enum Error for value: error + /// + public static LabelStatus Error { get; } = new("error"); + + + /// + /// Enum Voided for value: voided + /// + public static LabelStatus Voided { get; } = new("voided"); + + + public override string ToString() => _value; +} + +internal class LabelStatusJsonConverter : JsonConverter +{ + public override LabelStatus? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new LabelStatus(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, LabelStatus value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(LabelStatus); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/Link.cs b/ShipEngineSDK/Model/Link.cs new file mode 100644 index 00000000..b5ed45b9 --- /dev/null +++ b/ShipEngineSDK/Model/Link.cs @@ -0,0 +1,73 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 link to a related resource +/// +public partial class Link +{ + + /// + /// The URL of the linked resource, if any + /// + /// The URL of the linked resource, if any + /// + /// http://api.shipengine.com/v1/labels/se-28529731 + /// + [JsonPropertyName("href")] + [JsonRequired] + public string Href { get; set; } + + /// + /// The type of resource, or the type of relationship to the parent resource + /// + /// The type of resource, or the type of relationship to the parent resource + [JsonPropertyName("type")] + public string Type { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class Link {\n"); + sb.Append(" Href: ").Append(Href).Append("\n"); + sb.Append(" Type: ").Append(Type).Append("\n"); + 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/ListAccountSettingsBody.cs b/ShipEngineSDK/Model/ListAccountSettingsBody.cs new file mode 100644 index 00000000..51db7928 --- /dev/null +++ b/ShipEngineSDK/Model/ListAccountSettingsBody.cs @@ -0,0 +1,59 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An account settings list response body +/// +public partial class ListAccountSettingsBody +{ + + /// + /// Gets or Sets DefaultLabelLayout CLOVUS + /// + [JsonPropertyName("default_label_layout")] + public DefaultLabelLayout? DefaultLabelLayout { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ListAccountSettingsBody {\n"); + sb.Append(" DefaultLabelLayout: ").Append(DefaultLabelLayout).Append("\n"); + 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/ListBatchErrorsResponseBody.cs b/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs new file mode 100644 index 00000000..6648bc9a --- /dev/null +++ b/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs @@ -0,0 +1,70 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 batch errors response body +/// +public partial class ListBatchErrorsResponseBody +{ + + /// + /// The errors currently associated with the batch + /// + /// The errors currently associated with the batch + [JsonPropertyName("errors")] + [JsonRequired] + public List Errors { get; set; } + + /// + /// Gets or Sets Links + /// + [JsonPropertyName("links")] + [JsonRequired] + public PaginationLink Links { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ListBatchErrorsResponseBody {\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); + sb.Append(" Links: ").Append(Links).Append("\n"); + 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/ListBatchesResponseBody.cs b/ShipEngineSDK/Model/ListBatchesResponseBody.cs new file mode 100644 index 00000000..c0933199 --- /dev/null +++ b/ShipEngineSDK/Model/ListBatchesResponseBody.cs @@ -0,0 +1,106 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 list batch response body +/// +public partial class ListBatchesResponseBody +{ + + /// + /// Batch List + /// + /// Batch List + [JsonPropertyName("batches")] + [JsonRequired] + public List Batches { get; set; } + + /// + /// The total number of batches the API call returned + /// + /// The total number of batches the API call returned + /// + /// 10 + /// + [JsonPropertyName("total")] + [JsonRequired] + public long Total { get; set; } + + /// + /// The page that is currently being read + /// + /// The page that is currently being read + /// + /// 1 + /// + [JsonPropertyName("page")] + [JsonRequired] + public int Page { get; set; } + + /// + /// The total number of batch pages the API call returned + /// + /// The total number of batch pages the API call returned + /// + /// 10 + /// + [JsonPropertyName("pages")] + [JsonRequired] + public int Pages { get; set; } + + /// + /// Gets or Sets Links + /// + [JsonPropertyName("links")] + [JsonRequired] + public PaginationLink Links { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ListBatchesResponseBody {\n"); + sb.Append(" Batches: ").Append(Batches).Append("\n"); + sb.Append(" Total: ").Append(Total).Append("\n"); + sb.Append(" Page: ").Append(Page).Append("\n"); + sb.Append(" Pages: ").Append(Pages).Append("\n"); + sb.Append(" Links: ").Append(Links).Append("\n"); + 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/ListCarrierPackageTypesResponseBody.cs b/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs new file mode 100644 index 00000000..72fa7160 --- /dev/null +++ b/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs @@ -0,0 +1,61 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 list carrier package types response body +/// +public partial class ListCarrierPackageTypesResponseBody +{ + + /// + /// An array of custom package types + /// + /// An array of custom package types + [JsonPropertyName("packages")] + public List Packages { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ListCarrierPackageTypesResponseBody {\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); + 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/ListCarrierServicesResponseBody.cs b/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs new file mode 100644 index 00000000..09c8620d --- /dev/null +++ b/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs @@ -0,0 +1,61 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 carrier list services response body +/// +public partial class ListCarrierServicesResponseBody +{ + + /// + /// An array of services associated with the carrier + /// + /// An array of services associated with the carrier + [JsonPropertyName("services")] + public List Services { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ListCarrierServicesResponseBody {\n"); + sb.Append(" Services: ").Append(Services).Append("\n"); + 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/ListCarriersResponseBody.cs b/ShipEngineSDK/Model/ListCarriersResponseBody.cs new file mode 100644 index 00000000..0cc2ebba --- /dev/null +++ b/ShipEngineSDK/Model/ListCarriersResponseBody.cs @@ -0,0 +1,62 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 carrier list response body +/// +public partial class ListCarriersResponseBody +{ + + /// + /// The carrier response body + /// + /// The carrier response body + [JsonPropertyName("carriers")] + [JsonRequired] + public List Carriers { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ListCarriersResponseBody {\n"); + sb.Append(" Carriers: ").Append(Carriers).Append("\n"); + 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/ListManifestsResponseBody.cs b/ShipEngineSDK/Model/ListManifestsResponseBody.cs new file mode 100644 index 00000000..3f7b16b4 --- /dev/null +++ b/ShipEngineSDK/Model/ListManifestsResponseBody.cs @@ -0,0 +1,107 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 list manifests response body +/// +public partial class ListManifestsResponseBody +{ + + /// + /// The list of available manifests + /// + /// The list of available manifests + [JsonPropertyName("manifests")] + [JsonRequired] + public List Manifests { get; set; } + + /// + /// The total number of manifests returned + /// + /// The total number of manifests returned + /// + /// 3 + /// + [JsonPropertyName("total")] + [JsonRequired] + public long Total { get; set; } + + /// + /// Current page of the list manifests results + /// + /// Current page of the list manifests results + /// + /// 3 + /// + [JsonPropertyName("page")] + [JsonRequired] + public int Page { get; set; } + + /// + /// Total number of pages for list manifests results + /// + /// Total number of pages for list manifests results + /// + /// 4 + /// + [JsonPropertyName("pages")] + [JsonRequired] + public int Pages { get; set; } + + /// + /// Helpful links to other pages of results + /// + /// Helpful links to other pages of results + [JsonPropertyName("links")] + [JsonRequired] + public PaginationLink Links { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ListManifestsResponseBody {\n"); + sb.Append(" Manifests: ").Append(Manifests).Append("\n"); + sb.Append(" Total: ").Append(Total).Append("\n"); + sb.Append(" Page: ").Append(Page).Append("\n"); + sb.Append(" Pages: ").Append(Pages).Append("\n"); + sb.Append(" Links: ").Append(Links).Append("\n"); + 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/ListPackageTypesResponseBody.cs b/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs new file mode 100644 index 00000000..1b4b368d --- /dev/null +++ b/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs @@ -0,0 +1,61 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 list package types response body +/// +public partial class ListPackageTypesResponseBody +{ + + /// + /// An array of custom package types + /// + /// An array of custom package types + [JsonPropertyName("packages")] + public List Packages { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ListPackageTypesResponseBody {\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); + 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/ListPickupResponseBody.cs b/ShipEngineSDK/Model/ListPickupResponseBody.cs new file mode 100644 index 00000000..8a13dd93 --- /dev/null +++ b/ShipEngineSDK/Model/ListPickupResponseBody.cs @@ -0,0 +1,107 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 list pickup response body +/// +public partial class ListPickupResponseBody +{ + + /// + /// An array of pickups associated with the user's account. + /// + /// An array of pickups associated with the user's account. + [JsonPropertyName("pickups")] + [JsonRequired] + public List Pickups { get; set; } + + /// + /// The total number of pickups returned + /// + /// The total number of pickups returned + /// + /// 3 + /// + [JsonPropertyName("total")] + [JsonRequired] + public long Total { get; set; } + + /// + /// Current page of the list pickups results + /// + /// Current page of the list pickups results + /// + /// 3 + /// + [JsonPropertyName("page")] + [JsonRequired] + public int Page { get; set; } + + /// + /// Total number of pages for list pickups results + /// + /// Total number of pages for list pickups results + /// + /// 4 + /// + [JsonPropertyName("pages")] + [JsonRequired] + public int Pages { get; set; } + + /// + /// Helpful links to other pages of results + /// + /// Helpful links to other pages of results + [JsonPropertyName("links")] + [JsonRequired] + public PaginationLink Links { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ListPickupResponseBody {\n"); + sb.Append(" Pickups: ").Append(Pickups).Append("\n"); + sb.Append(" Total: ").Append(Total).Append("\n"); + sb.Append(" Page: ").Append(Page).Append("\n"); + sb.Append(" Pages: ").Append(Pages).Append("\n"); + sb.Append(" Links: ").Append(Links).Append("\n"); + 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/ListServicePointsResponseBody.cs b/ShipEngineSDK/Model/ListServicePointsResponseBody.cs new file mode 100644 index 00000000..d48caaca --- /dev/null +++ b/ShipEngineSDK/Model/ListServicePointsResponseBody.cs @@ -0,0 +1,90 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 list service points response body +/// +public partial class ListServicePointsResponseBody +{ + + /// + /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html + /// + /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html + /// + /// 48.842608 + /// + [JsonPropertyName("lat")] + public double Lat { get; set; } + + /// + /// The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html + /// + /// The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html + /// + /// 0.032875 + /// + [JsonPropertyName("long")] + public double Long { get; set; } + + /// + /// Gets or Sets ServicePoints + /// + [JsonPropertyName("service_points")] + public List ServicePoints { get; set; } + + /// + /// The errors associated with the failed API call + /// + /// The errors associated with the failed API call + [JsonPropertyName("errors")] + public List Errors { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ListServicePointsResponseBody {\n"); + sb.Append(" Lat: ").Append(Lat).Append("\n"); + sb.Append(" Long: ").Append(Long).Append("\n"); + sb.Append(" ServicePoints: ").Append(ServicePoints).Append("\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); + 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/ListServicePointsResponseBodyServicePointsInner.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs new file mode 100644 index 00000000..f822ea2c --- /dev/null +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs @@ -0,0 +1,323 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// ListServicePointsResponseBodyServicePointsInner +/// +public partial class ListServicePointsResponseBodyServicePointsInner +{ + /// + /// Defines Features + /// + [JsonConverter(typeof(FeaturesEnumJsonConverter))] + public class FeaturesEnum + { + private string _value; + + internal FeaturesEnum() + { + _value = "drop_off_point"; + } + + public FeaturesEnum(string value) + { + + } + + /// + /// Enum DropOffPoint for value: drop_off_point + /// + public static FeaturesEnum DropOffPoint { get; } = new("drop_off_point"); + + + /// + /// Enum PickupPoint for value: pickup_point + /// + public static FeaturesEnum PickupPoint { get; } = new("pickup_point"); + + + /// + /// Enum PrintServices for value: print_services + /// + public static FeaturesEnum PrintServices { get; } = new("print_services"); + + + /// + /// Enum AfterHoursLocker for value: after_hours_locker + /// + public static FeaturesEnum AfterHoursLocker { get; } = new("after_hours_locker"); + + + /// + /// Enum AfterHoursDropbox for value: after_hours_dropbox + /// + public static FeaturesEnum AfterHoursDropbox { get; } = new("after_hours_dropbox"); + + + public override string ToString() => _value; + } + + internal class FeaturesEnumJsonConverter : JsonConverter + { + public override FeaturesEnum? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new FeaturesEnum(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, FeaturesEnum value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(FeaturesEnum); + } + + /// + /// Service point type + /// + /// Service point type + [JsonConverter(typeof(TypeEnumJsonConverter))] + public class TypeEnum + { + private string _value; + + internal TypeEnum() + { + _value = "pudo"; + } + + public TypeEnum(string value) + { + + } + + /// + /// Enum Pudo for value: pudo + /// + public static TypeEnum Pudo { get; } = new("pudo"); + + + /// + /// Enum Locker for value: locker + /// + public static TypeEnum Locker { get; } = new("locker"); + + + public override string ToString() => _value; + } + + internal class TypeEnumJsonConverter : JsonConverter + { + public override TypeEnum? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new TypeEnum(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, TypeEnum value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(TypeEnum); + } + + + /// + /// Service point type CLOVUS + /// + /// Service point type + [JsonPropertyName("type")] + public TypeEnum? Type { get; set; } + /// + /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// dhl_express + /// + [JsonPropertyName("carrier_code")] + public string CarrierCode { get; set; } + + /// + /// Gets or Sets ServiceCodes + /// + [JsonPropertyName("service_codes")] + public List ServiceCodes { get; set; } + + /// + /// A unique identifier for a carrier drop off point. + /// + /// A unique identifier for a carrier drop off point. + /// + /// 614940 + /// + [JsonPropertyName("service_point_id")] + public string ServicePointId { get; set; } + + /// + /// If this is a business address, then the company name should be specified here. + /// + /// If this is a business address, then the company name should be specified here. + /// + /// My fancy company name + /// + [JsonPropertyName("company_name")] + public string CompanyName { get; set; } + + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// PLACE DU CANADA + /// + [JsonPropertyName("address_line1")] + public string AddressLine1 { get; set; } + + /// + /// The name of the city or locality + /// + /// The name of the city or locality + /// + /// TRUN + /// + [JsonPropertyName("city_locality")] + public string CityLocality { get; set; } + + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// TRUN + /// + [JsonPropertyName("state_province")] + public string StateProvince { get; set; } + + /// + /// postal code + /// + /// postal code + /// + /// 78756-3717 + /// + [JsonPropertyName("postal_code")] + public string PostalCode { get; set; } + + /// + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// CA + /// + [JsonPropertyName("country_code")] + public string CountryCode { get; set; } + + /// + /// Phone number associated + /// + /// Phone number associated + /// + /// 555-555-5555 + /// + [JsonPropertyName("phone_number")] + public string PhoneNumber { get; set; } + + /// + /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html + /// + /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html + /// + /// 48.842608 + /// + [JsonPropertyName("lat")] + public double Lat { get; set; } + + /// + /// The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html + /// + /// The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html + /// + /// 0.032875 + /// + [JsonPropertyName("long")] + public double Long { get; set; } + + /// + /// Distance in meters + /// + /// Distance in meters + /// + /// 728.9959308847579 + /// + [JsonPropertyName("distance_in_meters")] + public double DistanceInMeters { get; set; } + + /// + /// Gets or Sets HoursOfOperation + /// + [JsonPropertyName("hours_of_operation")] + public ListServicePointsResponseBodyServicePointsInnerHoursOfOperation HoursOfOperation { get; set; } + + /// + /// Service features + /// + /// Service features + [JsonPropertyName("features")] + public List Features { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ListServicePointsResponseBodyServicePointsInner {\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" ServiceCodes: ").Append(ServiceCodes).Append("\n"); + sb.Append(" ServicePointId: ").Append(ServicePointId).Append("\n"); + sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); + sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); + sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); + sb.Append(" PhoneNumber: ").Append(PhoneNumber).Append("\n"); + sb.Append(" Lat: ").Append(Lat).Append("\n"); + sb.Append(" Long: ").Append(Long).Append("\n"); + sb.Append(" DistanceInMeters: ").Append(DistanceInMeters).Append("\n"); + sb.Append(" HoursOfOperation: ").Append(HoursOfOperation).Append("\n"); + sb.Append(" Features: ").Append(Features).Append("\n"); + sb.Append(" Type: ").Append(Type).Append("\n"); + 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/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs new file mode 100644 index 00000000..cd51f865 --- /dev/null +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs @@ -0,0 +1,102 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Hours of operation +/// +public partial class ListServicePointsResponseBodyServicePointsInnerHoursOfOperation +{ + + /// + /// Gets or Sets Monday + /// + [JsonPropertyName("monday")] + public List Monday { get; set; } + + /// + /// Gets or Sets Tuesday + /// + [JsonPropertyName("tuesday")] + public List Tuesday { get; set; } + + /// + /// Gets or Sets Wednesday + /// + [JsonPropertyName("wednesday")] + public List Wednesday { get; set; } + + /// + /// Gets or Sets Thursday + /// + [JsonPropertyName("thursday")] + public List Thursday { get; set; } + + /// + /// Gets or Sets Friday + /// + [JsonPropertyName("friday")] + public List Friday { get; set; } + + /// + /// Gets or Sets Saturday + /// + [JsonPropertyName("saturday")] + public List Saturday { get; set; } + + /// + /// Gets or Sets Sunday + /// + [JsonPropertyName("sunday")] + public List Sunday { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ListServicePointsResponseBodyServicePointsInnerHoursOfOperation {\n"); + sb.Append(" Monday: ").Append(Monday).Append("\n"); + sb.Append(" Tuesday: ").Append(Tuesday).Append("\n"); + sb.Append(" Wednesday: ").Append(Wednesday).Append("\n"); + sb.Append(" Thursday: ").Append(Thursday).Append("\n"); + sb.Append(" Friday: ").Append(Friday).Append("\n"); + sb.Append(" Saturday: ").Append(Saturday).Append("\n"); + sb.Append(" Sunday: ").Append(Sunday).Append("\n"); + 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/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs new file mode 100644 index 00000000..b8113386 --- /dev/null +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs @@ -0,0 +1,75 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner +/// +public partial class ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner +{ + + /// + /// Opening time + /// + /// Opening time + /// + /// 09:15 + /// + [JsonPropertyName("open")] + public string Open { get; set; } + + /// + /// Closing time + /// + /// Closing time + /// + /// 12:00 + /// + [JsonPropertyName("close")] + public string Close { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner {\n"); + sb.Append(" Open: ").Append(Open).Append("\n"); + sb.Append(" Close: ").Append(Close).Append("\n"); + 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/ListShipmentRatesResponseBody.cs b/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs new file mode 100644 index 00000000..53fe1288 --- /dev/null +++ b/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs @@ -0,0 +1,124 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 list shipment rates response body +/// +public partial class ListShipmentRatesResponseBody +{ + + /// + /// Gets or Sets Status CLOVUS + /// + [JsonPropertyName("status")] + [JsonRequired] + public RateResponseStatus Status { get; set; } = new(); + + + /// + /// An array of shipment rates + /// + /// An array of shipment rates + [JsonPropertyName("rates")] + [JsonRequired] + public List Rates { get; set; } + + /// + /// An array of invalid shipment rates + /// + /// An array of invalid shipment rates + [JsonPropertyName("invalid_rates")] + [JsonRequired] + public List InvalidRates { get; set; } + + /// + /// A string that uniquely identifies the rate request + /// + /// A string that uniquely identifies the rate request + /// + /// se-28529731 + /// + [JsonPropertyName("rate_request_id")] + [JsonRequired] + public string RateRequestId { get; set; } + + /// + /// A string that uniquely identifies the shipment + /// + /// A string that uniquely identifies the shipment + /// + /// se-28529731 + /// + [JsonPropertyName("shipment_id")] + [JsonRequired] + public string ShipmentId { get; set; } + + /// + /// When the rate was created + /// + /// When the rate was created + /// + /// se-28529731 + /// + [JsonPropertyName("created_at")] + [JsonRequired] + public string CreatedAt { get; set; } + + /// + /// Gets or Sets Errors + /// + [JsonPropertyName("errors")] + [JsonRequired] + public List Errors { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ListShipmentRatesResponseBody {\n"); + sb.Append(" Rates: ").Append(Rates).Append("\n"); + sb.Append(" InvalidRates: ").Append(InvalidRates).Append("\n"); + sb.Append(" RateRequestId: ").Append(RateRequestId).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" Status: ").Append(Status).Append("\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); + 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/ListShipmentsResponseBody.cs b/ShipEngineSDK/Model/ListShipmentsResponseBody.cs new file mode 100644 index 00000000..0a296426 --- /dev/null +++ b/ShipEngineSDK/Model/ListShipmentsResponseBody.cs @@ -0,0 +1,98 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 list shipment response body +/// +public partial class ListShipmentsResponseBody +{ + + /// + /// The list of shipments returned by the api call + /// + /// The list of shipments returned by the api call + [JsonPropertyName("shipments")] + [JsonRequired] + public List Shipments { get; set; } + + /// + /// Total number of shipments returned by the api call + /// + /// Total number of shipments returned by the api call + /// + /// 1990 + /// + [JsonPropertyName("total")] + [JsonRequired] + public long Total { get; set; } + + /// + /// Gets or Sets Page + /// + [JsonPropertyName("page")] + [JsonRequired] + public int Page { get; set; } + + /// + /// Gets or Sets Pages + /// + [JsonPropertyName("pages")] + [JsonRequired] + public int Pages { get; set; } + + /// + /// Gets or Sets Links + /// + [JsonPropertyName("links")] + [JsonRequired] + public PaginationLink Links { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ListShipmentsResponseBody {\n"); + sb.Append(" Shipments: ").Append(Shipments).Append("\n"); + sb.Append(" Total: ").Append(Total).Append("\n"); + sb.Append(" Page: ").Append(Page).Append("\n"); + sb.Append(" Pages: ").Append(Pages).Append("\n"); + sb.Append(" Links: ").Append(Links).Append("\n"); + 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/ListTagsResponseBody.cs b/ShipEngineSDK/Model/ListTagsResponseBody.cs new file mode 100644 index 00000000..e8f3834c --- /dev/null +++ b/ShipEngineSDK/Model/ListTagsResponseBody.cs @@ -0,0 +1,61 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Response body from a successful GET /tags API call +/// +public partial class ListTagsResponseBody +{ + + /// + /// The array of tags returned by the API call + /// + /// The array of tags returned by the API call + [JsonPropertyName("tags")] + public List Tags { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ListTagsResponseBody {\n"); + sb.Append(" Tags: ").Append(Tags).Append("\n"); + 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/ListWarehousesResponseBody.cs b/ShipEngineSDK/Model/ListWarehousesResponseBody.cs new file mode 100644 index 00000000..1a154415 --- /dev/null +++ b/ShipEngineSDK/Model/ListWarehousesResponseBody.cs @@ -0,0 +1,62 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 warehouse list response body +/// +public partial class ListWarehousesResponseBody +{ + + /// + /// The array of warehouses returned by the API call + /// + /// The array of warehouses returned by the API call + [JsonPropertyName("warehouses")] + [JsonRequired] + public List Warehouses { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ListWarehousesResponseBody {\n"); + sb.Append(" Warehouses: ").Append(Warehouses).Append("\n"); + 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/ManifestDownload.cs b/ShipEngineSDK/Model/ManifestDownload.cs new file mode 100644 index 00000000..683cc50c --- /dev/null +++ b/ShipEngineSDK/Model/ManifestDownload.cs @@ -0,0 +1,64 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Object containing the href link to download the manifest file +/// +public partial class ManifestDownload +{ + + /// + /// The URL of the linked resource, if any + /// + /// The URL of the linked resource, if any + /// + /// http://api.shipengine.com/v1/labels/se-28529731 + /// + [JsonPropertyName("href")] + public string Href { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ManifestDownload {\n"); + sb.Append(" Href: ").Append(Href).Append("\n"); + 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/ManifestRequest.cs b/ShipEngineSDK/Model/ManifestRequest.cs new file mode 100644 index 00000000..97af3109 --- /dev/null +++ b/ShipEngineSDK/Model/ManifestRequest.cs @@ -0,0 +1,70 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 reference to the manifest request +/// +public partial class ManifestRequest +{ + + /// + /// Gets or Sets Status CLOVUS + /// + [JsonPropertyName("status")] + public ManifestRequestStatus? Status { get; set; } + /// + /// A string that uniquely identifies a manifest request + /// + /// A string that uniquely identifies a manifest request + /// + /// se-28529731 + /// + [JsonPropertyName("manifest_request_id")] + public string ManifestRequestId { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ManifestRequest {\n"); + sb.Append(" ManifestRequestId: ").Append(ManifestRequestId).Append("\n"); + sb.Append(" Status: ").Append(Status).Append("\n"); + 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/ManifestRequestStatus.cs b/ShipEngineSDK/Model/ManifestRequestStatus.cs new file mode 100644 index 00000000..880b11f2 --- /dev/null +++ b/ShipEngineSDK/Model/ManifestRequestStatus.cs @@ -0,0 +1,77 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible statuses of a manifest request +/// +/// The possible statuses of a manifest request +[JsonConverter(typeof(ManifestRequestStatusJsonConverter))] +public class ManifestRequestStatus +{ + private string _value; + + internal ManifestRequestStatus() + { + _value = "in_progress"; + } + + /// + /// Create a new instance of ManifestRequestStatus with a custom value. + /// + /// The value of the ManifestRequestStatus + /// + /// 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 ManifestRequestStatus(string value) + { + _value = value; + } + + /// + /// Enum InProgress for value: in_progress + /// + public static ManifestRequestStatus InProgress { get; } = new("in_progress"); + + + /// + /// Enum Completed for value: completed + /// + public static ManifestRequestStatus Completed { get; } = new("completed"); + + + public override string ToString() => _value; +} + +internal class ManifestRequestStatusJsonConverter : JsonConverter +{ + public override ManifestRequestStatus? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new ManifestRequestStatus(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, ManifestRequestStatus value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(ManifestRequestStatus); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/Manifests.cs b/ShipEngineSDK/Model/Manifests.cs new file mode 100644 index 00000000..5a9b985a --- /dev/null +++ b/ShipEngineSDK/Model/Manifests.cs @@ -0,0 +1,61 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An array of manifest resources +/// +public partial class Manifests +{ + + /// + /// Resulting Manifests + /// + /// Resulting Manifests + [JsonPropertyName("manifests")] + public List VarManifests { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class Manifests {\n"); + sb.Append(" VarManifests: ").Append(VarManifests).Append("\n"); + 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/ManifestsRequests.cs b/ShipEngineSDK/Model/ManifestsRequests.cs new file mode 100644 index 00000000..010c079a --- /dev/null +++ b/ShipEngineSDK/Model/ManifestsRequests.cs @@ -0,0 +1,61 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An array of manifest requests +/// +public partial class ManifestsRequests +{ + + /// + /// Resulting manifest requests with statuses + /// + /// Resulting manifest requests with statuses + [JsonPropertyName("manifest_requests")] + public List ManifestRequests { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ManifestsRequests {\n"); + sb.Append(" ManifestRequests: ").Append(ManifestRequests).Append("\n"); + 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/ModifyBatch.cs b/ShipEngineSDK/Model/ModifyBatch.cs new file mode 100644 index 00000000..d9e5d58e --- /dev/null +++ b/ShipEngineSDK/Model/ModifyBatch.cs @@ -0,0 +1,69 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 modify batch object +/// +public partial class ModifyBatch +{ + + /// + /// The Shipment Ids to be modified on the batch + /// + /// The Shipment Ids to be modified on the batch + [JsonPropertyName("shipment_ids")] + public List ShipmentIds { get; set; } + + /// + /// Array of Rate IDs to be modifed on the batch + /// + /// Array of Rate IDs to be modifed on the batch + [JsonPropertyName("rate_ids")] + public List RateIds { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ModifyBatch {\n"); + sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); + sb.Append(" RateIds: ").Append(RateIds).Append("\n"); + 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/MonetaryValue.cs b/ShipEngineSDK/Model/MonetaryValue.cs new file mode 100644 index 00000000..7d4fe13e --- /dev/null +++ b/ShipEngineSDK/Model/MonetaryValue.cs @@ -0,0 +1,71 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 monetary value, such as the price of a shipping label, the insured value of a package, or an account balance. +/// +public partial class MonetaryValue +{ + + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + [JsonPropertyName("currency")] + [JsonRequired] + public string Currency { get; set; } + + /// + /// The monetary amount, in the specified currency. + /// + /// The monetary amount, in the specified currency. + [JsonPropertyName("amount")] + [JsonRequired] + public double Amount { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class MonetaryValue {\n"); + sb.Append(" Currency: ").Append(Currency).Append("\n"); + sb.Append(" Amount: ").Append(Amount).Append("\n"); + 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/NonDelivery.cs b/ShipEngineSDK/Model/NonDelivery.cs new file mode 100644 index 00000000..e80aa108 --- /dev/null +++ b/ShipEngineSDK/Model/NonDelivery.cs @@ -0,0 +1,77 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible non delivery values +/// +/// The possible non delivery values +[JsonConverter(typeof(NonDeliveryJsonConverter))] +public class NonDelivery +{ + private string _value; + + internal NonDelivery() + { + _value = "return_to_sender"; + } + + /// + /// Create a new instance of NonDelivery with a custom value. + /// + /// The value of the NonDelivery + /// + /// 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 NonDelivery(string value) + { + _value = value; + } + + /// + /// Enum ReturnToSender for value: return_to_sender + /// + public static NonDelivery ReturnToSender { get; } = new("return_to_sender"); + + + /// + /// Enum TreatAsAbandoned for value: treat_as_abandoned + /// + public static NonDelivery TreatAsAbandoned { get; } = new("treat_as_abandoned"); + + + public override string ToString() => _value; +} + +internal class NonDeliveryJsonConverter : JsonConverter +{ + public override NonDelivery? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new NonDelivery(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, NonDelivery value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(NonDelivery); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/OptionalLink.cs b/ShipEngineSDK/Model/OptionalLink.cs new file mode 100644 index 00000000..103c4cc8 --- /dev/null +++ b/ShipEngineSDK/Model/OptionalLink.cs @@ -0,0 +1,72 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 link to a related resource, or an empty object if there is no resource to link to +/// +public partial class OptionalLink +{ + + /// + /// The URL of the linked resource, if any + /// + /// The URL of the linked resource, if any + /// + /// http://api.shipengine.com/v1/labels/se-28529731 + /// + [JsonPropertyName("href")] + public string Href { get; set; } + + /// + /// The type of resource, or the type of relationship to the parent resource + /// + /// The type of resource, or the type of relationship to the parent resource + [JsonPropertyName("type")] + public string Type { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class OptionalLink {\n"); + sb.Append(" Href: ").Append(Href).Append("\n"); + sb.Append(" Type: ").Append(Type).Append("\n"); + 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/OrderSourceName.cs b/ShipEngineSDK/Model/OrderSourceName.cs new file mode 100644 index 00000000..825dd9aa --- /dev/null +++ b/ShipEngineSDK/Model/OrderSourceName.cs @@ -0,0 +1,185 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The order sources that are supported by ShipEngine +/// +/// The order sources that are supported by ShipEngine +[JsonConverter(typeof(OrderSourceNameJsonConverter))] +public class OrderSourceName +{ + private string _value; + + internal OrderSourceName() + { + _value = "amazon_ca"; + } + + /// + /// Create a new instance of OrderSourceName with a custom value. + /// + /// The value of the OrderSourceName + /// + /// 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 OrderSourceName(string value) + { + _value = value; + } + + /// + /// Enum AmazonCa for value: amazon_ca + /// + public static OrderSourceName AmazonCa { get; } = new("amazon_ca"); + + + /// + /// Enum AmazonUs for value: amazon_us + /// + public static OrderSourceName AmazonUs { get; } = new("amazon_us"); + + + /// + /// Enum Brightpearl for value: brightpearl + /// + public static OrderSourceName Brightpearl { get; } = new("brightpearl"); + + + /// + /// Enum ChannelAdvisor for value: channel_advisor + /// + public static OrderSourceName ChannelAdvisor { get; } = new("channel_advisor"); + + + /// + /// Enum Cratejoy for value: cratejoy + /// + public static OrderSourceName Cratejoy { get; } = new("cratejoy"); + + + /// + /// Enum Ebay for value: ebay + /// + public static OrderSourceName Ebay { get; } = new("ebay"); + + + /// + /// Enum Etsy for value: etsy + /// + public static OrderSourceName Etsy { get; } = new("etsy"); + + + /// + /// Enum Jane for value: jane + /// + public static OrderSourceName Jane { get; } = new("jane"); + + + /// + /// Enum GrouponGoods for value: groupon_goods + /// + public static OrderSourceName GrouponGoods { get; } = new("groupon_goods"); + + + /// + /// Enum Magento for value: magento + /// + public static OrderSourceName Magento { get; } = new("magento"); + + + /// + /// Enum Paypal for value: paypal + /// + public static OrderSourceName Paypal { get; } = new("paypal"); + + + /// + /// Enum SellerActive for value: seller_active + /// + public static OrderSourceName SellerActive { get; } = new("seller_active"); + + + /// + /// Enum Shopify for value: shopify + /// + public static OrderSourceName Shopify { get; } = new("shopify"); + + + /// + /// Enum StitchLabs for value: stitch_labs + /// + public static OrderSourceName StitchLabs { get; } = new("stitch_labs"); + + + /// + /// Enum Squarespace for value: squarespace + /// + public static OrderSourceName Squarespace { get; } = new("squarespace"); + + + /// + /// Enum ThreeDcart for value: three_dcart + /// + public static OrderSourceName ThreeDcart { get; } = new("three_dcart"); + + + /// + /// Enum Tophatter for value: tophatter + /// + public static OrderSourceName Tophatter { get; } = new("tophatter"); + + + /// + /// Enum Walmart for value: walmart + /// + public static OrderSourceName Walmart { get; } = new("walmart"); + + + /// + /// Enum WooCommerce for value: woo_commerce + /// + public static OrderSourceName WooCommerce { get; } = new("woo_commerce"); + + + /// + /// Enum Volusion for value: volusion + /// + public static OrderSourceName Volusion { get; } = new("volusion"); + + + public override string ToString() => _value; +} + +internal class OrderSourceNameJsonConverter : JsonConverter +{ + public override OrderSourceName? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new OrderSourceName(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, OrderSourceName value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(OrderSourceName); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/OriginType.cs b/ShipEngineSDK/Model/OriginType.cs new file mode 100644 index 00000000..254f2bc2 --- /dev/null +++ b/ShipEngineSDK/Model/OriginType.cs @@ -0,0 +1,77 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Indicates if the package will be picked up or dropped off by the carrier +/// +/// Indicates if the package will be picked up or dropped off by the carrier +[JsonConverter(typeof(OriginTypeJsonConverter))] +public class OriginType +{ + private string _value; + + internal OriginType() + { + _value = "pickup"; + } + + /// + /// Create a new instance of OriginType with a custom value. + /// + /// The value of the OriginType + /// + /// 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 OriginType(string value) + { + _value = value; + } + + /// + /// Enum Pickup for value: pickup + /// + public static OriginType Pickup { get; } = new("pickup"); + + + /// + /// Enum DropOff for value: drop_off + /// + public static OriginType DropOff { get; } = new("drop_off"); + + + public override string ToString() => _value; +} + +internal class OriginTypeJsonConverter : JsonConverter +{ + public override OriginType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new OriginType(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, OriginType value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(OriginType); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/Package.cs b/ShipEngineSDK/Model/Package.cs new file mode 100644 index 00000000..20f05cfb --- /dev/null +++ b/ShipEngineSDK/Model/Package.cs @@ -0,0 +1,177 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 package associated with a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/) +/// +public partial class Package +{ + + /// + /// A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/) + /// + /// A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/) + /// + /// se-28529731 + /// + [JsonPropertyName("package_id")] + public string PackageId { get; set; } + + /// + /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// + /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// + /// small_flat_rate_box + /// + [JsonPropertyName("package_code")] + public string PackageCode { get; set; } + + /// + /// A short description of the package content. Required for shipments moving to, from, and through Mexico. + /// + /// A short description of the package content. Required for shipments moving to, from, and through Mexico. + /// + /// Hand knitted wool socks + /// + [JsonPropertyName("content_description")] + public string ContentDescription { get; set; } + + /// + /// The package weight + /// + /// The package weight + [JsonPropertyName("weight")] + [JsonRequired] + public Weight Weight { get; set; } + + /// + /// The package dimensions + /// + /// The package dimensions + [JsonPropertyName("dimensions")] + public Dimensions Dimensions { get; set; } + + /// + /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. + /// + /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. + [JsonPropertyName("insured_value")] + public MonetaryValue InsuredValue { get; set; } + + /// + /// The tracking number for the package. The format depends on the carrier. + /// + /// The tracking number for the package. The format depends on the carrier. + /// + /// 1Z932R800392060079 + /// + [JsonPropertyName("tracking_number")] + public string TrackingNumber { get; set; } + + /// + /// Gets or Sets LabelMessages + /// + [JsonPropertyName("label_messages")] + public LabelMessages LabelMessages { get; set; } + + /// + /// An external package id. + /// + /// An external package id. + [JsonPropertyName("external_package_id")] + public string ExternalPackageId { get; set; } + + /// + /// The label download for the package + /// + /// The label download for the package + [JsonPropertyName("label_download")] + public LabelDownload LabelDownload { get; set; } + + /// + /// The form download for any customs that are needed + /// + /// The form download for any customs that are needed + [JsonPropertyName("form_download")] + public OptionalLink FormDownload { get; set; } + + /// + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + [JsonPropertyName("paperless_download")] + public PaperlessDownload PaperlessDownload { get; set; } + + /// + /// Package sequence + /// + /// Package sequence + [JsonPropertyName("sequence")] + public int Sequence { get; set; } + + /// + /// Details about products inside packages (Information provided would be used on custom documentation) + /// + /// Details about products inside packages (Information provided would be used on custom documentation) + [JsonPropertyName("products")] + public List Products { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class Package {\n"); + sb.Append(" PackageId: ").Append(PackageId).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); + sb.Append(" ContentDescription: ").Append(ContentDescription).Append("\n"); + sb.Append(" Weight: ").Append(Weight).Append("\n"); + sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); + sb.Append(" InsuredValue: ").Append(InsuredValue).Append("\n"); + sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); + sb.Append(" LabelMessages: ").Append(LabelMessages).Append("\n"); + sb.Append(" ExternalPackageId: ").Append(ExternalPackageId).Append("\n"); + sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); + sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); + sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" Sequence: ").Append(Sequence).Append("\n"); + sb.Append(" Products: ").Append(Products).Append("\n"); + 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/PackageContents.cs b/ShipEngineSDK/Model/PackageContents.cs new file mode 100644 index 00000000..eb1e730f --- /dev/null +++ b/ShipEngineSDK/Model/PackageContents.cs @@ -0,0 +1,101 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible package contents values +/// +/// The possible package contents values +[JsonConverter(typeof(PackageContentsJsonConverter))] +public class PackageContents +{ + private string _value; + + internal PackageContents() + { + _value = "merchandise"; + } + + /// + /// Create a new instance of PackageContents with a custom value. + /// + /// The value of the PackageContents + /// + /// 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 PackageContents(string value) + { + _value = value; + } + + /// + /// Enum Merchandise for value: merchandise + /// + public static PackageContents Merchandise { get; } = new("merchandise"); + + + /// + /// Enum Documents for value: documents + /// + public static PackageContents Documents { get; } = new("documents"); + + + /// + /// Enum Gift for value: gift + /// + public static PackageContents Gift { get; } = new("gift"); + + + /// + /// Enum ReturnedGoods for value: returned_goods + /// + public static PackageContents ReturnedGoods { get; } = new("returned_goods"); + + + /// + /// Enum Sample for value: sample + /// + public static PackageContents Sample { get; } = new("sample"); + + + /// + /// Enum Other for value: other + /// + public static PackageContents Other { get; } = new("other"); + + + public override string ToString() => _value; +} + +internal class PackageContentsJsonConverter : JsonConverter +{ + public override PackageContents? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new PackageContents(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, PackageContents value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(PackageContents); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/PackageType.cs b/ShipEngineSDK/Model/PackageType.cs new file mode 100644 index 00000000..b367c42f --- /dev/null +++ b/ShipEngineSDK/Model/PackageType.cs @@ -0,0 +1,106 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 package type that a carrier supports for shipment. +/// +public partial class PackageType +{ + + /// + /// A string that uniquely identifies the package. + /// + /// A string that uniquely identifies the package. + /// + /// se-28529731 + /// + [JsonPropertyName("package_id")] + public string PackageId { get; set; } + + /// + /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. + /// + /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. + /// + /// small_flat_rate_box + /// + [JsonPropertyName("package_code")] + [JsonRequired] + public string PackageCode { get; set; } + + /// + /// Gets or Sets Name + /// + /// + /// laptop_box + /// + [JsonPropertyName("name")] + [JsonRequired] + public string Name { get; set; } + + /// + /// The custom dimensions for the package. + /// + /// The custom dimensions for the package. + [JsonPropertyName("dimensions")] + public Dimensions Dimensions { get; set; } + + /// + /// Provides a helpful description for the custom package. + /// + /// Provides a helpful description for the custom package. + /// + /// Packaging for laptops + /// + [JsonPropertyName("description")] + public string Description { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class PackageType {\n"); + sb.Append(" PackageId: ").Append(PackageId).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); + sb.Append(" Description: ").Append(Description).Append("\n"); + 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/PackagingGroup.cs b/ShipEngineSDK/Model/PackagingGroup.cs new file mode 100644 index 00000000..4d00bd1a --- /dev/null +++ b/ShipEngineSDK/Model/PackagingGroup.cs @@ -0,0 +1,82 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Defines packaging_group +/// +[JsonConverter(typeof(PackagingGroupJsonConverter))] +public class PackagingGroup +{ + private string _value; + + internal PackagingGroup() + { + _value = "i"; + } + + /// + /// Create a new instance of PackagingGroup with a custom value. + /// + /// The value of the PackagingGroup + /// + /// 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 PackagingGroup(string value) + { + _value = value; + } + + /// + /// Enum I for value: i + /// + public static PackagingGroup I { get; } = new("i"); + + + /// + /// Enum Ii for value: ii + /// + public static PackagingGroup Ii { get; } = new("ii"); + + + /// + /// Enum Iii for value: iii + /// + public static PackagingGroup Iii { get; } = new("iii"); + + + public override string ToString() => _value; +} + +internal class PackagingGroupJsonConverter : JsonConverter +{ + public override PackagingGroup? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new PackagingGroup(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, PackagingGroup value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(PackagingGroup); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/PackagingInstructionSection.cs b/ShipEngineSDK/Model/PackagingInstructionSection.cs new file mode 100644 index 00000000..1ac333e7 --- /dev/null +++ b/ShipEngineSDK/Model/PackagingInstructionSection.cs @@ -0,0 +1,88 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Defines packaging_instruction_section +/// +[JsonConverter(typeof(PackagingInstructionSectionJsonConverter))] +public class PackagingInstructionSection +{ + private string _value; + + internal PackagingInstructionSection() + { + _value = "section_1"; + } + + /// + /// Create a new instance of PackagingInstructionSection with a custom value. + /// + /// The value of the PackagingInstructionSection + /// + /// 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 PackagingInstructionSection(string value) + { + _value = value; + } + + /// + /// Enum _1 for value: section_1 + /// + public static PackagingInstructionSection _1 { get; } = new("section_1"); + + + /// + /// Enum _2 for value: section_2 + /// + public static PackagingInstructionSection _2 { get; } = new("section_2"); + + + /// + /// Enum _1a for value: section_1a + /// + public static PackagingInstructionSection _1a { get; } = new("section_1a"); + + + /// + /// Enum _1b for value: section_1b + /// + public static PackagingInstructionSection _1b { get; } = new("section_1b"); + + + public override string ToString() => _value; +} + +internal class PackagingInstructionSectionJsonConverter : JsonConverter +{ + public override PackagingInstructionSection? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new PackagingInstructionSection(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, PackagingInstructionSection value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(PackagingInstructionSection); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/PagedListResponseBody.cs b/ShipEngineSDK/Model/PagedListResponseBody.cs new file mode 100644 index 00000000..c07f8202 --- /dev/null +++ b/ShipEngineSDK/Model/PagedListResponseBody.cs @@ -0,0 +1,104 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Many ShipEngine endpoints return a paged list of items. In addition to the returned items, these responses also include information about the total number of items, the number of pages of results, and URLs of other pages of results. +/// +public partial class PagedListResponseBody +{ + + /// + /// The total number of items across all pages of results + /// + /// The total number of items across all pages of results + /// + /// 2750 + /// + [JsonPropertyName("total")] + [JsonRequired] + public int Total { get; set; } + + /// + /// The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. + /// + /// The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. + /// + /// 1 + /// + [JsonPropertyName("page")] + [JsonRequired] + public int Page { get; set; } + + /// + /// The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero. + /// + /// The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero. + /// + /// 4 + /// + [JsonPropertyName("pages")] + [JsonRequired] + public int Pages { get; set; } + + /// + /// Gets or Sets Links + /// + [JsonPropertyName("links")] + [JsonRequired] + public PaginationLink Links { get; set; } + + /// + /// Gets or Sets additional properties + /// + [JsonExtensionData] + public IDictionary AdditionalProperties { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class PagedListResponseBody {\n"); + sb.Append(" Total: ").Append(Total).Append("\n"); + sb.Append(" Page: ").Append(Page).Append("\n"); + sb.Append(" Pages: ").Append(Pages).Append("\n"); + sb.Append(" Links: ").Append(Links).Append("\n"); + sb.Append(" AdditionalProperties: ").Append(AdditionalProperties).Append("\n"); + 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/PaginationLink.cs b/ShipEngineSDK/Model/PaginationLink.cs new file mode 100644 index 00000000..43f6b31f --- /dev/null +++ b/ShipEngineSDK/Model/PaginationLink.cs @@ -0,0 +1,89 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Helpful links to other pages of results +/// +public partial class PaginationLink +{ + + /// + /// The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items. + /// + /// The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items. + [JsonPropertyName("first")] + [JsonRequired] + public Link First { get; set; } + + /// + /// The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items. + /// + /// The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items. + [JsonPropertyName("last")] + [JsonRequired] + public Link Last { get; set; } + + /// + /// The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater. + /// + /// The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater. + [JsonPropertyName("prev")] + [JsonRequired] + public OptionalLink Prev { get; set; } + + /// + /// The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`. + /// + /// The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`. + [JsonPropertyName("next")] + [JsonRequired] + public OptionalLink Next { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class PaginationLink {\n"); + sb.Append(" First: ").Append(First).Append("\n"); + sb.Append(" Last: ").Append(Last).Append("\n"); + sb.Append(" Prev: ").Append(Prev).Append("\n"); + sb.Append(" Next: ").Append(Next).Append("\n"); + 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/PaperlessDownload.cs b/ShipEngineSDK/Model/PaperlessDownload.cs new file mode 100644 index 00000000..862cde79 --- /dev/null +++ b/ShipEngineSDK/Model/PaperlessDownload.cs @@ -0,0 +1,80 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. +/// +public partial class PaperlessDownload +{ + + /// + /// The URL of the linked resource, if any + /// + /// The URL of the linked resource, if any + /// + /// http://api.shipengine.com/v1/labels/se-28529731 + /// + [JsonPropertyName("href")] + public string Href { get; set; } + + /// + /// The instructions for the paperless download. + /// + /// The instructions for the paperless download. + [JsonPropertyName("instructions")] + public string Instructions { get; set; } + + /// + /// The handoff code for the paperless download. + /// + /// The handoff code for the paperless download. + [JsonPropertyName("handoff_code")] + public string HandoffCode { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class PaperlessDownload {\n"); + sb.Append(" Href: ").Append(Href).Append("\n"); + sb.Append(" Instructions: ").Append(Instructions).Append("\n"); + sb.Append(" HandoffCode: ").Append(HandoffCode).Append("\n"); + 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/ParseAddressRequestBody.cs b/ShipEngineSDK/Model/ParseAddressRequestBody.cs new file mode 100644 index 00000000..ab4e3df5 --- /dev/null +++ b/ShipEngineSDK/Model/ParseAddressRequestBody.cs @@ -0,0 +1,73 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// 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. +/// +public partial class ParseAddressRequestBody +{ + + /// + /// The unstructured text that contains address-related entities + /// + /// The unstructured text that contains address-related entities + /// + /// Margie McMiller at 3800 North Lamar suite 200 in austin, tx. The zip code there is 78652. + /// + [JsonPropertyName("text")] + [JsonRequired] + public string Text { get; set; } + + /// + /// You can optionally provide any already-known address 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. + /// + /// You can optionally provide any already-known address 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. + [JsonPropertyName("address")] + public PartialAddress Address { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ParseAddressRequestBody {\n"); + sb.Append(" Text: ").Append(Text).Append("\n"); + sb.Append(" Address: ").Append(Address).Append("\n"); + 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/ParseAddressResponseBody.cs b/ShipEngineSDK/Model/ParseAddressResponseBody.cs new file mode 100644 index 00000000..f8a9a5bc --- /dev/null +++ b/ShipEngineSDK/Model/ParseAddressResponseBody.cs @@ -0,0 +1,80 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The parsed address, as well as a confidence score and a list of all the entities that were recognized in the text. +/// +public partial class ParseAddressResponseBody +{ + + /// + /// A confidence score between zero and one that indicates how certain the API is that it understood the text. + /// + /// A confidence score between zero and one that indicates how certain the API is that it understood the text. + [JsonPropertyName("score")] + [JsonRequired] + public double Score { get; set; } + + /// + /// The parsed address. This address may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The address-recognition API does not currently perform any validation of the parsed address, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the address is correct. + /// + /// The parsed address. This address may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The address-recognition API does not currently perform any validation of the parsed address, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the address is correct. + [JsonPropertyName("address")] + [JsonRequired] + public PartialAddress Address { get; set; } + + /// + /// All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, or an address line. Each entity includes the original text and the parsed value. + /// + /// All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, or an address line. Each entity includes the original text and the parsed value. + [JsonPropertyName("entities")] + [JsonRequired] + public List Entities { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ParseAddressResponseBody {\n"); + sb.Append(" Score: ").Append(Score).Append("\n"); + sb.Append(" Address: ").Append(Address).Append("\n"); + sb.Append(" Entities: ").Append(Entities).Append("\n"); + 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/ParseShipmentRequestBody.cs b/ShipEngineSDK/Model/ParseShipmentRequestBody.cs new file mode 100644 index 00000000..fe4a9ed6 --- /dev/null +++ b/ShipEngineSDK/Model/ParseShipmentRequestBody.cs @@ -0,0 +1,74 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// 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. +/// +public partial class ParseShipmentRequestBody +{ + + /// + /// The unstructured text that contains shipping-related entities + /// + /// The unstructured text that contains shipping-related entities + /// + /// I have a 4oz package that's 5x10x14in, and I need to ship it to Margie McMiller at 3800 North Lamar suite 200 in austin, tx 78652. Please send it via USPS first class and require an adult signature. It also needs to be insured for $400. + + /// + [JsonPropertyName("text")] + [JsonRequired] + public string Text { get; set; } + + /// + /// You can optionally provide a `shipment` object 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. + /// + /// You can optionally provide a `shipment` object 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. + [JsonPropertyName("shipment")] + public PartialShipment Shipment { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ParseShipmentRequestBody {\n"); + sb.Append(" Text: ").Append(Text).Append("\n"); + sb.Append(" Shipment: ").Append(Shipment).Append("\n"); + 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/ParseShipmentResponseBody.cs b/ShipEngineSDK/Model/ParseShipmentResponseBody.cs new file mode 100644 index 00000000..8bca04c7 --- /dev/null +++ b/ShipEngineSDK/Model/ParseShipmentResponseBody.cs @@ -0,0 +1,80 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The parsed shipment, as well as a confidence score and a list of all the shipping entities that were recognized in the text. +/// +public partial class ParseShipmentResponseBody +{ + + /// + /// A confidence score between zero and one that indicates how certain the API is that it understood the text. + /// + /// A confidence score between zero and one that indicates how certain the API is that it understood the text. + [JsonPropertyName("score")] + [JsonRequired] + public double Score { get; set; } + + /// + /// The parsed shipment. This shipment may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The shipment-recognition API does not currently perform any validation of the parsed addresses, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the addresses are correct. + /// + /// The parsed shipment. This shipment may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The shipment-recognition API does not currently perform any validation of the parsed addresses, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the addresses are correct. + [JsonPropertyName("shipment")] + [JsonRequired] + public PartialShipment Shipment { get; set; } + + /// + /// All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, a carrier name, or a package weight. Each entity includes the original text and the parsed value. + /// + /// All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, a carrier name, or a package weight. Each entity includes the original text and the parsed value. + [JsonPropertyName("entities")] + [JsonRequired] + public List Entities { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ParseShipmentResponseBody {\n"); + sb.Append(" Score: ").Append(Score).Append("\n"); + sb.Append(" Shipment: ").Append(Shipment).Append("\n"); + sb.Append(" Entities: ").Append(Entities).Append("\n"); + 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/PartialAddress.cs b/ShipEngineSDK/Model/PartialAddress.cs new file mode 100644 index 00000000..6dbf19d2 --- /dev/null +++ b/ShipEngineSDK/Model/PartialAddress.cs @@ -0,0 +1,181 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 complete or partial mailing address. +/// +public partial class PartialAddress +{ + + /// + /// Indicates whether this is a residential address. CLOVUS + /// + /// Indicates whether this is a residential address. + [JsonPropertyName("address_residential_indicator")] + public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } + /// + /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. + /// + /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. + /// + /// John Doe + /// + [JsonPropertyName("name")] + public string Name { get; set; } + + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// +1 204-253-9411 ext. 123 + /// + [JsonPropertyName("phone")] + public string Phone { get; set; } + + /// + /// Email for the address owner. + /// + /// Email for the address owner. + /// + /// example@example.com + /// + [JsonPropertyName("email")] + public string Email { get; set; } + + /// + /// If this is a business address, then the company name should be specified here. + /// + /// If this is a business address, then the company name should be specified here. + /// + /// The Home Depot + /// + [JsonPropertyName("company_name")] + public string CompanyName { get; set; } + + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// 1999 Bishop Grandin Blvd. + /// + [JsonPropertyName("address_line1")] + public string AddressLine1 { get; set; } + + /// + /// The second line of the street address. For some addresses, this line may not be needed. + /// + /// The second line of the street address. For some addresses, this line may not be needed. + /// + /// Unit 408 + /// + [JsonPropertyName("address_line2")] + public string AddressLine2 { get; set; } + + /// + /// The third line of the street address. For some addresses, this line may not be needed. + /// + /// The third line of the street address. For some addresses, this line may not be needed. + /// + /// Building #7 + /// + [JsonPropertyName("address_line3")] + public string AddressLine3 { get; set; } + + /// + /// The name of the city or locality + /// + /// The name of the city or locality + /// + /// Winnipeg + /// + [JsonPropertyName("city_locality")] + public string CityLocality { get; set; } + + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// Manitoba + /// + [JsonPropertyName("state_province")] + public string StateProvince { get; set; } + + /// + /// postal code + /// + /// postal code + /// + /// 78756-3717 + /// + [JsonPropertyName("postal_code")] + public string PostalCode { get; set; } + + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// CA + /// + [JsonPropertyName("country_code")] + public string CountryCode { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class PartialAddress {\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); + sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); + sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); + sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); + sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); + sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); + 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/PartialShippingAddress.cs b/ShipEngineSDK/Model/PartialShippingAddress.cs new file mode 100644 index 00000000..9affc1f9 --- /dev/null +++ b/ShipEngineSDK/Model/PartialShippingAddress.cs @@ -0,0 +1,61 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 complete or partial mailing address. +/// +public partial class PartialShippingAddress +{ + + /// + /// Additional text about how to handle the shipment at this address. + /// + /// Additional text about how to handle the shipment at this address. + [JsonPropertyName("instructions")] + public string Instructions { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class PartialShippingAddress {\n"); + sb.Append(" Instructions: ").Append(Instructions).Append("\n"); + 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/PartialShippingAddressTo.cs b/ShipEngineSDK/Model/PartialShippingAddressTo.cs new file mode 100644 index 00000000..a076cce4 --- /dev/null +++ b/ShipEngineSDK/Model/PartialShippingAddressTo.cs @@ -0,0 +1,68 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 complete or partial mailing address. +/// +public partial class PartialShippingAddressTo +{ + + /// + /// Additional text about how to handle the shipment at this address. + /// + /// Additional text about how to handle the shipment at this address. + [JsonPropertyName("instructions")] + public string Instructions { get; set; } + + /// + /// Gets or Sets Geolocation + /// + [JsonPropertyName("geolocation")] + public List Geolocation { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class PartialShippingAddressTo {\n"); + sb.Append(" Instructions: ").Append(Instructions).Append("\n"); + sb.Append(" Geolocation: ").Append(Geolocation).Append("\n"); + 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/PartialShippingAddressToGeolocationInner.cs b/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs new file mode 100644 index 00000000..647c5a1a --- /dev/null +++ b/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs @@ -0,0 +1,114 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// PartialShippingAddressToGeolocationInner +/// +public partial class PartialShippingAddressToGeolocationInner +{ + /// + /// Enum of available type of geolocation items: - 'what3words' functionality allows to specify a location by providing 3 words that have been assign to the specific location see [link](https://what3words.com/business) for more details. + /// + /// Enum of available type of geolocation items: - 'what3words' functionality allows to specify a location by providing 3 words that have been assign to the specific location see [link](https://what3words.com/business) for more details. + [JsonConverter(typeof(TypeEnumJsonConverter))] + public class TypeEnum + { + private string _value; + + internal TypeEnum() + { + _value = "what3words"; + } + + public TypeEnum(string value) + { + + } + + /// + /// Enum What3words for value: what3words + /// + public static TypeEnum What3words { get; } = new("what3words"); + + + public override string ToString() => _value; + } + + internal class TypeEnumJsonConverter : JsonConverter + { + public override TypeEnum? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new TypeEnum(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, TypeEnum value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(TypeEnum); + } + + + /// + /// Enum of available type of geolocation items: - 'what3words' functionality allows to specify a location by providing 3 words that have been assign to the specific location see [link](https://what3words.com/business) for more details. CLOVUS + /// + /// Enum of available type of geolocation items: - 'what3words' functionality allows to specify a location by providing 3 words that have been assign to the specific location see [link](https://what3words.com/business) for more details. + /// + /// what3words + /// + [JsonPropertyName("type")] + public TypeEnum? Type { get; set; } + /// + /// value of the geolocation item + /// + /// value of the geolocation item + /// + /// cats.with.thumbs + /// + [JsonPropertyName("value")] + public string Value { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class PartialShippingAddressToGeolocationInner {\n"); + sb.Append(" Type: ").Append(Type).Append("\n"); + sb.Append(" Value: ").Append(Value).Append("\n"); + 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/PaymentAmount.cs b/ShipEngineSDK/Model/PaymentAmount.cs new file mode 100644 index 00000000..fbfb3f41 --- /dev/null +++ b/ShipEngineSDK/Model/PaymentAmount.cs @@ -0,0 +1,68 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// PaymentAmount +/// +public partial class PaymentAmount +{ + + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + [JsonPropertyName("currency")] + public string Currency { get; set; } + + /// + /// Gets or Sets Amount + /// + [JsonPropertyName("amount")] + public double Amount { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class PaymentAmount {\n"); + sb.Append(" Currency: ").Append(Currency).Append("\n"); + sb.Append(" Amount: ").Append(Amount).Append("\n"); + 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/Products.cs b/ShipEngineSDK/Model/Products.cs new file mode 100644 index 00000000..8673ead5 --- /dev/null +++ b/ShipEngineSDK/Model/Products.cs @@ -0,0 +1,165 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The customs declaration for a single item in the shipment. +/// +public partial class Products +{ + + /// + /// A description of the item + /// + /// A description of the item + [JsonPropertyName("description")] + public string Description { get; set; } + + /// + /// The quantity of this item in the shipment. + /// + /// The quantity of this item in the shipment. + [JsonPropertyName("quantity")] + public int Quantity { get; set; } + + /// + /// The declared value of each item + /// + /// The declared value of each item + [JsonPropertyName("value")] + public MonetaryValue Value { get; set; } + + /// + /// The item weight + /// + /// The item weight + [JsonPropertyName("weight")] + public Weight Weight { get; set; } + + /// + /// The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item. + /// + /// The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item. + /// + /// 3926.1 + /// + [JsonPropertyName("harmonized_tariff_code")] + public string HarmonizedTariffCode { get; set; } + + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated + /// + /// CA + /// + [JsonPropertyName("country_of_origin")] + public string CountryOfOrigin { get; set; } + + /// + /// Gets or Sets UnitOfMeasure + /// + [JsonPropertyName("unit_of_measure")] + public string UnitOfMeasure { get; set; } + + /// + /// The SKU (Stock Keeping Unit) of the item + /// + /// The SKU (Stock Keeping Unit) of the item + [JsonPropertyName("sku")] + public string Sku { get; set; } + + /// + /// Description of the Custom Item's SKU + /// + /// Description of the Custom Item's SKU + [JsonPropertyName("sku_description")] + public string SkuDescription { get; set; } + + /// + /// Manufacturers Identification code + /// + /// Manufacturers Identification code + [JsonPropertyName("mid_code")] + public string MidCode { get; set; } + + /// + /// link to the item on the seller website + /// + /// link to the item on the seller website + [JsonPropertyName("product_url")] + public string ProductUrl { get; set; } + + /// + /// VAT rate applicable to the item + /// + /// VAT rate applicable to the item + /// + /// 0.2 + /// + [JsonPropertyName("vat_rate")] + public double? VatRate { get; set; } + + /// + /// Details about dangerous goods inside products + /// + /// Details about dangerous goods inside products + [JsonPropertyName("dangerous_goods")] + public List DangerousGoods { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class Products {\n"); + sb.Append(" Description: ").Append(Description).Append("\n"); + sb.Append(" Quantity: ").Append(Quantity).Append("\n"); + sb.Append(" Value: ").Append(Value).Append("\n"); + sb.Append(" Weight: ").Append(Weight).Append("\n"); + sb.Append(" HarmonizedTariffCode: ").Append(HarmonizedTariffCode).Append("\n"); + sb.Append(" CountryOfOrigin: ").Append(CountryOfOrigin).Append("\n"); + sb.Append(" UnitOfMeasure: ").Append(UnitOfMeasure).Append("\n"); + sb.Append(" Sku: ").Append(Sku).Append("\n"); + sb.Append(" SkuDescription: ").Append(SkuDescription).Append("\n"); + sb.Append(" MidCode: ").Append(MidCode).Append("\n"); + sb.Append(" ProductUrl: ").Append(ProductUrl).Append("\n"); + sb.Append(" VatRate: ").Append(VatRate).Append("\n"); + sb.Append(" DangerousGoods: ").Append(DangerousGoods).Append("\n"); + 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/PurchaseLabelWithoutShipment.cs b/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs new file mode 100644 index 00000000..8315424f --- /dev/null +++ b/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs @@ -0,0 +1,84 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 purchase label without shipment resource +/// +public partial class PurchaseLabelWithoutShipment +{ + + /// + /// Gets or Sets ValidateAddress CLOVUS + /// + [JsonPropertyName("validate_address")] + public ValidateAddress? ValidateAddress { get; set; } + /// + /// Gets or Sets LabelLayout CLOVUS + /// + [JsonPropertyName("label_layout")] + public LabelLayout? LabelLayout { get; set; } + /// + /// Gets or Sets LabelFormat CLOVUS + /// + [JsonPropertyName("label_format")] + public LabelFormat? LabelFormat { get; set; } + /// + /// Gets or Sets LabelDownloadType CLOVUS + /// + [JsonPropertyName("label_download_type")] + public LabelDownloadType? LabelDownloadType { get; set; } + /// + /// The display format that the label should be shown in. CLOVUS + /// + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme")] + public DisplayScheme? DisplayScheme { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class PurchaseLabelWithoutShipment {\n"); + sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); + sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); + sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); + sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + 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/RateEstimateByCarrierId.cs b/ShipEngineSDK/Model/RateEstimateByCarrierId.cs new file mode 100644 index 00000000..7527c79d --- /dev/null +++ b/ShipEngineSDK/Model/RateEstimateByCarrierId.cs @@ -0,0 +1,65 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// RateEstimateByCarrierId +/// +public partial class RateEstimateByCarrierId +{ + + /// + /// A string that uniquely identifies the carrier + /// + /// A string that uniquely identifies the carrier + /// + /// se-28529731 + /// + [JsonPropertyName("carrier_id")] + [Obsolete] + public string CarrierId { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class RateEstimateByCarrierId {\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); + 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/RateEstimateByCarrierIds.cs b/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs new file mode 100644 index 00000000..243fa078 --- /dev/null +++ b/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs @@ -0,0 +1,61 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// RateEstimateByCarrierIds +/// +public partial class RateEstimateByCarrierIds +{ + + /// + /// Array of Carrier Ids + /// + /// Array of Carrier Ids + [JsonPropertyName("carrier_ids")] + public List CarrierIds { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class RateEstimateByCarrierIds {\n"); + sb.Append(" CarrierIds: ").Append(CarrierIds).Append("\n"); + 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/RateRequestBody.cs b/ShipEngineSDK/Model/RateRequestBody.cs new file mode 100644 index 00000000..2a4f1d03 --- /dev/null +++ b/ShipEngineSDK/Model/RateRequestBody.cs @@ -0,0 +1,100 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 rate request body +/// +public partial class RateRequestBody +{ + + /// + /// Array of carrier ids to get rates for + /// + /// Array of carrier ids to get rates for + [JsonPropertyName("carrier_ids")] + [JsonRequired] + public List CarrierIds { get; set; } + + /// + /// Gets or Sets PackageTypes + /// + [JsonPropertyName("package_types")] + public List PackageTypes { get; set; } + + /// + /// Gets or Sets ServiceCodes + /// + [JsonPropertyName("service_codes")] + public List ServiceCodes { get; set; } + + /// + /// Calculate the duties and tariffs for cross border shipments. + /// + /// Calculate the duties and tariffs for cross border shipments. + [JsonPropertyName("calculate_tax_amount")] + public bool CalculateTaxAmount { get; set; } + + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + [JsonPropertyName("preferred_currency")] + public string PreferredCurrency { get; set; } + + /// + /// Indicate if it's a return shipment + /// + /// Indicate if it's a return shipment + [JsonPropertyName("is_return")] + public bool IsReturn { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class RateRequestBody {\n"); + sb.Append(" CarrierIds: ").Append(CarrierIds).Append("\n"); + sb.Append(" PackageTypes: ").Append(PackageTypes).Append("\n"); + sb.Append(" ServiceCodes: ").Append(ServiceCodes).Append("\n"); + sb.Append(" CalculateTaxAmount: ").Append(CalculateTaxAmount).Append("\n"); + sb.Append(" PreferredCurrency: ").Append(PreferredCurrency).Append("\n"); + sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); + 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/RateRequestByShipmentIds.cs b/ShipEngineSDK/Model/RateRequestByShipmentIds.cs new file mode 100644 index 00000000..495563cb --- /dev/null +++ b/ShipEngineSDK/Model/RateRequestByShipmentIds.cs @@ -0,0 +1,62 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// RateRequestByShipmentIds +/// +public partial class RateRequestByShipmentIds +{ + + /// + /// The array of shipment IDs + /// + /// The array of shipment IDs + [JsonPropertyName("shipment_ids")] + [JsonRequired] + public List ShipmentIds { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class RateRequestByShipmentIds {\n"); + sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); + 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/RateRequestByShipments.cs b/ShipEngineSDK/Model/RateRequestByShipments.cs new file mode 100644 index 00000000..82b7c639 --- /dev/null +++ b/ShipEngineSDK/Model/RateRequestByShipments.cs @@ -0,0 +1,62 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// RateRequestByShipments +/// +public partial class RateRequestByShipments +{ + + /// + /// The array of shipments to get bulk rate estimates for + /// + /// The array of shipments to get bulk rate estimates for + [JsonPropertyName("shipments")] + [JsonRequired] + public List Shipments { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class RateRequestByShipments {\n"); + sb.Append(" Shipments: ").Append(Shipments).Append("\n"); + 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/RateRequestOptions.cs b/ShipEngineSDK/Model/RateRequestOptions.cs new file mode 100644 index 00000000..fd531ed9 --- /dev/null +++ b/ShipEngineSDK/Model/RateRequestOptions.cs @@ -0,0 +1,61 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// RateRequestOptions +/// +public partial class RateRequestOptions +{ + + /// + /// The rate options + /// + /// The rate options + [JsonPropertyName("rate_options")] + public RateRequestBody RateOptions { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class RateRequestOptions {\n"); + sb.Append(" RateOptions: ").Append(RateOptions).Append("\n"); + 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/RateRequestRateOptions.cs b/ShipEngineSDK/Model/RateRequestRateOptions.cs new file mode 100644 index 00000000..3056bafe --- /dev/null +++ b/ShipEngineSDK/Model/RateRequestRateOptions.cs @@ -0,0 +1,61 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// RateRequestRateOptions +/// +public partial class RateRequestRateOptions +{ + + /// + /// The rate options + /// + /// The rate options + [JsonPropertyName("rate_options")] + public RateRequestBody RateOptions { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class RateRequestRateOptions {\n"); + sb.Append(" RateOptions: ").Append(RateOptions).Append("\n"); + 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/RateResponse.cs b/ShipEngineSDK/Model/RateResponse.cs new file mode 100644 index 00000000..f622fd55 --- /dev/null +++ b/ShipEngineSDK/Model/RateResponse.cs @@ -0,0 +1,61 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// RateResponse +/// +public partial class RateResponse +{ + + /// + /// The rates response + /// + /// The rates response + [JsonPropertyName("rate_response")] + public RatesInformation VarRateResponse { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class RateResponse {\n"); + sb.Append(" VarRateResponse: ").Append(VarRateResponse).Append("\n"); + 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/RateResponseStatus.cs b/ShipEngineSDK/Model/RateResponseStatus.cs new file mode 100644 index 00000000..60d2efa9 --- /dev/null +++ b/ShipEngineSDK/Model/RateResponseStatus.cs @@ -0,0 +1,89 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible rate response status values +/// +/// The possible rate response status values +[JsonConverter(typeof(RateResponseStatusJsonConverter))] +public class RateResponseStatus +{ + private string _value; + + internal RateResponseStatus() + { + _value = "working"; + } + + /// + /// Create a new instance of RateResponseStatus with a custom value. + /// + /// The value of the RateResponseStatus + /// + /// 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 RateResponseStatus(string value) + { + _value = value; + } + + /// + /// Enum Working for value: working + /// + public static RateResponseStatus Working { get; } = new("working"); + + + /// + /// Enum Completed for value: completed + /// + public static RateResponseStatus Completed { get; } = new("completed"); + + + /// + /// Enum Partial for value: partial + /// + public static RateResponseStatus Partial { get; } = new("partial"); + + + /// + /// Enum Error for value: error + /// + public static RateResponseStatus Error { get; } = new("error"); + + + public override string ToString() => _value; +} + +internal class RateResponseStatusJsonConverter : JsonConverter +{ + public override RateResponseStatus? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new RateResponseStatus(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, RateResponseStatus value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(RateResponseStatus); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/RateType.cs b/ShipEngineSDK/Model/RateType.cs new file mode 100644 index 00000000..3ed284f8 --- /dev/null +++ b/ShipEngineSDK/Model/RateType.cs @@ -0,0 +1,77 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible rate type values +/// +/// The possible rate type values +[JsonConverter(typeof(RateTypeJsonConverter))] +public class RateType +{ + private string _value; + + internal RateType() + { + _value = "check"; + } + + /// + /// Create a new instance of RateType with a custom value. + /// + /// The value of the RateType + /// + /// 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 RateType(string value) + { + _value = value; + } + + /// + /// Enum Check for value: check + /// + public static RateType Check { get; } = new("check"); + + + /// + /// Enum Shipment for value: shipment + /// + public static RateType Shipment { get; } = new("shipment"); + + + public override string ToString() => _value; +} + +internal class RateTypeJsonConverter : JsonConverter +{ + public override RateType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new RateType(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, RateType value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(RateType); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/RatesInformation.cs b/ShipEngineSDK/Model/RatesInformation.cs new file mode 100644 index 00000000..c0f8bf03 --- /dev/null +++ b/ShipEngineSDK/Model/RatesInformation.cs @@ -0,0 +1,115 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 rates information resource +/// +public partial class RatesInformation +{ + + /// + /// Gets or Sets Status CLOVUS + /// + [JsonPropertyName("status")] + public RateResponseStatus? Status { get; set; } + /// + /// An array of shipment rates + /// + /// An array of shipment rates + [JsonPropertyName("rates")] + public List Rates { get; set; } + + /// + /// An array of invalid shipment rates + /// + /// An array of invalid shipment rates + [JsonPropertyName("invalid_rates")] + public List InvalidRates { get; set; } + + /// + /// A string that uniquely identifies the rate request + /// + /// A string that uniquely identifies the rate request + /// + /// se-28529731 + /// + [JsonPropertyName("rate_request_id")] + public string RateRequestId { get; set; } + + /// + /// A string that uniquely identifies the shipment + /// + /// A string that uniquely identifies the shipment + /// + /// se-28529731 + /// + [JsonPropertyName("shipment_id")] + public string ShipmentId { get; set; } + + /// + /// When the rate was created + /// + /// When the rate was created + /// + /// se-28529731 + /// + [JsonPropertyName("created_at")] + public string CreatedAt { get; set; } + + /// + /// Gets or Sets Errors + /// + [JsonPropertyName("errors")] + public List Errors { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class RatesInformation {\n"); + sb.Append(" Rates: ").Append(Rates).Append("\n"); + sb.Append(" InvalidRates: ").Append(InvalidRates).Append("\n"); + sb.Append(" RateRequestId: ").Append(RateRequestId).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" Status: ").Append(Status).Append("\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); + 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/ReasonCode.cs b/ShipEngineSDK/Model/ReasonCode.cs new file mode 100644 index 00000000..460a1c21 --- /dev/null +++ b/ShipEngineSDK/Model/ReasonCode.cs @@ -0,0 +1,107 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible normalized reasons a label void request may not have been approved +/// +/// The possible normalized reasons a label void request may not have been approved +[JsonConverter(typeof(ReasonCodeJsonConverter))] +public class ReasonCode +{ + private string _value; + + internal ReasonCode() + { + _value = "unknown"; + } + + /// + /// Create a new instance of ReasonCode with a custom value. + /// + /// The value of the ReasonCode + /// + /// 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 ReasonCode(string value) + { + _value = value; + } + + /// + /// Enum Unknown for value: unknown + /// + public static ReasonCode Unknown { get; } = new("unknown"); + + + /// + /// Enum Unspecified for value: unspecified + /// + public static ReasonCode Unspecified { get; } = new("unspecified"); + + + /// + /// Enum ValidationFailed for value: validation_failed + /// + public static ReasonCode ValidationFailed { get; } = new("validation_failed"); + + + /// + /// Enum LabelNotFoundWithinVoidPeriod for value: label_not_found_within_void_period + /// + public static ReasonCode LabelNotFoundWithinVoidPeriod { get; } = new("label_not_found_within_void_period"); + + + /// + /// Enum LabelAlreadyUsed for value: label_already_used + /// + public static ReasonCode LabelAlreadyUsed { get; } = new("label_already_used"); + + + /// + /// Enum LabelAlreadyVoided for value: label_already_voided + /// + public static ReasonCode LabelAlreadyVoided { get; } = new("label_already_voided"); + + + /// + /// Enum ContactCarrier for value: contact_carrier + /// + public static ReasonCode ContactCarrier { get; } = new("contact_carrier"); + + + public override string ToString() => _value; +} + +internal class ReasonCodeJsonConverter : JsonConverter +{ + public override ReasonCode? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new ReasonCode(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, ReasonCode value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(ReasonCode); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/RecognizedEntity.cs b/ShipEngineSDK/Model/RecognizedEntity.cs new file mode 100644 index 00000000..647066c5 --- /dev/null +++ b/ShipEngineSDK/Model/RecognizedEntity.cs @@ -0,0 +1,106 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An entity is a single piece of data that was recognized in unstructured text. For example, a city, a postal code, package dimensions, insured value, etc. Each entity includes the original text and the parsed value. +/// +public partial class RecognizedEntity +{ + + /// + /// The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.) + /// + /// The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.) + [JsonPropertyName("type")] + [JsonRequired] + public string Type { get; set; } + + /// + /// A confidence score between zero and one that indicates how certain the API is that it correctly recognized this entity + /// + /// A confidence score between zero and one that indicates how certain the API is that it correctly recognized this entity + [JsonPropertyName("score")] + [JsonRequired] + public double Score { get; set; } + + /// + /// The substring from the original text that was recognized as this entity + /// + /// The substring from the original text that was recognized as this entity + [JsonPropertyName("text")] + [JsonRequired] + public string Text { get; set; } + + /// + /// The index of the first character of this entity within the original text + /// + /// The index of the first character of this entity within the original text + [JsonPropertyName("start_index")] + [JsonRequired] + public int StartIndex { get; set; } + + /// + /// The index of the last character of this entity within the original text + /// + /// The index of the last character of this entity within the original text + [JsonPropertyName("end_index")] + [JsonRequired] + public int EndIndex { get; set; } + + /// + /// The normalized value of the entity. Most entity results have a `value` field, which is the normalized value of the entity. For example, if the substring \"john doe\" was recognized as a \"person\" entity, then the value might be normalized to have proper capitalization (e.g. \"John Doe\"). Or if the substring \"ft worth\" was recognized as a \"city\" entity, then the value might be normalized to \"Fort Worth\". Some entities have other information in addition to, or instead of a `value`. For example, a \"dimensions\" entity will have separate fields for `length`, `width`, `height`, and `unit`. + /// + /// The normalized value of the entity. Most entity results have a `value` field, which is the normalized value of the entity. For example, if the substring \"john doe\" was recognized as a \"person\" entity, then the value might be normalized to have proper capitalization (e.g. \"John Doe\"). Or if the substring \"ft worth\" was recognized as a \"city\" entity, then the value might be normalized to \"Fort Worth\". Some entities have other information in addition to, or instead of a `value`. For example, a \"dimensions\" entity will have separate fields for `length`, `width`, `height`, and `unit`. + [JsonPropertyName("result")] + public Dictionary Result { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class RecognizedEntity {\n"); + sb.Append(" Type: ").Append(Type).Append("\n"); + sb.Append(" Score: ").Append(Score).Append("\n"); + sb.Append(" Text: ").Append(Text).Append("\n"); + sb.Append(" StartIndex: ").Append(StartIndex).Append("\n"); + sb.Append(" EndIndex: ").Append(EndIndex).Append("\n"); + sb.Append(" Result: ").Append(Result).Append("\n"); + 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/Redirect.cs b/ShipEngineSDK/Model/Redirect.cs new file mode 100644 index 00000000..71b2144d --- /dev/null +++ b/ShipEngineSDK/Model/Redirect.cs @@ -0,0 +1,71 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The resource to return a redirect URL to. +/// +/// The resource to return a redirect URL to. +[JsonConverter(typeof(RedirectJsonConverter))] +public class Redirect +{ + private string _value; + + internal Redirect() + { + _value = "shipengine-dashboard"; + } + + /// + /// Create a new instance of Redirect with a custom value. + /// + /// The value of the Redirect + /// + /// 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 Redirect(string value) + { + _value = value; + } + + /// + /// Enum ShipengineDashboard for value: shipengine-dashboard + /// + public static Redirect ShipengineDashboard { get; } = new("shipengine-dashboard"); + + + public override string ToString() => _value; +} + +internal class RedirectJsonConverter : JsonConverter +{ + public override Redirect? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new Redirect(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, Redirect value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(Redirect); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/RegulationLevel.cs b/ShipEngineSDK/Model/RegulationLevel.cs new file mode 100644 index 00000000..151411a2 --- /dev/null +++ b/ShipEngineSDK/Model/RegulationLevel.cs @@ -0,0 +1,88 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Defines regulation_level +/// +[JsonConverter(typeof(RegulationLevelJsonConverter))] +public class RegulationLevel +{ + private string _value; + + internal RegulationLevel() + { + _value = "lightly_regulated"; + } + + /// + /// Create a new instance of RegulationLevel with a custom value. + /// + /// The value of the RegulationLevel + /// + /// 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 RegulationLevel(string value) + { + _value = value; + } + + /// + /// Enum LightlyRegulated for value: lightly_regulated + /// + public static RegulationLevel LightlyRegulated { get; } = new("lightly_regulated"); + + + /// + /// Enum FullyRegulated for value: fully_regulated + /// + public static RegulationLevel FullyRegulated { get; } = new("fully_regulated"); + + + /// + /// Enum LimitedQuantities for value: limited_quantities + /// + public static RegulationLevel LimitedQuantities { get; } = new("limited_quantities"); + + + /// + /// Enum ExceptedQuantity for value: excepted_quantity + /// + public static RegulationLevel ExceptedQuantity { get; } = new("excepted_quantity"); + + + public override string ToString() => _value; +} + +internal class RegulationLevelJsonConverter : JsonConverter +{ + public override RegulationLevel? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new RegulationLevel(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, RegulationLevel value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(RegulationLevel); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs b/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs new file mode 100644 index 00000000..5f5e2d17 --- /dev/null +++ b/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs @@ -0,0 +1,69 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 modify batch request body +/// +public partial class RemoveFromBatchRequestBody +{ + + /// + /// The Shipment Ids to be modified on the batch + /// + /// The Shipment Ids to be modified on the batch + [JsonPropertyName("shipment_ids")] + public List ShipmentIds { get; set; } + + /// + /// Array of Rate IDs to be modifed on the batch + /// + /// Array of Rate IDs to be modifed on the batch + [JsonPropertyName("rate_ids")] + public List RateIds { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class RemoveFromBatchRequestBody {\n"); + sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); + sb.Append(" RateIds: ").Append(RateIds).Append("\n"); + 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/ResponseMessage.cs b/ShipEngineSDK/Model/ResponseMessage.cs new file mode 100644 index 00000000..43e6525a --- /dev/null +++ b/ShipEngineSDK/Model/ResponseMessage.cs @@ -0,0 +1,92 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 response message that displays when additional info is needed for an address validation request. +/// +public partial class ResponseMessage +{ + + /// + /// Gets or Sets Code CLOVUS + /// + [JsonPropertyName("code")] + [JsonRequired] + public AddressValidationCode Code { get; set; } = new(); + + + /// + /// Gets or Sets Type CLOVUS + /// + [JsonPropertyName("type")] + [JsonRequired] + public AddressValidationMessageType Type { get; set; } = new(); + + + /// + /// Gets or Sets DetailCode CLOVUS + /// + [JsonPropertyName("detail_code")] + [JsonRequired] + public AddressValidationDetailCode DetailCode { get; set; } = new(); + + + /// + /// Message explaining the address validation error + /// + /// Message explaining the address validation error + /// + /// Invalid Postal Code + /// + [JsonPropertyName("message")] + [JsonRequired] + public string Message { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ResponseMessage {\n"); + sb.Append(" Code: ").Append(Code).Append("\n"); + sb.Append(" Message: ").Append(Message).Append("\n"); + sb.Append(" Type: ").Append(Type).Append("\n"); + sb.Append(" DetailCode: ").Append(DetailCode).Append("\n"); + 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/Service.cs b/ShipEngineSDK/Model/Service.cs new file mode 100644 index 00000000..4a6a81d8 --- /dev/null +++ b/ShipEngineSDK/Model/Service.cs @@ -0,0 +1,121 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 service offered by the carrier +/// +public partial class Service +{ + + /// + /// A string that uniquely identifies the carrier + /// + /// A string that uniquely identifies the carrier + /// + /// se-28529731 + /// + [JsonPropertyName("carrier_id")] + public string CarrierId { get; set; } + + /// + /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. + /// + /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. + /// + /// se-28529731 + /// + [JsonPropertyName("carrier_code")] + public string CarrierCode { get; set; } + + /// + /// service code + /// + /// service code + /// + /// usps_media_mail + /// + [JsonPropertyName("service_code")] + public string ServiceCode { get; set; } + + /// + /// User friendly service name + /// + /// User friendly service name + /// + /// USPS First Class Mail + /// + [JsonPropertyName("name")] + public string Name { get; set; } + + /// + /// Supports domestic shipping + /// + /// Supports domestic shipping + [JsonPropertyName("domestic")] + public bool Domestic { get; set; } + + /// + /// Supports international shipping. + /// + /// Supports international shipping. + [JsonPropertyName("international")] + public bool International { get; set; } + + /// + /// Carrier supports multiple packages per shipment + /// + /// Carrier supports multiple packages per shipment + [JsonPropertyName("is_multi_package_supported")] + public bool IsMultiPackageSupported { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class Service {\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Domestic: ").Append(Domestic).Append("\n"); + sb.Append(" International: ").Append(International).Append("\n"); + sb.Append(" IsMultiPackageSupported: ").Append(IsMultiPackageSupported).Append("\n"); + 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/ShipmentIdRequest.cs b/ShipEngineSDK/Model/ShipmentIdRequest.cs new file mode 100644 index 00000000..7fc69d69 --- /dev/null +++ b/ShipEngineSDK/Model/ShipmentIdRequest.cs @@ -0,0 +1,64 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// ShipmentIdRequest +/// +public partial class ShipmentIdRequest +{ + + /// + /// A string that uniquely identifies the shipment + /// + /// A string that uniquely identifies the shipment + /// + /// se-28529731 + /// + [JsonPropertyName("shipment_id")] + public string ShipmentId { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ShipmentIdRequest {\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + 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/ShipmentItem.cs b/ShipEngineSDK/Model/ShipmentItem.cs new file mode 100644 index 00000000..d1ab2ff4 --- /dev/null +++ b/ShipEngineSDK/Model/ShipmentItem.cs @@ -0,0 +1,126 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 shipment item +/// +public partial class ShipmentItem +{ + + /// + /// Gets or Sets OrderSourceCode CLOVUS + /// + [JsonPropertyName("order_source_code")] + public OrderSourceName? OrderSourceCode { get; set; } + /// + /// item name + /// + /// item name + [JsonPropertyName("name")] + public string Name { get; set; } + + /// + /// sales order id + /// + /// sales order id + [JsonPropertyName("sales_order_id")] + public string SalesOrderId { get; set; } + + /// + /// sales order item id + /// + /// sales order item id + [JsonPropertyName("sales_order_item_id")] + public string SalesOrderItemId { get; set; } + + /// + /// The quantity of this item included in the shipment + /// + /// The quantity of this item included in the shipment + [JsonPropertyName("quantity")] + public int Quantity { get; set; } + + /// + /// Item Stock Keeping Unit + /// + /// Item Stock Keeping Unit + [JsonPropertyName("sku")] + public string Sku { get; set; } + + /// + /// external order id + /// + /// external order id + [JsonPropertyName("external_order_id")] + public string ExternalOrderId { get; set; } + + /// + /// external order item id + /// + /// external order item id + [JsonPropertyName("external_order_item_id")] + public string ExternalOrderItemId { get; set; } + + /// + /// Amazon Standard Identification Number + /// + /// Amazon Standard Identification Number + /// + /// B00005N5PF + /// + [JsonPropertyName("asin")] + public string Asin { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ShipmentItem {\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" SalesOrderId: ").Append(SalesOrderId).Append("\n"); + sb.Append(" SalesOrderItemId: ").Append(SalesOrderItemId).Append("\n"); + sb.Append(" Quantity: ").Append(Quantity).Append("\n"); + sb.Append(" Sku: ").Append(Sku).Append("\n"); + sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); + sb.Append(" ExternalOrderItemId: ").Append(ExternalOrderItemId).Append("\n"); + sb.Append(" Asin: ").Append(Asin).Append("\n"); + sb.Append(" OrderSourceCode: ").Append(OrderSourceCode).Append("\n"); + 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/ShipmentRequest.cs b/ShipEngineSDK/Model/ShipmentRequest.cs new file mode 100644 index 00000000..6ba0cf60 --- /dev/null +++ b/ShipEngineSDK/Model/ShipmentRequest.cs @@ -0,0 +1,61 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// ShipmentRequest +/// +public partial class ShipmentRequest +{ + + /// + /// The shipment object + /// + /// The shipment object + [JsonPropertyName("shipment")] + public AddressValidatingShipment Shipment { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ShipmentRequest {\n"); + sb.Append(" Shipment: ").Append(Shipment).Append("\n"); + 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/ShipmentStatus.cs b/ShipEngineSDK/Model/ShipmentStatus.cs new file mode 100644 index 00000000..67b2da2d --- /dev/null +++ b/ShipEngineSDK/Model/ShipmentStatus.cs @@ -0,0 +1,89 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible shipment status values +/// +/// The possible shipment status values +[JsonConverter(typeof(ShipmentStatusJsonConverter))] +public class ShipmentStatus +{ + private string _value; + + internal ShipmentStatus() + { + _value = "pending"; + } + + /// + /// Create a new instance of ShipmentStatus with a custom value. + /// + /// The value of the ShipmentStatus + /// + /// 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 ShipmentStatus(string value) + { + _value = value; + } + + /// + /// Enum Pending for value: pending + /// + public static ShipmentStatus Pending { get; } = new("pending"); + + + /// + /// Enum Processing for value: processing + /// + public static ShipmentStatus Processing { get; } = new("processing"); + + + /// + /// Enum LabelPurchased for value: label_purchased + /// + public static ShipmentStatus LabelPurchased { get; } = new("label_purchased"); + + + /// + /// Enum Cancelled for value: cancelled + /// + public static ShipmentStatus Cancelled { get; } = new("cancelled"); + + + public override string ToString() => _value; +} + +internal class ShipmentStatusJsonConverter : JsonConverter +{ + public override ShipmentStatus? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new ShipmentStatus(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, ShipmentStatus value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(ShipmentStatus); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/ShipmentsSortBy.cs b/ShipEngineSDK/Model/ShipmentsSortBy.cs new file mode 100644 index 00000000..2330540f --- /dev/null +++ b/ShipEngineSDK/Model/ShipmentsSortBy.cs @@ -0,0 +1,77 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible shipments sort by values +/// +/// The possible shipments sort by values +[JsonConverter(typeof(ShipmentsSortByJsonConverter))] +public class ShipmentsSortBy +{ + private string _value; + + internal ShipmentsSortBy() + { + _value = "modified_at"; + } + + /// + /// Create a new instance of ShipmentsSortBy with a custom value. + /// + /// The value of the ShipmentsSortBy + /// + /// 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 ShipmentsSortBy(string value) + { + _value = value; + } + + /// + /// Enum ModifiedAt for value: modified_at + /// + public static ShipmentsSortBy ModifiedAt { get; } = new("modified_at"); + + + /// + /// Enum CreatedAt for value: created_at + /// + public static ShipmentsSortBy CreatedAt { get; } = new("created_at"); + + + public override string ToString() => _value; +} + +internal class ShipmentsSortByJsonConverter : JsonConverter +{ + public override ShipmentsSortBy? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new ShipmentsSortBy(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, ShipmentsSortBy value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(ShipmentsSortBy); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/ShippingAddress.cs b/ShipEngineSDK/Model/ShippingAddress.cs new file mode 100644 index 00000000..cb85434e --- /dev/null +++ b/ShipEngineSDK/Model/ShippingAddress.cs @@ -0,0 +1,199 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// ShippingAddress +/// +public partial class ShippingAddress +{ + + /// + /// Indicates whether this is a residential address. CLOVUS + /// + /// Indicates whether this is a residential address. + [JsonPropertyName("address_residential_indicator")] + [JsonRequired] + public AddressResidentialIndicator AddressResidentialIndicator { get; set; } = new(); + + + /// + /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. + /// + /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. + /// + /// John Doe + /// + [JsonPropertyName("name")] + [JsonRequired] + public string Name { get; set; } + + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// +1 204-253-9411 ext. 123 + /// + [JsonPropertyName("phone")] + [JsonRequired] + public string Phone { get; set; } + + /// + /// Email for the address owner. + /// + /// Email for the address owner. + /// + /// example@example.com + /// + [JsonPropertyName("email")] + public string Email { get; set; } + + /// + /// If this is a business address, then the company name should be specified here. + /// + /// If this is a business address, then the company name should be specified here. + /// + /// The Home Depot + /// + [JsonPropertyName("company_name")] + public string CompanyName { get; set; } + + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// 1999 Bishop Grandin Blvd. + /// + [JsonPropertyName("address_line1")] + [JsonRequired] + public string AddressLine1 { get; set; } + + /// + /// The second line of the street address. For some addresses, this line may not be needed. + /// + /// The second line of the street address. For some addresses, this line may not be needed. + /// + /// Unit 408 + /// + [JsonPropertyName("address_line2")] + public string AddressLine2 { get; set; } + + /// + /// The third line of the street address. For some addresses, this line may not be needed. + /// + /// The third line of the street address. For some addresses, this line may not be needed. + /// + /// Building #7 + /// + [JsonPropertyName("address_line3")] + public string AddressLine3 { get; set; } + + /// + /// The name of the city or locality + /// + /// The name of the city or locality + /// + /// Winnipeg + /// + [JsonPropertyName("city_locality")] + [JsonRequired] + public string CityLocality { get; set; } + + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// Manitoba + /// + [JsonPropertyName("state_province")] + [JsonRequired] + public string StateProvince { get; set; } + + /// + /// postal code + /// + /// postal code + /// + /// 78756-3717 + /// + [JsonPropertyName("postal_code")] + [JsonRequired] + public string PostalCode { get; set; } + + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// CA + /// + [JsonPropertyName("country_code")] + [JsonRequired] + public string CountryCode { get; set; } + + /// + /// Additional text about how to handle the shipment at this address. + /// + /// Additional text about how to handle the shipment at this address. + [JsonPropertyName("instructions")] + public string Instructions { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ShippingAddress {\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); + sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); + sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); + sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); + sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); + sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); + sb.Append(" Instructions: ").Append(Instructions).Append("\n"); + 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/ShippingAddressTo.cs b/ShipEngineSDK/Model/ShippingAddressTo.cs new file mode 100644 index 00000000..f4f10064 --- /dev/null +++ b/ShipEngineSDK/Model/ShippingAddressTo.cs @@ -0,0 +1,206 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// ShippingAddressTo +/// +public partial class ShippingAddressTo +{ + + /// + /// Indicates whether this is a residential address. CLOVUS + /// + /// Indicates whether this is a residential address. + [JsonPropertyName("address_residential_indicator")] + [JsonRequired] + public AddressResidentialIndicator AddressResidentialIndicator { get; set; } = new(); + + + /// + /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. + /// + /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. + /// + /// John Doe + /// + [JsonPropertyName("name")] + [JsonRequired] + public string Name { get; set; } + + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// +1 204-253-9411 ext. 123 + /// + [JsonPropertyName("phone")] + [JsonRequired] + public string Phone { get; set; } + + /// + /// Email for the address owner. + /// + /// Email for the address owner. + /// + /// example@example.com + /// + [JsonPropertyName("email")] + public string Email { get; set; } + + /// + /// If this is a business address, then the company name should be specified here. + /// + /// If this is a business address, then the company name should be specified here. + /// + /// The Home Depot + /// + [JsonPropertyName("company_name")] + public string CompanyName { get; set; } + + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// 1999 Bishop Grandin Blvd. + /// + [JsonPropertyName("address_line1")] + [JsonRequired] + public string AddressLine1 { get; set; } + + /// + /// The second line of the street address. For some addresses, this line may not be needed. + /// + /// The second line of the street address. For some addresses, this line may not be needed. + /// + /// Unit 408 + /// + [JsonPropertyName("address_line2")] + public string AddressLine2 { get; set; } + + /// + /// The third line of the street address. For some addresses, this line may not be needed. + /// + /// The third line of the street address. For some addresses, this line may not be needed. + /// + /// Building #7 + /// + [JsonPropertyName("address_line3")] + public string AddressLine3 { get; set; } + + /// + /// The name of the city or locality + /// + /// The name of the city or locality + /// + /// Winnipeg + /// + [JsonPropertyName("city_locality")] + [JsonRequired] + public string CityLocality { get; set; } + + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// Manitoba + /// + [JsonPropertyName("state_province")] + [JsonRequired] + public string StateProvince { get; set; } + + /// + /// postal code + /// + /// postal code + /// + /// 78756-3717 + /// + [JsonPropertyName("postal_code")] + [JsonRequired] + public string PostalCode { get; set; } + + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// CA + /// + [JsonPropertyName("country_code")] + [JsonRequired] + public string CountryCode { get; set; } + + /// + /// Additional text about how to handle the shipment at this address. + /// + /// Additional text about how to handle the shipment at this address. + [JsonPropertyName("instructions")] + public string Instructions { get; set; } + + /// + /// Gets or Sets Geolocation + /// + [JsonPropertyName("geolocation")] + public List Geolocation { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ShippingAddressTo {\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); + sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); + sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); + sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); + sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); + sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); + sb.Append(" Instructions: ").Append(Instructions).Append("\n"); + sb.Append(" Geolocation: ").Append(Geolocation).Append("\n"); + 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/SmartPostHub.cs b/ShipEngineSDK/Model/SmartPostHub.cs new file mode 100644 index 00000000..23ec9ffd --- /dev/null +++ b/ShipEngineSDK/Model/SmartPostHub.cs @@ -0,0 +1,269 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible smart post hub values +/// +/// The possible smart post hub values +[JsonConverter(typeof(SmartPostHubJsonConverter))] +public class SmartPostHub +{ + private string _value; + + internal SmartPostHub() + { + _value = "none"; + } + + /// + /// Create a new instance of SmartPostHub with a custom value. + /// + /// The value of the SmartPostHub + /// + /// 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 SmartPostHub(string value) + { + _value = value; + } + + /// + /// Enum None for value: none + /// + public static SmartPostHub None { get; } = new("none"); + + + /// + /// Enum AllentownPa for value: allentown_pa + /// + public static SmartPostHub AllentownPa { get; } = new("allentown_pa"); + + + /// + /// Enum AtlantaGa for value: atlanta_ga + /// + public static SmartPostHub AtlantaGa { get; } = new("atlanta_ga"); + + + /// + /// Enum BaltimoreMd for value: baltimore_md + /// + public static SmartPostHub BaltimoreMd { get; } = new("baltimore_md"); + + + /// + /// Enum CharlotteNc for value: charlotte_nc + /// + public static SmartPostHub CharlotteNc { get; } = new("charlotte_nc"); + + + /// + /// Enum ChinoCa for value: chino_ca + /// + public static SmartPostHub ChinoCa { get; } = new("chino_ca"); + + + /// + /// Enum DallasTx for value: dallas_tx + /// + public static SmartPostHub DallasTx { get; } = new("dallas_tx"); + + + /// + /// Enum DenverCo for value: denver_co + /// + public static SmartPostHub DenverCo { get; } = new("denver_co"); + + + /// + /// Enum DetroitMi for value: detroit_mi + /// + public static SmartPostHub DetroitMi { get; } = new("detroit_mi"); + + + /// + /// Enum EdisonNj for value: edison_nj + /// + public static SmartPostHub EdisonNj { get; } = new("edison_nj"); + + + /// + /// Enum GroveCityOh for value: grove_city_oh + /// + public static SmartPostHub GroveCityOh { get; } = new("grove_city_oh"); + + + /// + /// Enum GroveportOh for value: groveport_oh + /// + public static SmartPostHub GroveportOh { get; } = new("groveport_oh"); + + + /// + /// Enum HoustonTx for value: houston_tx + /// + public static SmartPostHub HoustonTx { get; } = new("houston_tx"); + + + /// + /// Enum IndianapolisIn for value: indianapolis_in + /// + public static SmartPostHub IndianapolisIn { get; } = new("indianapolis_in"); + + + /// + /// Enum KansasCityKs for value: kansas_city_ks + /// + public static SmartPostHub KansasCityKs { get; } = new("kansas_city_ks"); + + + /// + /// Enum LosAngelesCa for value: los_angeles_ca + /// + public static SmartPostHub LosAngelesCa { get; } = new("los_angeles_ca"); + + + /// + /// Enum MartinsburgWv for value: martinsburg_wv + /// + public static SmartPostHub MartinsburgWv { get; } = new("martinsburg_wv"); + + + /// + /// Enum MemphisTn for value: memphis_tn + /// + public static SmartPostHub MemphisTn { get; } = new("memphis_tn"); + + + /// + /// Enum MinneapolisMn for value: minneapolis_mn + /// + public static SmartPostHub MinneapolisMn { get; } = new("minneapolis_mn"); + + + /// + /// Enum NewBerlinWi for value: new_berlin_wi + /// + public static SmartPostHub NewBerlinWi { get; } = new("new_berlin_wi"); + + + /// + /// Enum NorthboroughMa for value: northborough_ma + /// + public static SmartPostHub NorthboroughMa { get; } = new("northborough_ma"); + + + /// + /// Enum OrlandoFl for value: orlando_fl + /// + public static SmartPostHub OrlandoFl { get; } = new("orlando_fl"); + + + /// + /// Enum PhoneixAz for value: phoneix_az + /// + public static SmartPostHub PhoneixAz { get; } = new("phoneix_az"); + + + /// + /// Enum PittsburghPa for value: pittsburgh_pa + /// + public static SmartPostHub PittsburghPa { get; } = new("pittsburgh_pa"); + + + /// + /// Enum RenoNv for value: reno_nv + /// + public static SmartPostHub RenoNv { get; } = new("reno_nv"); + + + /// + /// Enum SacramentoCa for value: sacramento_ca + /// + public static SmartPostHub SacramentoCa { get; } = new("sacramento_ca"); + + + /// + /// Enum SaltLakeCityUt for value: salt_lake_city_ut + /// + public static SmartPostHub SaltLakeCityUt { get; } = new("salt_lake_city_ut"); + + + /// + /// Enum SeattleWa for value: seattle_wa + /// + public static SmartPostHub SeattleWa { get; } = new("seattle_wa"); + + + /// + /// Enum StLouisMo for value: st_louis_mo + /// + public static SmartPostHub StLouisMo { get; } = new("st_louis_mo"); + + + /// + /// Enum WindsorCt for value: windsor_ct + /// + public static SmartPostHub WindsorCt { get; } = new("windsor_ct"); + + + /// + /// Enum NewarkNy for value: newark_ny + /// + public static SmartPostHub NewarkNy { get; } = new("newark_ny"); + + + /// + /// Enum SouthBrunswickNj for value: south_brunswick_nj + /// + public static SmartPostHub SouthBrunswickNj { get; } = new("south_brunswick_nj"); + + + /// + /// Enum ScrantonPa for value: scranton_pa + /// + public static SmartPostHub ScrantonPa { get; } = new("scranton_pa"); + + + /// + /// Enum WheelingIl for value: wheeling_il + /// + public static SmartPostHub WheelingIl { get; } = new("wheeling_il"); + + + public override string ToString() => _value; +} + +internal class SmartPostHubJsonConverter : JsonConverter +{ + public override SmartPostHub? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new SmartPostHub(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, SmartPostHub value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(SmartPostHub); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/SortDir.cs b/ShipEngineSDK/Model/SortDir.cs new file mode 100644 index 00000000..abe55972 --- /dev/null +++ b/ShipEngineSDK/Model/SortDir.cs @@ -0,0 +1,77 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Controls the sort order of queries |Value |Description |:- -- -- -- --|:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`asc` |Return results in ascending order |`desc` |Return results in descending order +/// +/// Controls the sort order of queries |Value |Description |:- -- -- -- --|:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`asc` |Return results in ascending order |`desc` |Return results in descending order +[JsonConverter(typeof(SortDirJsonConverter))] +public class SortDir +{ + private string _value; + + internal SortDir() + { + _value = "asc"; + } + + /// + /// Create a new instance of SortDir with a custom value. + /// + /// The value of the SortDir + /// + /// 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 SortDir(string value) + { + _value = value; + } + + /// + /// Enum Asc for value: asc + /// + public static SortDir Asc { get; } = new("asc"); + + + /// + /// Enum Desc for value: desc + /// + public static SortDir Desc { get; } = new("desc"); + + + public override string ToString() => _value; +} + +internal class SortDirJsonConverter : JsonConverter +{ + public override SortDir? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new SortDir(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, SortDir value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(SortDir); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/StatusCode.cs b/ShipEngineSDK/Model/StatusCode.cs new file mode 100644 index 00000000..1103c0c4 --- /dev/null +++ b/ShipEngineSDK/Model/StatusCode.cs @@ -0,0 +1,107 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The tracking status codes |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`un` | Unknown |`ac` | Accepted |`it` | In Transit |`de` | Delivered |`ex` | Exception |`at` | Delivery Attempt |`ny` | Not Yet In System +/// +/// The tracking status codes |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`un` | Unknown |`ac` | Accepted |`it` | In Transit |`de` | Delivered |`ex` | Exception |`at` | Delivery Attempt |`ny` | Not Yet In System +[JsonConverter(typeof(StatusCodeJsonConverter))] +public class StatusCode +{ + private string _value; + + internal StatusCode() + { + _value = "un"; + } + + /// + /// Create a new instance of StatusCode with a custom value. + /// + /// The value of the StatusCode + /// + /// 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 StatusCode(string value) + { + _value = value; + } + + /// + /// Enum Un for value: un + /// + public static StatusCode Un { get; } = new("un"); + + + /// + /// Enum Ac for value: ac + /// + public static StatusCode Ac { get; } = new("ac"); + + + /// + /// Enum It for value: it + /// + public static StatusCode It { get; } = new("it"); + + + /// + /// Enum De for value: de + /// + public static StatusCode De { get; } = new("de"); + + + /// + /// Enum Ex for value: ex + /// + public static StatusCode Ex { get; } = new("ex"); + + + /// + /// Enum At for value: at + /// + public static StatusCode At { get; } = new("at"); + + + /// + /// Enum Ny for value: ny + /// + public static StatusCode Ny { get; } = new("ny"); + + + public override string ToString() => _value; +} + +internal class StatusCodeJsonConverter : JsonConverter +{ + public override StatusCode? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new StatusCode(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, StatusCode value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(StatusCode); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/Tag.cs b/ShipEngineSDK/Model/Tag.cs new file mode 100644 index 00000000..c5956fb3 --- /dev/null +++ b/ShipEngineSDK/Model/Tag.cs @@ -0,0 +1,65 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer. +/// +public partial class Tag +{ + + /// + /// The tag name. + /// + /// The tag name. + /// + /// Fragile + /// + [JsonPropertyName("name")] + [JsonRequired] + public string Name { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class Tag {\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + 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/TagShipmentResponseBody.cs b/ShipEngineSDK/Model/TagShipmentResponseBody.cs new file mode 100644 index 00000000..5eaabd98 --- /dev/null +++ b/ShipEngineSDK/Model/TagShipmentResponseBody.cs @@ -0,0 +1,61 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Get shipment tags response body +/// +public partial class TagShipmentResponseBody +{ + + /// + /// Gets or Sets Tags + /// + [JsonPropertyName("tags")] + [JsonRequired] + public List Tags { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class TagShipmentResponseBody {\n"); + sb.Append(" Tags: ").Append(Tags).Append("\n"); + 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/TaxIdentifier.cs b/ShipEngineSDK/Model/TaxIdentifier.cs new file mode 100644 index 00000000..22b20c87 --- /dev/null +++ b/ShipEngineSDK/Model/TaxIdentifier.cs @@ -0,0 +1,89 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 tax identifier object +/// +public partial class TaxIdentifier +{ + + /// + /// Gets or Sets TaxableEntityType CLOVUS + /// + [JsonPropertyName("taxable_entity_type")] + [JsonRequired] + public TaxableEntityType TaxableEntityType { get; set; } = new(); + + + /// + /// Gets or Sets IdentifierType CLOVUS + /// + [JsonPropertyName("identifier_type")] + [JsonRequired] + public IdentifierType IdentifierType { get; set; } = new(); + + + /// + /// The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code. + /// + /// The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code. + [JsonPropertyName("issuing_authority")] + [JsonRequired] + public string IssuingAuthority { get; set; } + + /// + /// The value of the identifier + /// + /// The value of the identifier + [JsonPropertyName("value")] + [JsonRequired] + public string Value { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class TaxIdentifier {\n"); + sb.Append(" TaxableEntityType: ").Append(TaxableEntityType).Append("\n"); + sb.Append(" IdentifierType: ").Append(IdentifierType).Append("\n"); + sb.Append(" IssuingAuthority: ").Append(IssuingAuthority).Append("\n"); + sb.Append(" Value: ").Append(Value).Append("\n"); + 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/TaxableEntityType.cs b/ShipEngineSDK/Model/TaxableEntityType.cs new file mode 100644 index 00000000..18334085 --- /dev/null +++ b/ShipEngineSDK/Model/TaxableEntityType.cs @@ -0,0 +1,83 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The taxable entity type for this tax item. Valid values include the following |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`shipper` | The shipper is responsible for this tax. |`recipient` | The recipient of the shipment is responsible for this tax. |`ior` | The importer of records is responsible for tax. +/// +/// The taxable entity type for this tax item. Valid values include the following |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`shipper` | The shipper is responsible for this tax. |`recipient` | The recipient of the shipment is responsible for this tax. |`ior` | The importer of records is responsible for tax. +[JsonConverter(typeof(TaxableEntityTypeJsonConverter))] +public class TaxableEntityType +{ + private string _value; + + internal TaxableEntityType() + { + _value = "shipper"; + } + + /// + /// Create a new instance of TaxableEntityType with a custom value. + /// + /// The value of the TaxableEntityType + /// + /// 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 TaxableEntityType(string value) + { + _value = value; + } + + /// + /// Enum Shipper for value: shipper + /// + public static TaxableEntityType Shipper { get; } = new("shipper"); + + + /// + /// Enum Recipient for value: recipient + /// + public static TaxableEntityType Recipient { get; } = new("recipient"); + + + /// + /// Enum Ior for value: ior + /// + public static TaxableEntityType Ior { get; } = new("ior"); + + + public override string ToString() => _value; +} + +internal class TaxableEntityTypeJsonConverter : JsonConverter +{ + public override TaxableEntityType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new TaxableEntityType(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, TaxableEntityType value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(TaxableEntityType); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs b/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs new file mode 100644 index 00000000..d518dade --- /dev/null +++ b/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs @@ -0,0 +1,69 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// TokensGetEphemeralTokenResponseBodyYaml +/// +public partial class TokensGetEphemeralTokenResponseBodyYaml +{ + + /// + /// The requested token that expires in 10 seconds. + /// + /// The requested token that expires in 10 seconds. + [JsonPropertyName("token")] + public string Token { get; set; } + + /// + /// The redirect url formatted with the requested token. + /// + /// The redirect url formatted with the requested token. + [JsonPropertyName("redirect_url")] + public string RedirectUrl { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class TokensGetEphemeralTokenResponseBodyYaml {\n"); + sb.Append(" Token: ").Append(Token).Append("\n"); + sb.Append(" RedirectUrl: ").Append(RedirectUrl).Append("\n"); + 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/TrackingStatus.cs b/ShipEngineSDK/Model/TrackingStatus.cs new file mode 100644 index 00000000..61910bdc --- /dev/null +++ b/ShipEngineSDK/Model/TrackingStatus.cs @@ -0,0 +1,89 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The different statuses that can apply to a shipment. +/// +/// The different statuses that can apply to a shipment. +[JsonConverter(typeof(TrackingStatusJsonConverter))] +public class TrackingStatus +{ + private string _value; + + internal TrackingStatus() + { + _value = "unknown"; + } + + /// + /// Create a new instance of TrackingStatus with a custom value. + /// + /// The value of the TrackingStatus + /// + /// 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 TrackingStatus(string value) + { + _value = value; + } + + /// + /// Enum Unknown for value: unknown + /// + public static TrackingStatus Unknown { get; } = new("unknown"); + + + /// + /// Enum InTransit for value: in_transit + /// + public static TrackingStatus InTransit { get; } = new("in_transit"); + + + /// + /// Enum Error for value: error + /// + public static TrackingStatus Error { get; } = new("error"); + + + /// + /// Enum Delivered for value: delivered + /// + public static TrackingStatus Delivered { get; } = new("delivered"); + + + public override string ToString() => _value; +} + +internal class TrackingStatusJsonConverter : JsonConverter +{ + public override TrackingStatus? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new TrackingStatus(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, TrackingStatus value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(TrackingStatus); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/TransportMean.cs b/ShipEngineSDK/Model/TransportMean.cs new file mode 100644 index 00000000..9532cc4b --- /dev/null +++ b/ShipEngineSDK/Model/TransportMean.cs @@ -0,0 +1,88 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Defines transport_mean +/// +[JsonConverter(typeof(TransportMeanJsonConverter))] +public class TransportMean +{ + private string _value; + + internal TransportMean() + { + _value = "ground"; + } + + /// + /// Create a new instance of TransportMean with a custom value. + /// + /// The value of the TransportMean + /// + /// 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 TransportMean(string value) + { + _value = value; + } + + /// + /// Enum Ground for value: ground + /// + public static TransportMean Ground { get; } = new("ground"); + + + /// + /// Enum Water for value: water + /// + public static TransportMean Water { get; } = new("water"); + + + /// + /// Enum CargoAircraftOnly for value: cargo_aircraft_only + /// + public static TransportMean CargoAircraftOnly { get; } = new("cargo_aircraft_only"); + + + /// + /// Enum PassengerAircraft for value: passenger_aircraft + /// + public static TransportMean PassengerAircraft { get; } = new("passenger_aircraft"); + + + public override string ToString() => _value; +} + +internal class TransportMeanJsonConverter : JsonConverter +{ + public override TransportMean? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new TransportMean(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, TransportMean value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(TransportMean); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs b/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs new file mode 100644 index 00000000..ca0f0058 --- /dev/null +++ b/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs @@ -0,0 +1,61 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An amazon buy shipping account settings request body +/// +public partial class UpdateAmazonBuyShippingRequestBody +{ + + /// + /// Email + /// + /// Email + [JsonPropertyName("email")] + public string Email { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class UpdateAmazonBuyShippingRequestBody {\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + 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/UpdateCarrierSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs new file mode 100644 index 00000000..c94981c0 --- /dev/null +++ b/ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs @@ -0,0 +1,379 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.IO; +using System.Linq; +using System.Reflection; +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; + +/// +/// UpdateCarrierSettingsRequestBody +/// +[JsonConverter(typeof(UpdateCarrierSettingsRequestBodyJsonConverter))] +//[DataContract(Name = "update_carrier_settings_request_body")] +public partial class UpdateCarrierSettingsRequestBody : AbstractOpenAPISchema +{ + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of UpdateDhlExpressSettingsRequestBody. + public UpdateCarrierSettingsRequestBody(UpdateDhlExpressSettingsRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of UpdateFedexSettingsRequestBody. + public UpdateCarrierSettingsRequestBody(UpdateFedexSettingsRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of UpdateNewgisticsSettingsRequestBody. + public UpdateCarrierSettingsRequestBody(UpdateNewgisticsSettingsRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of UpdateUpsSettingsRequestBody. + public UpdateCarrierSettingsRequestBody(UpdateUpsSettingsRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + /// + /// Initializes a new instance of the class + /// with the class + /// + /// An instance of UpdateAmazonBuyShippingRequestBody. + public UpdateCarrierSettingsRequestBody(UpdateAmazonBuyShippingRequestBody actualInstance) + { + this.IsNullable = false; + this.SchemaType = "oneOf"; + this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + } + + + private Object _actualInstance; + + /// + /// Gets or Sets ActualInstance + /// + public override Object ActualInstance + { + get + { + return _actualInstance; + } + set + { + if (value.GetType() == typeof(UpdateDhlExpressSettingsRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(UpdateFedexSettingsRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(UpdateNewgisticsSettingsRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(UpdateUpsSettingsRequestBody)) + { + this._actualInstance = value; + } + else if (value.GetType() == typeof(UpdateAmazonBuyShippingRequestBody)) + { + this._actualInstance = value; + } + else + { + throw new ArgumentException("Invalid instance found. Must be the following types: UpdateDhlExpressSettingsRequestBody, UpdateFedexSettingsRequestBody, UpdateNewgisticsSettingsRequestBody, UpdateUpsSettingsRequestBody, UpdateAmazonBuyShippingRequestBody"); + } + } + } + + /// + /// Get the actual instance of `UpdateDhlExpressSettingsRequestBody`. If the actual instance is not `UpdateDhlExpressSettingsRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of UpdateDhlExpressSettingsRequestBody + public UpdateDhlExpressSettingsRequestBody GetUpdateDhlExpressSettingsRequestBody() + { + return (UpdateDhlExpressSettingsRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `UpdateFedexSettingsRequestBody`. If the actual instance is not `UpdateFedexSettingsRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of UpdateFedexSettingsRequestBody + public UpdateFedexSettingsRequestBody GetUpdateFedexSettingsRequestBody() + { + return (UpdateFedexSettingsRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `UpdateNewgisticsSettingsRequestBody`. If the actual instance is not `UpdateNewgisticsSettingsRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of UpdateNewgisticsSettingsRequestBody + public UpdateNewgisticsSettingsRequestBody GetUpdateNewgisticsSettingsRequestBody() + { + return (UpdateNewgisticsSettingsRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `UpdateUpsSettingsRequestBody`. If the actual instance is not `UpdateUpsSettingsRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of UpdateUpsSettingsRequestBody + public UpdateUpsSettingsRequestBody GetUpdateUpsSettingsRequestBody() + { + return (UpdateUpsSettingsRequestBody)this.ActualInstance; + } + + /// + /// Get the actual instance of `UpdateAmazonBuyShippingRequestBody`. If the actual instance is not `UpdateAmazonBuyShippingRequestBody`, + /// the InvalidClassException will be thrown + /// + /// An instance of UpdateAmazonBuyShippingRequestBody + public UpdateAmazonBuyShippingRequestBody GetUpdateAmazonBuyShippingRequestBody() + { + return (UpdateAmazonBuyShippingRequestBody)this.ActualInstance; + } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + var sb = new StringBuilder(); + sb.Append("class UpdateCarrierSettingsRequestBody {\n"); + sb.Append(" ActualInstance: ").Append(this.ActualInstance).Append("\n"); + + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public override string ToJson() + { + return JsonSerializer.Serialize(this.ActualInstance, UpdateCarrierSettingsRequestBody.SerializerSettings); + } + +} + +/// +/// Custom JSON converter for UpdateCarrierSettingsRequestBody +/// +public class UpdateCarrierSettingsRequestBodyJsonConverter : JsonConverter +{ + private static HashSet OneOfTypes = [typeof(UpdateDhlExpressSettingsRequestBody), typeof(UpdateFedexSettingsRequestBody), typeof(UpdateNewgisticsSettingsRequestBody), typeof(UpdateUpsSettingsRequestBody), typeof(UpdateAmazonBuyShippingRequestBody)]; + private static HashSet MandatoryFields = []; + private static JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) + { + TypeInfoResolver = new DefaultJsonTypeInfoResolver + { + Modifiers = + { + static typeInfo => + { + if (typeInfo.Kind != JsonTypeInfoKind.Object) + return; + + foreach (JsonPropertyInfo propertyInfo in typeInfo.Properties) + { + // Strip IsRequired constraint from every property except those which define the underlying type + if (OneOfTypes.Contains(typeInfo.Type)) + { + var underlyingPropertyName = (propertyInfo.AttributeProvider as MemberInfo)?.Name; + propertyInfo.IsRequired = underlyingPropertyName != null && MandatoryFields.Contains(underlyingPropertyName); + } + else + { + propertyInfo.IsRequired = false; + } + } + } + } + } + }; + + /// + /// To write the JSON string + /// + /// JSON writer + /// Object to be converted into a JSON string + /// Serializer options + public override void Write(Utf8JsonWriter writer, UpdateCarrierSettingsRequestBody value, JsonSerializerOptions options) + { + writer.WriteStartObject(); + + + var node = JsonSerializer.SerializeToNode(value.ActualInstance, options); + foreach (var prop in node?.AsObject() ?? []) + { + if (prop.Value != null) + { + writer.WritePropertyName(prop.Key); + prop.Value.WriteTo(writer, options); + } + } + + writer.WriteEndObject(); + } + + /// + /// To convert a JSON string into an object + /// + /// JSON reader + /// Object type to convert + /// Serializer options + /// The object converted from the JSON string + public override UpdateCarrierSettingsRequestBody Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + if (reader.TokenType == JsonTokenType.Null) + { + return null; + } + + var jsonDoc = JsonDocument.ParseValue(ref reader); + UpdateCarrierSettingsRequestBody newUpdateCarrierSettingsRequestBody = null; + + int match = 0; + var matchedTypes = new List(); + + try + { + newUpdateCarrierSettingsRequestBody = new UpdateCarrierSettingsRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("UpdateDhlExpressSettingsRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into UpdateDhlExpressSettingsRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newUpdateCarrierSettingsRequestBody = new UpdateCarrierSettingsRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("UpdateFedexSettingsRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into UpdateFedexSettingsRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newUpdateCarrierSettingsRequestBody = new UpdateCarrierSettingsRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("UpdateNewgisticsSettingsRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into UpdateNewgisticsSettingsRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newUpdateCarrierSettingsRequestBody = new UpdateCarrierSettingsRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("UpdateUpsSettingsRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into UpdateUpsSettingsRequestBody: {1}", jsonDoc, exception.ToString())); + } + + try + { + newUpdateCarrierSettingsRequestBody = new UpdateCarrierSettingsRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + + matchedTypes.Add("UpdateAmazonBuyShippingRequestBody"); + match++; + } + catch (Exception exception) + { + // deserialization failed, try the next one + System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into UpdateAmazonBuyShippingRequestBody: {1}", jsonDoc, exception.ToString())); + } + + if (match == 0) + { + throw new InvalidDataException("The JSON string `" + jsonDoc + "` cannot be deserialized into any schema defined."); + } + + if (match > 1) + { + throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); + } + + + // deserialization is considered successful at this point if no exception has been thrown. + return newUpdateCarrierSettingsRequestBody; + } + + /// + /// Check if the object can be converted + /// + /// Object type + /// True if the object can be converted + public override bool CanConvert(Type objectType) + { + return typeof(UpdateCarrierSettingsRequestBody).IsAssignableFrom(objectType); + } +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs new file mode 100644 index 00000000..81308538 --- /dev/null +++ b/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs @@ -0,0 +1,77 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An update dhl express settings request body +/// +public partial class UpdateDhlExpressSettingsRequestBody +{ + + /// + /// Account nickname + /// + /// Account nickname + [JsonPropertyName("nickname")] + public string Nickname { get; set; } + + /// + /// Indicates if the account number should be hidden on the archive documentation + /// + /// Indicates if the account number should be hidden on the archive documentation + [JsonPropertyName("should_hide_account_number_on_archive_doc")] + public bool ShouldHideAccountNumberOnArchiveDoc { get; set; } + + /// + /// Indicates if this is primary account + /// + /// Indicates if this is primary account + [JsonPropertyName("is_primary_account")] + public bool IsPrimaryAccount { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class UpdateDhlExpressSettingsRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" ShouldHideAccountNumberOnArchiveDoc: ").Append(ShouldHideAccountNumberOnArchiveDoc).Append("\n"); + sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); + 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/UpdateFedexSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs new file mode 100644 index 00000000..0765d4b4 --- /dev/null +++ b/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs @@ -0,0 +1,100 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An update Fedex settings request body +/// +public partial class UpdateFedexSettingsRequestBody +{ + + /// + /// Gets or Sets PickupType CLOVUS + /// + [JsonPropertyName("pickup_type")] + public FedexPickupType? PickupType { get; set; } + /// + /// Gets or Sets SmartPostHub CLOVUS + /// + [JsonPropertyName("smart_post_hub")] + public SmartPostHub? SmartPostHub { get; set; } + /// + /// Gets or Sets SmartPostEndorsement CLOVUS + /// + [JsonPropertyName("smart_post_endorsement")] + public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } + /// + /// Account nickname + /// + /// Account nickname + [JsonPropertyName("nickname")] + public string Nickname { get; set; } + + /// + /// Gets or Sets IsPrimaryAccount + /// + [JsonPropertyName("is_primary_account")] + public bool IsPrimaryAccount { get; set; } + + /// + /// Gets or Sets SignatureImage + /// + [JsonPropertyName("signature_image")] + public string SignatureImage { get; set; } + + /// + /// Gets or Sets LetterheadImage + /// + [JsonPropertyName("letterhead_image")] + public string LetterheadImage { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class UpdateFedexSettingsRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" PickupType: ").Append(PickupType).Append("\n"); + sb.Append(" SmartPostHub: ").Append(SmartPostHub).Append("\n"); + sb.Append(" SmartPostEndorsement: ").Append(SmartPostEndorsement).Append("\n"); + sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); + sb.Append(" SignatureImage: ").Append(SignatureImage).Append("\n"); + sb.Append(" LetterheadImage: ").Append(LetterheadImage).Append("\n"); + 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/UpdateNewgisticsSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs new file mode 100644 index 00000000..bfea3343 --- /dev/null +++ b/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs @@ -0,0 +1,67 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 newgistics account settings request body +/// +public partial class UpdateNewgisticsSettingsRequestBody +{ + + /// + /// Gets or Sets IncludeBarcodeWithOrderNumber + /// + [JsonPropertyName("include_barcode_with_order_number")] + public bool IncludeBarcodeWithOrderNumber { get; set; } + + /// + /// Gets or Sets ReceiveEmailOnManifestProcessing + /// + [JsonPropertyName("receive_email_on_manifest_processing")] + public bool ReceiveEmailOnManifestProcessing { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class UpdateNewgisticsSettingsRequestBody {\n"); + sb.Append(" IncludeBarcodeWithOrderNumber: ").Append(IncludeBarcodeWithOrderNumber).Append("\n"); + sb.Append(" ReceiveEmailOnManifestProcessing: ").Append(ReceiveEmailOnManifestProcessing).Append("\n"); + 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/UpdatePackageTypeRequestBody.cs b/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs new file mode 100644 index 00000000..c8ab72cf --- /dev/null +++ b/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs @@ -0,0 +1,106 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An update package type request body +/// +public partial class UpdatePackageTypeRequestBody +{ + + /// + /// A string that uniquely identifies the package. + /// + /// A string that uniquely identifies the package. + /// + /// se-28529731 + /// + [JsonPropertyName("package_id")] + public string PackageId { get; set; } + + /// + /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. + /// + /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. + /// + /// small_flat_rate_box + /// + [JsonPropertyName("package_code")] + [JsonRequired] + public string PackageCode { get; set; } + + /// + /// Gets or Sets Name + /// + /// + /// laptop_box + /// + [JsonPropertyName("name")] + [JsonRequired] + public string Name { get; set; } + + /// + /// The custom dimensions for the package. + /// + /// The custom dimensions for the package. + [JsonPropertyName("dimensions")] + public Dimensions Dimensions { get; set; } + + /// + /// Provides a helpful description for the custom package. + /// + /// Provides a helpful description for the custom package. + /// + /// Packaging for laptops + /// + [JsonPropertyName("description")] + public string Description { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class UpdatePackageTypeRequestBody {\n"); + sb.Append(" PackageId: ").Append(PackageId).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); + sb.Append(" Description: ").Append(Description).Append("\n"); + 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/UpdateShipmentFields.cs b/ShipEngineSDK/Model/UpdateShipmentFields.cs new file mode 100644 index 00000000..72d03bc7 --- /dev/null +++ b/ShipEngineSDK/Model/UpdateShipmentFields.cs @@ -0,0 +1,59 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// UpdateShipmentFields +/// +public partial class UpdateShipmentFields +{ + + /// + /// Gets or Sets ValidateAddress CLOVUS + /// + [JsonPropertyName("validate_address")] + public ValidateAddress? ValidateAddress { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class UpdateShipmentFields {\n"); + sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); + 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/UpdateShipmentsTags.cs b/ShipEngineSDK/Model/UpdateShipmentsTags.cs new file mode 100644 index 00000000..e9eb0faf --- /dev/null +++ b/ShipEngineSDK/Model/UpdateShipmentsTags.cs @@ -0,0 +1,60 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// UpdateShipmentsTags +/// +public partial class UpdateShipmentsTags +{ + + /// + /// Gets or Sets ShipmentsTags + /// + [JsonPropertyName("shipments_tags")] + public List ShipmentsTags { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class UpdateShipmentsTags {\n"); + sb.Append(" ShipmentsTags: ").Append(ShipmentsTags).Append("\n"); + 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/UpdateShipmentsTagsRequestBody.cs b/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs new file mode 100644 index 00000000..24851e44 --- /dev/null +++ b/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs @@ -0,0 +1,60 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 request body with shipments and tags +/// +public partial class UpdateShipmentsTagsRequestBody +{ + + /// + /// Gets or Sets ShipmentsTags + /// + [JsonPropertyName("shipments_tags")] + public List ShipmentsTags { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class UpdateShipmentsTagsRequestBody {\n"); + sb.Append(" ShipmentsTags: ").Append(ShipmentsTags).Append("\n"); + 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/UpdateShipmentsTagsShipmentsTagsInner.cs b/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs new file mode 100644 index 00000000..08be40b3 --- /dev/null +++ b/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs @@ -0,0 +1,67 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// UpdateShipmentsTagsShipmentsTagsInner +/// +public partial class UpdateShipmentsTagsShipmentsTagsInner +{ + + /// + /// Gets or Sets ShipmentId + /// + [JsonPropertyName("shipment_id")] + public string ShipmentId { get; set; } + + /// + /// Gets or Sets Tags + /// + [JsonPropertyName("tags")] + public List Tags { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class UpdateShipmentsTagsShipmentsTagsInner {\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" Tags: ").Append(Tags).Append("\n"); + 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/UpdateUpsSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs new file mode 100644 index 00000000..bd3eaa94 --- /dev/null +++ b/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs @@ -0,0 +1,145 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An update UPS settings request body +/// +public partial class UpdateUpsSettingsRequestBody +{ + + /// + /// Gets or Sets PickupType CLOVUS + /// + [JsonPropertyName("pickup_type")] + public UpsPickupType? PickupType { get; set; } + /// + /// Gets or Sets MailInnovationsEndorsement CLOVUS + /// + [JsonPropertyName("mail_innovations_endorsement")] + public AncillaryServiceEndorsement? MailInnovationsEndorsement { get; set; } + /// + /// nickname + /// + /// nickname + [JsonPropertyName("nickname")] + public string Nickname { get; set; } + + /// + /// Indicates if this is the primary UPS account + /// + /// Indicates if this is the primary UPS account + [JsonPropertyName("is_primary_account")] + public bool IsPrimaryAccount { get; set; } + + /// + /// The use carbon neutral shipping program + /// + /// The use carbon neutral shipping program + [JsonPropertyName("use_carbon_neutral_shipping_program")] + public bool UseCarbonNeutralShippingProgram { get; set; } + + /// + /// The use ground freight pricing + /// + /// The use ground freight pricing + [JsonPropertyName("use_ground_freight_pricing")] + public bool UseGroundFreightPricing { get; set; } + + /// + /// The use consolidation services + /// + /// The use consolidation services + [JsonPropertyName("use_consolidation_services")] + public bool UseConsolidationServices { get; set; } + + /// + /// The use order number on mail innovations labels + /// + /// The use order number on mail innovations labels + [JsonPropertyName("use_order_number_on_mail_innovations_labels")] + public bool UseOrderNumberOnMailInnovationsLabels { get; set; } + + /// + /// mail innovations cost center + /// + /// mail innovations cost center + [JsonPropertyName("mail_innovations_cost_center")] + public string MailInnovationsCostCenter { get; set; } + + /// + /// The use negotiated rates + /// + /// The use negotiated rates + [JsonPropertyName("use_negotiated_rates")] + public bool UseNegotiatedRates { get; set; } + + /// + /// account postal code + /// + /// account postal code + [JsonPropertyName("account_postal_code")] + public string AccountPostalCode { get; set; } + + /// + /// The invoice + /// + /// The invoice + [JsonPropertyName("invoice")] + public UpsInvoice Invoice { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class UpdateUpsSettingsRequestBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); + sb.Append(" PickupType: ").Append(PickupType).Append("\n"); + sb.Append(" UseCarbonNeutralShippingProgram: ").Append(UseCarbonNeutralShippingProgram).Append("\n"); + sb.Append(" UseGroundFreightPricing: ").Append(UseGroundFreightPricing).Append("\n"); + sb.Append(" UseConsolidationServices: ").Append(UseConsolidationServices).Append("\n"); + sb.Append(" UseOrderNumberOnMailInnovationsLabels: ").Append(UseOrderNumberOnMailInnovationsLabels).Append("\n"); + sb.Append(" MailInnovationsEndorsement: ").Append(MailInnovationsEndorsement).Append("\n"); + sb.Append(" MailInnovationsCostCenter: ").Append(MailInnovationsCostCenter).Append("\n"); + sb.Append(" UseNegotiatedRates: ").Append(UseNegotiatedRates).Append("\n"); + sb.Append(" AccountPostalCode: ").Append(AccountPostalCode).Append("\n"); + sb.Append(" Invoice: ").Append(Invoice).Append("\n"); + 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/UpdateWarehouseSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateWarehouseSettingsRequestBody.cs new file mode 100644 index 00000000..7e26ceaf --- /dev/null +++ b/ShipEngineSDK/Model/UpdateWarehouseSettingsRequestBody.cs @@ -0,0 +1,64 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An update warehouse settings request body +/// +public partial class UpdateWarehouseSettingsRequestBody +{ + + /// + /// The default property on the warehouse. + /// + /// The default property on the warehouse. + /// + /// true + /// + [JsonPropertyName("is_default")] + public bool? IsDefault { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class UpdateWarehouseSettingsRequestBody {\n"); + sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); + 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/UpdateWebhookRequestBody.cs b/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs new file mode 100644 index 00000000..d235ab7e --- /dev/null +++ b/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs @@ -0,0 +1,72 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// An update webhook request body +/// +public partial class UpdateWebhookRequestBody +{ + + /// + /// The url that the wehbook sends the request + /// + /// The url that the wehbook sends the request + /// + /// http://api.shipengine.com/v1/labels/se-28529731 + /// + [JsonPropertyName("url")] + public string Url { get; set; } + + /// + /// Array of custom webhook headers + /// + /// Array of custom webhook headers + [JsonPropertyName("headers")] + public List Headers { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class UpdateWebhookRequestBody {\n"); + sb.Append(" Url: ").Append(Url).Append("\n"); + sb.Append(" Headers: ").Append(Headers).Append("\n"); + 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/UpsAccountSettings.cs b/ShipEngineSDK/Model/UpsAccountSettings.cs new file mode 100644 index 00000000..61799b90 --- /dev/null +++ b/ShipEngineSDK/Model/UpsAccountSettings.cs @@ -0,0 +1,145 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// UPS account settings +/// +public partial class UpsAccountSettings +{ + + /// + /// Gets or Sets PickupType CLOVUS + /// + [JsonPropertyName("pickup_type")] + public UpsPickupType? PickupType { get; set; } + /// + /// Gets or Sets MailInnovationsEndorsement CLOVUS + /// + [JsonPropertyName("mail_innovations_endorsement")] + public AncillaryServiceEndorsement? MailInnovationsEndorsement { get; set; } + /// + /// nickname + /// + /// nickname + [JsonPropertyName("nickname")] + public string Nickname { get; set; } + + /// + /// Indicates if this is the primary UPS account + /// + /// Indicates if this is the primary UPS account + [JsonPropertyName("is_primary_account")] + public bool IsPrimaryAccount { get; set; } + + /// + /// The use carbon neutral shipping program + /// + /// The use carbon neutral shipping program + [JsonPropertyName("use_carbon_neutral_shipping_program")] + public bool UseCarbonNeutralShippingProgram { get; set; } + + /// + /// The use ground freight pricing + /// + /// The use ground freight pricing + [JsonPropertyName("use_ground_freight_pricing")] + public bool UseGroundFreightPricing { get; set; } + + /// + /// The use consolidation services + /// + /// The use consolidation services + [JsonPropertyName("use_consolidation_services")] + public bool UseConsolidationServices { get; set; } + + /// + /// The use order number on mail innovations labels + /// + /// The use order number on mail innovations labels + [JsonPropertyName("use_order_number_on_mail_innovations_labels")] + public bool UseOrderNumberOnMailInnovationsLabels { get; set; } + + /// + /// mail innovations cost center + /// + /// mail innovations cost center + [JsonPropertyName("mail_innovations_cost_center")] + public string MailInnovationsCostCenter { get; set; } + + /// + /// The use negotiated rates + /// + /// The use negotiated rates + [JsonPropertyName("use_negotiated_rates")] + public bool UseNegotiatedRates { get; set; } + + /// + /// account postal code + /// + /// account postal code + [JsonPropertyName("account_postal_code")] + public string AccountPostalCode { get; set; } + + /// + /// The invoice + /// + /// The invoice + [JsonPropertyName("invoice")] + public UpsInvoice Invoice { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class UpsAccountSettings {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); + sb.Append(" PickupType: ").Append(PickupType).Append("\n"); + sb.Append(" UseCarbonNeutralShippingProgram: ").Append(UseCarbonNeutralShippingProgram).Append("\n"); + sb.Append(" UseGroundFreightPricing: ").Append(UseGroundFreightPricing).Append("\n"); + sb.Append(" UseConsolidationServices: ").Append(UseConsolidationServices).Append("\n"); + sb.Append(" UseOrderNumberOnMailInnovationsLabels: ").Append(UseOrderNumberOnMailInnovationsLabels).Append("\n"); + sb.Append(" MailInnovationsEndorsement: ").Append(MailInnovationsEndorsement).Append("\n"); + sb.Append(" MailInnovationsCostCenter: ").Append(MailInnovationsCostCenter).Append("\n"); + sb.Append(" UseNegotiatedRates: ").Append(UseNegotiatedRates).Append("\n"); + sb.Append(" AccountPostalCode: ").Append(AccountPostalCode).Append("\n"); + sb.Append(" Invoice: ").Append(Invoice).Append("\n"); + 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/UpsPickupType.cs b/ShipEngineSDK/Model/UpsPickupType.cs new file mode 100644 index 00000000..79e4ca2f --- /dev/null +++ b/ShipEngineSDK/Model/UpsPickupType.cs @@ -0,0 +1,83 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible ups pickup type values +/// +/// The possible ups pickup type values +[JsonConverter(typeof(UpsPickupTypeJsonConverter))] +public class UpsPickupType +{ + private string _value; + + internal UpsPickupType() + { + _value = "daily_pickup"; + } + + /// + /// Create a new instance of UpsPickupType with a custom value. + /// + /// The value of the UpsPickupType + /// + /// 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 UpsPickupType(string value) + { + _value = value; + } + + /// + /// Enum DailyPickup for value: daily_pickup + /// + public static UpsPickupType DailyPickup { get; } = new("daily_pickup"); + + + /// + /// Enum OccasionalPickup for value: occasional_pickup + /// + public static UpsPickupType OccasionalPickup { get; } = new("occasional_pickup"); + + + /// + /// Enum CustomerCounter for value: customer_counter + /// + public static UpsPickupType CustomerCounter { get; } = new("customer_counter"); + + + public override string ToString() => _value; +} + +internal class UpsPickupTypeJsonConverter : JsonConverter +{ + public override UpsPickupType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new UpsPickupType(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, UpsPickupType value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(UpsPickupType); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/UpsSettingsResponseBody.cs b/ShipEngineSDK/Model/UpsSettingsResponseBody.cs new file mode 100644 index 00000000..04d85955 --- /dev/null +++ b/ShipEngineSDK/Model/UpsSettingsResponseBody.cs @@ -0,0 +1,145 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 UPS settings response body +/// +public partial class UpsSettingsResponseBody +{ + + /// + /// Gets or Sets PickupType CLOVUS + /// + [JsonPropertyName("pickup_type")] + public UpsPickupType? PickupType { get; set; } + /// + /// Gets or Sets MailInnovationsEndorsement CLOVUS + /// + [JsonPropertyName("mail_innovations_endorsement")] + public AncillaryServiceEndorsement? MailInnovationsEndorsement { get; set; } + /// + /// nickname + /// + /// nickname + [JsonPropertyName("nickname")] + public string Nickname { get; set; } + + /// + /// Indicates if this is the primary UPS account + /// + /// Indicates if this is the primary UPS account + [JsonPropertyName("is_primary_account")] + public bool IsPrimaryAccount { get; set; } + + /// + /// The use carbon neutral shipping program + /// + /// The use carbon neutral shipping program + [JsonPropertyName("use_carbon_neutral_shipping_program")] + public bool UseCarbonNeutralShippingProgram { get; set; } + + /// + /// The use ground freight pricing + /// + /// The use ground freight pricing + [JsonPropertyName("use_ground_freight_pricing")] + public bool UseGroundFreightPricing { get; set; } + + /// + /// The use consolidation services + /// + /// The use consolidation services + [JsonPropertyName("use_consolidation_services")] + public bool UseConsolidationServices { get; set; } + + /// + /// The use order number on mail innovations labels + /// + /// The use order number on mail innovations labels + [JsonPropertyName("use_order_number_on_mail_innovations_labels")] + public bool UseOrderNumberOnMailInnovationsLabels { get; set; } + + /// + /// mail innovations cost center + /// + /// mail innovations cost center + [JsonPropertyName("mail_innovations_cost_center")] + public string MailInnovationsCostCenter { get; set; } + + /// + /// The use negotiated rates + /// + /// The use negotiated rates + [JsonPropertyName("use_negotiated_rates")] + public bool UseNegotiatedRates { get; set; } + + /// + /// account postal code + /// + /// account postal code + [JsonPropertyName("account_postal_code")] + public string AccountPostalCode { get; set; } + + /// + /// The invoice + /// + /// The invoice + [JsonPropertyName("invoice")] + public UpsInvoice Invoice { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class UpsSettingsResponseBody {\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); + sb.Append(" PickupType: ").Append(PickupType).Append("\n"); + sb.Append(" UseCarbonNeutralShippingProgram: ").Append(UseCarbonNeutralShippingProgram).Append("\n"); + sb.Append(" UseGroundFreightPricing: ").Append(UseGroundFreightPricing).Append("\n"); + sb.Append(" UseConsolidationServices: ").Append(UseConsolidationServices).Append("\n"); + sb.Append(" UseOrderNumberOnMailInnovationsLabels: ").Append(UseOrderNumberOnMailInnovationsLabels).Append("\n"); + sb.Append(" MailInnovationsEndorsement: ").Append(MailInnovationsEndorsement).Append("\n"); + sb.Append(" MailInnovationsCostCenter: ").Append(MailInnovationsCostCenter).Append("\n"); + sb.Append(" UseNegotiatedRates: ").Append(UseNegotiatedRates).Append("\n"); + sb.Append(" AccountPostalCode: ").Append(AccountPostalCode).Append("\n"); + sb.Append(" Invoice: ").Append(Invoice).Append("\n"); + 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/ValidateAddress.cs b/ShipEngineSDK/Model/ValidateAddress.cs new file mode 100644 index 00000000..73d89a0f --- /dev/null +++ b/ShipEngineSDK/Model/ValidateAddress.cs @@ -0,0 +1,83 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible validate address values +/// +/// The possible validate address values +[JsonConverter(typeof(ValidateAddressJsonConverter))] +public class ValidateAddress +{ + private string _value; + + internal ValidateAddress() + { + _value = "no_validation"; + } + + /// + /// Create a new instance of ValidateAddress with a custom value. + /// + /// The value of the ValidateAddress + /// + /// 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 ValidateAddress(string value) + { + _value = value; + } + + /// + /// Enum NoValidation for value: no_validation + /// + public static ValidateAddress NoValidation { get; } = new("no_validation"); + + + /// + /// Enum ValidateOnly for value: validate_only + /// + public static ValidateAddress ValidateOnly { get; } = new("validate_only"); + + + /// + /// Enum ValidateAndClean for value: validate_and_clean + /// + public static ValidateAddress ValidateAndClean { get; } = new("validate_and_clean"); + + + public override string ToString() => _value; +} + +internal class ValidateAddressJsonConverter : JsonConverter +{ + public override ValidateAddress? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new ValidateAddress(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, ValidateAddress value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(ValidateAddress); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/ValidateShipmentFields.cs b/ShipEngineSDK/Model/ValidateShipmentFields.cs new file mode 100644 index 00000000..2a94351f --- /dev/null +++ b/ShipEngineSDK/Model/ValidateShipmentFields.cs @@ -0,0 +1,59 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// ValidateShipmentFields +/// +public partial class ValidateShipmentFields +{ + + /// + /// Gets or Sets ValidateAddress CLOVUS + /// + [JsonPropertyName("validate_address")] + public ValidateAddress? ValidateAddress { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class ValidateShipmentFields {\n"); + sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); + 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/ValidationStatus.cs b/ShipEngineSDK/Model/ValidationStatus.cs new file mode 100644 index 00000000..7e81f094 --- /dev/null +++ b/ShipEngineSDK/Model/ValidationStatus.cs @@ -0,0 +1,89 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible validation status values +/// +/// The possible validation status values +[JsonConverter(typeof(ValidationStatusJsonConverter))] +public class ValidationStatus +{ + private string _value; + + internal ValidationStatus() + { + _value = "valid"; + } + + /// + /// Create a new instance of ValidationStatus with a custom value. + /// + /// The value of the ValidationStatus + /// + /// 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 ValidationStatus(string value) + { + _value = value; + } + + /// + /// Enum Valid for value: valid + /// + public static ValidationStatus Valid { get; } = new("valid"); + + + /// + /// Enum Invalid for value: invalid + /// + public static ValidationStatus Invalid { get; } = new("invalid"); + + + /// + /// Enum HasWarnings for value: has_warnings + /// + public static ValidationStatus HasWarnings { get; } = new("has_warnings"); + + + /// + /// Enum Unknown for value: unknown + /// + public static ValidationStatus Unknown { get; } = new("unknown"); + + + public override string ToString() => _value; +} + +internal class ValidationStatusJsonConverter : JsonConverter +{ + public override ValidationStatus? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new ValidationStatus(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, ValidationStatus value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(ValidationStatus); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/VoidLabelResponseBody.cs b/ShipEngineSDK/Model/VoidLabelResponseBody.cs new file mode 100644 index 00000000..19cd0c68 --- /dev/null +++ b/ShipEngineSDK/Model/VoidLabelResponseBody.cs @@ -0,0 +1,83 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 void label response body +/// +public partial class VoidLabelResponseBody +{ + + /// + /// Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later. CLOVUS + /// + /// Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later. + [JsonPropertyName("reason_code")] + public ReasonCode? ReasonCode { get; set; } + /// + /// Indicates whether the attempt to void the label was successful + /// + /// Indicates whether the attempt to void the label was successful + /// + /// false + /// + [JsonPropertyName("approved")] + [JsonRequired] + public bool Approved { get; set; } + + /// + /// Gets or Sets Message + /// + /// + /// Unable to delete FedEx shipment. Unable to retrieve record from database. + /// + [JsonPropertyName("message")] + [JsonRequired] + public string Message { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class VoidLabelResponseBody {\n"); + sb.Append(" Approved: ").Append(Approved).Append("\n"); + sb.Append(" Message: ").Append(Message).Append("\n"); + sb.Append(" ReasonCode: ").Append(ReasonCode).Append("\n"); + 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/Webhook.cs b/ShipEngineSDK/Model/Webhook.cs new file mode 100644 index 00000000..332caec7 --- /dev/null +++ b/ShipEngineSDK/Model/Webhook.cs @@ -0,0 +1,89 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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 webhook +/// +public partial class Webhook +{ + + /// + /// Gets or Sets Event CLOVUS + /// + [JsonPropertyName("event")] + public WebhookEvent? Event { get; set; } + /// + /// A string that uniquely identifies the webhook + /// + /// A string that uniquely identifies the webhook + /// + /// se-28529731 + /// + [JsonPropertyName("webhook_id")] + public string WebhookId { get; set; } + + /// + /// The url that the webhook sends the request to + /// + /// The url that the webhook sends the request to + /// + /// http://api.shipengine.com/v1/labels/se-28529731 + /// + [JsonPropertyName("url")] + public string Url { get; set; } + + /// + /// Array of custom webhook headers + /// + /// Array of custom webhook headers + [JsonPropertyName("headers")] + public List Headers { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class Webhook {\n"); + sb.Append(" WebhookId: ").Append(WebhookId).Append("\n"); + sb.Append(" Url: ").Append(Url).Append("\n"); + sb.Append(" Event: ").Append(Event).Append("\n"); + sb.Append(" Headers: ").Append(Headers).Append("\n"); + 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/WebhookEvent.cs b/ShipEngineSDK/Model/WebhookEvent.cs new file mode 100644 index 00000000..421becb0 --- /dev/null +++ b/ShipEngineSDK/Model/WebhookEvent.cs @@ -0,0 +1,107 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible webook event values +/// +/// The possible webook event values +[JsonConverter(typeof(WebhookEventJsonConverter))] +public class WebhookEvent +{ + private string _value; + + internal WebhookEvent() + { + _value = "batch"; + } + + /// + /// Create a new instance of WebhookEvent with a custom value. + /// + /// The value of the WebhookEvent + /// + /// 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 WebhookEvent(string value) + { + _value = value; + } + + /// + /// Enum Batch for value: batch + /// + public static WebhookEvent Batch { get; } = new("batch"); + + + /// + /// Enum CarrierConnected for value: carrier_connected + /// + public static WebhookEvent CarrierConnected { get; } = new("carrier_connected"); + + + /// + /// Enum OrderSourceRefreshComplete for value: order_source_refresh_complete + /// + public static WebhookEvent OrderSourceRefreshComplete { get; } = new("order_source_refresh_complete"); + + + /// + /// Enum Rate for value: rate + /// + public static WebhookEvent Rate { get; } = new("rate"); + + + /// + /// Enum ReportComplete for value: report_complete + /// + public static WebhookEvent ReportComplete { get; } = new("report_complete"); + + + /// + /// Enum SalesOrdersImported for value: sales_orders_imported + /// + public static WebhookEvent SalesOrdersImported { get; } = new("sales_orders_imported"); + + + /// + /// Enum Track for value: track + /// + public static WebhookEvent Track { get; } = new("track"); + + + public override string ToString() => _value; +} + +internal class WebhookEventJsonConverter : JsonConverter +{ + public override WebhookEvent? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new WebhookEvent(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, WebhookEvent value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(WebhookEvent); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/WebhookHeader.cs b/ShipEngineSDK/Model/WebhookHeader.cs new file mode 100644 index 00000000..ba941082 --- /dev/null +++ b/ShipEngineSDK/Model/WebhookHeader.cs @@ -0,0 +1,77 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// Optional header to be specified in webhook +/// +public partial class WebhookHeader +{ + + /// + /// Key/name of a header + /// + /// Key/name of a header + /// + /// custom-key + /// + [JsonPropertyName("key")] + [JsonRequired] + public string Key { get; set; } + + /// + /// Value of a header + /// + /// Value of a header + /// + /// custom-value + /// + [JsonPropertyName("value")] + [JsonRequired] + public string Value { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class WebhookHeader {\n"); + sb.Append(" Key: ").Append(Key).Append("\n"); + sb.Append(" Value: ").Append(Value).Append("\n"); + 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/Weight.cs b/ShipEngineSDK/Model/Weight.cs new file mode 100644 index 00000000..fe137a24 --- /dev/null +++ b/ShipEngineSDK/Model/Weight.cs @@ -0,0 +1,71 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The weight of a package +/// +public partial class Weight +{ + + /// + /// Gets or Sets Unit CLOVUS + /// + [JsonPropertyName("unit")] + [JsonRequired] + public WeightUnit Unit { get; set; } = new(); + + + /// + /// The weight, in the specified unit + /// + /// The weight, in the specified unit + [JsonPropertyName("value")] + [JsonRequired] + public double Value { get; set; } + + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class Weight {\n"); + sb.Append(" Value: ").Append(Value).Append("\n"); + sb.Append(" Unit: ").Append(Unit).Append("\n"); + 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/WeightUnit.cs b/ShipEngineSDK/Model/WeightUnit.cs new file mode 100644 index 00000000..2cc739c9 --- /dev/null +++ b/ShipEngineSDK/Model/WeightUnit.cs @@ -0,0 +1,89 @@ +/* + * ShipEngine API + * + * The version of the OpenAPI document: 1.1.202406212006 + * Contact: sales@shipengine.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +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; + +/// +/// The possible weight unit values +/// +/// The possible weight unit values +[JsonConverter(typeof(WeightUnitJsonConverter))] +public class WeightUnit +{ + private string _value; + + internal WeightUnit() + { + _value = "pound"; + } + + /// + /// Create a new instance of WeightUnit with a custom value. + /// + /// The value of the WeightUnit + /// + /// 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 WeightUnit(string value) + { + _value = value; + } + + /// + /// Enum Pound for value: pound + /// + public static WeightUnit Pound { get; } = new("pound"); + + + /// + /// Enum Ounce for value: ounce + /// + public static WeightUnit Ounce { get; } = new("ounce"); + + + /// + /// Enum Gram for value: gram + /// + public static WeightUnit Gram { get; } = new("gram"); + + + /// + /// Enum Kilogram for value: kilogram + /// + public static WeightUnit Kilogram { get; } = new("kilogram"); + + + public override string ToString() => _value; +} + +internal class WeightUnitJsonConverter : JsonConverter +{ + public override WeightUnit? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new WeightUnit(reader.GetString()) : null; + + public override void Write(Utf8JsonWriter writer, WeightUnit value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(WeightUnit); +} \ No newline at end of file From 5773578feb2477b5ff7aa846160763dfa7644b5f Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Tue, 16 Jul 2024 11:28:12 -0500 Subject: [PATCH 04/42] Add ToString comment for enum and mark some strings as nullable --- CHANGELOG.md | 10 +++++++++- .../Helpers/MockShipEngineFixture.cs | 6 ++---- ShipEngineSDK/ClientUtils.cs | 14 +++++++------- ShipEngineSDK/Config.cs | 2 +- ShipEngineSDK/Model/AccountSettingsImages.cs | 2 +- ShipEngineSDK/Model/AddressResidentialIndicator.cs | 5 ++++- ShipEngineSDK/Model/AddressValidationCode.cs | 5 ++++- ShipEngineSDK/Model/AddressValidationDetailCode.cs | 5 ++++- .../Model/AddressValidationMessageType.cs | 5 ++++- ShipEngineSDK/Model/AddressValidationStatus.cs | 5 ++++- ShipEngineSDK/Model/AllowedIncoterms.cs | 5 ++++- ShipEngineSDK/Model/AncillaryServiceEndorsement.cs | 5 ++++- ShipEngineSDK/Model/BatchStatus.cs | 5 ++++- ShipEngineSDK/Model/BatchesSortBy.cs | 5 ++++- ShipEngineSDK/Model/BillToParty.cs | 5 ++++- ShipEngineSDK/Model/CarrierName.cs | 5 ++++- ShipEngineSDK/Model/CarrierNameWithSettings.cs | 5 ++++- .../Model/CollectOnDeliveryPaymentType.cs | 5 ++++- .../Model/CreateAccountSettingsImageRequestBody.cs | 2 +- ShipEngineSDK/Model/DefaultLabelLayout.cs | 5 ++++- ShipEngineSDK/Model/DeliveryConfirmation.cs | 5 ++++- ShipEngineSDK/Model/DimensionUnit.cs | 5 ++++- ShipEngineSDK/Model/DisplayScheme.cs | 5 ++++- ShipEngineSDK/Model/ErrorCode.cs | 5 ++++- ShipEngineSDK/Model/ErrorSource.cs | 5 ++++- ShipEngineSDK/Model/ErrorType.cs | 5 ++++- ShipEngineSDK/Model/FedexPickupType.cs | 5 ++++- .../Model/GetAccountSettingsImagesResponseBody.cs | 2 +- .../GetServicePointByIdResponseBodyServicePoint.cs | 4 ++-- ShipEngineSDK/Model/IdentifierType.cs | 5 ++++- ShipEngineSDK/Model/InsuranceProvider.cs | 5 ++++- ShipEngineSDK/Model/LabelChargeEvent.cs | 5 ++++- ShipEngineSDK/Model/LabelDownloadType.cs | 5 ++++- ShipEngineSDK/Model/LabelFormat.cs | 5 ++++- ShipEngineSDK/Model/LabelLayout.cs | 5 ++++- ShipEngineSDK/Model/LabelStatus.cs | 5 ++++- ...tServicePointsResponseBodyServicePointsInner.cs | 4 ++-- ShipEngineSDK/Model/ManifestRequestStatus.cs | 5 ++++- ShipEngineSDK/Model/NonDelivery.cs | 5 ++++- ShipEngineSDK/Model/OrderSourceName.cs | 5 ++++- ShipEngineSDK/Model/OriginType.cs | 5 ++++- ShipEngineSDK/Model/PackageContents.cs | 5 ++++- ShipEngineSDK/Model/PackagingGroup.cs | 5 ++++- ShipEngineSDK/Model/PackagingInstructionSection.cs | 5 ++++- .../PartialShippingAddressToGeolocationInner.cs | 2 +- ShipEngineSDK/Model/RateResponseStatus.cs | 5 ++++- ShipEngineSDK/Model/RateType.cs | 5 ++++- ShipEngineSDK/Model/ReasonCode.cs | 5 ++++- ShipEngineSDK/Model/Redirect.cs | 5 ++++- ShipEngineSDK/Model/RegulationLevel.cs | 5 ++++- ShipEngineSDK/Model/ShipmentStatus.cs | 5 ++++- ShipEngineSDK/Model/ShipmentsSortBy.cs | 5 ++++- ShipEngineSDK/Model/SmartPostHub.cs | 5 ++++- ShipEngineSDK/Model/SortDir.cs | 5 ++++- ShipEngineSDK/Model/StatusCode.cs | 5 ++++- ShipEngineSDK/Model/TaxableEntityType.cs | 5 ++++- ShipEngineSDK/Model/TrackingStatus.cs | 5 ++++- ShipEngineSDK/Model/TransportMean.cs | 5 ++++- .../Model/UpdateAccountSettingsImageRequestBody.cs | 2 +- ShipEngineSDK/Model/UpsPickupType.cs | 5 ++++- ShipEngineSDK/Model/ValidateAddress.cs | 5 ++++- ShipEngineSDK/Model/ValidationStatus.cs | 5 ++++- ShipEngineSDK/Model/WebhookEvent.cs | 5 ++++- ShipEngineSDK/Model/WeightUnit.cs | 5 ++++- ShipEngineSDK/Multimap.cs | 2 +- ShipEngineSDK/NotNullIfNotNullAttribute.cs | 14 ++++++++++++++ ShipEngineSDK/RequestOptions.cs | 4 ++-- ShipEngineSDK/ShipEngine.cs | 8 +++++--- ShipEngineSDK/ShipEngineSDK.csproj | 2 +- generation/templates/modelEnum.mustache | 5 ++++- generation/templates/modelInnerEnum.mustache | 2 +- openapitools.json | 2 +- package.json | 2 +- 73 files changed, 270 insertions(+), 86 deletions(-) create mode 100644 ShipEngineSDK/NotNullIfNotNullAttribute.cs diff --git a/CHANGELOG.md b/CHANGELOG.md index fad20ad9..bbe10e5f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -161,4 +161,12 @@ Updated nuget package dependencies ## 3.0.0-beta.1 -- Created new SDK methods for the entire API that sit next to the pre-existing methods. The pre-existing methods will be deprecated eventually. \ No newline at end of file +## Added + +- Created new SDK methods for the entire API that sit next to the pre-existing methods. The pre-existing methods will be deprecated eventually. + +## 3.0.0-beta.2 + +## Changed + +- Add more explicit nullable reference types \ No newline at end of file diff --git a/ShipEngineSDK.Test/Helpers/MockShipEngineFixture.cs b/ShipEngineSDK.Test/Helpers/MockShipEngineFixture.cs index d5fca799..817545a1 100644 --- a/ShipEngineSDK.Test/Helpers/MockShipEngineFixture.cs +++ b/ShipEngineSDK.Test/Helpers/MockShipEngineFixture.cs @@ -21,10 +21,8 @@ public MockShipEngineFixture(Config config) }; HttpClient = new HttpClient(MockHandler.Object); - ShipEngine = new ShipEngine(config) - { - _client = ShipEngineClient.ConfigureHttpClient(config, HttpClient) - }; + var client = ShipEngineClient.ConfigureHttpClient(config, HttpClient); + ShipEngine = new ShipEngine(config, client); JsonSerializerOptions = new JsonSerializerOptions() { diff --git a/ShipEngineSDK/ClientUtils.cs b/ShipEngineSDK/ClientUtils.cs index 0ee5539b..2abeae29 100644 --- a/ShipEngineSDK/ClientUtils.cs +++ b/ShipEngineSDK/ClientUtils.cs @@ -6,6 +6,8 @@ namespace ShipEngineSDK; +using System.Diagnostics.CodeAnalysis; + /// /// Utility functions providing some benefit to API client consumers. /// @@ -69,7 +71,8 @@ public static Multimap ParameterToMultiMap(string collectionForm /// /// The parameter (header, path, query, form). /// Formatted string. - public static string ParameterToString(object obj) + [return: NotNullIfNotNull("obj")] + public static string? ParameterToString(object? obj) { return obj switch { @@ -111,17 +114,14 @@ private static bool HasEnumMemberAttrValue(object enumVal) /// /// /// EnumMember value as string otherwise null - private static string GetEnumMemberAttrValue(object enumVal) + private static string? GetEnumMemberAttrValue(object enumVal) { if (enumVal == null) throw new ArgumentNullException(nameof(enumVal)); var enumType = enumVal.GetType(); var memInfo = enumType.GetMember(enumVal.ToString() ?? throw new InvalidOperationException()); var attr = memInfo.FirstOrDefault()?.GetCustomAttributes(false).OfType().FirstOrDefault(); - if (attr != null) - { - return attr.Value; - } - return null; + + return attr?.Value; } } \ No newline at end of file diff --git a/ShipEngineSDK/Config.cs b/ShipEngineSDK/Config.cs index 9f813c47..97f85ef5 100644 --- a/ShipEngineSDK/Config.cs +++ b/ShipEngineSDK/Config.cs @@ -32,7 +32,7 @@ public class Config /// The number of retries to attempt after a failed request. Defaults to 1 public Config(string apiKey, TimeSpan? timeout = null, int retries = 1) { - if (apiKey == null || apiKey == "") + if (string.IsNullOrEmpty(apiKey)) { var message = "A ShipEngine API key must be specified."; throw new ShipEngineException(message, ErrorSource.Shipengine, ErrorType.Validation, ErrorCode.FieldValueRequired); diff --git a/ShipEngineSDK/Model/AccountSettingsImages.cs b/ShipEngineSDK/Model/AccountSettingsImages.cs index 05054427..51856d20 100644 --- a/ShipEngineSDK/Model/AccountSettingsImages.cs +++ b/ShipEngineSDK/Model/AccountSettingsImages.cs @@ -64,7 +64,7 @@ public ImageContentTypeEnum(string value) internal class ImageContentTypeEnumJsonConverter : JsonConverter { public override ImageContentTypeEnum? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new ImageContentTypeEnum(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new ImageContentTypeEnum(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, ImageContentTypeEnum value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/AddressResidentialIndicator.cs b/ShipEngineSDK/Model/AddressResidentialIndicator.cs index bcc94090..8f97f492 100644 --- a/ShipEngineSDK/Model/AddressResidentialIndicator.cs +++ b/ShipEngineSDK/Model/AddressResidentialIndicator.cs @@ -67,13 +67,16 @@ public AddressResidentialIndicator(string value) public static AddressResidentialIndicator No { get; } = new("no"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class AddressResidentialIndicatorJsonConverter : JsonConverter { public override AddressResidentialIndicator? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new AddressResidentialIndicator(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new AddressResidentialIndicator(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, AddressResidentialIndicator value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/AddressValidationCode.cs b/ShipEngineSDK/Model/AddressValidationCode.cs index 6d67ec18..548fc131 100644 --- a/ShipEngineSDK/Model/AddressValidationCode.cs +++ b/ShipEngineSDK/Model/AddressValidationCode.cs @@ -127,13 +127,16 @@ public AddressValidationCode(string value) public static AddressValidationCode R1003 { get; } = new("r1003"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class AddressValidationCodeJsonConverter : JsonConverter { public override AddressValidationCode? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new AddressValidationCode(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new AddressValidationCode(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, AddressValidationCode value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/AddressValidationDetailCode.cs b/ShipEngineSDK/Model/AddressValidationDetailCode.cs index a3546b44..61d3455e 100644 --- a/ShipEngineSDK/Model/AddressValidationDetailCode.cs +++ b/ShipEngineSDK/Model/AddressValidationDetailCode.cs @@ -397,13 +397,16 @@ public AddressValidationDetailCode(string value) public static AddressValidationDetailCode AddressNotFound { get; } = new("address_not_found"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class AddressValidationDetailCodeJsonConverter : JsonConverter { public override AddressValidationDetailCode? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new AddressValidationDetailCode(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new AddressValidationDetailCode(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, AddressValidationDetailCode value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/AddressValidationMessageType.cs b/ShipEngineSDK/Model/AddressValidationMessageType.cs index ac59692d..7a0c1e3c 100644 --- a/ShipEngineSDK/Model/AddressValidationMessageType.cs +++ b/ShipEngineSDK/Model/AddressValidationMessageType.cs @@ -67,13 +67,16 @@ public AddressValidationMessageType(string value) public static AddressValidationMessageType Info { get; } = new("info"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class AddressValidationMessageTypeJsonConverter : JsonConverter { public override AddressValidationMessageType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new AddressValidationMessageType(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new AddressValidationMessageType(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, AddressValidationMessageType value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/AddressValidationStatus.cs b/ShipEngineSDK/Model/AddressValidationStatus.cs index 737ac040..57c23240 100644 --- a/ShipEngineSDK/Model/AddressValidationStatus.cs +++ b/ShipEngineSDK/Model/AddressValidationStatus.cs @@ -73,13 +73,16 @@ public AddressValidationStatus(string value) public static AddressValidationStatus Error { get; } = new("error"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class AddressValidationStatusJsonConverter : JsonConverter { public override AddressValidationStatus? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new AddressValidationStatus(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new AddressValidationStatus(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, AddressValidationStatus value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/AllowedIncoterms.cs b/ShipEngineSDK/Model/AllowedIncoterms.cs index a8bd17b2..36b76e41 100644 --- a/ShipEngineSDK/Model/AllowedIncoterms.cs +++ b/ShipEngineSDK/Model/AllowedIncoterms.cs @@ -138,13 +138,16 @@ public AllowedIncoterms(string value) public static AllowedIncoterms Des { get; } = new("des"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class AllowedIncotermsJsonConverter : JsonConverter { public override AllowedIncoterms? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new AllowedIncoterms(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new AllowedIncoterms(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, AllowedIncoterms value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs b/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs index 6dfa711e..97f318d3 100644 --- a/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs +++ b/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs @@ -85,13 +85,16 @@ public AncillaryServiceEndorsement(string value) public static AncillaryServiceEndorsement LeaveIfNoResponse { get; } = new("leave_if_no_response"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class AncillaryServiceEndorsementJsonConverter : JsonConverter { public override AncillaryServiceEndorsement? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new AncillaryServiceEndorsement(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new AncillaryServiceEndorsement(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, AncillaryServiceEndorsement value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/BatchStatus.cs b/ShipEngineSDK/Model/BatchStatus.cs index 3ea0b579..07e0a34e 100644 --- a/ShipEngineSDK/Model/BatchStatus.cs +++ b/ShipEngineSDK/Model/BatchStatus.cs @@ -97,13 +97,16 @@ public BatchStatus(string value) public static BatchStatus Invalid { get; } = new("invalid"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class BatchStatusJsonConverter : JsonConverter { public override BatchStatus? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new BatchStatus(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new BatchStatus(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, BatchStatus value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/BatchesSortBy.cs b/ShipEngineSDK/Model/BatchesSortBy.cs index 2dc236c7..abf16ed3 100644 --- a/ShipEngineSDK/Model/BatchesSortBy.cs +++ b/ShipEngineSDK/Model/BatchesSortBy.cs @@ -67,13 +67,16 @@ public BatchesSortBy(string value) public static BatchesSortBy CreatedAt { get; } = new("created_at"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class BatchesSortByJsonConverter : JsonConverter { public override BatchesSortBy? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new BatchesSortBy(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new BatchesSortBy(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, BatchesSortBy value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/BillToParty.cs b/ShipEngineSDK/Model/BillToParty.cs index 67fd5fd5..1f36582d 100644 --- a/ShipEngineSDK/Model/BillToParty.cs +++ b/ShipEngineSDK/Model/BillToParty.cs @@ -61,13 +61,16 @@ public BillToParty(string value) public static BillToParty ThirdParty { get; } = new("third_party"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class BillToPartyJsonConverter : JsonConverter { public override BillToParty? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new BillToParty(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new BillToParty(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, BillToParty value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/CarrierName.cs b/ShipEngineSDK/Model/CarrierName.cs index 27b09555..7f38207f 100644 --- a/ShipEngineSDK/Model/CarrierName.cs +++ b/ShipEngineSDK/Model/CarrierName.cs @@ -217,13 +217,16 @@ public CarrierName(string value) public static CarrierName Lasership { get; } = new("lasership"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class CarrierNameJsonConverter : JsonConverter { public override CarrierName? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new CarrierName(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new CarrierName(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, CarrierName value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/CarrierNameWithSettings.cs b/ShipEngineSDK/Model/CarrierNameWithSettings.cs index fe9dce94..f917efbd 100644 --- a/ShipEngineSDK/Model/CarrierNameWithSettings.cs +++ b/ShipEngineSDK/Model/CarrierNameWithSettings.cs @@ -73,13 +73,16 @@ public CarrierNameWithSettings(string value) public static CarrierNameWithSettings Ups { get; } = new("ups"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class CarrierNameWithSettingsJsonConverter : JsonConverter { public override CarrierNameWithSettings? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new CarrierNameWithSettings(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new CarrierNameWithSettings(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, CarrierNameWithSettings value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs b/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs index 9929b535..1a76ec60 100644 --- a/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs +++ b/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs @@ -73,13 +73,16 @@ public CollectOnDeliveryPaymentType(string value) public static CollectOnDeliveryPaymentType None { get; } = new("none"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class CollectOnDeliveryPaymentTypeJsonConverter : JsonConverter { public override CollectOnDeliveryPaymentType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new CollectOnDeliveryPaymentType(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new CollectOnDeliveryPaymentType(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, CollectOnDeliveryPaymentType value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs index 3dd0a42d..216dc2d0 100644 --- a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs @@ -64,7 +64,7 @@ public ImageContentTypeEnum(string value) internal class ImageContentTypeEnumJsonConverter : JsonConverter { public override ImageContentTypeEnum? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new ImageContentTypeEnum(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new ImageContentTypeEnum(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, ImageContentTypeEnum value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/DefaultLabelLayout.cs b/ShipEngineSDK/Model/DefaultLabelLayout.cs index 75c76b12..890d871f 100644 --- a/ShipEngineSDK/Model/DefaultLabelLayout.cs +++ b/ShipEngineSDK/Model/DefaultLabelLayout.cs @@ -61,13 +61,16 @@ public DefaultLabelLayout(string value) public static DefaultLabelLayout Letter { get; } = new("Letter"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class DefaultLabelLayoutJsonConverter : JsonConverter { public override DefaultLabelLayout? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new DefaultLabelLayout(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new DefaultLabelLayout(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, DefaultLabelLayout value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/DeliveryConfirmation.cs b/ShipEngineSDK/Model/DeliveryConfirmation.cs index 6e792775..fdeee032 100644 --- a/ShipEngineSDK/Model/DeliveryConfirmation.cs +++ b/ShipEngineSDK/Model/DeliveryConfirmation.cs @@ -91,13 +91,16 @@ public DeliveryConfirmation(string value) public static DeliveryConfirmation VerbalConfirmation { get; } = new("verbal_confirmation"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class DeliveryConfirmationJsonConverter : JsonConverter { public override DeliveryConfirmation? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new DeliveryConfirmation(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new DeliveryConfirmation(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, DeliveryConfirmation value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/DimensionUnit.cs b/ShipEngineSDK/Model/DimensionUnit.cs index 96b980bf..ab64dac7 100644 --- a/ShipEngineSDK/Model/DimensionUnit.cs +++ b/ShipEngineSDK/Model/DimensionUnit.cs @@ -61,13 +61,16 @@ public DimensionUnit(string value) public static DimensionUnit Centimeter { get; } = new("centimeter"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class DimensionUnitJsonConverter : JsonConverter { public override DimensionUnit? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new DimensionUnit(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new DimensionUnit(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, DimensionUnit value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/DisplayScheme.cs b/ShipEngineSDK/Model/DisplayScheme.cs index 6023a0f0..1078d16c 100644 --- a/ShipEngineSDK/Model/DisplayScheme.cs +++ b/ShipEngineSDK/Model/DisplayScheme.cs @@ -79,13 +79,16 @@ public DisplayScheme(string value) public static DisplayScheme LabelAndPaperless { get; } = new("label_and_paperless"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class DisplaySchemeJsonConverter : JsonConverter { public override DisplayScheme? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new DisplayScheme(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new DisplayScheme(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, DisplayScheme value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/ErrorCode.cs b/ShipEngineSDK/Model/ErrorCode.cs index 25c8b99b..03a26c55 100644 --- a/ShipEngineSDK/Model/ErrorCode.cs +++ b/ShipEngineSDK/Model/ErrorCode.cs @@ -307,13 +307,16 @@ public ErrorCode(string value) public static ErrorCode NoRatesReturned { get; } = new("no_rates_returned"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class ErrorCodeJsonConverter : JsonConverter { public override ErrorCode? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new ErrorCode(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new ErrorCode(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, ErrorCode value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/ErrorSource.cs b/ShipEngineSDK/Model/ErrorSource.cs index ccc68753..c73e178b 100644 --- a/ShipEngineSDK/Model/ErrorSource.cs +++ b/ShipEngineSDK/Model/ErrorSource.cs @@ -67,13 +67,16 @@ public ErrorSource(string value) public static ErrorSource Shipengine { get; } = new("shipengine"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class ErrorSourceJsonConverter : JsonConverter { public override ErrorSource? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new ErrorSource(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new ErrorSource(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, ErrorSource value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/ErrorType.cs b/ShipEngineSDK/Model/ErrorType.cs index 95c47c41..c9f635db 100644 --- a/ShipEngineSDK/Model/ErrorType.cs +++ b/ShipEngineSDK/Model/ErrorType.cs @@ -85,13 +85,16 @@ public ErrorType(string value) public static ErrorType Integrations { get; } = new("integrations"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class ErrorTypeJsonConverter : JsonConverter { public override ErrorType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new ErrorType(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new ErrorType(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, ErrorType value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/FedexPickupType.cs b/ShipEngineSDK/Model/FedexPickupType.cs index 9eacf38e..2f19c3a5 100644 --- a/ShipEngineSDK/Model/FedexPickupType.cs +++ b/ShipEngineSDK/Model/FedexPickupType.cs @@ -85,13 +85,16 @@ public FedexPickupType(string value) public static FedexPickupType Station { get; } = new("station"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class FedexPickupTypeJsonConverter : JsonConverter { public override FedexPickupType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new FedexPickupType(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new FedexPickupType(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, FedexPickupType value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs b/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs index 5f0bebc4..969fbdea 100644 --- a/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs +++ b/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs @@ -64,7 +64,7 @@ public ImageContentTypeEnum(string value) internal class ImageContentTypeEnumJsonConverter : JsonConverter { public override ImageContentTypeEnum? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new ImageContentTypeEnum(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new ImageContentTypeEnum(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, ImageContentTypeEnum value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs b/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs index a30bf9c1..057d8211 100644 --- a/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs +++ b/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs @@ -81,7 +81,7 @@ public FeaturesEnum(string value) internal class FeaturesEnumJsonConverter : JsonConverter { public override FeaturesEnum? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new FeaturesEnum(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new FeaturesEnum(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, FeaturesEnum value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); @@ -127,7 +127,7 @@ public TypeEnum(string value) internal class TypeEnumJsonConverter : JsonConverter { public override TypeEnum? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new TypeEnum(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new TypeEnum(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, TypeEnum value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/IdentifierType.cs b/ShipEngineSDK/Model/IdentifierType.cs index a2d28f19..51a2405a 100644 --- a/ShipEngineSDK/Model/IdentifierType.cs +++ b/ShipEngineSDK/Model/IdentifierType.cs @@ -121,13 +121,16 @@ public IdentifierType(string value) public static IdentifierType Abn { get; } = new("abn"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class IdentifierTypeJsonConverter : JsonConverter { public override IdentifierType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new IdentifierType(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new IdentifierType(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, IdentifierType value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/InsuranceProvider.cs b/ShipEngineSDK/Model/InsuranceProvider.cs index bc84496a..1a86a3c9 100644 --- a/ShipEngineSDK/Model/InsuranceProvider.cs +++ b/ShipEngineSDK/Model/InsuranceProvider.cs @@ -73,13 +73,16 @@ public InsuranceProvider(string value) public static InsuranceProvider ThirdParty { get; } = new("third_party"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class InsuranceProviderJsonConverter : JsonConverter { public override InsuranceProvider? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new InsuranceProvider(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new InsuranceProvider(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, InsuranceProvider value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/LabelChargeEvent.cs b/ShipEngineSDK/Model/LabelChargeEvent.cs index 91f12aff..9458bea2 100644 --- a/ShipEngineSDK/Model/LabelChargeEvent.cs +++ b/ShipEngineSDK/Model/LabelChargeEvent.cs @@ -67,13 +67,16 @@ public LabelChargeEvent(string value) public static LabelChargeEvent OnCarrierAcceptance { get; } = new("on_carrier_acceptance"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class LabelChargeEventJsonConverter : JsonConverter { public override LabelChargeEvent? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new LabelChargeEvent(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new LabelChargeEvent(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, LabelChargeEvent value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/LabelDownloadType.cs b/ShipEngineSDK/Model/LabelDownloadType.cs index 17108609..52c63956 100644 --- a/ShipEngineSDK/Model/LabelDownloadType.cs +++ b/ShipEngineSDK/Model/LabelDownloadType.cs @@ -61,13 +61,16 @@ public LabelDownloadType(string value) public static LabelDownloadType Inline { get; } = new("inline"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class LabelDownloadTypeJsonConverter : JsonConverter { public override LabelDownloadType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new LabelDownloadType(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new LabelDownloadType(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, LabelDownloadType value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/LabelFormat.cs b/ShipEngineSDK/Model/LabelFormat.cs index 80868af5..17c46087 100644 --- a/ShipEngineSDK/Model/LabelFormat.cs +++ b/ShipEngineSDK/Model/LabelFormat.cs @@ -67,13 +67,16 @@ public LabelFormat(string value) public static LabelFormat Zpl { get; } = new("zpl"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class LabelFormatJsonConverter : JsonConverter { public override LabelFormat? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new LabelFormat(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new LabelFormat(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, LabelFormat value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/LabelLayout.cs b/ShipEngineSDK/Model/LabelLayout.cs index d1c51518..2e2b55aa 100644 --- a/ShipEngineSDK/Model/LabelLayout.cs +++ b/ShipEngineSDK/Model/LabelLayout.cs @@ -61,13 +61,16 @@ public LabelLayout(string value) public static LabelLayout Letter { get; } = new("letter"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class LabelLayoutJsonConverter : JsonConverter { public override LabelLayout? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new LabelLayout(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new LabelLayout(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, LabelLayout value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/LabelStatus.cs b/ShipEngineSDK/Model/LabelStatus.cs index e999ab27..a505973c 100644 --- a/ShipEngineSDK/Model/LabelStatus.cs +++ b/ShipEngineSDK/Model/LabelStatus.cs @@ -73,13 +73,16 @@ public LabelStatus(string value) public static LabelStatus Voided { get; } = new("voided"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class LabelStatusJsonConverter : JsonConverter { public override LabelStatus? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new LabelStatus(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new LabelStatus(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, LabelStatus value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs index f822ea2c..b1b5f195 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs @@ -81,7 +81,7 @@ public FeaturesEnum(string value) internal class FeaturesEnumJsonConverter : JsonConverter { public override FeaturesEnum? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new FeaturesEnum(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new FeaturesEnum(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, FeaturesEnum value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); @@ -127,7 +127,7 @@ public TypeEnum(string value) internal class TypeEnumJsonConverter : JsonConverter { public override TypeEnum? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new TypeEnum(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new TypeEnum(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, TypeEnum value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/ManifestRequestStatus.cs b/ShipEngineSDK/Model/ManifestRequestStatus.cs index 880b11f2..5ec0de18 100644 --- a/ShipEngineSDK/Model/ManifestRequestStatus.cs +++ b/ShipEngineSDK/Model/ManifestRequestStatus.cs @@ -61,13 +61,16 @@ public ManifestRequestStatus(string value) public static ManifestRequestStatus Completed { get; } = new("completed"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class ManifestRequestStatusJsonConverter : JsonConverter { public override ManifestRequestStatus? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new ManifestRequestStatus(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new ManifestRequestStatus(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, ManifestRequestStatus value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/NonDelivery.cs b/ShipEngineSDK/Model/NonDelivery.cs index e80aa108..d30867ea 100644 --- a/ShipEngineSDK/Model/NonDelivery.cs +++ b/ShipEngineSDK/Model/NonDelivery.cs @@ -61,13 +61,16 @@ public NonDelivery(string value) public static NonDelivery TreatAsAbandoned { get; } = new("treat_as_abandoned"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class NonDeliveryJsonConverter : JsonConverter { public override NonDelivery? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new NonDelivery(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new NonDelivery(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, NonDelivery value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/OrderSourceName.cs b/ShipEngineSDK/Model/OrderSourceName.cs index 825dd9aa..c8b3b7f0 100644 --- a/ShipEngineSDK/Model/OrderSourceName.cs +++ b/ShipEngineSDK/Model/OrderSourceName.cs @@ -169,13 +169,16 @@ public OrderSourceName(string value) public static OrderSourceName Volusion { get; } = new("volusion"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class OrderSourceNameJsonConverter : JsonConverter { public override OrderSourceName? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new OrderSourceName(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new OrderSourceName(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, OrderSourceName value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/OriginType.cs b/ShipEngineSDK/Model/OriginType.cs index 254f2bc2..64bb76ec 100644 --- a/ShipEngineSDK/Model/OriginType.cs +++ b/ShipEngineSDK/Model/OriginType.cs @@ -61,13 +61,16 @@ public OriginType(string value) public static OriginType DropOff { get; } = new("drop_off"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class OriginTypeJsonConverter : JsonConverter { public override OriginType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new OriginType(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new OriginType(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, OriginType value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/PackageContents.cs b/ShipEngineSDK/Model/PackageContents.cs index eb1e730f..2075eff7 100644 --- a/ShipEngineSDK/Model/PackageContents.cs +++ b/ShipEngineSDK/Model/PackageContents.cs @@ -85,13 +85,16 @@ public PackageContents(string value) public static PackageContents Other { get; } = new("other"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class PackageContentsJsonConverter : JsonConverter { public override PackageContents? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new PackageContents(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new PackageContents(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, PackageContents value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/PackagingGroup.cs b/ShipEngineSDK/Model/PackagingGroup.cs index 4d00bd1a..a39d43d0 100644 --- a/ShipEngineSDK/Model/PackagingGroup.cs +++ b/ShipEngineSDK/Model/PackagingGroup.cs @@ -66,13 +66,16 @@ public PackagingGroup(string value) public static PackagingGroup Iii { get; } = new("iii"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class PackagingGroupJsonConverter : JsonConverter { public override PackagingGroup? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new PackagingGroup(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new PackagingGroup(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, PackagingGroup value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/PackagingInstructionSection.cs b/ShipEngineSDK/Model/PackagingInstructionSection.cs index 1ac333e7..8cfcd274 100644 --- a/ShipEngineSDK/Model/PackagingInstructionSection.cs +++ b/ShipEngineSDK/Model/PackagingInstructionSection.cs @@ -72,13 +72,16 @@ public PackagingInstructionSection(string value) public static PackagingInstructionSection _1b { get; } = new("section_1b"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class PackagingInstructionSectionJsonConverter : JsonConverter { public override PackagingInstructionSection? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new PackagingInstructionSection(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new PackagingInstructionSection(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, PackagingInstructionSection value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs b/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs index 647c5a1a..5811fba4 100644 --- a/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs +++ b/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs @@ -58,7 +58,7 @@ public TypeEnum(string value) internal class TypeEnumJsonConverter : JsonConverter { public override TypeEnum? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new TypeEnum(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new TypeEnum(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, TypeEnum value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/RateResponseStatus.cs b/ShipEngineSDK/Model/RateResponseStatus.cs index 60d2efa9..42931f47 100644 --- a/ShipEngineSDK/Model/RateResponseStatus.cs +++ b/ShipEngineSDK/Model/RateResponseStatus.cs @@ -73,13 +73,16 @@ public RateResponseStatus(string value) public static RateResponseStatus Error { get; } = new("error"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class RateResponseStatusJsonConverter : JsonConverter { public override RateResponseStatus? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new RateResponseStatus(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new RateResponseStatus(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, RateResponseStatus value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/RateType.cs b/ShipEngineSDK/Model/RateType.cs index 3ed284f8..e6be2e69 100644 --- a/ShipEngineSDK/Model/RateType.cs +++ b/ShipEngineSDK/Model/RateType.cs @@ -61,13 +61,16 @@ public RateType(string value) public static RateType Shipment { get; } = new("shipment"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class RateTypeJsonConverter : JsonConverter { public override RateType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new RateType(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new RateType(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, RateType value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/ReasonCode.cs b/ShipEngineSDK/Model/ReasonCode.cs index 460a1c21..4ea6270e 100644 --- a/ShipEngineSDK/Model/ReasonCode.cs +++ b/ShipEngineSDK/Model/ReasonCode.cs @@ -91,13 +91,16 @@ public ReasonCode(string value) public static ReasonCode ContactCarrier { get; } = new("contact_carrier"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class ReasonCodeJsonConverter : JsonConverter { public override ReasonCode? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new ReasonCode(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new ReasonCode(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, ReasonCode value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/Redirect.cs b/ShipEngineSDK/Model/Redirect.cs index 71b2144d..24ff6553 100644 --- a/ShipEngineSDK/Model/Redirect.cs +++ b/ShipEngineSDK/Model/Redirect.cs @@ -55,13 +55,16 @@ public Redirect(string value) public static Redirect ShipengineDashboard { get; } = new("shipengine-dashboard"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class RedirectJsonConverter : JsonConverter { public override Redirect? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new Redirect(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new Redirect(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, Redirect value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/RegulationLevel.cs b/ShipEngineSDK/Model/RegulationLevel.cs index 151411a2..9cf6c240 100644 --- a/ShipEngineSDK/Model/RegulationLevel.cs +++ b/ShipEngineSDK/Model/RegulationLevel.cs @@ -72,13 +72,16 @@ public RegulationLevel(string value) public static RegulationLevel ExceptedQuantity { get; } = new("excepted_quantity"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class RegulationLevelJsonConverter : JsonConverter { public override RegulationLevel? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new RegulationLevel(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new RegulationLevel(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, RegulationLevel value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/ShipmentStatus.cs b/ShipEngineSDK/Model/ShipmentStatus.cs index 67b2da2d..d124afe8 100644 --- a/ShipEngineSDK/Model/ShipmentStatus.cs +++ b/ShipEngineSDK/Model/ShipmentStatus.cs @@ -73,13 +73,16 @@ public ShipmentStatus(string value) public static ShipmentStatus Cancelled { get; } = new("cancelled"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class ShipmentStatusJsonConverter : JsonConverter { public override ShipmentStatus? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new ShipmentStatus(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new ShipmentStatus(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, ShipmentStatus value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/ShipmentsSortBy.cs b/ShipEngineSDK/Model/ShipmentsSortBy.cs index 2330540f..f5ed40bf 100644 --- a/ShipEngineSDK/Model/ShipmentsSortBy.cs +++ b/ShipEngineSDK/Model/ShipmentsSortBy.cs @@ -61,13 +61,16 @@ public ShipmentsSortBy(string value) public static ShipmentsSortBy CreatedAt { get; } = new("created_at"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class ShipmentsSortByJsonConverter : JsonConverter { public override ShipmentsSortBy? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new ShipmentsSortBy(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new ShipmentsSortBy(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, ShipmentsSortBy value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/SmartPostHub.cs b/ShipEngineSDK/Model/SmartPostHub.cs index 23ec9ffd..03de0d3f 100644 --- a/ShipEngineSDK/Model/SmartPostHub.cs +++ b/ShipEngineSDK/Model/SmartPostHub.cs @@ -253,13 +253,16 @@ public SmartPostHub(string value) public static SmartPostHub WheelingIl { get; } = new("wheeling_il"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class SmartPostHubJsonConverter : JsonConverter { public override SmartPostHub? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new SmartPostHub(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new SmartPostHub(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, SmartPostHub value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/SortDir.cs b/ShipEngineSDK/Model/SortDir.cs index abe55972..113462cb 100644 --- a/ShipEngineSDK/Model/SortDir.cs +++ b/ShipEngineSDK/Model/SortDir.cs @@ -61,13 +61,16 @@ public SortDir(string value) public static SortDir Desc { get; } = new("desc"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class SortDirJsonConverter : JsonConverter { public override SortDir? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new SortDir(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new SortDir(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, SortDir value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/StatusCode.cs b/ShipEngineSDK/Model/StatusCode.cs index 1103c0c4..b345ae5e 100644 --- a/ShipEngineSDK/Model/StatusCode.cs +++ b/ShipEngineSDK/Model/StatusCode.cs @@ -91,13 +91,16 @@ public StatusCode(string value) public static StatusCode Ny { get; } = new("ny"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class StatusCodeJsonConverter : JsonConverter { public override StatusCode? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new StatusCode(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new StatusCode(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, StatusCode value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/TaxableEntityType.cs b/ShipEngineSDK/Model/TaxableEntityType.cs index 18334085..864cb5b3 100644 --- a/ShipEngineSDK/Model/TaxableEntityType.cs +++ b/ShipEngineSDK/Model/TaxableEntityType.cs @@ -67,13 +67,16 @@ public TaxableEntityType(string value) public static TaxableEntityType Ior { get; } = new("ior"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class TaxableEntityTypeJsonConverter : JsonConverter { public override TaxableEntityType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new TaxableEntityType(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new TaxableEntityType(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, TaxableEntityType value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/TrackingStatus.cs b/ShipEngineSDK/Model/TrackingStatus.cs index 61910bdc..862e90fc 100644 --- a/ShipEngineSDK/Model/TrackingStatus.cs +++ b/ShipEngineSDK/Model/TrackingStatus.cs @@ -73,13 +73,16 @@ public TrackingStatus(string value) public static TrackingStatus Delivered { get; } = new("delivered"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class TrackingStatusJsonConverter : JsonConverter { public override TrackingStatus? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new TrackingStatus(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new TrackingStatus(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, TrackingStatus value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/TransportMean.cs b/ShipEngineSDK/Model/TransportMean.cs index 9532cc4b..46c19983 100644 --- a/ShipEngineSDK/Model/TransportMean.cs +++ b/ShipEngineSDK/Model/TransportMean.cs @@ -72,13 +72,16 @@ public TransportMean(string value) public static TransportMean PassengerAircraft { get; } = new("passenger_aircraft"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class TransportMeanJsonConverter : JsonConverter { public override TransportMean? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new TransportMean(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new TransportMean(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, TransportMean value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs index 344e41bf..ae16b84a 100644 --- a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs @@ -64,7 +64,7 @@ public ImageContentTypeEnum(string value) internal class ImageContentTypeEnumJsonConverter : JsonConverter { public override ImageContentTypeEnum? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new ImageContentTypeEnum(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new ImageContentTypeEnum(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, ImageContentTypeEnum value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/UpsPickupType.cs b/ShipEngineSDK/Model/UpsPickupType.cs index 79e4ca2f..1630109f 100644 --- a/ShipEngineSDK/Model/UpsPickupType.cs +++ b/ShipEngineSDK/Model/UpsPickupType.cs @@ -67,13 +67,16 @@ public UpsPickupType(string value) public static UpsPickupType CustomerCounter { get; } = new("customer_counter"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class UpsPickupTypeJsonConverter : JsonConverter { public override UpsPickupType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new UpsPickupType(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new UpsPickupType(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, UpsPickupType value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/ValidateAddress.cs b/ShipEngineSDK/Model/ValidateAddress.cs index 73d89a0f..554c7669 100644 --- a/ShipEngineSDK/Model/ValidateAddress.cs +++ b/ShipEngineSDK/Model/ValidateAddress.cs @@ -67,13 +67,16 @@ public ValidateAddress(string value) public static ValidateAddress ValidateAndClean { get; } = new("validate_and_clean"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class ValidateAddressJsonConverter : JsonConverter { public override ValidateAddress? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new ValidateAddress(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new ValidateAddress(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, ValidateAddress value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/ValidationStatus.cs b/ShipEngineSDK/Model/ValidationStatus.cs index 7e81f094..823c662c 100644 --- a/ShipEngineSDK/Model/ValidationStatus.cs +++ b/ShipEngineSDK/Model/ValidationStatus.cs @@ -73,13 +73,16 @@ public ValidationStatus(string value) public static ValidationStatus Unknown { get; } = new("unknown"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class ValidationStatusJsonConverter : JsonConverter { public override ValidationStatus? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new ValidationStatus(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new ValidationStatus(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, ValidationStatus value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/WebhookEvent.cs b/ShipEngineSDK/Model/WebhookEvent.cs index 421becb0..1d2bab65 100644 --- a/ShipEngineSDK/Model/WebhookEvent.cs +++ b/ShipEngineSDK/Model/WebhookEvent.cs @@ -91,13 +91,16 @@ public WebhookEvent(string value) public static WebhookEvent Track { get; } = new("track"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class WebhookEventJsonConverter : JsonConverter { public override WebhookEvent? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new WebhookEvent(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new WebhookEvent(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, WebhookEvent value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Model/WeightUnit.cs b/ShipEngineSDK/Model/WeightUnit.cs index 2cc739c9..1117bc9e 100644 --- a/ShipEngineSDK/Model/WeightUnit.cs +++ b/ShipEngineSDK/Model/WeightUnit.cs @@ -73,13 +73,16 @@ public WeightUnit(string value) public static WeightUnit Kilogram { get; } = new("kilogram"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class WeightUnitJsonConverter : JsonConverter { public override WeightUnit? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new WeightUnit(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new WeightUnit(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, WeightUnit value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/ShipEngineSDK/Multimap.cs b/ShipEngineSDK/Multimap.cs index 4500b438..cc5ad8b0 100644 --- a/ShipEngineSDK/Multimap.cs +++ b/ShipEngineSDK/Multimap.cs @@ -239,7 +239,7 @@ public void CopyTo(Array array, int index) /// The object to use as the key of the item to add. /// The object to use as the value of the item to add. /// Thrown when couldn't add value to Multimap. - public void Add(TKey key, TValue value) + public void Add(TKey key, TValue? value) { if (value == null) { diff --git a/ShipEngineSDK/NotNullIfNotNullAttribute.cs b/ShipEngineSDK/NotNullIfNotNullAttribute.cs new file mode 100644 index 00000000..94388bb4 --- /dev/null +++ b/ShipEngineSDK/NotNullIfNotNullAttribute.cs @@ -0,0 +1,14 @@ +/* + * Add an implementation of NotNullIfNotNull for NETStandard2 + * https://medium.com/@pawel.gerr/c-8-nullable-reference-types-in-net-standard-2-1-and-net-4-x-e1f5a3e657f3 + */ + +#if !NETSTANDARD2_1 +namespace System.Diagnostics.CodeAnalysis; + +[AttributeUsage(AttributeTargets.Property | AttributeTargets.Parameter | AttributeTargets.ReturnValue, AllowMultiple = true)] +internal sealed class NotNullIfNotNullAttribute(string parameterName) : Attribute +{ + public string ParameterName { get; } = parameterName; +} +#endif \ No newline at end of file diff --git a/ShipEngineSDK/RequestOptions.cs b/ShipEngineSDK/RequestOptions.cs index d1cb8d50..60e47eb1 100644 --- a/ShipEngineSDK/RequestOptions.cs +++ b/ShipEngineSDK/RequestOptions.cs @@ -59,12 +59,12 @@ public class RequestOptions(string path) /// /// Operation associated with the request path. /// - internal string Operation { get; set; } + internal string? Operation { get; set; } /// /// Any data associated with a request body. /// - internal string Data { get; set; } + internal string? Data { get; set; } internal string FullPath() { diff --git a/ShipEngineSDK/ShipEngine.cs b/ShipEngineSDK/ShipEngine.cs index f08206e7..cdf9a6e3 100644 --- a/ShipEngineSDK/ShipEngine.cs +++ b/ShipEngineSDK/ShipEngine.cs @@ -189,12 +189,12 @@ public partial class ShipEngine : ShipEngineClient, IDisposable, IShipEngine /// /// Global HttpClient for ShipEngine instance. /// - public HttpClient _client; + private readonly HttpClient _client; /// /// Global config for ShipEngine instance. /// - public Config _config; + private readonly Config _config; /// /// Initialize the ShipEngine SDK with an API Key @@ -219,9 +219,11 @@ public ShipEngine(Config config) : base() /// /// Initialize the ShipEngine SDK with an httpClient object /// + /// Config object containing custom configurations /// HttpClient object to be used for ShipEngine API calls. We expect the httpClient has already been configured with ConfigureHttpClient - public ShipEngine(HttpClient httpClient) : base() + public ShipEngine(Config config, HttpClient httpClient) : base() { + _config = config; _client = httpClient; } diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index b018cb3e..97647017 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-beta.1 + 3.0.0-beta.2 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET diff --git a/generation/templates/modelEnum.mustache b/generation/templates/modelEnum.mustache index e000a1cf..2a2137a1 100644 --- a/generation/templates/modelEnum.mustache +++ b/generation/templates/modelEnum.mustache @@ -46,13 +46,16 @@ {{/enumVars}} {{/allowableValues}} + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } internal class {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}JsonConverter : JsonConverter<{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}> { public override {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/generation/templates/modelInnerEnum.mustache b/generation/templates/modelInnerEnum.mustache index 5bf28b4d..80ff29b1 100644 --- a/generation/templates/modelInnerEnum.mustache +++ b/generation/templates/modelInnerEnum.mustache @@ -45,7 +45,7 @@ internal class {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}JsonConverter : JsonConverter<{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}> { public override {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => - reader.TokenType == JsonTokenType.String ? new {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}(reader.GetString()) : null; + reader.TokenType == JsonTokenType.String ? new {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}(reader.GetString()!) : null; public override void Write(Utf8JsonWriter writer, {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} value, JsonSerializerOptions options) => writer.WriteStringValue(value.ToString()); diff --git a/openapitools.json b/openapitools.json index 063d5145..854678cc 100644 --- a/openapitools.json +++ b/openapitools.json @@ -13,7 +13,7 @@ "packageName": "ShipEngineSDK", "ignoreFileOverride": "./.openapi-generator-ignore", "additionalProperties": { - "packageVersion": "3.0.0-beta.1", + "packageVersion": "3.0.0-beta.2", "targetFramework": "netstandard2.0", "validatable": false, "sourceFolder": "", diff --git a/package.json b/package.json index 8b929de6..e99bea64 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "shipengine-dotnet", - "version": "3.0.0-beta.1", + "version": "3.0.0-beta.2", "description": "Package primarily used to generate the API and models from OpenApi spec\"", "main": "index.js", "directories": { From 0467687ebb03c199ba231c5383f018b79ed95b01 Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Tue, 16 Jul 2024 13:47:04 -0500 Subject: [PATCH 05/42] Address some code issues --- ShipEngineSDK/DateJsonConverter.cs | 20 +- ShipEngineSDK/Model/AbstractOpenAPISchema.cs | 8 + ShipEngineSDK/Model/AccountSettings.cs | 2 + ShipEngineSDK/Model/AccountSettingsImages.cs | 17 +- .../Model/AddFundsToCarrierRequestBody.cs | 2 + .../Model/AddFundsToCarrierResponseBody.cs | 2 + .../Model/AddFundsToInsuranceRequestBody.cs | 2 + .../Model/AddFundsToInsuranceResponseBody.cs | 2 + ShipEngineSDK/Model/AddToBatchRequestBody.cs | 2 + ShipEngineSDK/Model/Address.cs | 2 + .../Model/AddressResidentialIndicator.cs | 3 + ShipEngineSDK/Model/AddressToValidate.cs | 2 + .../Model/AddressValidatingShipment.cs | 2 + ShipEngineSDK/Model/AddressValidationCode.cs | 3 + .../Model/AddressValidationDetailCode.cs | 3 + .../Model/AddressValidationMessageType.cs | 3 + .../Model/AddressValidationResult.cs | 2 + .../Model/AddressValidationStatus.cs | 3 + .../Model/AdvancedShipmentOptions.cs | 2 + ...cedShipmentOptionsDangerousGoodsContact.cs | 2 + .../AdvancedShipmentOptionsFedexFreight.cs | 2 + ShipEngineSDK/Model/AllowedIncoterms.cs | 3 + ShipEngineSDK/Model/AlternativeIdentifier.cs | 2 + ShipEngineSDK/Model/AlternativeIdentifiers.cs | 2 + .../Model/AncillaryServiceEndorsement.cs | 3 + ShipEngineSDK/Model/Batch.cs | 2 + ShipEngineSDK/Model/BatchResponseError.cs | 2 + ShipEngineSDK/Model/BatchStatus.cs | 3 + ShipEngineSDK/Model/BatchesSortBy.cs | 3 + ShipEngineSDK/Model/BillToParty.cs | 3 + ShipEngineSDK/Model/BulkRate.cs | 2 + .../Model/CalculateRatesRequestBody.cs | 30 +- .../Model/CalculateRatesResponseBody.cs | 2 + ShipEngineSDK/Model/Carrier.cs | 2 + ShipEngineSDK/Model/CarrierAdvancedOption.cs | 2 + ShipEngineSDK/Model/CarrierName.cs | 3 + .../Model/CarrierNameWithSettings.cs | 3 + ShipEngineSDK/Model/CollectOnDelivery.cs | 2 + .../Model/CollectOnDeliveryPaymentType.cs | 3 + .../Model/CompareBulkRatesRequestBody.cs | 30 +- .../ConnectAccessWorldwideRequestBody.cs | 2 + .../ConnectAmazonBuyShippingRequestBody.cs | 2 + .../Model/ConnectAmazonShippingUk.cs | 2 + ShipEngineSDK/Model/ConnectApcRequestBody.cs | 2 + .../Model/ConnectAsendiaRequestBody.cs | 2 + .../Model/ConnectAustraliaPostRequestBody.cs | 2 + .../Model/ConnectCanadaPostRequestBody.cs | 2 + .../Model/ConnectCarrierRequestBody.cs | 262 ++++++++---------- .../Model/ConnectCarrierResponseBody.cs | 2 + .../Model/ConnectDhlEcommerceRequestBody.cs | 2 + .../Model/ConnectDhlExpressAuRequestBody.cs | 2 + .../Model/ConnectDhlExpressCaRequestBody.cs | 2 + .../Model/ConnectDhlExpressRequestBody.cs | 2 + .../Model/ConnectDhlExpressUkRequestBody.cs | 2 + ShipEngineSDK/Model/ConnectDpdRequestBody.cs | 2 + .../Model/ConnectEndiciaRequestBody.cs | 2 + .../Model/ConnectFedexRequestBody.cs | 2 + .../Model/ConnectFedexUkRequestBody.cs | 2 + .../Model/ConnectFirstmileRequestBody.cs | 2 + ShipEngineSDK/Model/ConnectImexRequestBody.cs | 2 + .../Model/ConnectInsurerRequestBody.cs | 2 + .../Model/ConnectLasershipRequestBody.cs | 2 + .../Model/ConnectNewgisticsRequestBody.cs | 2 + .../Model/ConnectOntracRequestBody.cs | 2 + .../Model/ConnectPurolatorRequestBody.cs | 2 + .../Model/ConnectRoyalMailRequestBody.cs | 2 + .../Model/ConnectRrDonnelleyRequestBody.cs | 2 + ShipEngineSDK/Model/ConnectSekoRequestBody.cs | 2 + .../Model/ConnectSendleRequestBody.cs | 2 + .../Model/ConnectStampsRequestBody.cs | 2 + ShipEngineSDK/Model/ConnectUpsRequestBody.cs | 2 + ShipEngineSDK/Model/ContactDetails.cs | 2 + .../CreateAccountSettingsImageRequestBody.cs | 17 +- .../Model/CreateAndProcessBatchRequestBody.cs | 2 + ...AndProcessBatchRequestBodyProcessLabels.cs | 2 + .../Model/CreateAndValidateShipment.cs | 2 + ShipEngineSDK/Model/CreateBatchRequest.cs | 28 +- ShipEngineSDK/Model/CreateBatchRequestBody.cs | 2 + .../Model/CreateBatchResponseBody.cs | 2 + .../Model/CreateLabelFromRateRequestBody.cs | 2 + .../Model/CreateLabelFromRateResponseBody.cs | 2 + .../CreateLabelFromShipmentRequestBody.cs | 2 + .../CreateLabelFromShipmentResponseBody.cs | 2 + ShipEngineSDK/Model/CreateLabelRequestBody.cs | 2 + .../Model/CreateLabelResponseBody.cs | 2 + .../CreateManifestByObjectRequestBody.cs | 2 + .../CreateManifestLabelIdsRequestBody.cs | 2 + .../Model/CreateManifestRequestBody.cs | 28 +- .../Model/CreateManifestResponseBody.cs | 2 + .../Model/CreatePackageTypeRequestBody.cs | 2 + .../Model/CreatePackageTypeResponseBody.cs | 2 + .../Model/CreateReturnLabelRequestBody.cs | 2 + .../Model/CreateReturnLabelResponseBody.cs | 2 + .../Model/CreateShipmentResponseBodyFields.cs | 2 + .../Model/CreateShipmentsRequestBody.cs | 2 + .../Model/CreateShipmentsResponseBody.cs | 2 + ShipEngineSDK/Model/CreateTagResponseBody.cs | 2 + .../Model/CreateWarehouseRequestBody.cs | 2 + .../Model/CreateWarehouseResponseBody.cs | 2 + .../Model/CreateWebhookRequestBody.cs | 2 + .../Model/CreateWebhookResponseBody.cs | 2 + ShipEngineSDK/Model/CustomsItem.cs | 2 + ShipEngineSDK/Model/DangerousAmount.cs | 2 + ShipEngineSDK/Model/DangerousGoods.cs | 2 + ShipEngineSDK/Model/DefaultLabelLayout.cs | 3 + .../Model/DeletePickupByIdResponseBody.cs | 2 + .../DeleteScheduledPickupResponseBody.cs | 2 + ShipEngineSDK/Model/DeliveryConfirmation.cs | 3 + ShipEngineSDK/Model/DeprecatedManifest.cs | 2 + .../Model/DhlExpressAccountSettings.cs | 2 + .../Model/DhlExpressSettingsResponseBody.cs | 2 + ShipEngineSDK/Model/DimensionUnit.cs | 3 + ShipEngineSDK/Model/Dimensions.cs | 2 + ShipEngineSDK/Model/DisplayScheme.cs | 3 + ShipEngineSDK/Model/Error.cs | 2 + ShipEngineSDK/Model/ErrorCode.cs | 3 + ShipEngineSDK/Model/ErrorResponseBody.cs | 2 + ShipEngineSDK/Model/ErrorSource.cs | 3 + ShipEngineSDK/Model/ErrorType.cs | 3 + .../Model/ErrorWithLabelIdResponseBody.cs | 2 + .../Model/EstimateRatesRequestBody.cs | 54 ++-- ShipEngineSDK/Model/FedexAccountSettings.cs | 2 + .../Model/FedexAccountSettingsRequestBody.cs | 2 + ShipEngineSDK/Model/FedexPickupType.cs | 3 + .../Model/FedexSettingsResponseBody.cs | 2 + .../GetAccountSettingsImagesResponseBody.cs | 17 +- .../Model/GetAccountSettingsResponseBody.cs | 2 + .../Model/GetBatchByExternalIdResponseBody.cs | 2 + .../Model/GetBatchByIdResponseBody.cs | 2 + .../Model/GetCarrierByIdResponseBody.cs | 2 + .../Model/GetCarrierOptionsResponseBody.cs | 2 + .../Model/GetCarrierSettingsResponseBody.cs | 37 ++- .../Model/GetCarriersResponseBody.cs | 2 + .../Model/GetInsuranceBalanceResponseBody.cs | 2 + ...etLabelByExternalShipmentIdResponseBody.cs | 2 + .../Model/GetLabelByIdResponseBody.cs | 2 + .../Model/GetManifestByIdResponseBody.cs | 2 + .../Model/GetPackageTypeByIdResponseBody.cs | 2 + .../Model/GetPickupByIdResponseBody.cs | 2 + ShipEngineSDK/Model/GetPickupsResponseBody.cs | 2 + .../Model/GetRateByIdResponseBody.cs | 2 + .../Model/GetServicePointByIdResponseBody.cs | 2 + ...ervicePointByIdResponseBodyServicePoint.cs | 32 ++- .../Model/GetServicePointsRequest.cs | 19 +- .../Model/GetServicePointsRequestBody.cs | 2 + .../GetServicePointsRequestBodyAddress.cs | 2 + ...tServicePointsRequestBodyProvidersInner.cs | 2 + .../GetServicePointsRequestBodyShipment.cs | 2 + .../GetShipmentByExternalIdResponseBody.cs | 2 + .../Model/GetShipmentByIdResponseBody.cs | 2 + .../GetTrackingLogFromLabelResponseBody.cs | 2 + .../Model/GetTrackingLogResponseBody.cs | 2 + .../Model/GetWarehouseByIdResponseBody.cs | 2 + .../Model/GetWebhookByIdResponseBody.cs | 2 + ShipEngineSDK/Model/IdentifierType.cs | 3 + ShipEngineSDK/Model/ImporterOfRecords.cs | 2 + ShipEngineSDK/Model/InsuranceProvider.cs | 3 + .../Model/InternationalShipmentOptions.cs | 2 + .../Model/InvoiceAdditionalDetails.cs | 2 + ShipEngineSDK/Model/Label.cs | 2 + ShipEngineSDK/Model/LabelChargeEvent.cs | 3 + ShipEngineSDK/Model/LabelDownload.cs | 2 + ShipEngineSDK/Model/LabelDownloadType.cs | 3 + ShipEngineSDK/Model/LabelFormat.cs | 3 + ShipEngineSDK/Model/LabelLayout.cs | 3 + ShipEngineSDK/Model/LabelMessages.cs | 2 + ShipEngineSDK/Model/LabelPackagesInner.cs | 2 + ShipEngineSDK/Model/LabelStatus.cs | 3 + ShipEngineSDK/Model/Link.cs | 2 + .../Model/ListAccountImagesResponseBody.cs | 2 + .../Model/ListAccountSettingsBody.cs | 2 + .../ListAccountSettingsImagesResponseBody.cs | 2 + .../Model/ListBatchErrorsResponseBody.cs | 2 + .../Model/ListBatchesResponseBody.cs | 2 + .../ListCarrierPackageTypesResponseBody.cs | 2 + .../Model/ListCarrierServicesResponseBody.cs | 2 + .../Model/ListCarriersResponseBody.cs | 2 + ShipEngineSDK/Model/ListLabelsResponseBody.cs | 2 + .../Model/ListManifestsResponseBody.cs | 2 + .../Model/ListPackageTypesResponseBody.cs | 2 + ShipEngineSDK/Model/ListPickupResponseBody.cs | 2 + .../Model/ListServicePointsResponseBody.cs | 2 + ...icePointsResponseBodyServicePointsInner.cs | 32 ++- ...eBodyServicePointsInnerHoursOfOperation.cs | 2 + ...ePointsInnerHoursOfOperationMondayInner.cs | 2 + .../Model/ListShipmentRatesResponseBody.cs | 2 + .../Model/ListShipmentsResponseBody.cs | 2 + ShipEngineSDK/Model/ListTagsResponseBody.cs | 2 + .../Model/ListWarehousesResponseBody.cs | 2 + ShipEngineSDK/Model/Manifest.cs | 2 + ShipEngineSDK/Model/ManifestDownload.cs | 2 + ShipEngineSDK/Model/ManifestRequest.cs | 2 + ShipEngineSDK/Model/ManifestRequestStatus.cs | 3 + ShipEngineSDK/Model/Manifests.cs | 2 + ShipEngineSDK/Model/ManifestsRequests.cs | 2 + ShipEngineSDK/Model/ModifyBatch.cs | 2 + ShipEngineSDK/Model/MonetaryValue.cs | 2 + ShipEngineSDK/Model/NonDelivery.cs | 3 + ShipEngineSDK/Model/OptionalLink.cs | 2 + ShipEngineSDK/Model/OrderSourceName.cs | 3 + ShipEngineSDK/Model/OriginType.cs | 3 + ShipEngineSDK/Model/Package.cs | 2 + ShipEngineSDK/Model/PackageContents.cs | 3 + ShipEngineSDK/Model/PackageType.cs | 2 + ShipEngineSDK/Model/PackagingGroup.cs | 3 + .../Model/PackagingInstructionSection.cs | 3 + ShipEngineSDK/Model/PagedListResponseBody.cs | 2 + ShipEngineSDK/Model/PaginationLink.cs | 2 + ShipEngineSDK/Model/PaperlessDownload.cs | 2 + .../Model/ParseAddressRequestBody.cs | 2 + .../Model/ParseAddressResponseBody.cs | 2 + .../Model/ParseShipmentRequestBody.cs | 2 + .../Model/ParseShipmentResponseBody.cs | 2 + ShipEngineSDK/Model/PartialAddress.cs | 2 + ShipEngineSDK/Model/PartialShipment.cs | 2 + ShipEngineSDK/Model/PartialShippingAddress.cs | 2 + .../Model/PartialShippingAddressTo.cs | 2 + ...artialShippingAddressToGeolocationInner.cs | 17 +- ShipEngineSDK/Model/PaymentAmount.cs | 2 + ShipEngineSDK/Model/Pickup.cs | 2 + ShipEngineSDK/Model/PickupResponseBody.cs | 2 + ShipEngineSDK/Model/PickupWindow.cs | 2 + ShipEngineSDK/Model/PickupWindows.cs | 2 + .../Model/ProcessBatchRequestBody.cs | 2 + ShipEngineSDK/Model/Products.cs | 2 + .../Model/PurchaseLabelWithoutShipment.cs | 2 + ShipEngineSDK/Model/Rate.cs | 2 + ShipEngineSDK/Model/RateEstimate.cs | 2 + .../Model/RateEstimateByCarrierId.cs | 2 + .../Model/RateEstimateByCarrierIds.cs | 2 + ShipEngineSDK/Model/RateEstimateOptions.cs | 2 + ShipEngineSDK/Model/RateRequestBody.cs | 2 + .../Model/RateRequestByShipmentIds.cs | 2 + ShipEngineSDK/Model/RateRequestByShipments.cs | 2 + ShipEngineSDK/Model/RateRequestOptions.cs | 2 + ShipEngineSDK/Model/RateRequestRateOptions.cs | 2 + ShipEngineSDK/Model/RateResponse.cs | 2 + ShipEngineSDK/Model/RateResponseStatus.cs | 3 + ShipEngineSDK/Model/RateType.cs | 3 + ShipEngineSDK/Model/RatesInformation.cs | 2 + ShipEngineSDK/Model/ReasonCode.cs | 3 + ShipEngineSDK/Model/RecognizedEntity.cs | 2 + ShipEngineSDK/Model/Redirect.cs | 3 + ShipEngineSDK/Model/RegulationLevel.cs | 3 + .../Model/RemoveFromBatchRequestBody.cs | 2 + ShipEngineSDK/Model/ResponseMessage.cs | 2 + .../Model/SchedulePickupRequestBody.cs | 2 + .../Model/SchedulePickupResponseBody.cs | 2 + ShipEngineSDK/Model/Service.cs | 2 + ShipEngineSDK/Model/Shipment.cs | 2 + ShipEngineSDK/Model/ShipmentIdRequest.cs | 2 + ShipEngineSDK/Model/ShipmentItem.cs | 2 + ShipEngineSDK/Model/ShipmentRequest.cs | 2 + ShipEngineSDK/Model/ShipmentStatus.cs | 3 + ShipEngineSDK/Model/ShipmentsSortBy.cs | 3 + ShipEngineSDK/Model/ShippingAddress.cs | 2 + ShipEngineSDK/Model/ShippingAddressTo.cs | 2 + ShipEngineSDK/Model/SmartPostHub.cs | 3 + ShipEngineSDK/Model/SortDir.cs | 3 + ShipEngineSDK/Model/StatusCode.cs | 3 + ShipEngineSDK/Model/Tag.cs | 2 + .../Model/TagShipmentResponseBody.cs | 2 + ShipEngineSDK/Model/TaxIdentifier.cs | 2 + ShipEngineSDK/Model/TaxableEntityType.cs | 3 + ...TokensGetEphemeralTokenResponseBodyYaml.cs | 2 + ShipEngineSDK/Model/TrackEvent.cs | 2 + ShipEngineSDK/Model/TrackingInformation.cs | 2 + ShipEngineSDK/Model/TrackingStatus.cs | 3 + ShipEngineSDK/Model/TransportMean.cs | 3 + .../UpdateAccountSettingsImageRequestBody.cs | 17 +- .../UpdateAmazonBuyShippingRequestBody.cs | 2 + .../Model/UpdateCarrierSettingsRequestBody.cs | 55 ++-- .../UpdateDhlExpressSettingsRequestBody.cs | 2 + .../Model/UpdateFedexSettingsRequestBody.cs | 2 + .../UpdateNewgisticsSettingsRequestBody.cs | 2 + .../Model/UpdatePackageTypeRequestBody.cs | 2 + ShipEngineSDK/Model/UpdateShipmentFields.cs | 2 + .../Model/UpdateShipmentRequestBody.cs | 2 + .../Model/UpdateShipmentResponseBody.cs | 2 + ShipEngineSDK/Model/UpdateShipmentsTags.cs | 2 + .../Model/UpdateShipmentsTagsRequestBody.cs | 2 + .../UpdateShipmentsTagsShipmentsTagsInner.cs | 2 + .../Model/UpdateUpsSettingsRequestBody.cs | 2 + .../Model/UpdateWarehouseRequestBody.cs | 2 + .../UpdateWarehouseSettingsRequestBody.cs | 2 + .../Model/UpdateWebhookRequestBody.cs | 2 + ShipEngineSDK/Model/UpsAccountSettings.cs | 2 + ShipEngineSDK/Model/UpsInvoice.cs | 2 + ShipEngineSDK/Model/UpsPickupType.cs | 3 + .../Model/UpsSettingsResponseBody.cs | 2 + ShipEngineSDK/Model/ValidateAddress.cs | 3 + ShipEngineSDK/Model/ValidateShipmentFields.cs | 2 + ShipEngineSDK/Model/ValidationStatus.cs | 3 + ShipEngineSDK/Model/VoidLabelResponseBody.cs | 2 + ShipEngineSDK/Model/Warehouse.cs | 2 + ShipEngineSDK/Model/Webhook.cs | 2 + ShipEngineSDK/Model/WebhookEvent.cs | 3 + ShipEngineSDK/Model/WebhookHeader.cs | 2 + ShipEngineSDK/Model/Weight.cs | 2 + ShipEngineSDK/Model/WeightUnit.cs | 3 + .../templates/AbstractOpenAPISchema.mustache | 8 + generation/templates/modelEnum.mustache | 3 + generation/templates/modelGeneric.mustache | 2 + generation/templates/modelInnerEnum.mustache | 15 +- generation/templates/modelOneOf.mustache | 21 +- 305 files changed, 1058 insertions(+), 328 deletions(-) diff --git a/ShipEngineSDK/DateJsonConverter.cs b/ShipEngineSDK/DateJsonConverter.cs index c874b5f0..f5e7015e 100644 --- a/ShipEngineSDK/DateJsonConverter.cs +++ b/ShipEngineSDK/DateJsonConverter.cs @@ -5,13 +5,29 @@ namespace ShipEngineSDK; using System.Text.Json; using System.Text.Json.Serialization; +/// +/// Converts a Date to and from JSON +/// public class DateJsonConverter : JsonConverter { private const string Format = "yyyy-MM-dd"; + /// + /// Read a Date from a JSON string + /// + /// JSON reader + /// Object type to convert + /// Serializer options + /// The object converted from the JSON string public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => DateTime.ParseExact(reader.GetString()!, Format, CultureInfo.InvariantCulture); - public override void Write(Utf8JsonWriter writer, DateTime dateTimeValue, JsonSerializerOptions options) => - writer.WriteStringValue(dateTimeValue.ToString(Format, CultureInfo.InvariantCulture)); + /// + /// Write a Date to a JSON string + /// + /// JSON writer + /// Object to be converted into a JSON string + /// Serializer options + public override void Write(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString(Format, CultureInfo.InvariantCulture)); } \ No newline at end of file diff --git a/ShipEngineSDK/Model/AbstractOpenAPISchema.cs b/ShipEngineSDK/Model/AbstractOpenAPISchema.cs index 9371f286..80146d0d 100644 --- a/ShipEngineSDK/Model/AbstractOpenAPISchema.cs +++ b/ShipEngineSDK/Model/AbstractOpenAPISchema.cs @@ -28,6 +28,14 @@ public abstract partial class AbstractOpenAPISchema DictionaryKeyPolicy = JsonNamingPolicy.SnakeCaseLower }; + /// + /// Constructor + /// + protected AbstractOpenAPISchema(string schemaType) + { + SchemaType = schemaType; + } + /// /// Gets or Sets the actual instance /// diff --git a/ShipEngineSDK/Model/AccountSettings.cs b/ShipEngineSDK/Model/AccountSettings.cs index 7d0adfe6..197e54d9 100644 --- a/ShipEngineSDK/Model/AccountSettings.cs +++ b/ShipEngineSDK/Model/AccountSettings.cs @@ -42,7 +42,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class AccountSettings {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" DefaultLabelLayout: ").Append(DefaultLabelLayout).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/AccountSettingsImages.cs b/ShipEngineSDK/Model/AccountSettingsImages.cs index 51856d20..8b0f9fed 100644 --- a/ShipEngineSDK/Model/AccountSettingsImages.cs +++ b/ShipEngineSDK/Model/AccountSettingsImages.cs @@ -34,16 +34,27 @@ public partial class AccountSettingsImages [JsonConverter(typeof(ImageContentTypeEnumJsonConverter))] public class ImageContentTypeEnum { - private string _value; + private readonly string _value; + /// + /// Create a new instance of ImageContentTypeEnum with a predefined value. + /// internal ImageContentTypeEnum() { _value = "image/png"; } + /// + /// Create a new instance of ImageContentTypeEnum with a custom value. + /// + /// The value of the ImageContentTypeEnum + /// + /// 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 ImageContentTypeEnum(string value) { - + _value = value; } /// @@ -149,6 +160,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class AccountSettingsImages {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); @@ -156,6 +168,7 @@ public override string ToString() sb.Append(" ImageData: ").Append(ImageData).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs b/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs index ac8c4218..2b577292 100644 --- a/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs +++ b/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs @@ -53,8 +53,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class AddFundsToCarrierRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Currency: ").Append(Currency).Append("\n"); sb.Append(" Amount: ").Append(Amount).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs b/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs index 2c73a767..fc888a37 100644 --- a/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs +++ b/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs @@ -45,7 +45,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class AddFundsToCarrierResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Balance: ").Append(Balance).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs b/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs index b5ab318c..b8441d51 100644 --- a/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs +++ b/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs @@ -53,8 +53,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class AddFundsToInsuranceRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Currency: ").Append(Currency).Append("\n"); sb.Append(" Amount: ").Append(Amount).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs b/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs index 61b77b06..f2021847 100644 --- a/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs +++ b/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs @@ -53,8 +53,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class AddFundsToInsuranceResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Currency: ").Append(Currency).Append("\n"); sb.Append(" Amount: ").Append(Amount).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/AddToBatchRequestBody.cs b/ShipEngineSDK/Model/AddToBatchRequestBody.cs index ac178568..885b6e30 100644 --- a/ShipEngineSDK/Model/AddToBatchRequestBody.cs +++ b/ShipEngineSDK/Model/AddToBatchRequestBody.cs @@ -51,8 +51,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class AddToBatchRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); sb.Append(" RateIds: ").Append(RateIds).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/Address.cs b/ShipEngineSDK/Model/Address.cs index 7fbe8d11..65d99375 100644 --- a/ShipEngineSDK/Model/Address.cs +++ b/ShipEngineSDK/Model/Address.cs @@ -163,6 +163,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class Address {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" Phone: ").Append(Phone).Append("\n"); sb.Append(" Email: ").Append(Email).Append("\n"); @@ -175,6 +176,7 @@ public override string ToString() sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/AddressResidentialIndicator.cs b/ShipEngineSDK/Model/AddressResidentialIndicator.cs index 8f97f492..19993ba4 100644 --- a/ShipEngineSDK/Model/AddressResidentialIndicator.cs +++ b/ShipEngineSDK/Model/AddressResidentialIndicator.cs @@ -31,6 +31,9 @@ public class AddressResidentialIndicator { private string _value; + /// + /// Create a new instance of AddressResidentialIndicator with a predefined value. + /// internal AddressResidentialIndicator() { _value = "unknown"; diff --git a/ShipEngineSDK/Model/AddressToValidate.cs b/ShipEngineSDK/Model/AddressToValidate.cs index 3fdd775a..c1e867b9 100644 --- a/ShipEngineSDK/Model/AddressToValidate.cs +++ b/ShipEngineSDK/Model/AddressToValidate.cs @@ -157,6 +157,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class AddressToValidate {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" Phone: ").Append(Phone).Append("\n"); sb.Append(" Email: ").Append(Email).Append("\n"); @@ -169,6 +170,7 @@ public override string ToString() sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/AddressValidatingShipment.cs b/ShipEngineSDK/Model/AddressValidatingShipment.cs index 0b9e6e1c..aae27aff 100644 --- a/ShipEngineSDK/Model/AddressValidatingShipment.cs +++ b/ShipEngineSDK/Model/AddressValidatingShipment.cs @@ -257,6 +257,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class AddressValidatingShipment {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); @@ -285,6 +286,7 @@ public override string ToString() sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/AddressValidationCode.cs b/ShipEngineSDK/Model/AddressValidationCode.cs index 548fc131..77010c33 100644 --- a/ShipEngineSDK/Model/AddressValidationCode.cs +++ b/ShipEngineSDK/Model/AddressValidationCode.cs @@ -31,6 +31,9 @@ public class AddressValidationCode { private string _value; + /// + /// Create a new instance of AddressValidationCode with a predefined value. + /// internal AddressValidationCode() { _value = "a1000"; diff --git a/ShipEngineSDK/Model/AddressValidationDetailCode.cs b/ShipEngineSDK/Model/AddressValidationDetailCode.cs index 61d3455e..cd4c30e5 100644 --- a/ShipEngineSDK/Model/AddressValidationDetailCode.cs +++ b/ShipEngineSDK/Model/AddressValidationDetailCode.cs @@ -31,6 +31,9 @@ public class AddressValidationDetailCode { private string _value; + /// + /// Create a new instance of AddressValidationDetailCode with a predefined value. + /// internal AddressValidationDetailCode() { _value = "unsupported_country"; diff --git a/ShipEngineSDK/Model/AddressValidationMessageType.cs b/ShipEngineSDK/Model/AddressValidationMessageType.cs index 7a0c1e3c..777473ec 100644 --- a/ShipEngineSDK/Model/AddressValidationMessageType.cs +++ b/ShipEngineSDK/Model/AddressValidationMessageType.cs @@ -31,6 +31,9 @@ public class AddressValidationMessageType { private string _value; + /// + /// Create a new instance of AddressValidationMessageType with a predefined value. + /// internal AddressValidationMessageType() { _value = "error"; diff --git a/ShipEngineSDK/Model/AddressValidationResult.cs b/ShipEngineSDK/Model/AddressValidationResult.cs index db456746..4ef8a11b 100644 --- a/ShipEngineSDK/Model/AddressValidationResult.cs +++ b/ShipEngineSDK/Model/AddressValidationResult.cs @@ -69,10 +69,12 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class AddressValidationResult {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Status: ").Append(Status).Append("\n"); sb.Append(" OriginalAddress: ").Append(OriginalAddress).Append("\n"); sb.Append(" MatchedAddress: ").Append(MatchedAddress).Append("\n"); sb.Append(" Messages: ").Append(Messages).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/AddressValidationStatus.cs b/ShipEngineSDK/Model/AddressValidationStatus.cs index 57c23240..aa90f11e 100644 --- a/ShipEngineSDK/Model/AddressValidationStatus.cs +++ b/ShipEngineSDK/Model/AddressValidationStatus.cs @@ -31,6 +31,9 @@ public class AddressValidationStatus { private string _value; + /// + /// Create a new instance of AddressValidationStatus with a predefined value. + /// internal AddressValidationStatus() { _value = "unverified"; diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptions.cs b/ShipEngineSDK/Model/AdvancedShipmentOptions.cs index cebb43be..9b4fc56e 100644 --- a/ShipEngineSDK/Model/AdvancedShipmentOptions.cs +++ b/ShipEngineSDK/Model/AdvancedShipmentOptions.cs @@ -197,6 +197,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class AdvancedShipmentOptions {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" BillToAccount: ").Append(BillToAccount).Append("\n"); sb.Append(" BillToCountryCode: ").Append(BillToCountryCode).Append("\n"); sb.Append(" BillToParty: ").Append(BillToParty).Append("\n"); @@ -220,6 +221,7 @@ public override string ToString() sb.Append(" ThirdPartyConsignee: ").Append(ThirdPartyConsignee).Append("\n"); sb.Append(" DangerousGoods: ").Append(DangerousGoods).Append("\n"); sb.Append(" DangerousGoodsContact: ").Append(DangerousGoodsContact).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs b/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs index ceb9922b..f0a5df25 100644 --- a/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs +++ b/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs @@ -51,8 +51,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class AdvancedShipmentOptionsDangerousGoodsContact {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" Phone: ").Append(Phone).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs b/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs index 6ee2545d..7477ac56 100644 --- a/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs +++ b/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs @@ -49,8 +49,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class AdvancedShipmentOptionsFedexFreight {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipperLoadAndCount: ").Append(ShipperLoadAndCount).Append("\n"); sb.Append(" BookingConfirmation: ").Append(BookingConfirmation).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/AllowedIncoterms.cs b/ShipEngineSDK/Model/AllowedIncoterms.cs index 36b76e41..603a03b0 100644 --- a/ShipEngineSDK/Model/AllowedIncoterms.cs +++ b/ShipEngineSDK/Model/AllowedIncoterms.cs @@ -30,6 +30,9 @@ public class AllowedIncoterms { private string _value; + /// + /// Create a new instance of AllowedIncoterms with a predefined value. + /// internal AllowedIncoterms() { _value = "exw"; diff --git a/ShipEngineSDK/Model/AlternativeIdentifier.cs b/ShipEngineSDK/Model/AlternativeIdentifier.cs index a5cfb608..946aa902 100644 --- a/ShipEngineSDK/Model/AlternativeIdentifier.cs +++ b/ShipEngineSDK/Model/AlternativeIdentifier.cs @@ -57,8 +57,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class AlternativeIdentifier {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" Value: ").Append(Value).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/AlternativeIdentifiers.cs b/ShipEngineSDK/Model/AlternativeIdentifiers.cs index 39751e11..7dd456eb 100644 --- a/ShipEngineSDK/Model/AlternativeIdentifiers.cs +++ b/ShipEngineSDK/Model/AlternativeIdentifiers.cs @@ -44,7 +44,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class AlternativeIdentifiers {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" VarAlternativeIdentifiers: ").Append(VarAlternativeIdentifiers).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs b/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs index 97f318d3..a216e1f1 100644 --- a/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs +++ b/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs @@ -31,6 +31,9 @@ public class AncillaryServiceEndorsement { private string _value; + /// + /// Create a new instance of AncillaryServiceEndorsement with a predefined value. + /// internal AncillaryServiceEndorsement() { _value = "none"; diff --git a/ShipEngineSDK/Model/Batch.cs b/ShipEngineSDK/Model/Batch.cs index e5b186c1..27b0f661 100644 --- a/ShipEngineSDK/Model/Batch.cs +++ b/ShipEngineSDK/Model/Batch.cs @@ -233,6 +233,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class Batch {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); sb.Append(" BatchId: ").Append(BatchId).Append("\n"); @@ -254,6 +255,7 @@ public override string ToString() sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/BatchResponseError.cs b/ShipEngineSDK/Model/BatchResponseError.cs index 49fc0641..b93ff9f0 100644 --- a/ShipEngineSDK/Model/BatchResponseError.cs +++ b/ShipEngineSDK/Model/BatchResponseError.cs @@ -64,9 +64,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class BatchResponseError {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Error: ").Append(Error).Append("\n"); sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/BatchStatus.cs b/ShipEngineSDK/Model/BatchStatus.cs index 07e0a34e..fa43248a 100644 --- a/ShipEngineSDK/Model/BatchStatus.cs +++ b/ShipEngineSDK/Model/BatchStatus.cs @@ -31,6 +31,9 @@ public class BatchStatus { private string _value; + /// + /// Create a new instance of BatchStatus with a predefined value. + /// internal BatchStatus() { _value = "open"; diff --git a/ShipEngineSDK/Model/BatchesSortBy.cs b/ShipEngineSDK/Model/BatchesSortBy.cs index abf16ed3..c5057a31 100644 --- a/ShipEngineSDK/Model/BatchesSortBy.cs +++ b/ShipEngineSDK/Model/BatchesSortBy.cs @@ -31,6 +31,9 @@ public class BatchesSortBy { private string _value; + /// + /// Create a new instance of BatchesSortBy with a predefined value. + /// internal BatchesSortBy() { _value = "ship_date"; diff --git a/ShipEngineSDK/Model/BillToParty.cs b/ShipEngineSDK/Model/BillToParty.cs index 1f36582d..42bca333 100644 --- a/ShipEngineSDK/Model/BillToParty.cs +++ b/ShipEngineSDK/Model/BillToParty.cs @@ -31,6 +31,9 @@ public class BillToParty { private string _value; + /// + /// Create a new instance of BillToParty with a predefined value. + /// internal BillToParty() { _value = "recipient"; diff --git a/ShipEngineSDK/Model/BulkRate.cs b/ShipEngineSDK/Model/BulkRate.cs index 0cbd0297..b7e8b7bc 100644 --- a/ShipEngineSDK/Model/BulkRate.cs +++ b/ShipEngineSDK/Model/BulkRate.cs @@ -86,11 +86,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class BulkRate {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" RateRequestId: ").Append(RateRequestId).Append("\n"); sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CalculateRatesRequestBody.cs b/ShipEngineSDK/Model/CalculateRatesRequestBody.cs index e848a3f1..b7f1b2a6 100644 --- a/ShipEngineSDK/Model/CalculateRatesRequestBody.cs +++ b/ShipEngineSDK/Model/CalculateRatesRequestBody.cs @@ -44,11 +44,10 @@ public partial class CalculateRatesRequestBody : AbstractOpenAPISchema /// with the class /// /// An instance of ShipmentIdRequest. - public CalculateRatesRequestBody(ShipmentIdRequest actualInstance) + public CalculateRatesRequestBody(ShipmentIdRequest actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -56,11 +55,10 @@ public CalculateRatesRequestBody(ShipmentIdRequest actualInstance) /// with the class /// /// An instance of ShipmentRequest. - public CalculateRatesRequestBody(ShipmentRequest actualInstance) + public CalculateRatesRequestBody(ShipmentRequest actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } @@ -143,9 +141,9 @@ public override string ToJson() /// public class CalculateRatesRequestBodyJsonConverter : JsonConverter { - private static HashSet OneOfTypes = [typeof(ShipmentIdRequest), typeof(ShipmentRequest)]; - private static HashSet MandatoryFields = ["Shipment", "ShipmentId"]; - private static JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) + private static readonly HashSet OneOfTypes = [typeof(ShipmentIdRequest), typeof(ShipmentRequest)]; + private static readonly HashSet MandatoryFields = ["Shipment", "ShipmentId"]; + private static readonly JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) { TypeInfoResolver = new DefaultJsonTypeInfoResolver { @@ -207,7 +205,7 @@ public override void Write(Utf8JsonWriter writer, CalculateRatesRequestBody valu /// Object type to convert /// Serializer options /// The object converted from the JSON string - public override CalculateRatesRequestBody Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override CalculateRatesRequestBody? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { if (reader.TokenType == JsonTokenType.Null) { @@ -215,14 +213,14 @@ public override CalculateRatesRequestBody Read(ref Utf8JsonReader reader, Type t } var jsonDoc = JsonDocument.ParseValue(ref reader); - CalculateRatesRequestBody newCalculateRatesRequestBody = null; + CalculateRatesRequestBody? newCalculateRatesRequestBody = null; int match = 0; var matchedTypes = new List(); try { - newCalculateRatesRequestBody = new CalculateRatesRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newCalculateRatesRequestBody = new CalculateRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ShipmentIdRequest"); match++; @@ -230,12 +228,12 @@ public override CalculateRatesRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ShipmentIdRequest: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ShipmentIdRequest: {1}", jsonDoc, exception); } try { - newCalculateRatesRequestBody = new CalculateRatesRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newCalculateRatesRequestBody = new CalculateRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ShipmentRequest"); match++; @@ -243,7 +241,7 @@ public override CalculateRatesRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ShipmentRequest: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ShipmentRequest: {1}", jsonDoc, exception); } if (match == 0) @@ -256,7 +254,7 @@ public override CalculateRatesRequestBody Read(ref Utf8JsonReader reader, Type t throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); } - newCalculateRatesRequestBody.RateOptions = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("rate_options"), DeserializingOptions); + newCalculateRatesRequestBody!.RateOptions = jsonDoc.RootElement.GetProperty("rate_options").Deserialize(DeserializingOptions)!; // deserialization is considered successful at this point if no exception has been thrown. return newCalculateRatesRequestBody; diff --git a/ShipEngineSDK/Model/CalculateRatesResponseBody.cs b/ShipEngineSDK/Model/CalculateRatesResponseBody.cs index fc801a3b..a2674308 100644 --- a/ShipEngineSDK/Model/CalculateRatesResponseBody.cs +++ b/ShipEngineSDK/Model/CalculateRatesResponseBody.cs @@ -274,6 +274,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CalculateRatesResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); @@ -302,6 +303,7 @@ public override string ToString() sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); sb.Append(" RateResponse: ").Append(RateResponse).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/Carrier.cs b/ShipEngineSDK/Model/Carrier.cs index 3836f301..a6eac9f7 100644 --- a/ShipEngineSDK/Model/Carrier.cs +++ b/ShipEngineSDK/Model/Carrier.cs @@ -153,6 +153,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class Carrier {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); @@ -167,6 +168,7 @@ public override string ToString() sb.Append(" Services: ").Append(Services).Append("\n"); sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" Options: ").Append(Options).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CarrierAdvancedOption.cs b/ShipEngineSDK/Model/CarrierAdvancedOption.cs index 40017ad6..a1e4f42f 100644 --- a/ShipEngineSDK/Model/CarrierAdvancedOption.cs +++ b/ShipEngineSDK/Model/CarrierAdvancedOption.cs @@ -64,9 +64,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CarrierAdvancedOption {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" DefaultValue: ").Append(DefaultValue).Append("\n"); sb.Append(" Description: ").Append(Description).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CarrierName.cs b/ShipEngineSDK/Model/CarrierName.cs index 7f38207f..d69d9d9b 100644 --- a/ShipEngineSDK/Model/CarrierName.cs +++ b/ShipEngineSDK/Model/CarrierName.cs @@ -31,6 +31,9 @@ public class CarrierName { private string _value; + /// + /// Create a new instance of CarrierName with a predefined value. + /// internal CarrierName() { _value = "access_worldwide"; diff --git a/ShipEngineSDK/Model/CarrierNameWithSettings.cs b/ShipEngineSDK/Model/CarrierNameWithSettings.cs index f917efbd..e804e283 100644 --- a/ShipEngineSDK/Model/CarrierNameWithSettings.cs +++ b/ShipEngineSDK/Model/CarrierNameWithSettings.cs @@ -31,6 +31,9 @@ public class CarrierNameWithSettings { private string _value; + /// + /// Create a new instance of CarrierNameWithSettings with a predefined value. + /// internal CarrierNameWithSettings() { _value = "dhl_express"; diff --git a/ShipEngineSDK/Model/CollectOnDelivery.cs b/ShipEngineSDK/Model/CollectOnDelivery.cs index 49446865..5a9f3954 100644 --- a/ShipEngineSDK/Model/CollectOnDelivery.cs +++ b/ShipEngineSDK/Model/CollectOnDelivery.cs @@ -48,8 +48,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CollectOnDelivery {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" PaymentType: ").Append(PaymentType).Append("\n"); sb.Append(" PaymentAmount: ").Append(PaymentAmount).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs b/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs index 1a76ec60..51a17df6 100644 --- a/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs +++ b/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs @@ -31,6 +31,9 @@ public class CollectOnDeliveryPaymentType { private string _value; + /// + /// Create a new instance of CollectOnDeliveryPaymentType with a predefined value. + /// internal CollectOnDeliveryPaymentType() { _value = "any"; diff --git a/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs b/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs index bb2913cd..eb431c56 100644 --- a/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs +++ b/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs @@ -45,11 +45,10 @@ public partial class CompareBulkRatesRequestBody : AbstractOpenAPISchema /// with the class /// /// An instance of RateRequestByShipmentIds. - public CompareBulkRatesRequestBody(RateRequestByShipmentIds actualInstance) + public CompareBulkRatesRequestBody(RateRequestByShipmentIds actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -57,11 +56,10 @@ public CompareBulkRatesRequestBody(RateRequestByShipmentIds actualInstance) /// with the class /// /// An instance of RateRequestByShipments. - public CompareBulkRatesRequestBody(RateRequestByShipments actualInstance) + public CompareBulkRatesRequestBody(RateRequestByShipments actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } @@ -144,9 +142,9 @@ public override string ToJson() /// public class CompareBulkRatesRequestBodyJsonConverter : JsonConverter { - private static HashSet OneOfTypes = [typeof(RateRequestByShipmentIds), typeof(RateRequestByShipments)]; - private static HashSet MandatoryFields = ["RateOptions"]; - private static JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) + private static readonly HashSet OneOfTypes = [typeof(RateRequestByShipmentIds), typeof(RateRequestByShipments)]; + private static readonly HashSet MandatoryFields = ["RateOptions"]; + private static readonly JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) { TypeInfoResolver = new DefaultJsonTypeInfoResolver { @@ -208,7 +206,7 @@ public override void Write(Utf8JsonWriter writer, CompareBulkRatesRequestBody va /// Object type to convert /// Serializer options /// The object converted from the JSON string - public override CompareBulkRatesRequestBody Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override CompareBulkRatesRequestBody? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { if (reader.TokenType == JsonTokenType.Null) { @@ -216,14 +214,14 @@ public override CompareBulkRatesRequestBody Read(ref Utf8JsonReader reader, Type } var jsonDoc = JsonDocument.ParseValue(ref reader); - CompareBulkRatesRequestBody newCompareBulkRatesRequestBody = null; + CompareBulkRatesRequestBody? newCompareBulkRatesRequestBody = null; int match = 0; var matchedTypes = new List(); try { - newCompareBulkRatesRequestBody = new CompareBulkRatesRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newCompareBulkRatesRequestBody = new CompareBulkRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("RateRequestByShipmentIds"); match++; @@ -231,12 +229,12 @@ public override CompareBulkRatesRequestBody Read(ref Utf8JsonReader reader, Type catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into RateRequestByShipmentIds: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into RateRequestByShipmentIds: {1}", jsonDoc, exception); } try { - newCompareBulkRatesRequestBody = new CompareBulkRatesRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newCompareBulkRatesRequestBody = new CompareBulkRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("RateRequestByShipments"); match++; @@ -244,7 +242,7 @@ public override CompareBulkRatesRequestBody Read(ref Utf8JsonReader reader, Type catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into RateRequestByShipments: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into RateRequestByShipments: {1}", jsonDoc, exception); } if (match == 0) @@ -257,7 +255,7 @@ public override CompareBulkRatesRequestBody Read(ref Utf8JsonReader reader, Type throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); } - newCompareBulkRatesRequestBody.RateOptions = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("rate_options"), DeserializingOptions); + newCompareBulkRatesRequestBody!.RateOptions = jsonDoc.RootElement.GetProperty("rate_options").Deserialize(DeserializingOptions)!; // deserialization is considered successful at this point if no exception has been thrown. return newCompareBulkRatesRequestBody; diff --git a/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs b/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs index d7109fa1..4c3f604e 100644 --- a/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs @@ -64,9 +64,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectAccessWorldwideRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" Username: ").Append(Username).Append("\n"); sb.Append(" Password: ").Append(Password).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs b/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs index e452c93b..ecd46bea 100644 --- a/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs @@ -73,10 +73,12 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectAmazonBuyShippingRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" MerchantSellerId: ").Append(MerchantSellerId).Append("\n"); sb.Append(" MwsAuthToken: ").Append(MwsAuthToken).Append("\n"); sb.Append(" Email: ").Append(Email).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs b/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs index 04879a9f..49f6cf68 100644 --- a/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs +++ b/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs @@ -56,8 +56,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectAmazonShippingUk {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" AuthCode: ").Append(AuthCode).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectApcRequestBody.cs b/ShipEngineSDK/Model/ConnectApcRequestBody.cs index 71eef843..ce173f2c 100644 --- a/ShipEngineSDK/Model/ConnectApcRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectApcRequestBody.cs @@ -70,9 +70,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectApcRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" Username: ").Append(Username).Append("\n"); sb.Append(" Password: ").Append(Password).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs b/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs index d53c35a6..a8267cb3 100644 --- a/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs @@ -72,10 +72,12 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectAsendiaRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); sb.Append(" FtpUsername: ").Append(FtpUsername).Append("\n"); sb.Append(" FtpPassword: ").Append(FtpPassword).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs b/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs index d82798e8..197549ac 100644 --- a/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs @@ -69,10 +69,12 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectAustraliaPostRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); sb.Append(" ApiKey: ").Append(ApiKey).Append("\n"); sb.Append(" ApiSecret: ").Append(ApiSecret).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs b/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs index 3dfa58fe..9faef3ac 100644 --- a/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs @@ -77,11 +77,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectCanadaPostRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" ApiKey: ").Append(ApiKey).Append("\n"); sb.Append(" ApiSecret: ").Append(ApiSecret).Append("\n"); sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); sb.Append(" ContractId: ").Append(ContractId).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs b/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs index 2c7822ce..94af5d4b 100644 --- a/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs @@ -36,11 +36,10 @@ public partial class ConnectCarrierRequestBody : AbstractOpenAPISchema /// with the class /// /// An instance of ConnectAccessWorldwideRequestBody. - public ConnectCarrierRequestBody(ConnectAccessWorldwideRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectAccessWorldwideRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -48,11 +47,10 @@ public ConnectCarrierRequestBody(ConnectAccessWorldwideRequestBody actualInstanc /// with the class /// /// An instance of ConnectAmazonBuyShippingRequestBody. - public ConnectCarrierRequestBody(ConnectAmazonBuyShippingRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectAmazonBuyShippingRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -60,11 +58,10 @@ public ConnectCarrierRequestBody(ConnectAmazonBuyShippingRequestBody actualInsta /// with the class /// /// An instance of ConnectAmazonShippingUk. - public ConnectCarrierRequestBody(ConnectAmazonShippingUk actualInstance) + public ConnectCarrierRequestBody(ConnectAmazonShippingUk actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -72,11 +69,10 @@ public ConnectCarrierRequestBody(ConnectAmazonShippingUk actualInstance) /// with the class /// /// An instance of ConnectApcRequestBody. - public ConnectCarrierRequestBody(ConnectApcRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectApcRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -84,11 +80,10 @@ public ConnectCarrierRequestBody(ConnectApcRequestBody actualInstance) /// with the class /// /// An instance of ConnectAsendiaRequestBody. - public ConnectCarrierRequestBody(ConnectAsendiaRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectAsendiaRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -96,11 +91,10 @@ public ConnectCarrierRequestBody(ConnectAsendiaRequestBody actualInstance) /// with the class /// /// An instance of ConnectAustraliaPostRequestBody. - public ConnectCarrierRequestBody(ConnectAustraliaPostRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectAustraliaPostRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -108,11 +102,10 @@ public ConnectCarrierRequestBody(ConnectAustraliaPostRequestBody actualInstance) /// with the class /// /// An instance of ConnectCanadaPostRequestBody. - public ConnectCarrierRequestBody(ConnectCanadaPostRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectCanadaPostRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -120,11 +113,10 @@ public ConnectCarrierRequestBody(ConnectCanadaPostRequestBody actualInstance) /// with the class /// /// An instance of ConnectDhlEcommerceRequestBody. - public ConnectCarrierRequestBody(ConnectDhlEcommerceRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectDhlEcommerceRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -132,11 +124,10 @@ public ConnectCarrierRequestBody(ConnectDhlEcommerceRequestBody actualInstance) /// with the class /// /// An instance of ConnectDhlExpressRequestBody. - public ConnectCarrierRequestBody(ConnectDhlExpressRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectDhlExpressRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -144,11 +135,10 @@ public ConnectCarrierRequestBody(ConnectDhlExpressRequestBody actualInstance) /// with the class /// /// An instance of ConnectDhlExpressAuRequestBody. - public ConnectCarrierRequestBody(ConnectDhlExpressAuRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectDhlExpressAuRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -156,11 +146,10 @@ public ConnectCarrierRequestBody(ConnectDhlExpressAuRequestBody actualInstance) /// with the class /// /// An instance of ConnectDhlExpressCaRequestBody. - public ConnectCarrierRequestBody(ConnectDhlExpressCaRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectDhlExpressCaRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -168,11 +157,10 @@ public ConnectCarrierRequestBody(ConnectDhlExpressCaRequestBody actualInstance) /// with the class /// /// An instance of ConnectDhlExpressUkRequestBody. - public ConnectCarrierRequestBody(ConnectDhlExpressUkRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectDhlExpressUkRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -180,11 +168,10 @@ public ConnectCarrierRequestBody(ConnectDhlExpressUkRequestBody actualInstance) /// with the class /// /// An instance of ConnectDpdRequestBody. - public ConnectCarrierRequestBody(ConnectDpdRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectDpdRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -192,11 +179,10 @@ public ConnectCarrierRequestBody(ConnectDpdRequestBody actualInstance) /// with the class /// /// An instance of ConnectEndiciaRequestBody. - public ConnectCarrierRequestBody(ConnectEndiciaRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectEndiciaRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -204,11 +190,10 @@ public ConnectCarrierRequestBody(ConnectEndiciaRequestBody actualInstance) /// with the class /// /// An instance of ConnectFedexRequestBody. - public ConnectCarrierRequestBody(ConnectFedexRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectFedexRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -216,11 +201,10 @@ public ConnectCarrierRequestBody(ConnectFedexRequestBody actualInstance) /// with the class /// /// An instance of ConnectFedexUkRequestBody. - public ConnectCarrierRequestBody(ConnectFedexUkRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectFedexUkRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -228,11 +212,10 @@ public ConnectCarrierRequestBody(ConnectFedexUkRequestBody actualInstance) /// with the class /// /// An instance of ConnectFirstmileRequestBody. - public ConnectCarrierRequestBody(ConnectFirstmileRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectFirstmileRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -240,11 +223,10 @@ public ConnectCarrierRequestBody(ConnectFirstmileRequestBody actualInstance) /// with the class /// /// An instance of ConnectImexRequestBody. - public ConnectCarrierRequestBody(ConnectImexRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectImexRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -252,11 +234,10 @@ public ConnectCarrierRequestBody(ConnectImexRequestBody actualInstance) /// with the class /// /// An instance of ConnectLasershipRequestBody. - public ConnectCarrierRequestBody(ConnectLasershipRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectLasershipRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -264,11 +245,10 @@ public ConnectCarrierRequestBody(ConnectLasershipRequestBody actualInstance) /// with the class /// /// An instance of ConnectNewgisticsRequestBody. - public ConnectCarrierRequestBody(ConnectNewgisticsRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectNewgisticsRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -276,11 +256,10 @@ public ConnectCarrierRequestBody(ConnectNewgisticsRequestBody actualInstance) /// with the class /// /// An instance of ConnectOntracRequestBody. - public ConnectCarrierRequestBody(ConnectOntracRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectOntracRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -288,11 +267,10 @@ public ConnectCarrierRequestBody(ConnectOntracRequestBody actualInstance) /// with the class /// /// An instance of ConnectPurolatorRequestBody. - public ConnectCarrierRequestBody(ConnectPurolatorRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectPurolatorRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -300,11 +278,10 @@ public ConnectCarrierRequestBody(ConnectPurolatorRequestBody actualInstance) /// with the class /// /// An instance of ConnectRoyalMailRequestBody. - public ConnectCarrierRequestBody(ConnectRoyalMailRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectRoyalMailRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -312,11 +289,10 @@ public ConnectCarrierRequestBody(ConnectRoyalMailRequestBody actualInstance) /// with the class /// /// An instance of ConnectRrDonnelleyRequestBody. - public ConnectCarrierRequestBody(ConnectRrDonnelleyRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectRrDonnelleyRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -324,11 +300,10 @@ public ConnectCarrierRequestBody(ConnectRrDonnelleyRequestBody actualInstance) /// with the class /// /// An instance of ConnectSekoRequestBody. - public ConnectCarrierRequestBody(ConnectSekoRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectSekoRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -336,11 +311,10 @@ public ConnectCarrierRequestBody(ConnectSekoRequestBody actualInstance) /// with the class /// /// An instance of ConnectSendleRequestBody. - public ConnectCarrierRequestBody(ConnectSendleRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectSendleRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -348,11 +322,10 @@ public ConnectCarrierRequestBody(ConnectSendleRequestBody actualInstance) /// with the class /// /// An instance of ConnectStampsRequestBody. - public ConnectCarrierRequestBody(ConnectStampsRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectStampsRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -360,11 +333,10 @@ public ConnectCarrierRequestBody(ConnectStampsRequestBody actualInstance) /// with the class /// /// An instance of ConnectUpsRequestBody. - public ConnectCarrierRequestBody(ConnectUpsRequestBody actualInstance) + public ConnectCarrierRequestBody(ConnectUpsRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } @@ -810,9 +782,9 @@ public override string ToJson() /// public class ConnectCarrierRequestBodyJsonConverter : JsonConverter { - private static HashSet OneOfTypes = [typeof(ConnectAccessWorldwideRequestBody), typeof(ConnectAmazonBuyShippingRequestBody), typeof(ConnectAmazonShippingUk), typeof(ConnectApcRequestBody), typeof(ConnectAsendiaRequestBody), typeof(ConnectAustraliaPostRequestBody), typeof(ConnectCanadaPostRequestBody), typeof(ConnectDhlEcommerceRequestBody), typeof(ConnectDhlExpressRequestBody), typeof(ConnectDhlExpressAuRequestBody), typeof(ConnectDhlExpressCaRequestBody), typeof(ConnectDhlExpressUkRequestBody), typeof(ConnectDpdRequestBody), typeof(ConnectEndiciaRequestBody), typeof(ConnectFedexRequestBody), typeof(ConnectFedexUkRequestBody), typeof(ConnectFirstmileRequestBody), typeof(ConnectImexRequestBody), typeof(ConnectLasershipRequestBody), typeof(ConnectNewgisticsRequestBody), typeof(ConnectOntracRequestBody), typeof(ConnectPurolatorRequestBody), typeof(ConnectRoyalMailRequestBody), typeof(ConnectRrDonnelleyRequestBody), typeof(ConnectSekoRequestBody), typeof(ConnectSendleRequestBody), typeof(ConnectStampsRequestBody), typeof(ConnectUpsRequestBody)]; - private static HashSet MandatoryFields = ["AccessKey", "Account", "AccountNumber", "ActivationKey", "Address", "Address1", "AgreeToEula", "ApiKey", "ApiSecret", "AuthCode", "City", "ClientId", "ContactName", "ContractId", "CountryCode", "CustomerBranch", "DistributionCenter", "Email", "FirstName", "FtpPassword", "FtpUsername", "InductionSite", "LasershipCriticalEntryTime", "LasershipCriticalPullTime", "LastName", "MailerId", "MerchantSellerId", "MwsAuthToken", "Nickname", "Passphrase", "Password", "Phone", "PickupNumber", "PostalCode", "SendleId", "SiteId", "State", "Username", "WebServicesId", "WebServicesKey"]; - private static JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) + private static readonly HashSet OneOfTypes = [typeof(ConnectAccessWorldwideRequestBody), typeof(ConnectAmazonBuyShippingRequestBody), typeof(ConnectAmazonShippingUk), typeof(ConnectApcRequestBody), typeof(ConnectAsendiaRequestBody), typeof(ConnectAustraliaPostRequestBody), typeof(ConnectCanadaPostRequestBody), typeof(ConnectDhlEcommerceRequestBody), typeof(ConnectDhlExpressRequestBody), typeof(ConnectDhlExpressAuRequestBody), typeof(ConnectDhlExpressCaRequestBody), typeof(ConnectDhlExpressUkRequestBody), typeof(ConnectDpdRequestBody), typeof(ConnectEndiciaRequestBody), typeof(ConnectFedexRequestBody), typeof(ConnectFedexUkRequestBody), typeof(ConnectFirstmileRequestBody), typeof(ConnectImexRequestBody), typeof(ConnectLasershipRequestBody), typeof(ConnectNewgisticsRequestBody), typeof(ConnectOntracRequestBody), typeof(ConnectPurolatorRequestBody), typeof(ConnectRoyalMailRequestBody), typeof(ConnectRrDonnelleyRequestBody), typeof(ConnectSekoRequestBody), typeof(ConnectSendleRequestBody), typeof(ConnectStampsRequestBody), typeof(ConnectUpsRequestBody)]; + private static readonly HashSet MandatoryFields = ["AccessKey", "Account", "AccountNumber", "ActivationKey", "Address", "Address1", "AgreeToEula", "ApiKey", "ApiSecret", "AuthCode", "City", "ClientId", "ContactName", "ContractId", "CountryCode", "CustomerBranch", "DistributionCenter", "Email", "FirstName", "FtpPassword", "FtpUsername", "InductionSite", "LasershipCriticalEntryTime", "LasershipCriticalPullTime", "LastName", "MailerId", "MerchantSellerId", "MwsAuthToken", "Nickname", "Passphrase", "Password", "Phone", "PickupNumber", "PostalCode", "SendleId", "SiteId", "State", "Username", "WebServicesId", "WebServicesKey"]; + private static readonly JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) { TypeInfoResolver = new DefaultJsonTypeInfoResolver { @@ -872,7 +844,7 @@ public override void Write(Utf8JsonWriter writer, ConnectCarrierRequestBody valu /// Object type to convert /// Serializer options /// The object converted from the JSON string - public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override ConnectCarrierRequestBody? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { if (reader.TokenType == JsonTokenType.Null) { @@ -880,14 +852,14 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t } var jsonDoc = JsonDocument.ParseValue(ref reader); - ConnectCarrierRequestBody newConnectCarrierRequestBody = null; + ConnectCarrierRequestBody? newConnectCarrierRequestBody = null; int match = 0; var matchedTypes = new List(); try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectAccessWorldwideRequestBody"); match++; @@ -895,12 +867,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectAccessWorldwideRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectAccessWorldwideRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectAmazonBuyShippingRequestBody"); match++; @@ -908,12 +880,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectAmazonBuyShippingRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectAmazonBuyShippingRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectAmazonShippingUk"); match++; @@ -921,12 +893,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectAmazonShippingUk: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectAmazonShippingUk: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectApcRequestBody"); match++; @@ -934,12 +906,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectApcRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectApcRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectAsendiaRequestBody"); match++; @@ -947,12 +919,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectAsendiaRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectAsendiaRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectAustraliaPostRequestBody"); match++; @@ -960,12 +932,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectAustraliaPostRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectAustraliaPostRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectCanadaPostRequestBody"); match++; @@ -973,12 +945,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectCanadaPostRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectCanadaPostRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectDhlEcommerceRequestBody"); match++; @@ -986,12 +958,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectDhlEcommerceRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectDhlEcommerceRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectDhlExpressRequestBody"); match++; @@ -999,12 +971,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectDhlExpressRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectDhlExpressRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectDhlExpressAuRequestBody"); match++; @@ -1012,12 +984,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectDhlExpressAuRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectDhlExpressAuRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectDhlExpressCaRequestBody"); match++; @@ -1025,12 +997,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectDhlExpressCaRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectDhlExpressCaRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectDhlExpressUkRequestBody"); match++; @@ -1038,12 +1010,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectDhlExpressUkRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectDhlExpressUkRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectDpdRequestBody"); match++; @@ -1051,12 +1023,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectDpdRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectDpdRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectEndiciaRequestBody"); match++; @@ -1064,12 +1036,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectEndiciaRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectEndiciaRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectFedexRequestBody"); match++; @@ -1077,12 +1049,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectFedexRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectFedexRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectFedexUkRequestBody"); match++; @@ -1090,12 +1062,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectFedexUkRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectFedexUkRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectFirstmileRequestBody"); match++; @@ -1103,12 +1075,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectFirstmileRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectFirstmileRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectImexRequestBody"); match++; @@ -1116,12 +1088,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectImexRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectImexRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectLasershipRequestBody"); match++; @@ -1129,12 +1101,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectLasershipRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectLasershipRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectNewgisticsRequestBody"); match++; @@ -1142,12 +1114,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectNewgisticsRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectNewgisticsRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectOntracRequestBody"); match++; @@ -1155,12 +1127,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectOntracRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectOntracRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectPurolatorRequestBody"); match++; @@ -1168,12 +1140,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectPurolatorRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectPurolatorRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectRoyalMailRequestBody"); match++; @@ -1181,12 +1153,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectRoyalMailRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectRoyalMailRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectRrDonnelleyRequestBody"); match++; @@ -1194,12 +1166,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectRrDonnelleyRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectRrDonnelleyRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectSekoRequestBody"); match++; @@ -1207,12 +1179,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectSekoRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectSekoRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectSendleRequestBody"); match++; @@ -1220,12 +1192,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectSendleRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectSendleRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectStampsRequestBody"); match++; @@ -1233,12 +1205,12 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectStampsRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectStampsRequestBody: {1}", jsonDoc, exception); } try { - newConnectCarrierRequestBody = new ConnectCarrierRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newConnectCarrierRequestBody = new ConnectCarrierRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("ConnectUpsRequestBody"); match++; @@ -1246,7 +1218,7 @@ public override ConnectCarrierRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into ConnectUpsRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ConnectUpsRequestBody: {1}", jsonDoc, exception); } if (match == 0) diff --git a/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs b/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs index 969f66e6..96933418 100644 --- a/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs +++ b/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs @@ -48,7 +48,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectCarrierResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs index 917dea6e..93e592ae 100644 --- a/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs @@ -147,6 +147,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectDhlEcommerceRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" ClientId: ").Append(ClientId).Append("\n"); sb.Append(" Username: ").Append(Username).Append("\n"); @@ -162,6 +163,7 @@ public override string ToString() sb.Append(" SoldTo: ").Append(SoldTo).Append("\n"); sb.Append(" RegistrationId: ").Append(RegistrationId).Append("\n"); sb.Append(" SoftwareName: ").Append(SoftwareName).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs index a5317c02..af3dc808 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs @@ -53,8 +53,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectDhlExpressAuRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs index 5a09aee5..aeaa0a65 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs @@ -53,8 +53,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectDhlExpressCaRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs index 2519b0ec..c2257d54 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs @@ -77,11 +77,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectDhlExpressRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); sb.Append(" SiteId: ").Append(SiteId).Append("\n"); sb.Append(" Password: ").Append(Password).Append("\n"); sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs index 952f9674..333235e4 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs @@ -72,10 +72,12 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectDhlExpressUkRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); sb.Append(" SiteId: ").Append(SiteId).Append("\n"); sb.Append(" Password: ").Append(Password).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectDpdRequestBody.cs b/ShipEngineSDK/Model/ConnectDpdRequestBody.cs index ed9b15a1..d4937639 100644 --- a/ShipEngineSDK/Model/ConnectDpdRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDpdRequestBody.cs @@ -61,9 +61,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectDpdRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); sb.Append(" Password: ").Append(Password).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs b/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs index 8c2ab8ce..a961cf34 100644 --- a/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs @@ -61,9 +61,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectEndiciaRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" Account: ").Append(Account).Append("\n"); sb.Append(" Passphrase: ").Append(Passphrase).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectFedexRequestBody.cs b/ShipEngineSDK/Model/ConnectFedexRequestBody.cs index 386b69db..d2bb64c3 100644 --- a/ShipEngineSDK/Model/ConnectFedexRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectFedexRequestBody.cs @@ -157,6 +157,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectFedexRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); sb.Append(" Address1: ").Append(Address1).Append("\n"); sb.Append(" Address2: ").Append(Address2).Append("\n"); @@ -172,6 +173,7 @@ public override string ToString() sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" AgreeToEula: ").Append(AgreeToEula).Append("\n"); sb.Append(" MeterNumber: ").Append(MeterNumber).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs b/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs index b2921853..088181f6 100644 --- a/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs @@ -157,6 +157,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectFedexUkRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); sb.Append(" Address1: ").Append(Address1).Append("\n"); sb.Append(" Address2: ").Append(Address2).Append("\n"); @@ -172,6 +173,7 @@ public override string ToString() sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" AgreeToEula: ").Append(AgreeToEula).Append("\n"); sb.Append(" MeterNumber: ").Append(MeterNumber).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs b/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs index f16eb45b..fa5b7c06 100644 --- a/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs @@ -71,10 +71,12 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectFirstmileRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" MailerId: ").Append(MailerId).Append("\n"); sb.Append(" ProfileName: ").Append(ProfileName).Append("\n"); sb.Append(" Password: ").Append(Password).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectImexRequestBody.cs b/ShipEngineSDK/Model/ConnectImexRequestBody.cs index 1d1c1d22..52d73920 100644 --- a/ShipEngineSDK/Model/ConnectImexRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectImexRequestBody.cs @@ -61,9 +61,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectImexRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" Username: ").Append(Username).Append("\n"); sb.Append(" Password: ").Append(Password).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs b/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs index a00ca969..5f7bb2fd 100644 --- a/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs @@ -55,8 +55,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectInsurerRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Email: ").Append(Email).Append("\n"); sb.Append(" PolicyId: ").Append(PolicyId).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs b/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs index 0936bf68..788e4f0d 100644 --- a/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs @@ -229,6 +229,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectLasershipRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" WebServicesId: ").Append(WebServicesId).Append("\n"); sb.Append(" WebServicesKey: ").Append(WebServicesKey).Append("\n"); @@ -255,6 +256,7 @@ public override string ToString() sb.Append(" AttrRefrigerated: ").Append(AttrRefrigerated).Append("\n"); sb.Append(" AttrPerishable: ").Append(AttrPerishable).Append("\n"); sb.Append(" AttrNoRTS: ").Append(AttrNoRTS).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs b/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs index 74d361a9..6a10e7eb 100644 --- a/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs @@ -67,10 +67,12 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectNewgisticsRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" MerchantId: ").Append(MerchantId).Append("\n"); sb.Append(" MailerId: ").Append(MailerId).Append("\n"); sb.Append(" InductionSite: ").Append(InductionSite).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectOntracRequestBody.cs b/ShipEngineSDK/Model/ConnectOntracRequestBody.cs index 1af2af35..546572a8 100644 --- a/ShipEngineSDK/Model/ConnectOntracRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectOntracRequestBody.cs @@ -61,9 +61,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectOntracRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); sb.Append(" Password: ").Append(Password).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs b/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs index bf27967b..0c0fcbd7 100644 --- a/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs @@ -61,9 +61,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectPurolatorRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); sb.Append(" ActivationKey: ").Append(ActivationKey).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs b/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs index 789a2a10..90214400 100644 --- a/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs @@ -132,6 +132,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectRoyalMailRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); sb.Append(" ObaEmail: ").Append(ObaEmail).Append("\n"); sb.Append(" ContactName: ").Append(ContactName).Append("\n"); @@ -144,6 +145,7 @@ public override string ToString() sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); sb.Append(" Phone: ").Append(Phone).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs b/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs index 7d07dddd..e1e0d6e2 100644 --- a/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs @@ -61,9 +61,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectRrDonnelleyRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" Username: ").Append(Username).Append("\n"); sb.Append(" Password: ").Append(Password).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectSekoRequestBody.cs b/ShipEngineSDK/Model/ConnectSekoRequestBody.cs index 7c5aa65a..1e32b40a 100644 --- a/ShipEngineSDK/Model/ConnectSekoRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectSekoRequestBody.cs @@ -53,8 +53,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectSekoRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" AccessKey: ").Append(AccessKey).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectSendleRequestBody.cs b/ShipEngineSDK/Model/ConnectSendleRequestBody.cs index b69ed9df..a3505c9f 100644 --- a/ShipEngineSDK/Model/ConnectSendleRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectSendleRequestBody.cs @@ -64,9 +64,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectSendleRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" SendleId: ").Append(SendleId).Append("\n"); sb.Append(" ApiKey: ").Append(ApiKey).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectStampsRequestBody.cs b/ShipEngineSDK/Model/ConnectStampsRequestBody.cs index b08c3f1d..4c8020e8 100644 --- a/ShipEngineSDK/Model/ConnectStampsRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectStampsRequestBody.cs @@ -61,9 +61,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectStampsRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" Username: ").Append(Username).Append("\n"); sb.Append(" Password: ").Append(Password).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ConnectUpsRequestBody.cs b/ShipEngineSDK/Model/ConnectUpsRequestBody.cs index b38c9957..f4208cfa 100644 --- a/ShipEngineSDK/Model/ConnectUpsRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectUpsRequestBody.cs @@ -53,8 +53,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ConnectUpsRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ContactDetails.cs b/ShipEngineSDK/Model/ContactDetails.cs index 753f58a9..16d0b139 100644 --- a/ShipEngineSDK/Model/ContactDetails.cs +++ b/ShipEngineSDK/Model/ContactDetails.cs @@ -63,9 +63,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ContactDetails {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" Email: ").Append(Email).Append("\n"); sb.Append(" Phone: ").Append(Phone).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs index 216dc2d0..a3024026 100644 --- a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs @@ -34,16 +34,27 @@ public partial class CreateAccountSettingsImageRequestBody [JsonConverter(typeof(ImageContentTypeEnumJsonConverter))] public class ImageContentTypeEnum { - private string _value; + private readonly string _value; + /// + /// Create a new instance of ImageContentTypeEnum with a predefined value. + /// internal ImageContentTypeEnum() { _value = "image/png"; } + /// + /// Create a new instance of ImageContentTypeEnum with a custom value. + /// + /// The value of the ImageContentTypeEnum + /// + /// 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 ImageContentTypeEnum(string value) { - + _value = value; } /// @@ -154,6 +165,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateAccountSettingsImageRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); @@ -161,6 +173,7 @@ public override string ToString() sb.Append(" ImageData: ").Append(ImageData).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs index b3686ccd..18976f87 100644 --- a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs +++ b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs @@ -77,11 +77,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateAndProcessBatchRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ExternalBatchId: ").Append(ExternalBatchId).Append("\n"); sb.Append(" BatchNotes: ").Append(BatchNotes).Append("\n"); sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); sb.Append(" RateIds: ").Append(RateIds).Append("\n"); sb.Append(" ProcessLabels: ").Append(ProcessLabels).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs index acad886c..c47588d9 100644 --- a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs +++ b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs @@ -70,11 +70,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateAndProcessBatchRequestBodyProcessLabels {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CreateBatchAndProcessLabels: ").Append(CreateBatchAndProcessLabels).Append("\n"); sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateAndValidateShipment.cs b/ShipEngineSDK/Model/CreateAndValidateShipment.cs index 2fc80fd6..1e12804b 100644 --- a/ShipEngineSDK/Model/CreateAndValidateShipment.cs +++ b/ShipEngineSDK/Model/CreateAndValidateShipment.cs @@ -262,6 +262,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateAndValidateShipment {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); @@ -291,6 +292,7 @@ public override string ToString() sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); sb.Append(" AddressValidation: ").Append(AddressValidation).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateBatchRequest.cs b/ShipEngineSDK/Model/CreateBatchRequest.cs index 0627a2b6..c1c8c75c 100644 --- a/ShipEngineSDK/Model/CreateBatchRequest.cs +++ b/ShipEngineSDK/Model/CreateBatchRequest.cs @@ -36,11 +36,10 @@ public partial class CreateBatchRequest : AbstractOpenAPISchema /// with the class /// /// An instance of CreateBatchRequestBody. - public CreateBatchRequest(CreateBatchRequestBody actualInstance) + public CreateBatchRequest(CreateBatchRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -48,11 +47,10 @@ public CreateBatchRequest(CreateBatchRequestBody actualInstance) /// with the class /// /// An instance of CreateAndProcessBatchRequestBody. - public CreateBatchRequest(CreateAndProcessBatchRequestBody actualInstance) + public CreateBatchRequest(CreateAndProcessBatchRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } @@ -134,9 +132,9 @@ public override string ToJson() /// public class CreateBatchRequestJsonConverter : JsonConverter { - private static HashSet OneOfTypes = [typeof(CreateBatchRequestBody), typeof(CreateAndProcessBatchRequestBody)]; - private static HashSet MandatoryFields = []; - private static JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) + private static readonly HashSet OneOfTypes = [typeof(CreateBatchRequestBody), typeof(CreateAndProcessBatchRequestBody)]; + private static readonly HashSet MandatoryFields = []; + private static readonly JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) { TypeInfoResolver = new DefaultJsonTypeInfoResolver { @@ -196,7 +194,7 @@ public override void Write(Utf8JsonWriter writer, CreateBatchRequest value, Json /// Object type to convert /// Serializer options /// The object converted from the JSON string - public override CreateBatchRequest Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override CreateBatchRequest? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { if (reader.TokenType == JsonTokenType.Null) { @@ -204,14 +202,14 @@ public override CreateBatchRequest Read(ref Utf8JsonReader reader, Type typeToCo } var jsonDoc = JsonDocument.ParseValue(ref reader); - CreateBatchRequest newCreateBatchRequest = null; + CreateBatchRequest? newCreateBatchRequest = null; int match = 0; var matchedTypes = new List(); try { - newCreateBatchRequest = new CreateBatchRequest(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newCreateBatchRequest = new CreateBatchRequest(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("CreateBatchRequestBody"); match++; @@ -219,12 +217,12 @@ public override CreateBatchRequest Read(ref Utf8JsonReader reader, Type typeToCo catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into CreateBatchRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into CreateBatchRequestBody: {1}", jsonDoc, exception); } try { - newCreateBatchRequest = new CreateBatchRequest(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newCreateBatchRequest = new CreateBatchRequest(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("CreateAndProcessBatchRequestBody"); match++; @@ -232,7 +230,7 @@ public override CreateBatchRequest Read(ref Utf8JsonReader reader, Type typeToCo catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into CreateAndProcessBatchRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into CreateAndProcessBatchRequestBody: {1}", jsonDoc, exception); } if (match == 0) diff --git a/ShipEngineSDK/Model/CreateBatchRequestBody.cs b/ShipEngineSDK/Model/CreateBatchRequestBody.cs index 8666c921..871e4067 100644 --- a/ShipEngineSDK/Model/CreateBatchRequestBody.cs +++ b/ShipEngineSDK/Model/CreateBatchRequestBody.cs @@ -71,10 +71,12 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateBatchRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ExternalBatchId: ").Append(ExternalBatchId).Append("\n"); sb.Append(" BatchNotes: ").Append(BatchNotes).Append("\n"); sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); sb.Append(" RateIds: ").Append(RateIds).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateBatchResponseBody.cs b/ShipEngineSDK/Model/CreateBatchResponseBody.cs index fce16421..c536bd99 100644 --- a/ShipEngineSDK/Model/CreateBatchResponseBody.cs +++ b/ShipEngineSDK/Model/CreateBatchResponseBody.cs @@ -233,6 +233,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateBatchResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); sb.Append(" BatchId: ").Append(BatchId).Append("\n"); @@ -254,6 +255,7 @@ public override string ToString() sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs b/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs index c3a10a36..557ff48d 100644 --- a/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs @@ -63,11 +63,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateLabelFromRateRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs index 93d0b6cc..7e7d2980 100644 --- a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs @@ -334,6 +334,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateLabelFromRateResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" LabelId: ").Append(LabelId).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); @@ -372,6 +373,7 @@ public override string ToString() sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs b/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs index e0716539..e6de6353 100644 --- a/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs @@ -63,11 +63,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateLabelFromShipmentRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs index 6cd4e69f..92a14139 100644 --- a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs @@ -334,6 +334,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateLabelFromShipmentResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" LabelId: ").Append(LabelId).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); @@ -372,6 +373,7 @@ public override string ToString() sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateLabelRequestBody.cs b/ShipEngineSDK/Model/CreateLabelRequestBody.cs index a2e32152..368e1282 100644 --- a/ShipEngineSDK/Model/CreateLabelRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelRequestBody.cs @@ -355,6 +355,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateLabelRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipToServicePointId: ").Append(ShipToServicePointId).Append("\n"); sb.Append(" ShipFromServicePointId: ").Append(ShipFromServicePointId).Append("\n"); sb.Append(" LabelId: ").Append(LabelId).Append("\n"); @@ -395,6 +396,7 @@ public override string ToString() sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateLabelResponseBody.cs b/ShipEngineSDK/Model/CreateLabelResponseBody.cs index ab0b734a..449556b1 100644 --- a/ShipEngineSDK/Model/CreateLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelResponseBody.cs @@ -376,6 +376,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateLabelResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" LabelId: ").Append(LabelId).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); @@ -414,6 +415,7 @@ public override string ToString() sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs b/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs index c4d843d7..b74b6734 100644 --- a/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs +++ b/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs @@ -84,11 +84,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateManifestByObjectRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ExcludedLabelIds: ").Append(ExcludedLabelIds).Append("\n"); sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs b/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs index 216c891c..720bdb9d 100644 --- a/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs +++ b/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs @@ -45,7 +45,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateManifestLabelIdsRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateManifestRequestBody.cs b/ShipEngineSDK/Model/CreateManifestRequestBody.cs index 35217d49..f46afcd6 100644 --- a/ShipEngineSDK/Model/CreateManifestRequestBody.cs +++ b/ShipEngineSDK/Model/CreateManifestRequestBody.cs @@ -36,11 +36,10 @@ public partial class CreateManifestRequestBody : AbstractOpenAPISchema /// with the class /// /// An instance of CreateManifestByObjectRequestBody. - public CreateManifestRequestBody(CreateManifestByObjectRequestBody actualInstance) + public CreateManifestRequestBody(CreateManifestByObjectRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -48,11 +47,10 @@ public CreateManifestRequestBody(CreateManifestByObjectRequestBody actualInstanc /// with the class /// /// An instance of CreateManifestLabelIdsRequestBody. - public CreateManifestRequestBody(CreateManifestLabelIdsRequestBody actualInstance) + public CreateManifestRequestBody(CreateManifestLabelIdsRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } @@ -134,9 +132,9 @@ public override string ToJson() /// public class CreateManifestRequestBodyJsonConverter : JsonConverter { - private static HashSet OneOfTypes = [typeof(CreateManifestByObjectRequestBody), typeof(CreateManifestLabelIdsRequestBody)]; - private static HashSet MandatoryFields = ["CarrierId", "LabelIds", "ShipDate", "WarehouseId"]; - private static JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) + private static readonly HashSet OneOfTypes = [typeof(CreateManifestByObjectRequestBody), typeof(CreateManifestLabelIdsRequestBody)]; + private static readonly HashSet MandatoryFields = ["CarrierId", "LabelIds", "ShipDate", "WarehouseId"]; + private static readonly JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) { TypeInfoResolver = new DefaultJsonTypeInfoResolver { @@ -196,7 +194,7 @@ public override void Write(Utf8JsonWriter writer, CreateManifestRequestBody valu /// Object type to convert /// Serializer options /// The object converted from the JSON string - public override CreateManifestRequestBody Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override CreateManifestRequestBody? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { if (reader.TokenType == JsonTokenType.Null) { @@ -204,14 +202,14 @@ public override CreateManifestRequestBody Read(ref Utf8JsonReader reader, Type t } var jsonDoc = JsonDocument.ParseValue(ref reader); - CreateManifestRequestBody newCreateManifestRequestBody = null; + CreateManifestRequestBody? newCreateManifestRequestBody = null; int match = 0; var matchedTypes = new List(); try { - newCreateManifestRequestBody = new CreateManifestRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newCreateManifestRequestBody = new CreateManifestRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("CreateManifestByObjectRequestBody"); match++; @@ -219,12 +217,12 @@ public override CreateManifestRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into CreateManifestByObjectRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into CreateManifestByObjectRequestBody: {1}", jsonDoc, exception); } try { - newCreateManifestRequestBody = new CreateManifestRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newCreateManifestRequestBody = new CreateManifestRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("CreateManifestLabelIdsRequestBody"); match++; @@ -232,7 +230,7 @@ public override CreateManifestRequestBody Read(ref Utf8JsonReader reader, Type t catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into CreateManifestLabelIdsRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into CreateManifestLabelIdsRequestBody: {1}", jsonDoc, exception); } if (match == 0) diff --git a/ShipEngineSDK/Model/CreateManifestResponseBody.cs b/ShipEngineSDK/Model/CreateManifestResponseBody.cs index cebeae76..a8142e30 100644 --- a/ShipEngineSDK/Model/CreateManifestResponseBody.cs +++ b/ShipEngineSDK/Model/CreateManifestResponseBody.cs @@ -182,6 +182,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateManifestResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Manifests: ").Append(Manifests).Append("\n"); sb.Append(" ManifestRequests: ").Append(ManifestRequests).Append("\n"); sb.Append(" ManifestId: ").Append(ManifestId).Append("\n"); @@ -196,6 +197,7 @@ public override string ToString() sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); sb.Append(" RequestId: ").Append(RequestId).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs b/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs index e5c364cd..4cc0340e 100644 --- a/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs +++ b/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs @@ -85,11 +85,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreatePackageTypeRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" PackageId: ").Append(PackageId).Append("\n"); sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); sb.Append(" Description: ").Append(Description).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs b/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs index 10903c4b..a1953b4a 100644 --- a/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs +++ b/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs @@ -85,11 +85,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreatePackageTypeResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" PackageId: ").Append(PackageId).Append("\n"); sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); sb.Append(" Description: ").Append(Description).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs b/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs index fe82fe62..031539b6 100644 --- a/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs +++ b/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs @@ -76,12 +76,14 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateReturnLabelRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs index 29abb891..acc0703e 100644 --- a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs @@ -334,6 +334,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateReturnLabelResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" LabelId: ").Append(LabelId).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); @@ -372,6 +373,7 @@ public override string ToString() sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs b/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs index be8e0e11..f4c788d2 100644 --- a/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs +++ b/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs @@ -52,8 +52,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateShipmentResponseBodyFields {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Errors: ").Append(Errors).Append("\n"); sb.Append(" AddressValidation: ").Append(AddressValidation).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs b/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs index 1395787e..88a2711a 100644 --- a/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs +++ b/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs @@ -45,7 +45,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateShipmentsRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Shipments: ").Append(Shipments).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs b/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs index e50461ec..3e65a225 100644 --- a/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs +++ b/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs @@ -53,8 +53,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateShipmentsResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" HasErrors: ").Append(HasErrors).Append("\n"); sb.Append(" Shipments: ").Append(Shipments).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateTagResponseBody.cs b/ShipEngineSDK/Model/CreateTagResponseBody.cs index 434126da..fdd5ece3 100644 --- a/ShipEngineSDK/Model/CreateTagResponseBody.cs +++ b/ShipEngineSDK/Model/CreateTagResponseBody.cs @@ -48,7 +48,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateTagResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs b/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs index 36b347b5..d88f9697 100644 --- a/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs +++ b/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs @@ -90,12 +90,14 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateWarehouseRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" OriginAddress: ").Append(OriginAddress).Append("\n"); sb.Append(" ReturnAddress: ").Append(ReturnAddress).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs b/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs index 21c292db..a696df92 100644 --- a/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs +++ b/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs @@ -93,12 +93,14 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateWarehouseResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" OriginAddress: ").Append(OriginAddress).Append("\n"); sb.Append(" ReturnAddress: ").Append(ReturnAddress).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateWebhookRequestBody.cs b/ShipEngineSDK/Model/CreateWebhookRequestBody.cs index fe892be2..571c7bfe 100644 --- a/ShipEngineSDK/Model/CreateWebhookRequestBody.cs +++ b/ShipEngineSDK/Model/CreateWebhookRequestBody.cs @@ -63,9 +63,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateWebhookRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Event: ").Append(Event).Append("\n"); sb.Append(" Url: ").Append(Url).Append("\n"); sb.Append(" Headers: ").Append(Headers).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateWebhookResponseBody.cs b/ShipEngineSDK/Model/CreateWebhookResponseBody.cs index 77fb2977..e938e549 100644 --- a/ShipEngineSDK/Model/CreateWebhookResponseBody.cs +++ b/ShipEngineSDK/Model/CreateWebhookResponseBody.cs @@ -74,10 +74,12 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CreateWebhookResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" WebhookId: ").Append(WebhookId).Append("\n"); sb.Append(" Url: ").Append(Url).Append("\n"); sb.Append(" Event: ").Append(Event).Append("\n"); sb.Append(" Headers: ").Append(Headers).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CustomsItem.cs b/ShipEngineSDK/Model/CustomsItem.cs index 433e90a0..a9a52eb3 100644 --- a/ShipEngineSDK/Model/CustomsItem.cs +++ b/ShipEngineSDK/Model/CustomsItem.cs @@ -123,6 +123,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class CustomsItem {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CustomsItemId: ").Append(CustomsItemId).Append("\n"); sb.Append(" Description: ").Append(Description).Append("\n"); sb.Append(" Quantity: ").Append(Quantity).Append("\n"); @@ -134,6 +135,7 @@ public override string ToString() sb.Append(" UnitOfMeasure: ").Append(UnitOfMeasure).Append("\n"); sb.Append(" Sku: ").Append(Sku).Append("\n"); sb.Append(" SkuDescription: ").Append(SkuDescription).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/DangerousAmount.cs b/ShipEngineSDK/Model/DangerousAmount.cs index 6ae8fba1..ecfeb166 100644 --- a/ShipEngineSDK/Model/DangerousAmount.cs +++ b/ShipEngineSDK/Model/DangerousAmount.cs @@ -51,8 +51,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class DangerousAmount {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Amount: ").Append(Amount).Append("\n"); sb.Append(" Unit: ").Append(Unit).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/DangerousGoods.cs b/ShipEngineSDK/Model/DangerousGoods.cs index 4f5cb43e..041d2f5d 100644 --- a/ShipEngineSDK/Model/DangerousGoods.cs +++ b/ShipEngineSDK/Model/DangerousGoods.cs @@ -168,6 +168,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class DangerousGoods {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" IdNumber: ").Append(IdNumber).Append("\n"); sb.Append(" ShippingName: ").Append(ShippingName).Append("\n"); sb.Append(" TechnicalName: ").Append(TechnicalName).Append("\n"); @@ -187,6 +188,7 @@ public override string ToString() sb.Append(" ReportableQuantity: ").Append(ReportableQuantity).Append("\n"); sb.Append(" TunnelCode: ").Append(TunnelCode).Append("\n"); sb.Append(" AdditionalDescription: ").Append(AdditionalDescription).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/DefaultLabelLayout.cs b/ShipEngineSDK/Model/DefaultLabelLayout.cs index 890d871f..c980735d 100644 --- a/ShipEngineSDK/Model/DefaultLabelLayout.cs +++ b/ShipEngineSDK/Model/DefaultLabelLayout.cs @@ -31,6 +31,9 @@ public class DefaultLabelLayout { private string _value; + /// + /// Create a new instance of DefaultLabelLayout with a predefined value. + /// internal DefaultLabelLayout() { _value = "4x6"; diff --git a/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs b/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs index e9190dd9..10c9ce36 100644 --- a/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs +++ b/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs @@ -67,9 +67,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class DeletePickupByIdResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" RequestId: ").Append(RequestId).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); sb.Append(" PickupId: ").Append(PickupId).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs b/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs index 13cb20e2..a3214a6f 100644 --- a/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs +++ b/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs @@ -48,7 +48,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class DeleteScheduledPickupResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" PickupId: ").Append(PickupId).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/DeliveryConfirmation.cs b/ShipEngineSDK/Model/DeliveryConfirmation.cs index fdeee032..e7a0fbb1 100644 --- a/ShipEngineSDK/Model/DeliveryConfirmation.cs +++ b/ShipEngineSDK/Model/DeliveryConfirmation.cs @@ -31,6 +31,9 @@ public class DeliveryConfirmation { private string _value; + /// + /// Create a new instance of DeliveryConfirmation with a predefined value. + /// internal DeliveryConfirmation() { _value = "none"; diff --git a/ShipEngineSDK/Model/DeprecatedManifest.cs b/ShipEngineSDK/Model/DeprecatedManifest.cs index d0cbca3f..80ef19d5 100644 --- a/ShipEngineSDK/Model/DeprecatedManifest.cs +++ b/ShipEngineSDK/Model/DeprecatedManifest.cs @@ -140,6 +140,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class DeprecatedManifest {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ManifestId: ").Append(ManifestId).Append("\n"); sb.Append(" FormId: ").Append(FormId).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); @@ -150,6 +151,7 @@ public override string ToString() sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ManifestDownload: ").Append(ManifestDownload).Append("\n"); sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/DhlExpressAccountSettings.cs b/ShipEngineSDK/Model/DhlExpressAccountSettings.cs index 46b44b6b..74cf1713 100644 --- a/ShipEngineSDK/Model/DhlExpressAccountSettings.cs +++ b/ShipEngineSDK/Model/DhlExpressAccountSettings.cs @@ -58,9 +58,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class DhlExpressAccountSettings {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" ShouldHideAccountNumberOnArchiveDoc: ").Append(ShouldHideAccountNumberOnArchiveDoc).Append("\n"); sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs b/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs index cf01ffcb..2568c425 100644 --- a/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs @@ -58,9 +58,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class DhlExpressSettingsResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" ShouldHideAccountNumberOnArchiveDoc: ").Append(ShouldHideAccountNumberOnArchiveDoc).Append("\n"); sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/DimensionUnit.cs b/ShipEngineSDK/Model/DimensionUnit.cs index ab64dac7..0621116c 100644 --- a/ShipEngineSDK/Model/DimensionUnit.cs +++ b/ShipEngineSDK/Model/DimensionUnit.cs @@ -31,6 +31,9 @@ public class DimensionUnit { private string _value; + /// + /// Create a new instance of DimensionUnit with a predefined value. + /// internal DimensionUnit() { _value = "inch"; diff --git a/ShipEngineSDK/Model/Dimensions.cs b/ShipEngineSDK/Model/Dimensions.cs index 976b74c2..ca0fe759 100644 --- a/ShipEngineSDK/Model/Dimensions.cs +++ b/ShipEngineSDK/Model/Dimensions.cs @@ -69,10 +69,12 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class Dimensions {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Unit: ").Append(Unit).Append("\n"); sb.Append(" Length: ").Append(Length).Append("\n"); sb.Append(" Width: ").Append(Width).Append("\n"); sb.Append(" Height: ").Append(Height).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/DisplayScheme.cs b/ShipEngineSDK/Model/DisplayScheme.cs index 1078d16c..03430cdd 100644 --- a/ShipEngineSDK/Model/DisplayScheme.cs +++ b/ShipEngineSDK/Model/DisplayScheme.cs @@ -31,6 +31,9 @@ public class DisplayScheme { private string _value; + /// + /// Create a new instance of DisplayScheme with a predefined value. + /// internal DisplayScheme() { _value = "label"; diff --git a/ShipEngineSDK/Model/Error.cs b/ShipEngineSDK/Model/Error.cs index c1906b9d..cde7aa03 100644 --- a/ShipEngineSDK/Model/Error.cs +++ b/ShipEngineSDK/Model/Error.cs @@ -72,10 +72,12 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class Error {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ErrorSource: ").Append(ErrorSource).Append("\n"); sb.Append(" ErrorType: ").Append(ErrorType).Append("\n"); sb.Append(" ErrorCode: ").Append(ErrorCode).Append("\n"); sb.Append(" Message: ").Append(Message).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ErrorCode.cs b/ShipEngineSDK/Model/ErrorCode.cs index 03a26c55..11eb6b7d 100644 --- a/ShipEngineSDK/Model/ErrorCode.cs +++ b/ShipEngineSDK/Model/ErrorCode.cs @@ -31,6 +31,9 @@ public class ErrorCode { private string _value; + /// + /// Create a new instance of ErrorCode with a predefined value. + /// internal ErrorCode() { _value = "auto_fund_not_supported"; diff --git a/ShipEngineSDK/Model/ErrorResponseBody.cs b/ShipEngineSDK/Model/ErrorResponseBody.cs index b977ffaa..0cd5d0c9 100644 --- a/ShipEngineSDK/Model/ErrorResponseBody.cs +++ b/ShipEngineSDK/Model/ErrorResponseBody.cs @@ -56,8 +56,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ErrorResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" RequestId: ").Append(RequestId).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ErrorSource.cs b/ShipEngineSDK/Model/ErrorSource.cs index c73e178b..bc611c3a 100644 --- a/ShipEngineSDK/Model/ErrorSource.cs +++ b/ShipEngineSDK/Model/ErrorSource.cs @@ -31,6 +31,9 @@ public class ErrorSource { private string _value; + /// + /// Create a new instance of ErrorSource with a predefined value. + /// internal ErrorSource() { _value = "carrier"; diff --git a/ShipEngineSDK/Model/ErrorType.cs b/ShipEngineSDK/Model/ErrorType.cs index c9f635db..247c0db7 100644 --- a/ShipEngineSDK/Model/ErrorType.cs +++ b/ShipEngineSDK/Model/ErrorType.cs @@ -31,6 +31,9 @@ public class ErrorType { private string _value; + /// + /// Create a new instance of ErrorType with a predefined value. + /// internal ErrorType() { _value = "account_status"; diff --git a/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs b/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs index 5e9bea3f..f91f1a36 100644 --- a/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs +++ b/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs @@ -56,8 +56,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ErrorWithLabelIdResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" RequestId: ").Append(RequestId).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/EstimateRatesRequestBody.cs b/ShipEngineSDK/Model/EstimateRatesRequestBody.cs index b43e0d46..ca9bbd89 100644 --- a/ShipEngineSDK/Model/EstimateRatesRequestBody.cs +++ b/ShipEngineSDK/Model/EstimateRatesRequestBody.cs @@ -161,11 +161,10 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// with the class /// /// An instance of RateEstimateByCarrierId. - public EstimateRatesRequestBody(RateEstimateByCarrierId actualInstance) + public EstimateRatesRequestBody(RateEstimateByCarrierId actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -173,11 +172,10 @@ public EstimateRatesRequestBody(RateEstimateByCarrierId actualInstance) /// with the class /// /// An instance of RateEstimateByCarrierIds. - public EstimateRatesRequestBody(RateEstimateByCarrierIds actualInstance) + public EstimateRatesRequestBody(RateEstimateByCarrierIds actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } @@ -272,9 +270,9 @@ public override string ToJson() /// public class EstimateRatesRequestBodyJsonConverter : JsonConverter { - private static HashSet OneOfTypes = [typeof(RateEstimateByCarrierId), typeof(RateEstimateByCarrierIds)]; - private static HashSet MandatoryFields = ["FromCityLocality", "FromCountryCode", "FromPostalCode", "FromStateProvince", "ShipDate", "ToCityLocality", "ToCountryCode", "ToPostalCode", "ToStateProvince", "Weight"]; - private static JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) + private static readonly HashSet OneOfTypes = [typeof(RateEstimateByCarrierId), typeof(RateEstimateByCarrierIds)]; + private static readonly HashSet MandatoryFields = ["FromCityLocality", "FromCountryCode", "FromPostalCode", "FromStateProvince", "ShipDate", "ToCityLocality", "ToCountryCode", "ToPostalCode", "ToStateProvince", "Weight"]; + private static readonly JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) { TypeInfoResolver = new DefaultJsonTypeInfoResolver { @@ -360,7 +358,7 @@ public override void Write(Utf8JsonWriter writer, EstimateRatesRequestBody value /// Object type to convert /// Serializer options /// The object converted from the JSON string - public override EstimateRatesRequestBody Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override EstimateRatesRequestBody? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { if (reader.TokenType == JsonTokenType.Null) { @@ -368,14 +366,14 @@ public override EstimateRatesRequestBody Read(ref Utf8JsonReader reader, Type ty } var jsonDoc = JsonDocument.ParseValue(ref reader); - EstimateRatesRequestBody newEstimateRatesRequestBody = null; + EstimateRatesRequestBody? newEstimateRatesRequestBody = null; int match = 0; var matchedTypes = new List(); try { - newEstimateRatesRequestBody = new EstimateRatesRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newEstimateRatesRequestBody = new EstimateRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("RateEstimateByCarrierId"); match++; @@ -383,12 +381,12 @@ public override EstimateRatesRequestBody Read(ref Utf8JsonReader reader, Type ty catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into RateEstimateByCarrierId: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into RateEstimateByCarrierId: {1}", jsonDoc, exception); } try { - newEstimateRatesRequestBody = new EstimateRatesRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newEstimateRatesRequestBody = new EstimateRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("RateEstimateByCarrierIds"); match++; @@ -396,7 +394,7 @@ public override EstimateRatesRequestBody Read(ref Utf8JsonReader reader, Type ty catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into RateEstimateByCarrierIds: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into RateEstimateByCarrierIds: {1}", jsonDoc, exception); } if (match == 0) @@ -409,19 +407,19 @@ public override EstimateRatesRequestBody Read(ref Utf8JsonReader reader, Type ty throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); } - newEstimateRatesRequestBody.FromCountryCode = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("from_country_code"), DeserializingOptions); - newEstimateRatesRequestBody.FromPostalCode = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("from_postal_code"), DeserializingOptions); - newEstimateRatesRequestBody.FromCityLocality = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("from_city_locality"), DeserializingOptions); - newEstimateRatesRequestBody.FromStateProvince = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("from_state_province"), DeserializingOptions); - newEstimateRatesRequestBody.ToCountryCode = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("to_country_code"), DeserializingOptions); - newEstimateRatesRequestBody.ToPostalCode = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("to_postal_code"), DeserializingOptions); - newEstimateRatesRequestBody.ToCityLocality = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("to_city_locality"), DeserializingOptions); - newEstimateRatesRequestBody.ToStateProvince = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("to_state_province"), DeserializingOptions); - newEstimateRatesRequestBody.Weight = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("weight"), DeserializingOptions); - newEstimateRatesRequestBody.Dimensions = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("dimensions"), DeserializingOptions); - newEstimateRatesRequestBody.Confirmation = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("confirmation"), DeserializingOptions); - newEstimateRatesRequestBody.AddressResidentialIndicator = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("address_residential_indicator"), DeserializingOptions); - newEstimateRatesRequestBody.ShipDate = JsonSerializer.Deserialize(jsonDoc.RootElement.GetProperty("ship_date"), DeserializingOptions); + newEstimateRatesRequestBody!.FromCountryCode = jsonDoc.RootElement.GetProperty("from_country_code").Deserialize(DeserializingOptions)!; + newEstimateRatesRequestBody!.FromPostalCode = jsonDoc.RootElement.GetProperty("from_postal_code").Deserialize(DeserializingOptions)!; + newEstimateRatesRequestBody!.FromCityLocality = jsonDoc.RootElement.GetProperty("from_city_locality").Deserialize(DeserializingOptions)!; + newEstimateRatesRequestBody!.FromStateProvince = jsonDoc.RootElement.GetProperty("from_state_province").Deserialize(DeserializingOptions)!; + newEstimateRatesRequestBody!.ToCountryCode = jsonDoc.RootElement.GetProperty("to_country_code").Deserialize(DeserializingOptions)!; + newEstimateRatesRequestBody!.ToPostalCode = jsonDoc.RootElement.GetProperty("to_postal_code").Deserialize(DeserializingOptions)!; + newEstimateRatesRequestBody!.ToCityLocality = jsonDoc.RootElement.GetProperty("to_city_locality").Deserialize(DeserializingOptions)!; + newEstimateRatesRequestBody!.ToStateProvince = jsonDoc.RootElement.GetProperty("to_state_province").Deserialize(DeserializingOptions)!; + newEstimateRatesRequestBody!.Weight = jsonDoc.RootElement.GetProperty("weight").Deserialize(DeserializingOptions)!; + newEstimateRatesRequestBody!.Dimensions = jsonDoc.RootElement.GetProperty("dimensions").Deserialize(DeserializingOptions)!; + newEstimateRatesRequestBody!.Confirmation = jsonDoc.RootElement.GetProperty("confirmation").Deserialize(DeserializingOptions)!; + newEstimateRatesRequestBody!.AddressResidentialIndicator = jsonDoc.RootElement.GetProperty("address_residential_indicator").Deserialize(DeserializingOptions)!; + newEstimateRatesRequestBody!.ShipDate = jsonDoc.RootElement.GetProperty("ship_date").Deserialize(DeserializingOptions)!; // deserialization is considered successful at this point if no exception has been thrown. return newEstimateRatesRequestBody; diff --git a/ShipEngineSDK/Model/FedexAccountSettings.cs b/ShipEngineSDK/Model/FedexAccountSettings.cs index 1087fbfc..fecfd972 100644 --- a/ShipEngineSDK/Model/FedexAccountSettings.cs +++ b/ShipEngineSDK/Model/FedexAccountSettings.cs @@ -77,6 +77,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class FedexAccountSettings {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" PickupType: ").Append(PickupType).Append("\n"); sb.Append(" SmartPostHub: ").Append(SmartPostHub).Append("\n"); @@ -84,6 +85,7 @@ public override string ToString() sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); sb.Append(" SignatureImage: ").Append(SignatureImage).Append("\n"); sb.Append(" LetterheadImage: ").Append(LetterheadImage).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs b/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs index b8a0eb5a..45cb0d22 100644 --- a/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs @@ -77,6 +77,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class FedexAccountSettingsRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" PickupType: ").Append(PickupType).Append("\n"); sb.Append(" SmartPostHub: ").Append(SmartPostHub).Append("\n"); @@ -84,6 +85,7 @@ public override string ToString() sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); sb.Append(" SignatureImage: ").Append(SignatureImage).Append("\n"); sb.Append(" LetterheadImage: ").Append(LetterheadImage).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/FedexPickupType.cs b/ShipEngineSDK/Model/FedexPickupType.cs index 2f19c3a5..a1670140 100644 --- a/ShipEngineSDK/Model/FedexPickupType.cs +++ b/ShipEngineSDK/Model/FedexPickupType.cs @@ -31,6 +31,9 @@ public class FedexPickupType { private string _value; + /// + /// Create a new instance of FedexPickupType with a predefined value. + /// internal FedexPickupType() { _value = "none"; diff --git a/ShipEngineSDK/Model/FedexSettingsResponseBody.cs b/ShipEngineSDK/Model/FedexSettingsResponseBody.cs index 299427b2..da788999 100644 --- a/ShipEngineSDK/Model/FedexSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/FedexSettingsResponseBody.cs @@ -77,6 +77,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class FedexSettingsResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" PickupType: ").Append(PickupType).Append("\n"); sb.Append(" SmartPostHub: ").Append(SmartPostHub).Append("\n"); @@ -84,6 +85,7 @@ public override string ToString() sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); sb.Append(" SignatureImage: ").Append(SignatureImage).Append("\n"); sb.Append(" LetterheadImage: ").Append(LetterheadImage).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs b/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs index 969fbdea..6eddc0ad 100644 --- a/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs +++ b/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs @@ -34,16 +34,27 @@ public partial class GetAccountSettingsImagesResponseBody [JsonConverter(typeof(ImageContentTypeEnumJsonConverter))] public class ImageContentTypeEnum { - private string _value; + private readonly string _value; + /// + /// Create a new instance of ImageContentTypeEnum with a predefined value. + /// internal ImageContentTypeEnum() { _value = "image/png"; } + /// + /// Create a new instance of ImageContentTypeEnum with a custom value. + /// + /// The value of the ImageContentTypeEnum + /// + /// 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 ImageContentTypeEnum(string value) { - + _value = value; } /// @@ -149,6 +160,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetAccountSettingsImagesResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); @@ -156,6 +168,7 @@ public override string ToString() sb.Append(" ImageData: ").Append(ImageData).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetAccountSettingsResponseBody.cs b/ShipEngineSDK/Model/GetAccountSettingsResponseBody.cs index 61ef35bf..d646b5d2 100644 --- a/ShipEngineSDK/Model/GetAccountSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/GetAccountSettingsResponseBody.cs @@ -42,7 +42,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetAccountSettingsResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" DefaultLabelLayout: ").Append(DefaultLabelLayout).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs b/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs index e60ece45..c8bc28fa 100644 --- a/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs @@ -233,6 +233,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetBatchByExternalIdResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); sb.Append(" BatchId: ").Append(BatchId).Append("\n"); @@ -254,6 +255,7 @@ public override string ToString() sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs b/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs index 11ba977a..43f66802 100644 --- a/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs @@ -233,6 +233,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetBatchByIdResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); sb.Append(" BatchId: ").Append(BatchId).Append("\n"); @@ -254,6 +255,7 @@ public override string ToString() sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs b/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs index 3c26922d..0b7faca8 100644 --- a/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs @@ -153,6 +153,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetCarrierByIdResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); @@ -167,6 +168,7 @@ public override string ToString() sb.Append(" Services: ").Append(Services).Append("\n"); sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" Options: ").Append(Options).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs b/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs index 90fd80f2..6ddb66d7 100644 --- a/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs @@ -44,7 +44,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetCarrierOptionsResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Options: ").Append(Options).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs b/ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs index f53a5a7e..25f6c3d4 100644 --- a/ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs @@ -36,11 +36,10 @@ public partial class GetCarrierSettingsResponseBody : AbstractOpenAPISchema /// with the class /// /// An instance of DhlExpressSettingsResponseBody. - public GetCarrierSettingsResponseBody(DhlExpressSettingsResponseBody actualInstance) + public GetCarrierSettingsResponseBody(DhlExpressSettingsResponseBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -48,11 +47,10 @@ public GetCarrierSettingsResponseBody(DhlExpressSettingsResponseBody actualInsta /// with the class /// /// An instance of FedexSettingsResponseBody. - public GetCarrierSettingsResponseBody(FedexSettingsResponseBody actualInstance) + public GetCarrierSettingsResponseBody(FedexSettingsResponseBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -60,11 +58,10 @@ public GetCarrierSettingsResponseBody(FedexSettingsResponseBody actualInstance) /// with the class /// /// An instance of UpsSettingsResponseBody. - public GetCarrierSettingsResponseBody(UpsSettingsResponseBody actualInstance) + public GetCarrierSettingsResponseBody(UpsSettingsResponseBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } @@ -160,9 +157,9 @@ public override string ToJson() /// public class GetCarrierSettingsResponseBodyJsonConverter : JsonConverter { - private static HashSet OneOfTypes = [typeof(DhlExpressSettingsResponseBody), typeof(FedexSettingsResponseBody), typeof(UpsSettingsResponseBody)]; - private static HashSet MandatoryFields = []; - private static JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) + private static readonly HashSet OneOfTypes = [typeof(DhlExpressSettingsResponseBody), typeof(FedexSettingsResponseBody), typeof(UpsSettingsResponseBody)]; + private static readonly HashSet MandatoryFields = []; + private static readonly JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) { TypeInfoResolver = new DefaultJsonTypeInfoResolver { @@ -222,7 +219,7 @@ public override void Write(Utf8JsonWriter writer, GetCarrierSettingsResponseBody /// Object type to convert /// Serializer options /// The object converted from the JSON string - public override GetCarrierSettingsResponseBody Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override GetCarrierSettingsResponseBody? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { if (reader.TokenType == JsonTokenType.Null) { @@ -230,14 +227,14 @@ public override GetCarrierSettingsResponseBody Read(ref Utf8JsonReader reader, T } var jsonDoc = JsonDocument.ParseValue(ref reader); - GetCarrierSettingsResponseBody newGetCarrierSettingsResponseBody = null; + GetCarrierSettingsResponseBody? newGetCarrierSettingsResponseBody = null; int match = 0; var matchedTypes = new List(); try { - newGetCarrierSettingsResponseBody = new GetCarrierSettingsResponseBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newGetCarrierSettingsResponseBody = new GetCarrierSettingsResponseBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("DhlExpressSettingsResponseBody"); match++; @@ -245,12 +242,12 @@ public override GetCarrierSettingsResponseBody Read(ref Utf8JsonReader reader, T catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into DhlExpressSettingsResponseBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into DhlExpressSettingsResponseBody: {1}", jsonDoc, exception); } try { - newGetCarrierSettingsResponseBody = new GetCarrierSettingsResponseBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newGetCarrierSettingsResponseBody = new GetCarrierSettingsResponseBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("FedexSettingsResponseBody"); match++; @@ -258,12 +255,12 @@ public override GetCarrierSettingsResponseBody Read(ref Utf8JsonReader reader, T catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into FedexSettingsResponseBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into FedexSettingsResponseBody: {1}", jsonDoc, exception); } try { - newGetCarrierSettingsResponseBody = new GetCarrierSettingsResponseBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newGetCarrierSettingsResponseBody = new GetCarrierSettingsResponseBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("UpsSettingsResponseBody"); match++; @@ -271,7 +268,7 @@ public override GetCarrierSettingsResponseBody Read(ref Utf8JsonReader reader, T catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into UpsSettingsResponseBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into UpsSettingsResponseBody: {1}", jsonDoc, exception); } if (match == 0) diff --git a/ShipEngineSDK/Model/GetCarriersResponseBody.cs b/ShipEngineSDK/Model/GetCarriersResponseBody.cs index 10439965..5cd42046 100644 --- a/ShipEngineSDK/Model/GetCarriersResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarriersResponseBody.cs @@ -64,9 +64,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetCarriersResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Carriers: ").Append(Carriers).Append("\n"); sb.Append(" RequestId: ").Append(RequestId).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs b/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs index d8de398f..0bea8563 100644 --- a/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs +++ b/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs @@ -53,8 +53,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetInsuranceBalanceResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Currency: ").Append(Currency).Append("\n"); sb.Append(" Amount: ").Append(Amount).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs index 202c4710..eedddfde 100644 --- a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs @@ -334,6 +334,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetLabelByExternalShipmentIdResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" LabelId: ").Append(LabelId).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); @@ -372,6 +373,7 @@ public override string ToString() sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs index 4f333348..cd61a72f 100644 --- a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs @@ -334,6 +334,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetLabelByIdResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" LabelId: ").Append(LabelId).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); @@ -372,6 +373,7 @@ public override string ToString() sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs b/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs index a56191ff..c869ded8 100644 --- a/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs @@ -140,6 +140,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetManifestByIdResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ManifestId: ").Append(ManifestId).Append("\n"); sb.Append(" FormId: ").Append(FormId).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); @@ -150,6 +151,7 @@ public override string ToString() sb.Append(" SubmissionId: ").Append(SubmissionId).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ManifestDownload: ").Append(ManifestDownload).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs b/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs index a5028ae7..cd911b63 100644 --- a/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs @@ -85,11 +85,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetPackageTypeByIdResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" PackageId: ").Append(PackageId).Append("\n"); sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); sb.Append(" Description: ").Append(Description).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs b/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs index 8af4f052..3ab41fc4 100644 --- a/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs @@ -164,6 +164,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetPickupByIdResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" PickupId: ").Append(PickupId).Append("\n"); sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); @@ -178,6 +179,7 @@ public override string ToString() sb.Append(" PickupWindows: ").Append(PickupWindows).Append("\n"); sb.Append(" RequestId: ").Append(RequestId).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetPickupsResponseBody.cs b/ShipEngineSDK/Model/GetPickupsResponseBody.cs index fee2f236..7ec6e605 100644 --- a/ShipEngineSDK/Model/GetPickupsResponseBody.cs +++ b/ShipEngineSDK/Model/GetPickupsResponseBody.cs @@ -105,6 +105,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetPickupsResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Pickups: ").Append(Pickups).Append("\n"); sb.Append(" Total: ").Append(Total).Append("\n"); sb.Append(" Page: ").Append(Page).Append("\n"); @@ -112,6 +113,7 @@ public override string ToString() sb.Append(" Links: ").Append(Links).Append("\n"); sb.Append(" RequestId: ").Append(RequestId).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetRateByIdResponseBody.cs b/ShipEngineSDK/Model/GetRateByIdResponseBody.cs index adeec0ea..4cb10944 100644 --- a/ShipEngineSDK/Model/GetRateByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetRateByIdResponseBody.cs @@ -257,6 +257,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetRateByIdResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" RateId: ").Append(RateId).Append("\n"); sb.Append(" RateType: ").Append(RateType).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); @@ -283,6 +284,7 @@ public override string ToString() sb.Append(" ValidationStatus: ").Append(ValidationStatus).Append("\n"); sb.Append(" WarningMessages: ").Append(WarningMessages).Append("\n"); sb.Append(" ErrorMessages: ").Append(ErrorMessages).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs b/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs index ac1547d4..21cf3ee2 100644 --- a/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs @@ -43,7 +43,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetServicePointByIdResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ServicePoint: ").Append(ServicePoint).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs b/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs index 057d8211..24a692e3 100644 --- a/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs +++ b/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs @@ -33,16 +33,27 @@ public partial class GetServicePointByIdResponseBodyServicePoint [JsonConverter(typeof(FeaturesEnumJsonConverter))] public class FeaturesEnum { - private string _value; + private readonly string _value; + /// + /// Create a new instance of FeaturesEnum with a predefined value. + /// internal FeaturesEnum() { _value = "drop_off_point"; } + /// + /// Create a new instance of FeaturesEnum with a custom value. + /// + /// The value of the FeaturesEnum + /// + /// 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 FeaturesEnum(string value) { - + _value = value; } /// @@ -97,16 +108,27 @@ public override bool CanConvert(Type typeToConvert) => [JsonConverter(typeof(TypeEnumJsonConverter))] public class TypeEnum { - private string _value; + private readonly string _value; + /// + /// Create a new instance of TypeEnum with a predefined value. + /// internal TypeEnum() { _value = "pudo"; } + /// + /// Create a new instance of TypeEnum with a custom value. + /// + /// The value of the TypeEnum + /// + /// 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 TypeEnum(string value) { - + _value = value; } /// @@ -281,6 +303,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetServicePointByIdResponseBodyServicePoint {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" ServiceCodes: ").Append(ServiceCodes).Append("\n"); sb.Append(" ServicePointId: ").Append(ServicePointId).Append("\n"); @@ -296,6 +319,7 @@ public override string ToString() sb.Append(" HoursOfOperation: ").Append(HoursOfOperation).Append("\n"); sb.Append(" Features: ").Append(Features).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetServicePointsRequest.cs b/ShipEngineSDK/Model/GetServicePointsRequest.cs index 339e5b89..44c1d279 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequest.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequest.cs @@ -36,11 +36,10 @@ public partial class GetServicePointsRequest : AbstractOpenAPISchema /// with the class /// /// An instance of GetServicePointsRequestBody. - public GetServicePointsRequest(GetServicePointsRequestBody actualInstance) + public GetServicePointsRequest(GetServicePointsRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } @@ -108,9 +107,9 @@ public override string ToJson() /// public class GetServicePointsRequestJsonConverter : JsonConverter { - private static HashSet OneOfTypes = [typeof(GetServicePointsRequestBody)]; - private static HashSet MandatoryFields = ["Providers"]; - private static JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) + private static readonly HashSet OneOfTypes = [typeof(GetServicePointsRequestBody)]; + private static readonly HashSet MandatoryFields = ["Providers"]; + private static readonly JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) { TypeInfoResolver = new DefaultJsonTypeInfoResolver { @@ -170,7 +169,7 @@ public override void Write(Utf8JsonWriter writer, GetServicePointsRequest value, /// Object type to convert /// Serializer options /// The object converted from the JSON string - public override GetServicePointsRequest Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override GetServicePointsRequest? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { if (reader.TokenType == JsonTokenType.Null) { @@ -178,14 +177,14 @@ public override GetServicePointsRequest Read(ref Utf8JsonReader reader, Type typ } var jsonDoc = JsonDocument.ParseValue(ref reader); - GetServicePointsRequest newGetServicePointsRequest = null; + GetServicePointsRequest? newGetServicePointsRequest = null; int match = 0; var matchedTypes = new List(); try { - newGetServicePointsRequest = new GetServicePointsRequest(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newGetServicePointsRequest = new GetServicePointsRequest(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("GetServicePointsRequestBody"); match++; @@ -193,7 +192,7 @@ public override GetServicePointsRequest Read(ref Utf8JsonReader reader, Type typ catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into GetServicePointsRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into GetServicePointsRequestBody: {1}", jsonDoc, exception); } if (match == 0) diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBody.cs b/ShipEngineSDK/Model/GetServicePointsRequestBody.cs index 08cc37c3..8186de8b 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBody.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBody.cs @@ -107,6 +107,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetServicePointsRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AddressQuery: ").Append(AddressQuery).Append("\n"); sb.Append(" Address: ").Append(Address).Append("\n"); sb.Append(" Providers: ").Append(Providers).Append("\n"); @@ -115,6 +116,7 @@ public override string ToString() sb.Append(" Radius: ").Append(Radius).Append("\n"); sb.Append(" MaxResults: ").Append(MaxResults).Append("\n"); sb.Append(" Shipment: ").Append(Shipment).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs index dab65357..2233c6dd 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs @@ -94,6 +94,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetServicePointsRequestBodyAddress {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); @@ -101,6 +102,7 @@ public override string ToString() sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs index 2ba26e2c..2d6cbc8e 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs @@ -53,8 +53,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetServicePointsRequestBodyProvidersInner {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs index b042e698..a515ffc5 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs @@ -44,7 +44,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetServicePointsRequestBodyShipment {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs b/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs index 879513de..6b7f5982 100644 --- a/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs @@ -271,6 +271,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetShipmentByExternalIdResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); @@ -298,6 +299,7 @@ public override string ToString() sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs b/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs index 2a7f1381..e9179ce2 100644 --- a/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs @@ -271,6 +271,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetShipmentByIdResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); @@ -298,6 +299,7 @@ public override string ToString() sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs index 722c97ff..2558c711 100644 --- a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs @@ -173,6 +173,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetTrackingLogFromLabelResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); sb.Append(" StatusCode: ").Append(StatusCode).Append("\n"); @@ -187,6 +188,7 @@ public override string ToString() sb.Append(" ActualDeliveryDate: ").Append(ActualDeliveryDate).Append("\n"); sb.Append(" ExceptionDescription: ").Append(ExceptionDescription).Append("\n"); sb.Append(" Events: ").Append(Events).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs index ad09d39b..8d8900ba 100644 --- a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs @@ -177,6 +177,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetTrackingLogResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); sb.Append(" StatusCode: ").Append(StatusCode).Append("\n"); @@ -191,6 +192,7 @@ public override string ToString() sb.Append(" ActualDeliveryDate: ").Append(ActualDeliveryDate).Append("\n"); sb.Append(" ExceptionDescription: ").Append(ExceptionDescription).Append("\n"); sb.Append(" Events: ").Append(Events).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs b/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs index ebac785d..9396a6e2 100644 --- a/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs @@ -93,12 +93,14 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetWarehouseByIdResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" OriginAddress: ").Append(OriginAddress).Append("\n"); sb.Append(" ReturnAddress: ").Append(ReturnAddress).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs b/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs index 0f81be67..924ae7a4 100644 --- a/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs @@ -74,10 +74,12 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class GetWebhookByIdResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" WebhookId: ").Append(WebhookId).Append("\n"); sb.Append(" Url: ").Append(Url).Append("\n"); sb.Append(" Event: ").Append(Event).Append("\n"); sb.Append(" Headers: ").Append(Headers).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/IdentifierType.cs b/ShipEngineSDK/Model/IdentifierType.cs index 51a2405a..112680da 100644 --- a/ShipEngineSDK/Model/IdentifierType.cs +++ b/ShipEngineSDK/Model/IdentifierType.cs @@ -31,6 +31,9 @@ public class IdentifierType { private string _value; + /// + /// Create a new instance of IdentifierType with a predefined value. + /// internal IdentifierType() { _value = "vat"; diff --git a/ShipEngineSDK/Model/ImporterOfRecords.cs b/ShipEngineSDK/Model/ImporterOfRecords.cs index 59826ed8..6b6ff91b 100644 --- a/ShipEngineSDK/Model/ImporterOfRecords.cs +++ b/ShipEngineSDK/Model/ImporterOfRecords.cs @@ -152,6 +152,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ImporterOfRecords {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" Phone: ").Append(Phone).Append("\n"); sb.Append(" Email: ").Append(Email).Append("\n"); @@ -163,6 +164,7 @@ public override string ToString() sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/InsuranceProvider.cs b/ShipEngineSDK/Model/InsuranceProvider.cs index 1a86a3c9..8216afe7 100644 --- a/ShipEngineSDK/Model/InsuranceProvider.cs +++ b/ShipEngineSDK/Model/InsuranceProvider.cs @@ -31,6 +31,9 @@ public class InsuranceProvider { private string _value; + /// + /// Create a new instance of InsuranceProvider with a predefined value. + /// internal InsuranceProvider() { _value = "none"; diff --git a/ShipEngineSDK/Model/InternationalShipmentOptions.cs b/ShipEngineSDK/Model/InternationalShipmentOptions.cs index b5693447..a737b721 100644 --- a/ShipEngineSDK/Model/InternationalShipmentOptions.cs +++ b/ShipEngineSDK/Model/InternationalShipmentOptions.cs @@ -95,6 +95,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class InternationalShipmentOptions {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Contents: ").Append(Contents).Append("\n"); sb.Append(" ContentsExplanation: ").Append(ContentsExplanation).Append("\n"); sb.Append(" NonDelivery: ").Append(NonDelivery).Append("\n"); @@ -103,6 +104,7 @@ public override string ToString() sb.Append(" InvoiceAdditionalDetails: ").Append(InvoiceAdditionalDetails).Append("\n"); sb.Append(" ImporterOfRecord: ").Append(ImporterOfRecord).Append("\n"); sb.Append(" CustomsItems: ").Append(CustomsItems).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs b/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs index 8a28d057..fca0610c 100644 --- a/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs +++ b/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs @@ -72,11 +72,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class InvoiceAdditionalDetails {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" FreightCharge: ").Append(FreightCharge).Append("\n"); sb.Append(" InsuranceCharge: ").Append(InsuranceCharge).Append("\n"); sb.Append(" Discount: ").Append(Discount).Append("\n"); sb.Append(" OtherCharge: ").Append(OtherCharge).Append("\n"); sb.Append(" OtherChargeDescription: ").Append(OtherChargeDescription).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/Label.cs b/ShipEngineSDK/Model/Label.cs index b4c29d3b..b2b58e32 100644 --- a/ShipEngineSDK/Model/Label.cs +++ b/ShipEngineSDK/Model/Label.cs @@ -334,6 +334,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class Label {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" LabelId: ").Append(LabelId).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); @@ -372,6 +373,7 @@ public override string ToString() sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/LabelChargeEvent.cs b/ShipEngineSDK/Model/LabelChargeEvent.cs index 9458bea2..73f200a2 100644 --- a/ShipEngineSDK/Model/LabelChargeEvent.cs +++ b/ShipEngineSDK/Model/LabelChargeEvent.cs @@ -31,6 +31,9 @@ public class LabelChargeEvent { private string _value; + /// + /// Create a new instance of LabelChargeEvent with a predefined value. + /// internal LabelChargeEvent() { _value = "carrier_default"; diff --git a/ShipEngineSDK/Model/LabelDownload.cs b/ShipEngineSDK/Model/LabelDownload.cs index e98853c8..1a2cfc0e 100644 --- a/ShipEngineSDK/Model/LabelDownload.cs +++ b/ShipEngineSDK/Model/LabelDownload.cs @@ -77,10 +77,12 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class LabelDownload {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Href: ").Append(Href).Append("\n"); sb.Append(" Pdf: ").Append(Pdf).Append("\n"); sb.Append(" Png: ").Append(Png).Append("\n"); sb.Append(" Zpl: ").Append(Zpl).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/LabelDownloadType.cs b/ShipEngineSDK/Model/LabelDownloadType.cs index 52c63956..6fb6d4ec 100644 --- a/ShipEngineSDK/Model/LabelDownloadType.cs +++ b/ShipEngineSDK/Model/LabelDownloadType.cs @@ -31,6 +31,9 @@ public class LabelDownloadType { private string _value; + /// + /// Create a new instance of LabelDownloadType with a predefined value. + /// internal LabelDownloadType() { _value = "url"; diff --git a/ShipEngineSDK/Model/LabelFormat.cs b/ShipEngineSDK/Model/LabelFormat.cs index 17c46087..3bc597ca 100644 --- a/ShipEngineSDK/Model/LabelFormat.cs +++ b/ShipEngineSDK/Model/LabelFormat.cs @@ -31,6 +31,9 @@ public class LabelFormat { private string _value; + /// + /// Create a new instance of LabelFormat with a predefined value. + /// internal LabelFormat() { _value = "pdf"; diff --git a/ShipEngineSDK/Model/LabelLayout.cs b/ShipEngineSDK/Model/LabelLayout.cs index 2e2b55aa..faddea8c 100644 --- a/ShipEngineSDK/Model/LabelLayout.cs +++ b/ShipEngineSDK/Model/LabelLayout.cs @@ -31,6 +31,9 @@ public class LabelLayout { private string _value; + /// + /// Create a new instance of LabelLayout with a predefined value. + /// internal LabelLayout() { _value = "4x6"; diff --git a/ShipEngineSDK/Model/LabelMessages.cs b/ShipEngineSDK/Model/LabelMessages.cs index fb3dbc19..fcf80cba 100644 --- a/ShipEngineSDK/Model/LabelMessages.cs +++ b/ShipEngineSDK/Model/LabelMessages.cs @@ -61,9 +61,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class LabelMessages {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Reference1: ").Append(Reference1).Append("\n"); sb.Append(" Reference2: ").Append(Reference2).Append("\n"); sb.Append(" Reference3: ").Append(Reference3).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/LabelPackagesInner.cs b/ShipEngineSDK/Model/LabelPackagesInner.cs index af933312..5b06ba3d 100644 --- a/ShipEngineSDK/Model/LabelPackagesInner.cs +++ b/ShipEngineSDK/Model/LabelPackagesInner.cs @@ -154,6 +154,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class LabelPackagesInner {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" PackageId: ").Append(PackageId).Append("\n"); sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" ContentDescription: ").Append(ContentDescription).Append("\n"); @@ -169,6 +170,7 @@ public override string ToString() sb.Append(" Sequence: ").Append(Sequence).Append("\n"); sb.Append(" Products: ").Append(Products).Append("\n"); sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/LabelStatus.cs b/ShipEngineSDK/Model/LabelStatus.cs index a505973c..29d0aff1 100644 --- a/ShipEngineSDK/Model/LabelStatus.cs +++ b/ShipEngineSDK/Model/LabelStatus.cs @@ -31,6 +31,9 @@ public class LabelStatus { private string _value; + /// + /// Create a new instance of LabelStatus with a predefined value. + /// internal LabelStatus() { _value = "processing"; diff --git a/ShipEngineSDK/Model/Link.cs b/ShipEngineSDK/Model/Link.cs index b5ed45b9..8a5abd10 100644 --- a/ShipEngineSDK/Model/Link.cs +++ b/ShipEngineSDK/Model/Link.cs @@ -55,8 +55,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class Link {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Href: ").Append(Href).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs b/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs index dc7d91d4..1e56ca7c 100644 --- a/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs +++ b/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs @@ -155,11 +155,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListAccountImagesResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Images: ").Append(Images).Append("\n"); sb.Append(" Total: ").Append(Total).Append("\n"); sb.Append(" Page: ").Append(Page).Append("\n"); sb.Append(" Pages: ").Append(Pages).Append("\n"); sb.Append(" Links: ").Append(Links).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListAccountSettingsBody.cs b/ShipEngineSDK/Model/ListAccountSettingsBody.cs index 51db7928..c03f4ae8 100644 --- a/ShipEngineSDK/Model/ListAccountSettingsBody.cs +++ b/ShipEngineSDK/Model/ListAccountSettingsBody.cs @@ -42,7 +42,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListAccountSettingsBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" DefaultLabelLayout: ").Append(DefaultLabelLayout).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs b/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs index 6c94e0c8..584e7d4e 100644 --- a/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs +++ b/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs @@ -155,11 +155,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListAccountSettingsImagesResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Images: ").Append(Images).Append("\n"); sb.Append(" Total: ").Append(Total).Append("\n"); sb.Append(" Page: ").Append(Page).Append("\n"); sb.Append(" Pages: ").Append(Pages).Append("\n"); sb.Append(" Links: ").Append(Links).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs b/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs index 6648bc9a..d2a47ee6 100644 --- a/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs +++ b/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs @@ -52,8 +52,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListBatchErrorsResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Errors: ").Append(Errors).Append("\n"); sb.Append(" Links: ").Append(Links).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListBatchesResponseBody.cs b/ShipEngineSDK/Model/ListBatchesResponseBody.cs index c0933199..53ae7b14 100644 --- a/ShipEngineSDK/Model/ListBatchesResponseBody.cs +++ b/ShipEngineSDK/Model/ListBatchesResponseBody.cs @@ -85,11 +85,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListBatchesResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Batches: ").Append(Batches).Append("\n"); sb.Append(" Total: ").Append(Total).Append("\n"); sb.Append(" Page: ").Append(Page).Append("\n"); sb.Append(" Pages: ").Append(Pages).Append("\n"); sb.Append(" Links: ").Append(Links).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs b/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs index 72fa7160..de5f8e4a 100644 --- a/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs +++ b/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs @@ -44,7 +44,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListCarrierPackageTypesResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Packages: ").Append(Packages).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs b/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs index 09c8620d..321ee33f 100644 --- a/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs +++ b/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs @@ -44,7 +44,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListCarrierServicesResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Services: ").Append(Services).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListCarriersResponseBody.cs b/ShipEngineSDK/Model/ListCarriersResponseBody.cs index 0cc2ebba..216671e7 100644 --- a/ShipEngineSDK/Model/ListCarriersResponseBody.cs +++ b/ShipEngineSDK/Model/ListCarriersResponseBody.cs @@ -45,7 +45,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListCarriersResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Carriers: ").Append(Carriers).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListLabelsResponseBody.cs b/ShipEngineSDK/Model/ListLabelsResponseBody.cs index 4d9f7d0c..2adaa123 100644 --- a/ShipEngineSDK/Model/ListLabelsResponseBody.cs +++ b/ShipEngineSDK/Model/ListLabelsResponseBody.cs @@ -393,11 +393,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListLabelsResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Labels: ").Append(Labels).Append("\n"); sb.Append(" Total: ").Append(Total).Append("\n"); sb.Append(" Page: ").Append(Page).Append("\n"); sb.Append(" Pages: ").Append(Pages).Append("\n"); sb.Append(" Links: ").Append(Links).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListManifestsResponseBody.cs b/ShipEngineSDK/Model/ListManifestsResponseBody.cs index 3f7b16b4..6c6f0863 100644 --- a/ShipEngineSDK/Model/ListManifestsResponseBody.cs +++ b/ShipEngineSDK/Model/ListManifestsResponseBody.cs @@ -86,11 +86,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListManifestsResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Manifests: ").Append(Manifests).Append("\n"); sb.Append(" Total: ").Append(Total).Append("\n"); sb.Append(" Page: ").Append(Page).Append("\n"); sb.Append(" Pages: ").Append(Pages).Append("\n"); sb.Append(" Links: ").Append(Links).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs b/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs index 1b4b368d..9bb1e96e 100644 --- a/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs +++ b/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs @@ -44,7 +44,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListPackageTypesResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Packages: ").Append(Packages).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListPickupResponseBody.cs b/ShipEngineSDK/Model/ListPickupResponseBody.cs index 8a13dd93..66f3e9ca 100644 --- a/ShipEngineSDK/Model/ListPickupResponseBody.cs +++ b/ShipEngineSDK/Model/ListPickupResponseBody.cs @@ -86,11 +86,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListPickupResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Pickups: ").Append(Pickups).Append("\n"); sb.Append(" Total: ").Append(Total).Append("\n"); sb.Append(" Page: ").Append(Page).Append("\n"); sb.Append(" Pages: ").Append(Pages).Append("\n"); sb.Append(" Links: ").Append(Links).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBody.cs b/ShipEngineSDK/Model/ListServicePointsResponseBody.cs index d48caaca..e4343ca3 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBody.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBody.cs @@ -70,10 +70,12 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListServicePointsResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Lat: ").Append(Lat).Append("\n"); sb.Append(" Long: ").Append(Long).Append("\n"); sb.Append(" ServicePoints: ").Append(ServicePoints).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs index b1b5f195..383c2097 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs @@ -33,16 +33,27 @@ public partial class ListServicePointsResponseBodyServicePointsInner [JsonConverter(typeof(FeaturesEnumJsonConverter))] public class FeaturesEnum { - private string _value; + private readonly string _value; + /// + /// Create a new instance of FeaturesEnum with a predefined value. + /// internal FeaturesEnum() { _value = "drop_off_point"; } + /// + /// Create a new instance of FeaturesEnum with a custom value. + /// + /// The value of the FeaturesEnum + /// + /// 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 FeaturesEnum(string value) { - + _value = value; } /// @@ -97,16 +108,27 @@ public override bool CanConvert(Type typeToConvert) => [JsonConverter(typeof(TypeEnumJsonConverter))] public class TypeEnum { - private string _value; + private readonly string _value; + /// + /// Create a new instance of TypeEnum with a predefined value. + /// internal TypeEnum() { _value = "pudo"; } + /// + /// Create a new instance of TypeEnum with a custom value. + /// + /// The value of the TypeEnum + /// + /// 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 TypeEnum(string value) { - + _value = value; } /// @@ -291,6 +313,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListServicePointsResponseBodyServicePointsInner {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" ServiceCodes: ").Append(ServiceCodes).Append("\n"); sb.Append(" ServicePointId: ").Append(ServicePointId).Append("\n"); @@ -307,6 +330,7 @@ public override string ToString() sb.Append(" HoursOfOperation: ").Append(HoursOfOperation).Append("\n"); sb.Append(" Features: ").Append(Features).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs index cd51f865..8a26562a 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs @@ -79,6 +79,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListServicePointsResponseBodyServicePointsInnerHoursOfOperation {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Monday: ").Append(Monday).Append("\n"); sb.Append(" Tuesday: ").Append(Tuesday).Append("\n"); sb.Append(" Wednesday: ").Append(Wednesday).Append("\n"); @@ -86,6 +87,7 @@ public override string ToString() sb.Append(" Friday: ").Append(Friday).Append("\n"); sb.Append(" Saturday: ").Append(Saturday).Append("\n"); sb.Append(" Sunday: ").Append(Sunday).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs index b8113386..c74750b3 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs @@ -57,8 +57,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Open: ").Append(Open).Append("\n"); sb.Append(" Close: ").Append(Close).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs b/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs index 53fe1288..8037b765 100644 --- a/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs +++ b/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs @@ -101,6 +101,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListShipmentRatesResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Rates: ").Append(Rates).Append("\n"); sb.Append(" InvalidRates: ").Append(InvalidRates).Append("\n"); sb.Append(" RateRequestId: ").Append(RateRequestId).Append("\n"); @@ -108,6 +109,7 @@ public override string ToString() sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListShipmentsResponseBody.cs b/ShipEngineSDK/Model/ListShipmentsResponseBody.cs index 0a296426..2a4412f5 100644 --- a/ShipEngineSDK/Model/ListShipmentsResponseBody.cs +++ b/ShipEngineSDK/Model/ListShipmentsResponseBody.cs @@ -77,11 +77,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListShipmentsResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Shipments: ").Append(Shipments).Append("\n"); sb.Append(" Total: ").Append(Total).Append("\n"); sb.Append(" Page: ").Append(Page).Append("\n"); sb.Append(" Pages: ").Append(Pages).Append("\n"); sb.Append(" Links: ").Append(Links).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListTagsResponseBody.cs b/ShipEngineSDK/Model/ListTagsResponseBody.cs index e8f3834c..98c01e5d 100644 --- a/ShipEngineSDK/Model/ListTagsResponseBody.cs +++ b/ShipEngineSDK/Model/ListTagsResponseBody.cs @@ -44,7 +44,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListTagsResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Tags: ").Append(Tags).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ListWarehousesResponseBody.cs b/ShipEngineSDK/Model/ListWarehousesResponseBody.cs index 1a154415..1cf80ddd 100644 --- a/ShipEngineSDK/Model/ListWarehousesResponseBody.cs +++ b/ShipEngineSDK/Model/ListWarehousesResponseBody.cs @@ -45,7 +45,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ListWarehousesResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Warehouses: ").Append(Warehouses).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/Manifest.cs b/ShipEngineSDK/Model/Manifest.cs index 114e965f..abce686e 100644 --- a/ShipEngineSDK/Model/Manifest.cs +++ b/ShipEngineSDK/Model/Manifest.cs @@ -130,6 +130,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class Manifest {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ManifestId: ").Append(ManifestId).Append("\n"); sb.Append(" FormId: ").Append(FormId).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); @@ -140,6 +141,7 @@ public override string ToString() sb.Append(" SubmissionId: ").Append(SubmissionId).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ManifestDownload: ").Append(ManifestDownload).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ManifestDownload.cs b/ShipEngineSDK/Model/ManifestDownload.cs index 683cc50c..fe32db8e 100644 --- a/ShipEngineSDK/Model/ManifestDownload.cs +++ b/ShipEngineSDK/Model/ManifestDownload.cs @@ -47,7 +47,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ManifestDownload {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Href: ").Append(Href).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ManifestRequest.cs b/ShipEngineSDK/Model/ManifestRequest.cs index 97af3109..9294c7a2 100644 --- a/ShipEngineSDK/Model/ManifestRequest.cs +++ b/ShipEngineSDK/Model/ManifestRequest.cs @@ -52,8 +52,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ManifestRequest {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ManifestRequestId: ").Append(ManifestRequestId).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ManifestRequestStatus.cs b/ShipEngineSDK/Model/ManifestRequestStatus.cs index 5ec0de18..57401bd0 100644 --- a/ShipEngineSDK/Model/ManifestRequestStatus.cs +++ b/ShipEngineSDK/Model/ManifestRequestStatus.cs @@ -31,6 +31,9 @@ public class ManifestRequestStatus { private string _value; + /// + /// Create a new instance of ManifestRequestStatus with a predefined value. + /// internal ManifestRequestStatus() { _value = "in_progress"; diff --git a/ShipEngineSDK/Model/Manifests.cs b/ShipEngineSDK/Model/Manifests.cs index 5a9b985a..29b943d0 100644 --- a/ShipEngineSDK/Model/Manifests.cs +++ b/ShipEngineSDK/Model/Manifests.cs @@ -44,7 +44,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class Manifests {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" VarManifests: ").Append(VarManifests).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ManifestsRequests.cs b/ShipEngineSDK/Model/ManifestsRequests.cs index 010c079a..0a15ad35 100644 --- a/ShipEngineSDK/Model/ManifestsRequests.cs +++ b/ShipEngineSDK/Model/ManifestsRequests.cs @@ -44,7 +44,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ManifestsRequests {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ManifestRequests: ").Append(ManifestRequests).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ModifyBatch.cs b/ShipEngineSDK/Model/ModifyBatch.cs index d9e5d58e..d2403304 100644 --- a/ShipEngineSDK/Model/ModifyBatch.cs +++ b/ShipEngineSDK/Model/ModifyBatch.cs @@ -51,8 +51,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ModifyBatch {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); sb.Append(" RateIds: ").Append(RateIds).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/MonetaryValue.cs b/ShipEngineSDK/Model/MonetaryValue.cs index 7d4fe13e..24ad59d6 100644 --- a/ShipEngineSDK/Model/MonetaryValue.cs +++ b/ShipEngineSDK/Model/MonetaryValue.cs @@ -53,8 +53,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class MonetaryValue {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Currency: ").Append(Currency).Append("\n"); sb.Append(" Amount: ").Append(Amount).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/NonDelivery.cs b/ShipEngineSDK/Model/NonDelivery.cs index d30867ea..ae9e5ad4 100644 --- a/ShipEngineSDK/Model/NonDelivery.cs +++ b/ShipEngineSDK/Model/NonDelivery.cs @@ -31,6 +31,9 @@ public class NonDelivery { private string _value; + /// + /// Create a new instance of NonDelivery with a predefined value. + /// internal NonDelivery() { _value = "return_to_sender"; diff --git a/ShipEngineSDK/Model/OptionalLink.cs b/ShipEngineSDK/Model/OptionalLink.cs index 103c4cc8..8818d005 100644 --- a/ShipEngineSDK/Model/OptionalLink.cs +++ b/ShipEngineSDK/Model/OptionalLink.cs @@ -54,8 +54,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class OptionalLink {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Href: ").Append(Href).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/OrderSourceName.cs b/ShipEngineSDK/Model/OrderSourceName.cs index c8b3b7f0..c0c75f72 100644 --- a/ShipEngineSDK/Model/OrderSourceName.cs +++ b/ShipEngineSDK/Model/OrderSourceName.cs @@ -31,6 +31,9 @@ public class OrderSourceName { private string _value; + /// + /// Create a new instance of OrderSourceName with a predefined value. + /// internal OrderSourceName() { _value = "amazon_ca"; diff --git a/ShipEngineSDK/Model/OriginType.cs b/ShipEngineSDK/Model/OriginType.cs index 64bb76ec..927e0c2a 100644 --- a/ShipEngineSDK/Model/OriginType.cs +++ b/ShipEngineSDK/Model/OriginType.cs @@ -31,6 +31,9 @@ public class OriginType { private string _value; + /// + /// Create a new instance of OriginType with a predefined value. + /// internal OriginType() { _value = "pickup"; diff --git a/ShipEngineSDK/Model/Package.cs b/ShipEngineSDK/Model/Package.cs index 20f05cfb..0998c920 100644 --- a/ShipEngineSDK/Model/Package.cs +++ b/ShipEngineSDK/Model/Package.cs @@ -147,6 +147,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class Package {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" PackageId: ").Append(PackageId).Append("\n"); sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" ContentDescription: ").Append(ContentDescription).Append("\n"); @@ -161,6 +162,7 @@ public override string ToString() sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); sb.Append(" Sequence: ").Append(Sequence).Append("\n"); sb.Append(" Products: ").Append(Products).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/PackageContents.cs b/ShipEngineSDK/Model/PackageContents.cs index 2075eff7..9be7aa4c 100644 --- a/ShipEngineSDK/Model/PackageContents.cs +++ b/ShipEngineSDK/Model/PackageContents.cs @@ -31,6 +31,9 @@ public class PackageContents { private string _value; + /// + /// Create a new instance of PackageContents with a predefined value. + /// internal PackageContents() { _value = "merchandise"; diff --git a/ShipEngineSDK/Model/PackageType.cs b/ShipEngineSDK/Model/PackageType.cs index b367c42f..e94428b3 100644 --- a/ShipEngineSDK/Model/PackageType.cs +++ b/ShipEngineSDK/Model/PackageType.cs @@ -85,11 +85,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class PackageType {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" PackageId: ").Append(PackageId).Append("\n"); sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); sb.Append(" Description: ").Append(Description).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/PackagingGroup.cs b/ShipEngineSDK/Model/PackagingGroup.cs index a39d43d0..3aca99c5 100644 --- a/ShipEngineSDK/Model/PackagingGroup.cs +++ b/ShipEngineSDK/Model/PackagingGroup.cs @@ -30,6 +30,9 @@ public class PackagingGroup { private string _value; + /// + /// Create a new instance of PackagingGroup with a predefined value. + /// internal PackagingGroup() { _value = "i"; diff --git a/ShipEngineSDK/Model/PackagingInstructionSection.cs b/ShipEngineSDK/Model/PackagingInstructionSection.cs index 8cfcd274..a56d1260 100644 --- a/ShipEngineSDK/Model/PackagingInstructionSection.cs +++ b/ShipEngineSDK/Model/PackagingInstructionSection.cs @@ -30,6 +30,9 @@ public class PackagingInstructionSection { private string _value; + /// + /// Create a new instance of PackagingInstructionSection with a predefined value. + /// internal PackagingInstructionSection() { _value = "section_1"; diff --git a/ShipEngineSDK/Model/PagedListResponseBody.cs b/ShipEngineSDK/Model/PagedListResponseBody.cs index c07f8202..591e0b11 100644 --- a/ShipEngineSDK/Model/PagedListResponseBody.cs +++ b/ShipEngineSDK/Model/PagedListResponseBody.cs @@ -83,11 +83,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class PagedListResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Total: ").Append(Total).Append("\n"); sb.Append(" Page: ").Append(Page).Append("\n"); sb.Append(" Pages: ").Append(Pages).Append("\n"); sb.Append(" Links: ").Append(Links).Append("\n"); sb.Append(" AdditionalProperties: ").Append(AdditionalProperties).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/PaginationLink.cs b/ShipEngineSDK/Model/PaginationLink.cs index 43f6b31f..9a8fb501 100644 --- a/ShipEngineSDK/Model/PaginationLink.cs +++ b/ShipEngineSDK/Model/PaginationLink.cs @@ -69,10 +69,12 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class PaginationLink {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" First: ").Append(First).Append("\n"); sb.Append(" Last: ").Append(Last).Append("\n"); sb.Append(" Prev: ").Append(Prev).Append("\n"); sb.Append(" Next: ").Append(Next).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/PaperlessDownload.cs b/ShipEngineSDK/Model/PaperlessDownload.cs index 862cde79..a8e06cce 100644 --- a/ShipEngineSDK/Model/PaperlessDownload.cs +++ b/ShipEngineSDK/Model/PaperlessDownload.cs @@ -61,9 +61,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class PaperlessDownload {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Href: ").Append(Href).Append("\n"); sb.Append(" Instructions: ").Append(Instructions).Append("\n"); sb.Append(" HandoffCode: ").Append(HandoffCode).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ParseAddressRequestBody.cs b/ShipEngineSDK/Model/ParseAddressRequestBody.cs index ab4e3df5..03c04530 100644 --- a/ShipEngineSDK/Model/ParseAddressRequestBody.cs +++ b/ShipEngineSDK/Model/ParseAddressRequestBody.cs @@ -55,8 +55,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ParseAddressRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Text: ").Append(Text).Append("\n"); sb.Append(" Address: ").Append(Address).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ParseAddressResponseBody.cs b/ShipEngineSDK/Model/ParseAddressResponseBody.cs index f8a9a5bc..59ee23b8 100644 --- a/ShipEngineSDK/Model/ParseAddressResponseBody.cs +++ b/ShipEngineSDK/Model/ParseAddressResponseBody.cs @@ -61,9 +61,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ParseAddressResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Score: ").Append(Score).Append("\n"); sb.Append(" Address: ").Append(Address).Append("\n"); sb.Append(" Entities: ").Append(Entities).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ParseShipmentRequestBody.cs b/ShipEngineSDK/Model/ParseShipmentRequestBody.cs index fe4a9ed6..57481407 100644 --- a/ShipEngineSDK/Model/ParseShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/ParseShipmentRequestBody.cs @@ -56,8 +56,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ParseShipmentRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Text: ").Append(Text).Append("\n"); sb.Append(" Shipment: ").Append(Shipment).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ParseShipmentResponseBody.cs b/ShipEngineSDK/Model/ParseShipmentResponseBody.cs index 8bca04c7..04a34988 100644 --- a/ShipEngineSDK/Model/ParseShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/ParseShipmentResponseBody.cs @@ -61,9 +61,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ParseShipmentResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Score: ").Append(Score).Append("\n"); sb.Append(" Shipment: ").Append(Shipment).Append("\n"); sb.Append(" Entities: ").Append(Entities).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/PartialAddress.cs b/ShipEngineSDK/Model/PartialAddress.cs index 6dbf19d2..9ab7393c 100644 --- a/ShipEngineSDK/Model/PartialAddress.cs +++ b/ShipEngineSDK/Model/PartialAddress.cs @@ -153,6 +153,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class PartialAddress {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" Phone: ").Append(Phone).Append("\n"); sb.Append(" Email: ").Append(Email).Append("\n"); @@ -165,6 +166,7 @@ public override string ToString() sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/PartialShipment.cs b/ShipEngineSDK/Model/PartialShipment.cs index 966518c7..64594367 100644 --- a/ShipEngineSDK/Model/PartialShipment.cs +++ b/ShipEngineSDK/Model/PartialShipment.cs @@ -247,6 +247,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class PartialShipment {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); @@ -274,6 +275,7 @@ public override string ToString() sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/PartialShippingAddress.cs b/ShipEngineSDK/Model/PartialShippingAddress.cs index 9affc1f9..b1d8f1ac 100644 --- a/ShipEngineSDK/Model/PartialShippingAddress.cs +++ b/ShipEngineSDK/Model/PartialShippingAddress.cs @@ -44,7 +44,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class PartialShippingAddress {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Instructions: ").Append(Instructions).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/PartialShippingAddressTo.cs b/ShipEngineSDK/Model/PartialShippingAddressTo.cs index a076cce4..edeedb19 100644 --- a/ShipEngineSDK/Model/PartialShippingAddressTo.cs +++ b/ShipEngineSDK/Model/PartialShippingAddressTo.cs @@ -50,8 +50,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class PartialShippingAddressTo {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Instructions: ").Append(Instructions).Append("\n"); sb.Append(" Geolocation: ").Append(Geolocation).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs b/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs index 5811fba4..5189e246 100644 --- a/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs +++ b/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs @@ -34,16 +34,27 @@ public partial class PartialShippingAddressToGeolocationInner [JsonConverter(typeof(TypeEnumJsonConverter))] public class TypeEnum { - private string _value; + private readonly string _value; + /// + /// Create a new instance of TypeEnum with a predefined value. + /// internal TypeEnum() { _value = "what3words"; } + /// + /// Create a new instance of TypeEnum with a custom value. + /// + /// The value of the TypeEnum + /// + /// 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 TypeEnum(string value) { - + _value = value; } /// @@ -96,8 +107,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class PartialShippingAddressToGeolocationInner {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" Value: ").Append(Value).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/PaymentAmount.cs b/ShipEngineSDK/Model/PaymentAmount.cs index fbfb3f41..9beb8623 100644 --- a/ShipEngineSDK/Model/PaymentAmount.cs +++ b/ShipEngineSDK/Model/PaymentAmount.cs @@ -50,8 +50,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class PaymentAmount {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Currency: ").Append(Currency).Append("\n"); sb.Append(" Amount: ").Append(Amount).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/Pickup.cs b/ShipEngineSDK/Model/Pickup.cs index b38e4aaf..962f837d 100644 --- a/ShipEngineSDK/Model/Pickup.cs +++ b/ShipEngineSDK/Model/Pickup.cs @@ -136,6 +136,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class Pickup {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" PickupId: ").Append(PickupId).Append("\n"); sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); @@ -148,6 +149,7 @@ public override string ToString() sb.Append(" PickupNotes: ").Append(PickupNotes).Append("\n"); sb.Append(" PickupWindow: ").Append(PickupWindow).Append("\n"); sb.Append(" PickupWindows: ").Append(PickupWindows).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/PickupResponseBody.cs b/ShipEngineSDK/Model/PickupResponseBody.cs index 4421fc84..7a177275 100644 --- a/ShipEngineSDK/Model/PickupResponseBody.cs +++ b/ShipEngineSDK/Model/PickupResponseBody.cs @@ -145,6 +145,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class PickupResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" PickupId: ").Append(PickupId).Append("\n"); sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); @@ -157,6 +158,7 @@ public override string ToString() sb.Append(" PickupNotes: ").Append(PickupNotes).Append("\n"); sb.Append(" PickupWindow: ").Append(PickupWindow).Append("\n"); sb.Append(" PickupWindows: ").Append(PickupWindows).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/PickupWindow.cs b/ShipEngineSDK/Model/PickupWindow.cs index 74687f9d..ffc64b82 100644 --- a/ShipEngineSDK/Model/PickupWindow.cs +++ b/ShipEngineSDK/Model/PickupWindow.cs @@ -59,8 +59,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class PickupWindow {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" StartAt: ").Append(StartAt).Append("\n"); sb.Append(" EndAt: ").Append(EndAt).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/PickupWindows.cs b/ShipEngineSDK/Model/PickupWindows.cs index 252d7484..1452ada2 100644 --- a/ShipEngineSDK/Model/PickupWindows.cs +++ b/ShipEngineSDK/Model/PickupWindows.cs @@ -57,8 +57,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class PickupWindows {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" StartAt: ").Append(StartAt).Append("\n"); sb.Append(" EndAt: ").Append(EndAt).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ProcessBatchRequestBody.cs b/ShipEngineSDK/Model/ProcessBatchRequestBody.cs index 80fac23d..279e4df5 100644 --- a/ShipEngineSDK/Model/ProcessBatchRequestBody.cs +++ b/ShipEngineSDK/Model/ProcessBatchRequestBody.cs @@ -63,10 +63,12 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ProcessBatchRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/Products.cs b/ShipEngineSDK/Model/Products.cs index 8673ead5..6a26a930 100644 --- a/ShipEngineSDK/Model/Products.cs +++ b/ShipEngineSDK/Model/Products.cs @@ -136,6 +136,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class Products {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Description: ").Append(Description).Append("\n"); sb.Append(" Quantity: ").Append(Quantity).Append("\n"); sb.Append(" Value: ").Append(Value).Append("\n"); @@ -149,6 +150,7 @@ public override string ToString() sb.Append(" ProductUrl: ").Append(ProductUrl).Append("\n"); sb.Append(" VatRate: ").Append(VatRate).Append("\n"); sb.Append(" DangerousGoods: ").Append(DangerousGoods).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs b/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs index 8315424f..61a77085 100644 --- a/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs +++ b/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs @@ -63,11 +63,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class PurchaseLabelWithoutShipment {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/Rate.cs b/ShipEngineSDK/Model/Rate.cs index 8e9a380a..ea2c0735 100644 --- a/ShipEngineSDK/Model/Rate.cs +++ b/ShipEngineSDK/Model/Rate.cs @@ -257,6 +257,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class Rate {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" RateId: ").Append(RateId).Append("\n"); sb.Append(" RateType: ").Append(RateType).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); @@ -283,6 +284,7 @@ public override string ToString() sb.Append(" ValidationStatus: ").Append(ValidationStatus).Append("\n"); sb.Append(" WarningMessages: ").Append(WarningMessages).Append("\n"); sb.Append(" ErrorMessages: ").Append(ErrorMessages).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/RateEstimate.cs b/ShipEngineSDK/Model/RateEstimate.cs index ec5ece2a..0f5ceebf 100644 --- a/ShipEngineSDK/Model/RateEstimate.cs +++ b/ShipEngineSDK/Model/RateEstimate.cs @@ -239,6 +239,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class RateEstimate {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" RateType: ").Append(RateType).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ShippingAmount: ").Append(ShippingAmount).Append("\n"); @@ -263,6 +264,7 @@ public override string ToString() sb.Append(" ValidationStatus: ").Append(ValidationStatus).Append("\n"); sb.Append(" WarningMessages: ").Append(WarningMessages).Append("\n"); sb.Append(" ErrorMessages: ").Append(ErrorMessages).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/RateEstimateByCarrierId.cs b/ShipEngineSDK/Model/RateEstimateByCarrierId.cs index 7527c79d..cb820e88 100644 --- a/ShipEngineSDK/Model/RateEstimateByCarrierId.cs +++ b/ShipEngineSDK/Model/RateEstimateByCarrierId.cs @@ -48,7 +48,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class RateEstimateByCarrierId {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs b/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs index 243fa078..f73d46d3 100644 --- a/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs +++ b/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs @@ -44,7 +44,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class RateEstimateByCarrierIds {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierIds: ").Append(CarrierIds).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/RateEstimateOptions.cs b/ShipEngineSDK/Model/RateEstimateOptions.cs index bd71d1f5..0749d17d 100644 --- a/ShipEngineSDK/Model/RateEstimateOptions.cs +++ b/ShipEngineSDK/Model/RateEstimateOptions.cs @@ -151,6 +151,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class RateEstimateOptions {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" FromCountryCode: ").Append(FromCountryCode).Append("\n"); sb.Append(" FromPostalCode: ").Append(FromPostalCode).Append("\n"); sb.Append(" FromCityLocality: ").Append(FromCityLocality).Append("\n"); @@ -164,6 +165,7 @@ public override string ToString() sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/RateRequestBody.cs b/ShipEngineSDK/Model/RateRequestBody.cs index 2a4f1d03..5cbd9e7a 100644 --- a/ShipEngineSDK/Model/RateRequestBody.cs +++ b/ShipEngineSDK/Model/RateRequestBody.cs @@ -78,12 +78,14 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class RateRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierIds: ").Append(CarrierIds).Append("\n"); sb.Append(" PackageTypes: ").Append(PackageTypes).Append("\n"); sb.Append(" ServiceCodes: ").Append(ServiceCodes).Append("\n"); sb.Append(" CalculateTaxAmount: ").Append(CalculateTaxAmount).Append("\n"); sb.Append(" PreferredCurrency: ").Append(PreferredCurrency).Append("\n"); sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/RateRequestByShipmentIds.cs b/ShipEngineSDK/Model/RateRequestByShipmentIds.cs index 495563cb..833702e4 100644 --- a/ShipEngineSDK/Model/RateRequestByShipmentIds.cs +++ b/ShipEngineSDK/Model/RateRequestByShipmentIds.cs @@ -45,7 +45,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class RateRequestByShipmentIds {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/RateRequestByShipments.cs b/ShipEngineSDK/Model/RateRequestByShipments.cs index 82b7c639..87b6adeb 100644 --- a/ShipEngineSDK/Model/RateRequestByShipments.cs +++ b/ShipEngineSDK/Model/RateRequestByShipments.cs @@ -45,7 +45,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class RateRequestByShipments {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Shipments: ").Append(Shipments).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/RateRequestOptions.cs b/ShipEngineSDK/Model/RateRequestOptions.cs index fd531ed9..4582220b 100644 --- a/ShipEngineSDK/Model/RateRequestOptions.cs +++ b/ShipEngineSDK/Model/RateRequestOptions.cs @@ -44,7 +44,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class RateRequestOptions {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" RateOptions: ").Append(RateOptions).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/RateRequestRateOptions.cs b/ShipEngineSDK/Model/RateRequestRateOptions.cs index 3056bafe..cba828e0 100644 --- a/ShipEngineSDK/Model/RateRequestRateOptions.cs +++ b/ShipEngineSDK/Model/RateRequestRateOptions.cs @@ -44,7 +44,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class RateRequestRateOptions {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" RateOptions: ").Append(RateOptions).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/RateResponse.cs b/ShipEngineSDK/Model/RateResponse.cs index f622fd55..103913a0 100644 --- a/ShipEngineSDK/Model/RateResponse.cs +++ b/ShipEngineSDK/Model/RateResponse.cs @@ -44,7 +44,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class RateResponse {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" VarRateResponse: ").Append(VarRateResponse).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/RateResponseStatus.cs b/ShipEngineSDK/Model/RateResponseStatus.cs index 42931f47..326a7ff1 100644 --- a/ShipEngineSDK/Model/RateResponseStatus.cs +++ b/ShipEngineSDK/Model/RateResponseStatus.cs @@ -31,6 +31,9 @@ public class RateResponseStatus { private string _value; + /// + /// Create a new instance of RateResponseStatus with a predefined value. + /// internal RateResponseStatus() { _value = "working"; diff --git a/ShipEngineSDK/Model/RateType.cs b/ShipEngineSDK/Model/RateType.cs index e6be2e69..d3ee5d86 100644 --- a/ShipEngineSDK/Model/RateType.cs +++ b/ShipEngineSDK/Model/RateType.cs @@ -31,6 +31,9 @@ public class RateType { private string _value; + /// + /// Create a new instance of RateType with a predefined value. + /// internal RateType() { _value = "check"; diff --git a/ShipEngineSDK/Model/RatesInformation.cs b/ShipEngineSDK/Model/RatesInformation.cs index c0f8bf03..821345f2 100644 --- a/ShipEngineSDK/Model/RatesInformation.cs +++ b/ShipEngineSDK/Model/RatesInformation.cs @@ -92,6 +92,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class RatesInformation {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Rates: ").Append(Rates).Append("\n"); sb.Append(" InvalidRates: ").Append(InvalidRates).Append("\n"); sb.Append(" RateRequestId: ").Append(RateRequestId).Append("\n"); @@ -99,6 +100,7 @@ public override string ToString() sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ReasonCode.cs b/ShipEngineSDK/Model/ReasonCode.cs index 4ea6270e..f4e5288e 100644 --- a/ShipEngineSDK/Model/ReasonCode.cs +++ b/ShipEngineSDK/Model/ReasonCode.cs @@ -31,6 +31,9 @@ public class ReasonCode { private string _value; + /// + /// Create a new instance of ReasonCode with a predefined value. + /// internal ReasonCode() { _value = "unknown"; diff --git a/ShipEngineSDK/Model/RecognizedEntity.cs b/ShipEngineSDK/Model/RecognizedEntity.cs index 647066c5..7f218ac1 100644 --- a/ShipEngineSDK/Model/RecognizedEntity.cs +++ b/ShipEngineSDK/Model/RecognizedEntity.cs @@ -84,12 +84,14 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class RecognizedEntity {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" Score: ").Append(Score).Append("\n"); sb.Append(" Text: ").Append(Text).Append("\n"); sb.Append(" StartIndex: ").Append(StartIndex).Append("\n"); sb.Append(" EndIndex: ").Append(EndIndex).Append("\n"); sb.Append(" Result: ").Append(Result).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/Redirect.cs b/ShipEngineSDK/Model/Redirect.cs index 24ff6553..5f6563ed 100644 --- a/ShipEngineSDK/Model/Redirect.cs +++ b/ShipEngineSDK/Model/Redirect.cs @@ -31,6 +31,9 @@ public class Redirect { private string _value; + /// + /// Create a new instance of Redirect with a predefined value. + /// internal Redirect() { _value = "shipengine-dashboard"; diff --git a/ShipEngineSDK/Model/RegulationLevel.cs b/ShipEngineSDK/Model/RegulationLevel.cs index 9cf6c240..c303327e 100644 --- a/ShipEngineSDK/Model/RegulationLevel.cs +++ b/ShipEngineSDK/Model/RegulationLevel.cs @@ -30,6 +30,9 @@ public class RegulationLevel { private string _value; + /// + /// Create a new instance of RegulationLevel with a predefined value. + /// internal RegulationLevel() { _value = "lightly_regulated"; diff --git a/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs b/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs index 5f5e2d17..2eed5458 100644 --- a/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs +++ b/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs @@ -51,8 +51,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class RemoveFromBatchRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); sb.Append(" RateIds: ").Append(RateIds).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ResponseMessage.cs b/ShipEngineSDK/Model/ResponseMessage.cs index 43e6525a..4cf7b1ac 100644 --- a/ShipEngineSDK/Model/ResponseMessage.cs +++ b/ShipEngineSDK/Model/ResponseMessage.cs @@ -72,10 +72,12 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ResponseMessage {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Code: ").Append(Code).Append("\n"); sb.Append(" Message: ").Append(Message).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" DetailCode: ").Append(DetailCode).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/SchedulePickupRequestBody.cs b/ShipEngineSDK/Model/SchedulePickupRequestBody.cs index 6b340f6a..236ddd0b 100644 --- a/ShipEngineSDK/Model/SchedulePickupRequestBody.cs +++ b/ShipEngineSDK/Model/SchedulePickupRequestBody.cs @@ -139,6 +139,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class SchedulePickupRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" PickupId: ").Append(PickupId).Append("\n"); sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); @@ -151,6 +152,7 @@ public override string ToString() sb.Append(" PickupNotes: ").Append(PickupNotes).Append("\n"); sb.Append(" PickupWindow: ").Append(PickupWindow).Append("\n"); sb.Append(" PickupWindows: ").Append(PickupWindows).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/SchedulePickupResponseBody.cs b/ShipEngineSDK/Model/SchedulePickupResponseBody.cs index 9ea58afd..37943f52 100644 --- a/ShipEngineSDK/Model/SchedulePickupResponseBody.cs +++ b/ShipEngineSDK/Model/SchedulePickupResponseBody.cs @@ -155,6 +155,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class SchedulePickupResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" PickupId: ").Append(PickupId).Append("\n"); sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); @@ -169,6 +170,7 @@ public override string ToString() sb.Append(" PickupWindows: ").Append(PickupWindows).Append("\n"); sb.Append(" RequestId: ").Append(RequestId).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/Service.cs b/ShipEngineSDK/Model/Service.cs index 4a6a81d8..533995e7 100644 --- a/ShipEngineSDK/Model/Service.cs +++ b/ShipEngineSDK/Model/Service.cs @@ -98,6 +98,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class Service {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); @@ -105,6 +106,7 @@ public override string ToString() sb.Append(" Domestic: ").Append(Domestic).Append("\n"); sb.Append(" International: ").Append(International).Append("\n"); sb.Append(" IsMultiPackageSupported: ").Append(IsMultiPackageSupported).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/Shipment.cs b/ShipEngineSDK/Model/Shipment.cs index 2ab70631..a2fe7e0f 100644 --- a/ShipEngineSDK/Model/Shipment.cs +++ b/ShipEngineSDK/Model/Shipment.cs @@ -271,6 +271,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class Shipment {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); @@ -298,6 +299,7 @@ public override string ToString() sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ShipmentIdRequest.cs b/ShipEngineSDK/Model/ShipmentIdRequest.cs index 7fc69d69..d34c01b0 100644 --- a/ShipEngineSDK/Model/ShipmentIdRequest.cs +++ b/ShipEngineSDK/Model/ShipmentIdRequest.cs @@ -47,7 +47,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ShipmentIdRequest {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ShipmentItem.cs b/ShipEngineSDK/Model/ShipmentItem.cs index d1ab2ff4..c7688820 100644 --- a/ShipEngineSDK/Model/ShipmentItem.cs +++ b/ShipEngineSDK/Model/ShipmentItem.cs @@ -101,6 +101,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ShipmentItem {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" SalesOrderId: ").Append(SalesOrderId).Append("\n"); sb.Append(" SalesOrderItemId: ").Append(SalesOrderItemId).Append("\n"); @@ -110,6 +111,7 @@ public override string ToString() sb.Append(" ExternalOrderItemId: ").Append(ExternalOrderItemId).Append("\n"); sb.Append(" Asin: ").Append(Asin).Append("\n"); sb.Append(" OrderSourceCode: ").Append(OrderSourceCode).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ShipmentRequest.cs b/ShipEngineSDK/Model/ShipmentRequest.cs index 6ba0cf60..dbae09c3 100644 --- a/ShipEngineSDK/Model/ShipmentRequest.cs +++ b/ShipEngineSDK/Model/ShipmentRequest.cs @@ -44,7 +44,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ShipmentRequest {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Shipment: ").Append(Shipment).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ShipmentStatus.cs b/ShipEngineSDK/Model/ShipmentStatus.cs index d124afe8..301fa15d 100644 --- a/ShipEngineSDK/Model/ShipmentStatus.cs +++ b/ShipEngineSDK/Model/ShipmentStatus.cs @@ -31,6 +31,9 @@ public class ShipmentStatus { private string _value; + /// + /// Create a new instance of ShipmentStatus with a predefined value. + /// internal ShipmentStatus() { _value = "pending"; diff --git a/ShipEngineSDK/Model/ShipmentsSortBy.cs b/ShipEngineSDK/Model/ShipmentsSortBy.cs index f5ed40bf..cf184e1f 100644 --- a/ShipEngineSDK/Model/ShipmentsSortBy.cs +++ b/ShipEngineSDK/Model/ShipmentsSortBy.cs @@ -31,6 +31,9 @@ public class ShipmentsSortBy { private string _value; + /// + /// Create a new instance of ShipmentsSortBy with a predefined value. + /// internal ShipmentsSortBy() { _value = "modified_at"; diff --git a/ShipEngineSDK/Model/ShippingAddress.cs b/ShipEngineSDK/Model/ShippingAddress.cs index cb85434e..737c0473 100644 --- a/ShipEngineSDK/Model/ShippingAddress.cs +++ b/ShipEngineSDK/Model/ShippingAddress.cs @@ -170,6 +170,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ShippingAddress {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" Phone: ").Append(Phone).Append("\n"); sb.Append(" Email: ").Append(Email).Append("\n"); @@ -183,6 +184,7 @@ public override string ToString() sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); sb.Append(" Instructions: ").Append(Instructions).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ShippingAddressTo.cs b/ShipEngineSDK/Model/ShippingAddressTo.cs index f4f10064..d490b9b1 100644 --- a/ShipEngineSDK/Model/ShippingAddressTo.cs +++ b/ShipEngineSDK/Model/ShippingAddressTo.cs @@ -176,6 +176,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ShippingAddressTo {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" Phone: ").Append(Phone).Append("\n"); sb.Append(" Email: ").Append(Email).Append("\n"); @@ -190,6 +191,7 @@ public override string ToString() sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); sb.Append(" Instructions: ").Append(Instructions).Append("\n"); sb.Append(" Geolocation: ").Append(Geolocation).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/SmartPostHub.cs b/ShipEngineSDK/Model/SmartPostHub.cs index 03de0d3f..d13f06d1 100644 --- a/ShipEngineSDK/Model/SmartPostHub.cs +++ b/ShipEngineSDK/Model/SmartPostHub.cs @@ -31,6 +31,9 @@ public class SmartPostHub { private string _value; + /// + /// Create a new instance of SmartPostHub with a predefined value. + /// internal SmartPostHub() { _value = "none"; diff --git a/ShipEngineSDK/Model/SortDir.cs b/ShipEngineSDK/Model/SortDir.cs index 113462cb..01eb52f0 100644 --- a/ShipEngineSDK/Model/SortDir.cs +++ b/ShipEngineSDK/Model/SortDir.cs @@ -31,6 +31,9 @@ public class SortDir { private string _value; + /// + /// Create a new instance of SortDir with a predefined value. + /// internal SortDir() { _value = "asc"; diff --git a/ShipEngineSDK/Model/StatusCode.cs b/ShipEngineSDK/Model/StatusCode.cs index b345ae5e..f41238b7 100644 --- a/ShipEngineSDK/Model/StatusCode.cs +++ b/ShipEngineSDK/Model/StatusCode.cs @@ -31,6 +31,9 @@ public class StatusCode { private string _value; + /// + /// Create a new instance of StatusCode with a predefined value. + /// internal StatusCode() { _value = "un"; diff --git a/ShipEngineSDK/Model/Tag.cs b/ShipEngineSDK/Model/Tag.cs index c5956fb3..6287a6e6 100644 --- a/ShipEngineSDK/Model/Tag.cs +++ b/ShipEngineSDK/Model/Tag.cs @@ -48,7 +48,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class Tag {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/TagShipmentResponseBody.cs b/ShipEngineSDK/Model/TagShipmentResponseBody.cs index 5eaabd98..3af90404 100644 --- a/ShipEngineSDK/Model/TagShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/TagShipmentResponseBody.cs @@ -44,7 +44,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class TagShipmentResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Tags: ").Append(Tags).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/TaxIdentifier.cs b/ShipEngineSDK/Model/TaxIdentifier.cs index 22b20c87..4938a5b8 100644 --- a/ShipEngineSDK/Model/TaxIdentifier.cs +++ b/ShipEngineSDK/Model/TaxIdentifier.cs @@ -69,10 +69,12 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class TaxIdentifier {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" TaxableEntityType: ").Append(TaxableEntityType).Append("\n"); sb.Append(" IdentifierType: ").Append(IdentifierType).Append("\n"); sb.Append(" IssuingAuthority: ").Append(IssuingAuthority).Append("\n"); sb.Append(" Value: ").Append(Value).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/TaxableEntityType.cs b/ShipEngineSDK/Model/TaxableEntityType.cs index 864cb5b3..e8969517 100644 --- a/ShipEngineSDK/Model/TaxableEntityType.cs +++ b/ShipEngineSDK/Model/TaxableEntityType.cs @@ -31,6 +31,9 @@ public class TaxableEntityType { private string _value; + /// + /// Create a new instance of TaxableEntityType with a predefined value. + /// internal TaxableEntityType() { _value = "shipper"; diff --git a/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs b/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs index d518dade..d1779535 100644 --- a/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs +++ b/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs @@ -51,8 +51,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class TokensGetEphemeralTokenResponseBodyYaml {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Token: ").Append(Token).Append("\n"); sb.Append(" RedirectUrl: ").Append(RedirectUrl).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/TrackEvent.cs b/ShipEngineSDK/Model/TrackEvent.cs index 59db5c3d..8a82c4a1 100644 --- a/ShipEngineSDK/Model/TrackEvent.cs +++ b/ShipEngineSDK/Model/TrackEvent.cs @@ -201,6 +201,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class TrackEvent {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" OccurredAt: ").Append(OccurredAt).Append("\n"); sb.Append(" CarrierOccurredAt: ").Append(CarrierOccurredAt).Append("\n"); sb.Append(" Description: ").Append(Description).Append("\n"); @@ -218,6 +219,7 @@ public override string ToString() sb.Append(" CarrierStatusDescription: ").Append(CarrierStatusDescription).Append("\n"); sb.Append(" Latitude: ").Append(Latitude).Append("\n"); sb.Append(" Longitude: ").Append(Longitude).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/TrackingInformation.cs b/ShipEngineSDK/Model/TrackingInformation.cs index 5d4e4264..1d7509fe 100644 --- a/ShipEngineSDK/Model/TrackingInformation.cs +++ b/ShipEngineSDK/Model/TrackingInformation.cs @@ -166,6 +166,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class TrackingInformation {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); sb.Append(" StatusCode: ").Append(StatusCode).Append("\n"); @@ -180,6 +181,7 @@ public override string ToString() sb.Append(" ActualDeliveryDate: ").Append(ActualDeliveryDate).Append("\n"); sb.Append(" ExceptionDescription: ").Append(ExceptionDescription).Append("\n"); sb.Append(" Events: ").Append(Events).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/TrackingStatus.cs b/ShipEngineSDK/Model/TrackingStatus.cs index 862e90fc..0100098d 100644 --- a/ShipEngineSDK/Model/TrackingStatus.cs +++ b/ShipEngineSDK/Model/TrackingStatus.cs @@ -31,6 +31,9 @@ public class TrackingStatus { private string _value; + /// + /// Create a new instance of TrackingStatus with a predefined value. + /// internal TrackingStatus() { _value = "unknown"; diff --git a/ShipEngineSDK/Model/TransportMean.cs b/ShipEngineSDK/Model/TransportMean.cs index 46c19983..6b8d825e 100644 --- a/ShipEngineSDK/Model/TransportMean.cs +++ b/ShipEngineSDK/Model/TransportMean.cs @@ -30,6 +30,9 @@ public class TransportMean { private string _value; + /// + /// Create a new instance of TransportMean with a predefined value. + /// internal TransportMean() { _value = "ground"; diff --git a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs index ae16b84a..fbd6053e 100644 --- a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs @@ -34,16 +34,27 @@ public partial class UpdateAccountSettingsImageRequestBody [JsonConverter(typeof(ImageContentTypeEnumJsonConverter))] public class ImageContentTypeEnum { - private string _value; + private readonly string _value; + /// + /// Create a new instance of ImageContentTypeEnum with a predefined value. + /// internal ImageContentTypeEnum() { _value = "image/png"; } + /// + /// Create a new instance of ImageContentTypeEnum with a custom value. + /// + /// The value of the ImageContentTypeEnum + /// + /// 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 ImageContentTypeEnum(string value) { - + _value = value; } /// @@ -150,6 +161,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class UpdateAccountSettingsImageRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); @@ -157,6 +169,7 @@ public override string ToString() sb.Append(" ImageData: ").Append(ImageData).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs b/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs index ca0f0058..33b6f648 100644 --- a/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs @@ -44,7 +44,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class UpdateAmazonBuyShippingRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Email: ").Append(Email).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs index c94981c0..1f8eb40f 100644 --- a/ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs @@ -36,11 +36,10 @@ public partial class UpdateCarrierSettingsRequestBody : AbstractOpenAPISchema /// with the class /// /// An instance of UpdateDhlExpressSettingsRequestBody. - public UpdateCarrierSettingsRequestBody(UpdateDhlExpressSettingsRequestBody actualInstance) + public UpdateCarrierSettingsRequestBody(UpdateDhlExpressSettingsRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -48,11 +47,10 @@ public UpdateCarrierSettingsRequestBody(UpdateDhlExpressSettingsRequestBody actu /// with the class /// /// An instance of UpdateFedexSettingsRequestBody. - public UpdateCarrierSettingsRequestBody(UpdateFedexSettingsRequestBody actualInstance) + public UpdateCarrierSettingsRequestBody(UpdateFedexSettingsRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -60,11 +58,10 @@ public UpdateCarrierSettingsRequestBody(UpdateFedexSettingsRequestBody actualIns /// with the class /// /// An instance of UpdateNewgisticsSettingsRequestBody. - public UpdateCarrierSettingsRequestBody(UpdateNewgisticsSettingsRequestBody actualInstance) + public UpdateCarrierSettingsRequestBody(UpdateNewgisticsSettingsRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -72,11 +69,10 @@ public UpdateCarrierSettingsRequestBody(UpdateNewgisticsSettingsRequestBody actu /// with the class /// /// An instance of UpdateUpsSettingsRequestBody. - public UpdateCarrierSettingsRequestBody(UpdateUpsSettingsRequestBody actualInstance) + public UpdateCarrierSettingsRequestBody(UpdateUpsSettingsRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } /// @@ -84,11 +80,10 @@ public UpdateCarrierSettingsRequestBody(UpdateUpsSettingsRequestBody actualInsta /// with the class /// /// An instance of UpdateAmazonBuyShippingRequestBody. - public UpdateCarrierSettingsRequestBody(UpdateAmazonBuyShippingRequestBody actualInstance) + public UpdateCarrierSettingsRequestBody(UpdateAmazonBuyShippingRequestBody actualInstance) : base("oneOf") { this.IsNullable = false; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); + _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); } @@ -212,9 +207,9 @@ public override string ToJson() /// public class UpdateCarrierSettingsRequestBodyJsonConverter : JsonConverter { - private static HashSet OneOfTypes = [typeof(UpdateDhlExpressSettingsRequestBody), typeof(UpdateFedexSettingsRequestBody), typeof(UpdateNewgisticsSettingsRequestBody), typeof(UpdateUpsSettingsRequestBody), typeof(UpdateAmazonBuyShippingRequestBody)]; - private static HashSet MandatoryFields = []; - private static JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) + private static readonly HashSet OneOfTypes = [typeof(UpdateDhlExpressSettingsRequestBody), typeof(UpdateFedexSettingsRequestBody), typeof(UpdateNewgisticsSettingsRequestBody), typeof(UpdateUpsSettingsRequestBody), typeof(UpdateAmazonBuyShippingRequestBody)]; + private static readonly HashSet MandatoryFields = []; + private static readonly JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) { TypeInfoResolver = new DefaultJsonTypeInfoResolver { @@ -274,7 +269,7 @@ public override void Write(Utf8JsonWriter writer, UpdateCarrierSettingsRequestBo /// Object type to convert /// Serializer options /// The object converted from the JSON string - public override UpdateCarrierSettingsRequestBody Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override UpdateCarrierSettingsRequestBody? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { if (reader.TokenType == JsonTokenType.Null) { @@ -282,14 +277,14 @@ public override UpdateCarrierSettingsRequestBody Read(ref Utf8JsonReader reader, } var jsonDoc = JsonDocument.ParseValue(ref reader); - UpdateCarrierSettingsRequestBody newUpdateCarrierSettingsRequestBody = null; + UpdateCarrierSettingsRequestBody? newUpdateCarrierSettingsRequestBody = null; int match = 0; var matchedTypes = new List(); try { - newUpdateCarrierSettingsRequestBody = new UpdateCarrierSettingsRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newUpdateCarrierSettingsRequestBody = new UpdateCarrierSettingsRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("UpdateDhlExpressSettingsRequestBody"); match++; @@ -297,12 +292,12 @@ public override UpdateCarrierSettingsRequestBody Read(ref Utf8JsonReader reader, catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into UpdateDhlExpressSettingsRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into UpdateDhlExpressSettingsRequestBody: {1}", jsonDoc, exception); } try { - newUpdateCarrierSettingsRequestBody = new UpdateCarrierSettingsRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newUpdateCarrierSettingsRequestBody = new UpdateCarrierSettingsRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("UpdateFedexSettingsRequestBody"); match++; @@ -310,12 +305,12 @@ public override UpdateCarrierSettingsRequestBody Read(ref Utf8JsonReader reader, catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into UpdateFedexSettingsRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into UpdateFedexSettingsRequestBody: {1}", jsonDoc, exception); } try { - newUpdateCarrierSettingsRequestBody = new UpdateCarrierSettingsRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newUpdateCarrierSettingsRequestBody = new UpdateCarrierSettingsRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("UpdateNewgisticsSettingsRequestBody"); match++; @@ -323,12 +318,12 @@ public override UpdateCarrierSettingsRequestBody Read(ref Utf8JsonReader reader, catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into UpdateNewgisticsSettingsRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into UpdateNewgisticsSettingsRequestBody: {1}", jsonDoc, exception); } try { - newUpdateCarrierSettingsRequestBody = new UpdateCarrierSettingsRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newUpdateCarrierSettingsRequestBody = new UpdateCarrierSettingsRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("UpdateUpsSettingsRequestBody"); match++; @@ -336,12 +331,12 @@ public override UpdateCarrierSettingsRequestBody Read(ref Utf8JsonReader reader, catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into UpdateUpsSettingsRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into UpdateUpsSettingsRequestBody: {1}", jsonDoc, exception); } try { - newUpdateCarrierSettingsRequestBody = new UpdateCarrierSettingsRequestBody(JsonSerializer.Deserialize(jsonDoc, DeserializingOptions)); + newUpdateCarrierSettingsRequestBody = new UpdateCarrierSettingsRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); matchedTypes.Add("UpdateAmazonBuyShippingRequestBody"); match++; @@ -349,7 +344,7 @@ public override UpdateCarrierSettingsRequestBody Read(ref Utf8JsonReader reader, catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into UpdateAmazonBuyShippingRequestBody: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into UpdateAmazonBuyShippingRequestBody: {1}", jsonDoc, exception); } if (match == 0) diff --git a/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs index 81308538..76f92e98 100644 --- a/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs @@ -58,9 +58,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class UpdateDhlExpressSettingsRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" ShouldHideAccountNumberOnArchiveDoc: ").Append(ShouldHideAccountNumberOnArchiveDoc).Append("\n"); sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs index 0765d4b4..f6594704 100644 --- a/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs @@ -77,6 +77,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class UpdateFedexSettingsRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" PickupType: ").Append(PickupType).Append("\n"); sb.Append(" SmartPostHub: ").Append(SmartPostHub).Append("\n"); @@ -84,6 +85,7 @@ public override string ToString() sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); sb.Append(" SignatureImage: ").Append(SignatureImage).Append("\n"); sb.Append(" LetterheadImage: ").Append(LetterheadImage).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs index bfea3343..71555a9d 100644 --- a/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs @@ -49,8 +49,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class UpdateNewgisticsSettingsRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" IncludeBarcodeWithOrderNumber: ").Append(IncludeBarcodeWithOrderNumber).Append("\n"); sb.Append(" ReceiveEmailOnManifestProcessing: ").Append(ReceiveEmailOnManifestProcessing).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs b/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs index c8ab72cf..2a5e6db9 100644 --- a/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs +++ b/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs @@ -85,11 +85,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class UpdatePackageTypeRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" PackageId: ").Append(PackageId).Append("\n"); sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); sb.Append(" Description: ").Append(Description).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/UpdateShipmentFields.cs b/ShipEngineSDK/Model/UpdateShipmentFields.cs index 72d03bc7..86a5aa38 100644 --- a/ShipEngineSDK/Model/UpdateShipmentFields.cs +++ b/ShipEngineSDK/Model/UpdateShipmentFields.cs @@ -42,7 +42,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class UpdateShipmentFields {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs b/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs index 7d2d35a6..85187327 100644 --- a/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs @@ -254,6 +254,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class UpdateShipmentRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); @@ -282,6 +283,7 @@ public override string ToString() sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs b/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs index d1aa48ce..f103d3bb 100644 --- a/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs @@ -286,6 +286,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class UpdateShipmentResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); @@ -315,6 +316,7 @@ public override string ToString() sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); sb.Append(" AddressValidation: ").Append(AddressValidation).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/UpdateShipmentsTags.cs b/ShipEngineSDK/Model/UpdateShipmentsTags.cs index e9eb0faf..92f96d2c 100644 --- a/ShipEngineSDK/Model/UpdateShipmentsTags.cs +++ b/ShipEngineSDK/Model/UpdateShipmentsTags.cs @@ -43,7 +43,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class UpdateShipmentsTags {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentsTags: ").Append(ShipmentsTags).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs b/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs index 24851e44..6b90c526 100644 --- a/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs @@ -43,7 +43,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class UpdateShipmentsTagsRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentsTags: ").Append(ShipmentsTags).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs b/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs index 08be40b3..57a04740 100644 --- a/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs +++ b/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs @@ -49,8 +49,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class UpdateShipmentsTagsShipmentsTagsInner {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); sb.Append(" Tags: ").Append(Tags).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs index bd3eaa94..96e93d6d 100644 --- a/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs @@ -117,6 +117,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class UpdateUpsSettingsRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); sb.Append(" PickupType: ").Append(PickupType).Append("\n"); @@ -129,6 +130,7 @@ public override string ToString() sb.Append(" UseNegotiatedRates: ").Append(UseNegotiatedRates).Append("\n"); sb.Append(" AccountPostalCode: ").Append(AccountPostalCode).Append("\n"); sb.Append(" Invoice: ").Append(Invoice).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs b/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs index 92b72d2f..91e53b12 100644 --- a/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs @@ -90,12 +90,14 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class UpdateWarehouseRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" OriginAddress: ").Append(OriginAddress).Append("\n"); sb.Append(" ReturnAddress: ").Append(ReturnAddress).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/UpdateWarehouseSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateWarehouseSettingsRequestBody.cs index 7e26ceaf..80991e43 100644 --- a/ShipEngineSDK/Model/UpdateWarehouseSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateWarehouseSettingsRequestBody.cs @@ -47,7 +47,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class UpdateWarehouseSettingsRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs b/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs index d235ab7e..1451803d 100644 --- a/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs @@ -54,8 +54,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class UpdateWebhookRequestBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Url: ").Append(Url).Append("\n"); sb.Append(" Headers: ").Append(Headers).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/UpsAccountSettings.cs b/ShipEngineSDK/Model/UpsAccountSettings.cs index 61799b90..050afe89 100644 --- a/ShipEngineSDK/Model/UpsAccountSettings.cs +++ b/ShipEngineSDK/Model/UpsAccountSettings.cs @@ -117,6 +117,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class UpsAccountSettings {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); sb.Append(" PickupType: ").Append(PickupType).Append("\n"); @@ -129,6 +130,7 @@ public override string ToString() sb.Append(" UseNegotiatedRates: ").Append(UseNegotiatedRates).Append("\n"); sb.Append(" AccountPostalCode: ").Append(AccountPostalCode).Append("\n"); sb.Append(" Invoice: ").Append(Invoice).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/UpsInvoice.cs b/ShipEngineSDK/Model/UpsInvoice.cs index cd084f33..18b96736 100644 --- a/ShipEngineSDK/Model/UpsInvoice.cs +++ b/ShipEngineSDK/Model/UpsInvoice.cs @@ -73,11 +73,13 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class UpsInvoice {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" InvoiceDate: ").Append(InvoiceDate).Append("\n"); sb.Append(" InvoiceNumber: ").Append(InvoiceNumber).Append("\n"); sb.Append(" ControlId: ").Append(ControlId).Append("\n"); sb.Append(" InvoiceAmount: ").Append(InvoiceAmount).Append("\n"); sb.Append(" InvoiceCurrencyCode: ").Append(InvoiceCurrencyCode).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/UpsPickupType.cs b/ShipEngineSDK/Model/UpsPickupType.cs index 1630109f..0ffd2552 100644 --- a/ShipEngineSDK/Model/UpsPickupType.cs +++ b/ShipEngineSDK/Model/UpsPickupType.cs @@ -31,6 +31,9 @@ public class UpsPickupType { private string _value; + /// + /// Create a new instance of UpsPickupType with a predefined value. + /// internal UpsPickupType() { _value = "daily_pickup"; diff --git a/ShipEngineSDK/Model/UpsSettingsResponseBody.cs b/ShipEngineSDK/Model/UpsSettingsResponseBody.cs index 04d85955..e0747409 100644 --- a/ShipEngineSDK/Model/UpsSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/UpsSettingsResponseBody.cs @@ -117,6 +117,7 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class UpsSettingsResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); sb.Append(" PickupType: ").Append(PickupType).Append("\n"); @@ -129,6 +130,7 @@ public override string ToString() sb.Append(" UseNegotiatedRates: ").Append(UseNegotiatedRates).Append("\n"); sb.Append(" AccountPostalCode: ").Append(AccountPostalCode).Append("\n"); sb.Append(" Invoice: ").Append(Invoice).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ValidateAddress.cs b/ShipEngineSDK/Model/ValidateAddress.cs index 554c7669..86e08df6 100644 --- a/ShipEngineSDK/Model/ValidateAddress.cs +++ b/ShipEngineSDK/Model/ValidateAddress.cs @@ -31,6 +31,9 @@ public class ValidateAddress { private string _value; + /// + /// Create a new instance of ValidateAddress with a predefined value. + /// internal ValidateAddress() { _value = "no_validation"; diff --git a/ShipEngineSDK/Model/ValidateShipmentFields.cs b/ShipEngineSDK/Model/ValidateShipmentFields.cs index 2a94351f..63d1af98 100644 --- a/ShipEngineSDK/Model/ValidateShipmentFields.cs +++ b/ShipEngineSDK/Model/ValidateShipmentFields.cs @@ -42,7 +42,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ValidateShipmentFields {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/ValidationStatus.cs b/ShipEngineSDK/Model/ValidationStatus.cs index 823c662c..a200085a 100644 --- a/ShipEngineSDK/Model/ValidationStatus.cs +++ b/ShipEngineSDK/Model/ValidationStatus.cs @@ -31,6 +31,9 @@ public class ValidationStatus { private string _value; + /// + /// Create a new instance of ValidationStatus with a predefined value. + /// internal ValidationStatus() { _value = "valid"; diff --git a/ShipEngineSDK/Model/VoidLabelResponseBody.cs b/ShipEngineSDK/Model/VoidLabelResponseBody.cs index 19cd0c68..64133641 100644 --- a/ShipEngineSDK/Model/VoidLabelResponseBody.cs +++ b/ShipEngineSDK/Model/VoidLabelResponseBody.cs @@ -64,9 +64,11 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class VoidLabelResponseBody {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Approved: ").Append(Approved).Append("\n"); sb.Append(" Message: ").Append(Message).Append("\n"); sb.Append(" ReasonCode: ").Append(ReasonCode).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/Warehouse.cs b/ShipEngineSDK/Model/Warehouse.cs index 5e6a7e11..49882090 100644 --- a/ShipEngineSDK/Model/Warehouse.cs +++ b/ShipEngineSDK/Model/Warehouse.cs @@ -88,12 +88,14 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class Warehouse {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" OriginAddress: ").Append(OriginAddress).Append("\n"); sb.Append(" ReturnAddress: ").Append(ReturnAddress).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/Webhook.cs b/ShipEngineSDK/Model/Webhook.cs index 332caec7..1b59b2a2 100644 --- a/ShipEngineSDK/Model/Webhook.cs +++ b/ShipEngineSDK/Model/Webhook.cs @@ -69,10 +69,12 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class Webhook {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" WebhookId: ").Append(WebhookId).Append("\n"); sb.Append(" Url: ").Append(Url).Append("\n"); sb.Append(" Event: ").Append(Event).Append("\n"); sb.Append(" Headers: ").Append(Headers).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/WebhookEvent.cs b/ShipEngineSDK/Model/WebhookEvent.cs index 1d2bab65..9ad63533 100644 --- a/ShipEngineSDK/Model/WebhookEvent.cs +++ b/ShipEngineSDK/Model/WebhookEvent.cs @@ -31,6 +31,9 @@ public class WebhookEvent { private string _value; + /// + /// Create a new instance of WebhookEvent with a predefined value. + /// internal WebhookEvent() { _value = "batch"; diff --git a/ShipEngineSDK/Model/WebhookHeader.cs b/ShipEngineSDK/Model/WebhookHeader.cs index ba941082..99e950ad 100644 --- a/ShipEngineSDK/Model/WebhookHeader.cs +++ b/ShipEngineSDK/Model/WebhookHeader.cs @@ -59,8 +59,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class WebhookHeader {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Key: ").Append(Key).Append("\n"); sb.Append(" Value: ").Append(Value).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/Weight.cs b/ShipEngineSDK/Model/Weight.cs index fe137a24..b0cf4a8a 100644 --- a/ShipEngineSDK/Model/Weight.cs +++ b/ShipEngineSDK/Model/Weight.cs @@ -53,8 +53,10 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class Weight {\n"); +#pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Value: ").Append(Value).Append("\n"); sb.Append(" Unit: ").Append(Unit).Append("\n"); +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/WeightUnit.cs b/ShipEngineSDK/Model/WeightUnit.cs index 1117bc9e..3c9d9055 100644 --- a/ShipEngineSDK/Model/WeightUnit.cs +++ b/ShipEngineSDK/Model/WeightUnit.cs @@ -31,6 +31,9 @@ public class WeightUnit { private string _value; + /// + /// Create a new instance of WeightUnit with a predefined value. + /// internal WeightUnit() { _value = "pound"; diff --git a/generation/templates/AbstractOpenAPISchema.mustache b/generation/templates/AbstractOpenAPISchema.mustache index 3c299cab..5a617983 100644 --- a/generation/templates/AbstractOpenAPISchema.mustache +++ b/generation/templates/AbstractOpenAPISchema.mustache @@ -21,6 +21,14 @@ namespace {{packageName}}.{{modelPackage}}; DictionaryKeyPolicy = JsonNamingPolicy.SnakeCaseLower }; + /// + /// Constructor + /// + protected AbstractOpenAPISchema(string schemaType) + { + SchemaType = schemaType; + } + /// /// Gets or Sets the actual instance /// diff --git a/generation/templates/modelEnum.mustache b/generation/templates/modelEnum.mustache index 2a2137a1..8f62a096 100644 --- a/generation/templates/modelEnum.mustache +++ b/generation/templates/modelEnum.mustache @@ -9,6 +9,9 @@ { private string _value; + /// + /// Create a new instance of {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} with a predefined value. + /// {{#allowableValues}} {{#enumVars}} {{#-first}} diff --git a/generation/templates/modelGeneric.mustache b/generation/templates/modelGeneric.mustache index beb447d2..bd7bed15 100644 --- a/generation/templates/modelGeneric.mustache +++ b/generation/templates/modelGeneric.mustache @@ -124,6 +124,7 @@ { StringBuilder sb = new StringBuilder(); sb.Append("class {{classname}} {\n"); +#pragma warning disable CS0612 // Type or member is obsolete {{#parent}} sb.Append(" ").Append(base.ToString().Replace("\n", "\n ")).Append("\n"); {{/parent}} @@ -133,6 +134,7 @@ {{#isAdditionalPropertiesTrue}} sb.Append(" AdditionalProperties: ").Append(AdditionalProperties).Append("\n"); {{/isAdditionalPropertiesTrue}} +#pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); } diff --git a/generation/templates/modelInnerEnum.mustache b/generation/templates/modelInnerEnum.mustache index 80ff29b1..03b785de 100644 --- a/generation/templates/modelInnerEnum.mustache +++ b/generation/templates/modelInnerEnum.mustache @@ -8,11 +8,14 @@ [JsonConverter(typeof({{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}JsonConverter))] {{>visibility}} class {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} { - private string _value; + private readonly string _value; {{#allowableValues}} {{#enumVars}} {{#-first}} + /// + /// Create a new instance of {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} with a predefined value. + /// internal {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}() { _value = "{{value}}"; @@ -21,9 +24,17 @@ {{/enumVars}} {{/allowableValues}} + /// + /// Create a new instance of {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} with a custom value. + /// + /// The value of the {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} + /// + /// 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 {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}(string value) { - + _value = value; } {{#allowableValues}} diff --git a/generation/templates/modelOneOf.mustache b/generation/templates/modelOneOf.mustache index 826a46e7..f0fb399c 100644 --- a/generation/templates/modelOneOf.mustache +++ b/generation/templates/modelOneOf.mustache @@ -104,11 +104,10 @@ /// with the class /// /// An instance of {{dataType}}. - public {{classname}}({{{dataType}}} actualInstance) + public {{classname}}({{{dataType}}} actualInstance) : base("oneOf") { this.IsNullable = {{#model.isNullable}}true{{/model.isNullable}}{{^model.isNullable}}false{{/model.isNullable}}; - this.SchemaType = "oneOf"; - this.ActualInstance = actualInstance{{^model.isNullable}}{{^isPrimitiveType}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isPrimitiveType}}{{#isPrimitiveType}}{{#isArray}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isArray}}{{/isPrimitiveType}}{{#isPrimitiveType}}{{#isFreeFormObject}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isFreeFormObject}}{{/isPrimitiveType}}{{#isPrimitiveType}}{{#isString}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isString}}{{/isPrimitiveType}}{{/model.isNullable}}; + _actualInstance = actualInstance{{^model.isNullable}}{{^isPrimitiveType}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isPrimitiveType}}{{#isPrimitiveType}}{{#isArray}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isArray}}{{/isPrimitiveType}}{{#isPrimitiveType}}{{#isFreeFormObject}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isFreeFormObject}}{{/isPrimitiveType}}{{#isPrimitiveType}}{{#isString}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isString}}{{/isPrimitiveType}}{{/model.isNullable}}; } {{/isNull}} @@ -253,9 +252,9 @@ /// public class {{classname}}JsonConverter : JsonConverter<{{classname}}> { - private static HashSet OneOfTypes = [{{#composedSchemas.oneOf}}typeof({{{dataType}}}){{^-last}}, {{/-last}}{{/composedSchemas.oneOf}}]; - private static HashSet MandatoryFields = [{{#allMandatory}}"{{.}}"{{^-last}}, {{/-last}}{{/allMandatory}}]; - private static JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) + private static readonly HashSet OneOfTypes = [{{#composedSchemas.oneOf}}typeof({{{dataType}}}){{^-last}}, {{/-last}}{{/composedSchemas.oneOf}}]; + private static readonly HashSet MandatoryFields = [{{#allMandatory}}"{{.}}"{{^-last}}, {{/-last}}{{/allMandatory}}]; + private static readonly JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) { TypeInfoResolver = new DefaultJsonTypeInfoResolver { @@ -321,7 +320,7 @@ public class {{classname}}JsonConverter : JsonConverter<{{classname}}> /// Object type to convert /// Serializer options /// The object converted from the JSON string - public override {{classname}} Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + public override {{classname}}? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { if (reader.TokenType == JsonTokenType.Null) { @@ -329,7 +328,7 @@ public class {{classname}}JsonConverter : JsonConverter<{{classname}}> } var jsonDoc = JsonDocument.ParseValue(ref reader); - {{classname}} new{{classname}} = null; + {{classname}}? new{{classname}} = null; int match = 0; var matchedTypes = new List(); @@ -337,7 +336,7 @@ public class {{classname}}JsonConverter : JsonConverter<{{classname}}> try { - new{{classname}} = new {{classname}}(JsonSerializer.Deserialize<{{{dataType}}}>(jsonDoc, DeserializingOptions)); + new{{classname}} = new {{classname}}(jsonDoc.Deserialize<{{{dataType}}}>(DeserializingOptions)!); matchedTypes.Add("{{{dataType}}}"); match++; @@ -345,7 +344,7 @@ public class {{classname}}JsonConverter : JsonConverter<{{classname}}> catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine(string.Format("Failed to deserialize `{0}` into {{{dataType}}}: {1}", jsonDoc, exception.ToString())); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into {{{dataType}}}: {1}", jsonDoc, exception); } {{/composedSchemas.oneOf}} @@ -361,7 +360,7 @@ public class {{classname}}JsonConverter : JsonConverter<{{classname}}> {{#composedSchemas.allOf}} {{#allVars}} - new{{classname}}.{{name}} = JsonSerializer.Deserialize<{{#isEnum}}{{{complexType}}}{{^complexType}}{{{datatypeWithEnum}}}{{/complexType}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}>(jsonDoc.RootElement.GetProperty("{{baseName}}"), DeserializingOptions); + new{{classname}}!.{{name}} = jsonDoc.RootElement.GetProperty("{{baseName}}").Deserialize<{{#isEnum}}{{{complexType}}}{{^complexType}}{{{datatypeWithEnum}}}{{/complexType}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}>(DeserializingOptions)!; {{/allVars}} {{/composedSchemas.allOf}} From f05bd4af7ef77d0f693e739ac6ad0643207f15f3 Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Tue, 16 Jul 2024 16:12:46 -0500 Subject: [PATCH 06/42] Mark non-required types as nullable --- .openapi-generator-ignore | 5 +- .openapi-generator/FILES | 1 - ShipEngineSDK/Api/AccountApi.cs | 30 +- ShipEngineSDK/Api/BatchesApi.cs | 166 ++++---- ShipEngineSDK/Api/CarrierAccountsApi.cs | 48 ++- ShipEngineSDK/Api/CarriersApi.cs | 30 +- ShipEngineSDK/Api/DownloadsApi.cs | 26 +- ShipEngineSDK/Api/LabelsApi.cs | 164 ++++---- ShipEngineSDK/Api/ManifestsApi.cs | 42 +- ShipEngineSDK/Api/PackagePickupsApi.cs | 42 +- ShipEngineSDK/Api/PackageTypesApi.cs | 30 +- ShipEngineSDK/Api/ShipmentsApi.cs | 136 +++---- ShipEngineSDK/Api/TokensApi.cs | 8 +- ShipEngineSDK/Api/TrackingApi.cs | 24 +- ShipEngineSDK/Api/WarehousesApi.cs | 60 +-- ShipEngineSDK/Api/WebhooksApi.cs | 30 +- ShipEngineSDK/Model/AccountSettingsImages.cs | 58 +-- .../Model/AddFundsToCarrierRequestBody.cs | 18 +- .../Model/AddFundsToInsuranceRequestBody.cs | 18 +- .../Model/AddFundsToInsuranceResponseBody.cs | 18 +- ShipEngineSDK/Model/AddToBatchRequestBody.cs | 18 +- ShipEngineSDK/Model/Address.cs | 128 +++--- ShipEngineSDK/Model/AddressToValidate.cs | 126 +++--- .../Model/AddressValidatingShipment.cs | 246 ++++++------ .../Model/AddressValidationResult.cs | 20 +- .../Model/AdvancedShipmentOptions.cs | 158 ++++---- ...cedShipmentOptionsDangerousGoodsContact.cs | 4 +- .../AdvancedShipmentOptionsFedexFreight.cs | 14 +- ShipEngineSDK/Model/AlternativeIdentifier.cs | 4 +- ShipEngineSDK/Model/AlternativeIdentifiers.cs | 2 +- ShipEngineSDK/Model/Batch.cs | 190 ++++----- ShipEngineSDK/Model/BatchResponseError.cs | 20 +- ShipEngineSDK/Model/BulkRate.cs | 42 +- .../Model/CalculateRatesRequestBody.cs | 2 +- .../Model/CalculateRatesResponseBody.cs | 294 +++++++------- ShipEngineSDK/Model/Carrier.cs | 136 +++---- ShipEngineSDK/Model/CarrierAdvancedOption.cs | 26 +- ShipEngineSDK/Model/CollectOnDelivery.cs | 4 +- .../ConnectAccessWorldwideRequestBody.cs | 18 +- .../ConnectAmazonBuyShippingRequestBody.cs | 24 +- .../Model/ConnectAmazonShippingUk.cs | 18 +- ShipEngineSDK/Model/ConnectApcRequestBody.cs | 22 +- .../Model/ConnectAsendiaRequestBody.cs | 34 +- .../Model/ConnectCanadaPostRequestBody.cs | 28 +- .../Model/ConnectDhlEcommerceRequestBody.cs | 94 ++--- .../Model/ConnectDhlExpressAuRequestBody.cs | 18 +- .../Model/ConnectDhlExpressCaRequestBody.cs | 18 +- .../Model/ConnectDhlExpressRequestBody.cs | 46 +-- .../Model/ConnectDhlExpressUkRequestBody.cs | 26 +- ShipEngineSDK/Model/ConnectDpdRequestBody.cs | 18 +- .../Model/ConnectEndiciaRequestBody.cs | 18 +- .../Model/ConnectFedexRequestBody.cs | 52 +-- .../Model/ConnectFedexUkRequestBody.cs | 52 +-- .../Model/ConnectFirstmileRequestBody.cs | 28 +- ShipEngineSDK/Model/ConnectImexRequestBody.cs | 18 +- .../Model/ConnectLasershipRequestBody.cs | 236 +++++------ .../Model/ConnectNewgisticsRequestBody.cs | 32 +- .../Model/ConnectOntracRequestBody.cs | 18 +- .../Model/ConnectRoyalMailRequestBody.cs | 104 ++--- .../Model/ConnectRrDonnelleyRequestBody.cs | 18 +- ShipEngineSDK/Model/ConnectSekoRequestBody.cs | 18 +- .../Model/ConnectSendleRequestBody.cs | 18 +- .../Model/ConnectStampsRequestBody.cs | 18 +- ShipEngineSDK/Model/ConnectUpsRequestBody.cs | 18 +- ShipEngineSDK/Model/ContactDetails.cs | 16 +- .../CreateAccountSettingsImageRequestBody.cs | 50 +-- .../Model/CreateAndProcessBatchRequestBody.cs | 42 +- ...AndProcessBatchRequestBodyProcessLabels.cs | 24 +- .../Model/CreateAndValidateShipment.cs | 270 ++++++------- ShipEngineSDK/Model/CreateBatchRequestBody.cs | 36 +- .../Model/CreateBatchResponseBody.cs | 190 ++++----- .../Model/CreateLabelFromRateRequestBody.cs | 34 +- .../Model/CreateLabelFromRateResponseBody.cs | 346 ++++++++-------- .../CreateLabelFromShipmentRequestBody.cs | 34 +- .../CreateLabelFromShipmentResponseBody.cs | 346 ++++++++-------- ShipEngineSDK/Model/CreateLabelRequestBody.cs | 376 +++++++++--------- .../Model/CreateLabelResponseBody.cs | 350 ++++++++-------- .../CreateManifestByObjectRequestBody.cs | 42 +- .../Model/CreateManifestResponseBody.cs | 136 +++---- .../Model/CreatePackageTypeRequestBody.cs | 38 +- .../Model/CreatePackageTypeResponseBody.cs | 38 +- .../Model/CreateReturnLabelRequestBody.cs | 34 +- .../Model/CreateReturnLabelResponseBody.cs | 346 ++++++++-------- .../Model/CreateShipmentResponseBodyFields.cs | 18 +- .../Model/CreateShipmentsResponseBody.cs | 18 +- .../Model/CreateWarehouseRequestBody.cs | 54 +-- .../Model/CreateWarehouseResponseBody.cs | 52 +-- .../Model/CreateWebhookRequestBody.cs | 2 +- .../Model/CreateWebhookResponseBody.cs | 26 +- ShipEngineSDK/Model/CustomsItem.cs | 100 ++--- ShipEngineSDK/Model/DangerousAmount.cs | 4 +- ShipEngineSDK/Model/DangerousGoods.cs | 136 +++---- .../Model/DeletePickupByIdResponseBody.cs | 24 +- ShipEngineSDK/Model/DeprecatedManifest.cs | 98 ++--- .../Model/DhlExpressAccountSettings.cs | 20 +- .../Model/DhlExpressSettingsResponseBody.cs | 20 +- ShipEngineSDK/Model/Dimensions.cs | 18 +- ShipEngineSDK/Model/Error.cs | 18 +- ShipEngineSDK/Model/ErrorResponseBody.cs | 18 +- .../Model/ErrorWithLabelIdResponseBody.cs | 18 +- .../Model/EstimateRatesRequestBody.cs | 108 ++--- ShipEngineSDK/Model/FedexAccountSettings.cs | 42 +- .../Model/FedexAccountSettingsRequestBody.cs | 42 +- .../Model/FedexSettingsResponseBody.cs | 42 +- .../GetAccountSettingsImagesResponseBody.cs | 58 +-- .../Model/GetBatchByExternalIdResponseBody.cs | 190 ++++----- .../Model/GetBatchByIdResponseBody.cs | 190 ++++----- .../Model/GetCarrierByIdResponseBody.cs | 136 +++---- .../Model/GetCarrierOptionsResponseBody.cs | 2 +- .../Model/GetCarriersResponseBody.cs | 18 +- .../Model/GetInsuranceBalanceResponseBody.cs | 18 +- ...etLabelByExternalShipmentIdResponseBody.cs | 346 ++++++++-------- .../Model/GetLabelByIdResponseBody.cs | 346 ++++++++-------- .../Model/GetManifestByIdResponseBody.cs | 90 ++--- .../Model/GetPackageTypeByIdResponseBody.cs | 38 +- .../Model/GetPickupByIdResponseBody.cs | 140 +++---- ShipEngineSDK/Model/GetPickupsResponseBody.cs | 46 +-- .../Model/GetRateByIdResponseBody.cs | 258 ++++++------ .../Model/GetServicePointByIdResponseBody.cs | 2 +- ...ervicePointByIdResponseBodyServicePoint.cs | 142 +++---- .../Model/GetServicePointsRequestBody.cs | 58 +-- .../GetServicePointsRequestBodyAddress.cs | 44 +- ...tServicePointsRequestBodyProvidersInner.cs | 4 +- .../GetServicePointsRequestBodyShipment.cs | 2 +- .../GetShipmentByExternalIdResponseBody.cs | 266 ++++++------- .../Model/GetShipmentByIdResponseBody.cs | 266 ++++++------- .../GetTrackingLogFromLabelResponseBody.cs | 142 +++---- .../Model/GetTrackingLogResponseBody.cs | 136 +++---- .../Model/GetWarehouseByIdResponseBody.cs | 52 +-- .../Model/GetWebhookByIdResponseBody.cs | 26 +- ShipEngineSDK/Model/ImporterOfRecords.cs | 114 +++--- .../Model/InternationalShipmentOptions.cs | 36 +- .../Model/InvoiceAdditionalDetails.cs | 24 +- ShipEngineSDK/Model/Label.cs | 346 ++++++++-------- ShipEngineSDK/Model/LabelDownload.cs | 8 +- ShipEngineSDK/Model/LabelPackagesInner.cs | 140 +++---- ShipEngineSDK/Model/Link.cs | 2 +- .../Model/ListAccountImagesResponseBody.cs | 24 +- .../ListAccountSettingsImagesResponseBody.cs | 24 +- .../Model/ListBatchesResponseBody.cs | 24 +- .../ListCarrierPackageTypesResponseBody.cs | 2 +- .../Model/ListCarrierServicesResponseBody.cs | 2 +- ShipEngineSDK/Model/ListLabelsResponseBody.cs | 24 +- .../Model/ListManifestsResponseBody.cs | 34 +- .../Model/ListPackageTypesResponseBody.cs | 2 +- ShipEngineSDK/Model/ListPickupResponseBody.cs | 44 +- .../Model/ListServicePointsResponseBody.cs | 22 +- ...icePointsResponseBodyServicePointsInner.cs | 156 ++++---- ...eBodyServicePointsInnerHoursOfOperation.cs | 48 +-- ...ePointsInnerHoursOfOperationMondayInner.cs | 22 +- .../Model/ListShipmentRatesResponseBody.cs | 50 +-- .../Model/ListShipmentsResponseBody.cs | 42 +- ShipEngineSDK/Model/ListTagsResponseBody.cs | 2 +- ShipEngineSDK/Model/Manifest.cs | 92 ++--- ShipEngineSDK/Model/ManifestDownload.cs | 2 +- ShipEngineSDK/Model/ManifestRequest.cs | 2 +- ShipEngineSDK/Model/Manifests.cs | 2 +- ShipEngineSDK/Model/ManifestsRequests.cs | 2 +- ShipEngineSDK/Model/ModifyBatch.cs | 18 +- ShipEngineSDK/Model/MonetaryValue.cs | 18 +- ShipEngineSDK/Model/OptionalLink.cs | 4 +- ShipEngineSDK/Model/Package.cs | 130 +++--- ShipEngineSDK/Model/PackageType.cs | 38 +- ShipEngineSDK/Model/PagedListResponseBody.cs | 24 +- ShipEngineSDK/Model/PaginationLink.cs | 18 +- ShipEngineSDK/Model/PaperlessDownload.cs | 20 +- .../Model/ParseAddressRequestBody.cs | 2 +- .../Model/ParseAddressResponseBody.cs | 18 +- .../Model/ParseShipmentRequestBody.cs | 2 +- .../Model/ParseShipmentResponseBody.cs | 18 +- ShipEngineSDK/Model/PartialAddress.cs | 116 +++--- ShipEngineSDK/Model/PartialShipment.cs | 238 +++++------ ShipEngineSDK/Model/PartialShippingAddress.cs | 2 +- .../Model/PartialShippingAddressTo.cs | 16 +- ...artialShippingAddressToGeolocationInner.cs | 2 +- ShipEngineSDK/Model/PaymentAmount.cs | 16 +- ShipEngineSDK/Model/Pickup.cs | 94 ++--- ShipEngineSDK/Model/PickupResponseBody.cs | 102 ++--- ShipEngineSDK/Model/PickupWindow.cs | 10 +- ShipEngineSDK/Model/PickupWindows.cs | 10 +- .../Model/ProcessBatchRequestBody.cs | 22 +- ShipEngineSDK/Model/Products.cs | 104 ++--- .../Model/PurchaseLabelWithoutShipment.cs | 34 +- ShipEngineSDK/Model/Rate.cs | 258 ++++++------ ShipEngineSDK/Model/RateEstimate.cs | 232 +++++------ .../Model/RateEstimateByCarrierId.cs | 2 +- .../Model/RateEstimateByCarrierIds.cs | 2 +- ShipEngineSDK/Model/RateEstimateOptions.cs | 100 ++--- ShipEngineSDK/Model/RateRequestBody.cs | 36 +- ShipEngineSDK/Model/RateRequestOptions.cs | 2 +- ShipEngineSDK/Model/RateRequestRateOptions.cs | 2 +- ShipEngineSDK/Model/RateResponse.cs | 2 +- ShipEngineSDK/Model/RatesInformation.cs | 52 +-- ShipEngineSDK/Model/RecognizedEntity.cs | 40 +- .../Model/RemoveFromBatchRequestBody.cs | 18 +- .../Model/SchedulePickupRequestBody.cs | 82 ++-- .../Model/SchedulePickupResponseBody.cs | 110 ++--- ShipEngineSDK/Model/Service.cs | 64 +-- ShipEngineSDK/Model/Shipment.cs | 266 ++++++------- ShipEngineSDK/Model/ShipmentIdRequest.cs | 2 +- ShipEngineSDK/Model/ShipmentItem.cs | 80 ++-- ShipEngineSDK/Model/ShipmentRequest.cs | 2 +- ShipEngineSDK/Model/ShippingAddress.cs | 130 +++--- ShipEngineSDK/Model/ShippingAddressTo.cs | 138 +++---- ShipEngineSDK/Model/TaxIdentifier.cs | 14 +- ...TokensGetEphemeralTokenResponseBodyYaml.cs | 18 +- ShipEngineSDK/Model/TrackEvent.cs | 160 ++++---- ShipEngineSDK/Model/TrackingInformation.cs | 126 +++--- .../UpdateAccountSettingsImageRequestBody.cs | 60 +-- .../UpdateAmazonBuyShippingRequestBody.cs | 2 +- .../UpdateDhlExpressSettingsRequestBody.cs | 20 +- .../Model/UpdateFedexSettingsRequestBody.cs | 42 +- .../UpdateNewgisticsSettingsRequestBody.cs | 4 +- .../Model/UpdatePackageTypeRequestBody.cs | 38 +- .../Model/UpdateShipmentRequestBody.cs | 246 ++++++------ .../Model/UpdateShipmentResponseBody.cs | 294 +++++++------- ShipEngineSDK/Model/UpdateShipmentsTags.cs | 2 +- .../Model/UpdateShipmentsTagsRequestBody.cs | 2 +- .../UpdateShipmentsTagsShipmentsTagsInner.cs | 4 +- .../Model/UpdateUpsSettingsRequestBody.cs | 94 ++--- .../Model/UpdateWarehouseRequestBody.cs | 54 +-- .../Model/UpdateWebhookRequestBody.cs | 18 +- ShipEngineSDK/Model/UpsAccountSettings.cs | 94 ++--- ShipEngineSDK/Model/UpsInvoice.cs | 38 +- .../Model/UpsSettingsResponseBody.cs | 94 ++--- ShipEngineSDK/Model/Warehouse.cs | 40 +- ShipEngineSDK/Model/Webhook.cs | 28 +- ShipEngineSDK/Model/Weight.cs | 2 +- generation/swagger.json | 44 +- generation/templates/modelGeneric.mustache | 2 +- generation/templates/modelOneOf.mustache | 2 +- openapitools.json | 4 +- 232 files changed, 7802 insertions(+), 7774 deletions(-) diff --git a/.openapi-generator-ignore b/.openapi-generator-ignore index 52e2ea1c..36141c71 100644 --- a/.openapi-generator-ignore +++ b/.openapi-generator-ignore @@ -26,11 +26,14 @@ **/*.csproj appveyor.yml git_push.sh +ShipEngineSDK/Api/IApi.cs ShipEngineSDK/Client/*.cs +ShipEngineSDK/Extensions/*.cs # We should re-enable these eventually README.md -docs/*.md +*/README.md +docs/**/* ShipEngineSDK.Test/*/*.cs api/** .gitignore diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index b2ccc123..687f2d8b 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -17,7 +17,6 @@ ShipEngineSDK/Api/TokensApi.cs ShipEngineSDK/Api/TrackingApi.cs ShipEngineSDK/Api/WarehousesApi.cs ShipEngineSDK/Api/WebhooksApi.cs -ShipEngineSDK/Model/AbstractOpenAPISchema.cs ShipEngineSDK/Model/AccountSettings.cs ShipEngineSDK/Model/AccountSettingsImages.cs ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs diff --git a/ShipEngineSDK/Api/AccountApi.cs b/ShipEngineSDK/Api/AccountApi.cs index 82029f36..777b3b51 100644 --- a/ShipEngineSDK/Api/AccountApi.cs +++ b/ShipEngineSDK/Api/AccountApi.cs @@ -132,11 +132,11 @@ public partial interface IShipEngine /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Label Image Id /// + /// Label Image Id /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task UpdateAccountSettingsImagesById(string labelImageId, UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, CancellationToken cancellationToken = default); + Task UpdateAccountSettingsImagesById(UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, string labelImageId, CancellationToken cancellationToken = default); /// /// Update Account Image By ID Update information for an account image. @@ -144,11 +144,11 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Label Image Id /// + /// Label Image Id /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task UpdateAccountSettingsImagesById(HttpClient methodClient, string labelImageId, UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, CancellationToken cancellationToken = default); + Task UpdateAccountSettingsImagesById(HttpClient methodClient, UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, string labelImageId, CancellationToken cancellationToken = default); } @@ -354,13 +354,13 @@ public async Task ListAccountSettings(HttpClient /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Label Image Id /// + /// Label Image Id /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public Task UpdateAccountSettingsImagesById(string labelImageId, UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, CancellationToken cancellationToken = default) + public Task UpdateAccountSettingsImagesById(UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, string labelImageId, CancellationToken cancellationToken = default) { - return UpdateAccountSettingsImagesById(_client, labelImageId, updateAccountSettingsImageRequestBody, cancellationToken); + return UpdateAccountSettingsImagesById(_client, updateAccountSettingsImageRequestBody, labelImageId, cancellationToken); } /// @@ -369,24 +369,24 @@ public Task UpdateAccountSettingsImagesById(string labelImageId, UpdateA /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Label Image Id /// + /// Label Image Id /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public async Task UpdateAccountSettingsImagesById(HttpClient methodClient, string labelImageId, UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, CancellationToken cancellationToken = default) + public async Task UpdateAccountSettingsImagesById(HttpClient methodClient, UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, string labelImageId, CancellationToken cancellationToken = default) { - // verify the required parameter 'labelImageId' is set - if (labelImageId == null) - { - throw new ArgumentNullException(nameof(labelImageId)); - } - // verify the required parameter 'updateAccountSettingsImageRequestBody' is set if (updateAccountSettingsImageRequestBody == null) { throw new ArgumentNullException(nameof(updateAccountSettingsImageRequestBody)); } + // verify the required parameter 'labelImageId' is set + if (labelImageId == null) + { + throw new ArgumentNullException(nameof(labelImageId)); + } + RequestOptions requestOptions = new("/v1/account/settings/images/{label_image_id}"); diff --git a/ShipEngineSDK/Api/BatchesApi.cs b/ShipEngineSDK/Api/BatchesApi.cs index 40fe8a35..948fbabd 100644 --- a/ShipEngineSDK/Api/BatchesApi.cs +++ b/ShipEngineSDK/Api/BatchesApi.cs @@ -31,11 +31,11 @@ public partial interface IShipEngine /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Batch ID /// + /// Batch ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task AddToBatch(string batchId, AddToBatchRequestBody addToBatchRequestBody, CancellationToken cancellationToken = default); + Task AddToBatch(AddToBatchRequestBody addToBatchRequestBody, string batchId, CancellationToken cancellationToken = default); /// /// Add to a Batch Add a Shipment or Rate to a Batch @@ -43,11 +43,11 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Batch ID /// + /// Batch ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task AddToBatch(HttpClient methodClient, string batchId, AddToBatchRequestBody addToBatchRequestBody, CancellationToken cancellationToken = default); + Task AddToBatch(HttpClient methodClient, AddToBatchRequestBody addToBatchRequestBody, string batchId, CancellationToken cancellationToken = default); /// /// Create A Batch Create a Batch @@ -139,11 +139,11 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// Batch ID - /// 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) /// (optional) + /// 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) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchErrorsResponseBody) - Task ListBatchErrors(string batchId, int? page, int? pagesize, CancellationToken cancellationToken = default); + Task ListBatchErrors(string batchId, int pagesize, int page, CancellationToken cancellationToken = default); /// /// Get Batch Errors Error handling in batches are handled differently than in a single synchronous request. You must retrieve the status of your batch by [getting a batch](https://www.shipengine.com/docs/reference/get-batch-by-id/) and getting an overview of the statuses or you can list errors directly here below to get detailed information about the errors. @@ -152,11 +152,11 @@ public partial interface IShipEngine /// Thrown when fails to make API call /// HttpClient to use for the request /// Batch ID - /// 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) /// (optional) + /// 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) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchErrorsResponseBody) - Task ListBatchErrors(HttpClient methodClient, string batchId, int? page, int? pagesize, CancellationToken cancellationToken = default); + Task ListBatchErrors(HttpClient methodClient, string batchId, int pagesize, int page, CancellationToken cancellationToken = default); /// /// List Batches List Batches associated with your Shipengine account @@ -164,14 +164,14 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// (optional) - /// 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) - /// The number of results to return per response. (optional, default to 25) + /// (optional) /// Controls the sort order of the query. (optional) /// Batch Number (optional) - /// (optional) + /// 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) + /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchesResponseBody) - Task ListBatches(BatchStatus? status, int? page, int? pageSize, SortDir? sortDir, string? batchNumber, BatchesSortBy? sortBy, CancellationToken cancellationToken = default); + Task ListBatches(BatchStatus status, BatchesSortBy sortBy, SortDir sortDir, string batchNumber, int page, int pageSize, CancellationToken cancellationToken = default); /// /// List Batches List Batches associated with your Shipengine account @@ -180,25 +180,25 @@ public partial interface IShipEngine /// Thrown when fails to make API call /// HttpClient to use for the request /// (optional) - /// 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) - /// The number of results to return per response. (optional, default to 25) + /// (optional) /// Controls the sort order of the query. (optional) /// Batch Number (optional) - /// (optional) + /// 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) + /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchesResponseBody) - Task ListBatches(HttpClient methodClient, BatchStatus? status, int? page, int? pageSize, SortDir? sortDir, string? batchNumber, BatchesSortBy? sortBy, CancellationToken cancellationToken = default); + Task ListBatches(HttpClient methodClient, BatchStatus status, BatchesSortBy sortBy, SortDir sortDir, string batchNumber, int page, int pageSize, CancellationToken cancellationToken = default); /// /// Process Batch ID Labels Process Batch ID Labels /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Batch ID /// + /// Batch ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task ProcessBatch(string batchId, ProcessBatchRequestBody processBatchRequestBody, CancellationToken cancellationToken = default); + Task ProcessBatch(ProcessBatchRequestBody processBatchRequestBody, string batchId, CancellationToken cancellationToken = default); /// /// Process Batch ID Labels Process Batch ID Labels @@ -206,22 +206,22 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Batch ID /// + /// Batch ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task ProcessBatch(HttpClient methodClient, string batchId, ProcessBatchRequestBody processBatchRequestBody, CancellationToken cancellationToken = default); + Task ProcessBatch(HttpClient methodClient, ProcessBatchRequestBody processBatchRequestBody, string batchId, CancellationToken cancellationToken = default); /// /// Remove From Batch Remove a shipment or rate from a batch /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Batch ID /// + /// Batch ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task RemoveFromBatch(string batchId, RemoveFromBatchRequestBody removeFromBatchRequestBody, CancellationToken cancellationToken = default); + Task RemoveFromBatch(RemoveFromBatchRequestBody removeFromBatchRequestBody, string batchId, CancellationToken cancellationToken = default); /// /// Remove From Batch Remove a shipment or rate from a batch @@ -229,11 +229,11 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Batch ID /// + /// Batch ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task RemoveFromBatch(HttpClient methodClient, string batchId, RemoveFromBatchRequestBody removeFromBatchRequestBody, CancellationToken cancellationToken = default); + Task RemoveFromBatch(HttpClient methodClient, RemoveFromBatchRequestBody removeFromBatchRequestBody, string batchId, CancellationToken cancellationToken = default); /// /// Update Batch By Id Update Batch By Id @@ -268,13 +268,13 @@ public partial class ShipEngine /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Batch ID /// + /// Batch ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public Task AddToBatch(string batchId, AddToBatchRequestBody addToBatchRequestBody, CancellationToken cancellationToken = default) + public Task AddToBatch(AddToBatchRequestBody addToBatchRequestBody, string batchId, CancellationToken cancellationToken = default) { - return AddToBatch(_client, batchId, addToBatchRequestBody, cancellationToken); + return AddToBatch(_client, addToBatchRequestBody, batchId, cancellationToken); } /// @@ -283,24 +283,24 @@ public Task AddToBatch(string batchId, AddToBatchRequestBody addToBatchR /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Batch ID /// + /// Batch ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public async Task AddToBatch(HttpClient methodClient, string batchId, AddToBatchRequestBody addToBatchRequestBody, CancellationToken cancellationToken = default) + public async Task AddToBatch(HttpClient methodClient, AddToBatchRequestBody addToBatchRequestBody, string batchId, CancellationToken cancellationToken = default) { - // verify the required parameter 'batchId' is set - if (batchId == null) - { - throw new ArgumentNullException(nameof(batchId)); - } - // verify the required parameter 'addToBatchRequestBody' is set if (addToBatchRequestBody == null) { throw new ArgumentNullException(nameof(addToBatchRequestBody)); } + // verify the required parameter 'batchId' is set + if (batchId == null) + { + throw new ArgumentNullException(nameof(batchId)); + } + RequestOptions requestOptions = new("/v1/batches/{batch_id}/add"); @@ -488,13 +488,13 @@ public async Task GetBatchById(HttpClient methodClient /// Thrown when required argument is null /// Thrown when fails to make API call /// Batch ID - /// 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) /// (optional) + /// 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) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchErrorsResponseBody) - public Task ListBatchErrors(string batchId, int? page = default, int? pagesize = default, CancellationToken cancellationToken = default) + public Task ListBatchErrors(string batchId, int pagesize = default, int page = default, CancellationToken cancellationToken = default) { - return ListBatchErrors(_client, batchId, page, pagesize, cancellationToken); + return ListBatchErrors(_client, batchId, pagesize, page, cancellationToken); } /// @@ -504,11 +504,11 @@ public Task ListBatchErrors(string batchId, int? pa /// Thrown when fails to make API call /// HttpClient to use for the request /// Batch ID - /// 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) /// (optional) + /// 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) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchErrorsResponseBody) - public async Task ListBatchErrors(HttpClient methodClient, string batchId, int? page = default, int? pagesize = default, CancellationToken cancellationToken = default) + public async Task ListBatchErrors(HttpClient methodClient, string batchId, int pagesize = default, int page = default, CancellationToken cancellationToken = default) { // verify the required parameter 'batchId' is set if (batchId == null) @@ -520,14 +520,14 @@ public async Task ListBatchErrors(HttpClient method RequestOptions requestOptions = new("/v1/batches/{batch_id}/errors"); requestOptions.PathParameters.Add("batch_id", ShipEngineSDK.ClientUtils.ParameterToString(batchId)); // path parameter - if (page != null) - { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page", page)); - } if (pagesize != null) { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "pagesize", pagesize)); } + if (page != null) + { + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page", page)); + } requestOptions.Operation = "BatchesApi.ListBatchErrors"; @@ -542,16 +542,16 @@ public async Task ListBatchErrors(HttpClient method /// Thrown when required argument is null /// Thrown when fails to make API call /// (optional) - /// 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) - /// The number of results to return per response. (optional, default to 25) + /// (optional) /// Controls the sort order of the query. (optional) /// Batch Number (optional) - /// (optional) + /// 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) + /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchesResponseBody) - public Task ListBatches(BatchStatus? status = default, int? page = default, int? pageSize = default, SortDir? sortDir = default, string? batchNumber = default, BatchesSortBy? sortBy = default, CancellationToken cancellationToken = default) + public Task ListBatches(BatchStatus status = default, BatchesSortBy sortBy = default, SortDir sortDir = default, string batchNumber = default, int page = default, int pageSize = default, CancellationToken cancellationToken = default) { - return ListBatches(_client, status, page, pageSize, sortDir, batchNumber, sortBy, cancellationToken); + return ListBatches(_client, status, sortBy, sortDir, batchNumber, page, pageSize, cancellationToken); } /// @@ -561,14 +561,14 @@ public Task ListBatches(BatchStatus? status = default, /// Thrown when fails to make API call /// HttpClient to use for the request /// (optional) - /// 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) - /// The number of results to return per response. (optional, default to 25) + /// (optional) /// Controls the sort order of the query. (optional) /// Batch Number (optional) - /// (optional) + /// 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) + /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchesResponseBody) - public async Task ListBatches(HttpClient methodClient, BatchStatus? status = default, int? page = default, int? pageSize = default, SortDir? sortDir = default, string? batchNumber = default, BatchesSortBy? sortBy = default, CancellationToken cancellationToken = default) + public async Task ListBatches(HttpClient methodClient, BatchStatus status = default, BatchesSortBy sortBy = default, SortDir sortDir = default, string batchNumber = default, int page = default, int pageSize = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/batches"); @@ -577,13 +577,9 @@ public async Task ListBatches(HttpClient methodClient, { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "status", status)); } - if (page != null) - { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page", page)); - } - if (pageSize != null) + if (sortBy != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page_size", pageSize)); + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "sort_by", sortBy)); } if (sortDir != null) { @@ -593,9 +589,13 @@ public async Task ListBatches(HttpClient methodClient, { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "batch_number", batchNumber)); } - if (sortBy != null) + if (page != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "sort_by", sortBy)); + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page", page)); + } + if (pageSize != null) + { + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page_size", pageSize)); } requestOptions.Operation = "BatchesApi.ListBatches"; @@ -610,13 +610,13 @@ public async Task ListBatches(HttpClient methodClient, /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Batch ID /// + /// Batch ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public Task ProcessBatch(string batchId, ProcessBatchRequestBody processBatchRequestBody, CancellationToken cancellationToken = default) + public Task ProcessBatch(ProcessBatchRequestBody processBatchRequestBody, string batchId, CancellationToken cancellationToken = default) { - return ProcessBatch(_client, batchId, processBatchRequestBody, cancellationToken); + return ProcessBatch(_client, processBatchRequestBody, batchId, cancellationToken); } /// @@ -625,24 +625,24 @@ public Task ProcessBatch(string batchId, ProcessBatchRequestBody process /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Batch ID /// + /// Batch ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public async Task ProcessBatch(HttpClient methodClient, string batchId, ProcessBatchRequestBody processBatchRequestBody, CancellationToken cancellationToken = default) + public async Task ProcessBatch(HttpClient methodClient, ProcessBatchRequestBody processBatchRequestBody, string batchId, CancellationToken cancellationToken = default) { - // verify the required parameter 'batchId' is set - if (batchId == null) - { - throw new ArgumentNullException(nameof(batchId)); - } - // verify the required parameter 'processBatchRequestBody' is set if (processBatchRequestBody == null) { throw new ArgumentNullException(nameof(processBatchRequestBody)); } + // verify the required parameter 'batchId' is set + if (batchId == null) + { + throw new ArgumentNullException(nameof(batchId)); + } + RequestOptions requestOptions = new("/v1/batches/{batch_id}/process/labels"); @@ -661,13 +661,13 @@ public async Task ProcessBatch(HttpClient methodClient, string batchId, /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Batch ID /// + /// Batch ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public Task RemoveFromBatch(string batchId, RemoveFromBatchRequestBody removeFromBatchRequestBody, CancellationToken cancellationToken = default) + public Task RemoveFromBatch(RemoveFromBatchRequestBody removeFromBatchRequestBody, string batchId, CancellationToken cancellationToken = default) { - return RemoveFromBatch(_client, batchId, removeFromBatchRequestBody, cancellationToken); + return RemoveFromBatch(_client, removeFromBatchRequestBody, batchId, cancellationToken); } /// @@ -676,24 +676,24 @@ public Task RemoveFromBatch(string batchId, RemoveFromBatchRequestBody r /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Batch ID /// + /// Batch ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public async Task RemoveFromBatch(HttpClient methodClient, string batchId, RemoveFromBatchRequestBody removeFromBatchRequestBody, CancellationToken cancellationToken = default) + public async Task RemoveFromBatch(HttpClient methodClient, RemoveFromBatchRequestBody removeFromBatchRequestBody, string batchId, CancellationToken cancellationToken = default) { - // verify the required parameter 'batchId' is set - if (batchId == null) - { - throw new ArgumentNullException(nameof(batchId)); - } - // verify the required parameter 'removeFromBatchRequestBody' is set if (removeFromBatchRequestBody == null) { throw new ArgumentNullException(nameof(removeFromBatchRequestBody)); } + // verify the required parameter 'batchId' is set + if (batchId == null) + { + throw new ArgumentNullException(nameof(batchId)); + } + RequestOptions requestOptions = new("/v1/batches/{batch_id}/remove"); diff --git a/ShipEngineSDK/Api/CarrierAccountsApi.cs b/ShipEngineSDK/Api/CarrierAccountsApi.cs index b3dcd874..308a5001 100644 --- a/ShipEngineSDK/Api/CarrierAccountsApi.cs +++ b/ShipEngineSDK/Api/CarrierAccountsApi.cs @@ -101,11 +101,11 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// The carrier name, such as `ups`, `fedex`, or `dhl_express`. - /// Carrier ID /// + /// Carrier ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task UpdateCarrierSettings(CarrierNameWithSettings carrierName, string carrierId, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, CancellationToken cancellationToken = default); + Task UpdateCarrierSettings(CarrierNameWithSettings carrierName, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, string carrierId, CancellationToken cancellationToken = default); /// /// Update carrier settings Update carrier settings @@ -114,11 +114,11 @@ public partial interface IShipEngine /// Thrown when fails to make API call /// HttpClient to use for the request /// The carrier name, such as `ups`, `fedex`, or `dhl_express`. - /// Carrier ID /// + /// Carrier ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task UpdateCarrierSettings(HttpClient methodClient, CarrierNameWithSettings carrierName, string carrierId, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, CancellationToken cancellationToken = default); + Task UpdateCarrierSettings(HttpClient methodClient, CarrierNameWithSettings carrierName, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, string carrierId, CancellationToken cancellationToken = default); } @@ -153,6 +153,12 @@ public Task ConnectCarrier(CarrierName carrierName, /// Task of ApiResponse (ConnectCarrierResponseBody) public async Task ConnectCarrier(HttpClient methodClient, CarrierName carrierName, ConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default) { + // verify the required parameter 'carrierName' is set + if (carrierName == null) + { + throw new ArgumentNullException(nameof(carrierName)); + } + // verify the required parameter 'connectCarrierRequestBody' is set if (connectCarrierRequestBody == null) { @@ -198,6 +204,12 @@ public Task DisconnectCarrier(CarrierName carrierName, string carrierId, /// Task of ApiResponse (string) public async Task DisconnectCarrier(HttpClient methodClient, CarrierName carrierName, string carrierId, CancellationToken cancellationToken = default) { + // verify the required parameter 'carrierName' is set + if (carrierName == null) + { + throw new ArgumentNullException(nameof(carrierName)); + } + // verify the required parameter 'carrierId' is set if (carrierId == null) { @@ -243,6 +255,12 @@ public Task GetCarrierSettings(CarrierNameWithSe /// Task of ApiResponse (GetCarrierSettingsResponseBody) public async Task GetCarrierSettings(HttpClient methodClient, CarrierNameWithSettings carrierName, string carrierId, CancellationToken cancellationToken = default) { + // verify the required parameter 'carrierName' is set + if (carrierName == null) + { + throw new ArgumentNullException(nameof(carrierName)); + } + // verify the required parameter 'carrierId' is set if (carrierId == null) { @@ -268,13 +286,13 @@ public async Task GetCarrierSettings(HttpClient /// Thrown when required argument is null /// Thrown when fails to make API call /// The carrier name, such as `ups`, `fedex`, or `dhl_express`. - /// Carrier ID /// + /// Carrier ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public Task UpdateCarrierSettings(CarrierNameWithSettings carrierName, string carrierId, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, CancellationToken cancellationToken = default) + public Task UpdateCarrierSettings(CarrierNameWithSettings carrierName, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, string carrierId, CancellationToken cancellationToken = default) { - return UpdateCarrierSettings(_client, carrierName, carrierId, updateCarrierSettingsRequestBody, cancellationToken); + return UpdateCarrierSettings(_client, carrierName, updateCarrierSettingsRequestBody, carrierId, cancellationToken); } /// @@ -284,16 +302,16 @@ public Task UpdateCarrierSettings(CarrierNameWithSettings carrierName, s /// Thrown when fails to make API call /// HttpClient to use for the request /// The carrier name, such as `ups`, `fedex`, or `dhl_express`. - /// Carrier ID /// + /// Carrier ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public async Task UpdateCarrierSettings(HttpClient methodClient, CarrierNameWithSettings carrierName, string carrierId, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, CancellationToken cancellationToken = default) + public async Task UpdateCarrierSettings(HttpClient methodClient, CarrierNameWithSettings carrierName, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, string carrierId, CancellationToken cancellationToken = default) { - // verify the required parameter 'carrierId' is set - if (carrierId == null) + // verify the required parameter 'carrierName' is set + if (carrierName == null) { - throw new ArgumentNullException(nameof(carrierId)); + throw new ArgumentNullException(nameof(carrierName)); } // verify the required parameter 'updateCarrierSettingsRequestBody' is set @@ -302,6 +320,12 @@ public async Task UpdateCarrierSettings(HttpClient methodClient, Carrier throw new ArgumentNullException(nameof(updateCarrierSettingsRequestBody)); } + // verify the required parameter 'carrierId' is set + if (carrierId == null) + { + throw new ArgumentNullException(nameof(carrierId)); + } + RequestOptions requestOptions = new("/v1/connections/carriers/{carrier_name}/{carrier_id}/settings"); diff --git a/ShipEngineSDK/Api/CarriersApi.cs b/ShipEngineSDK/Api/CarriersApi.cs index b1bdd096..c90da671 100644 --- a/ShipEngineSDK/Api/CarriersApi.cs +++ b/ShipEngineSDK/Api/CarriersApi.cs @@ -31,11 +31,11 @@ public partial interface IShipEngine /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Carrier ID /// + /// Carrier ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (AddFundsToCarrierResponseBody) - Task AddFundsToCarrier(string carrierId, AddFundsToCarrierRequestBody addFundsToCarrierRequestBody, CancellationToken cancellationToken = default); + Task AddFundsToCarrier(AddFundsToCarrierRequestBody addFundsToCarrierRequestBody, string carrierId, CancellationToken cancellationToken = default); /// /// Add Funds To Carrier Add Funds To A Carrier @@ -43,11 +43,11 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Carrier ID /// + /// Carrier ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (AddFundsToCarrierResponseBody) - Task AddFundsToCarrier(HttpClient methodClient, string carrierId, AddFundsToCarrierRequestBody addFundsToCarrierRequestBody, CancellationToken cancellationToken = default); + Task AddFundsToCarrier(HttpClient methodClient, AddFundsToCarrierRequestBody addFundsToCarrierRequestBody, string carrierId, CancellationToken cancellationToken = default); /// /// Disconnect Carrier by ID Disconnect a Carrier of the given ID from the account @@ -185,13 +185,13 @@ public partial class ShipEngine /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Carrier ID /// + /// Carrier ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (AddFundsToCarrierResponseBody) - public Task AddFundsToCarrier(string carrierId, AddFundsToCarrierRequestBody addFundsToCarrierRequestBody, CancellationToken cancellationToken = default) + public Task AddFundsToCarrier(AddFundsToCarrierRequestBody addFundsToCarrierRequestBody, string carrierId, CancellationToken cancellationToken = default) { - return AddFundsToCarrier(_client, carrierId, addFundsToCarrierRequestBody, cancellationToken); + return AddFundsToCarrier(_client, addFundsToCarrierRequestBody, carrierId, cancellationToken); } /// @@ -200,24 +200,24 @@ public Task AddFundsToCarrier(string carrierId, A /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Carrier ID /// + /// Carrier ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (AddFundsToCarrierResponseBody) - public async Task AddFundsToCarrier(HttpClient methodClient, string carrierId, AddFundsToCarrierRequestBody addFundsToCarrierRequestBody, CancellationToken cancellationToken = default) + public async Task AddFundsToCarrier(HttpClient methodClient, AddFundsToCarrierRequestBody addFundsToCarrierRequestBody, string carrierId, CancellationToken cancellationToken = default) { - // verify the required parameter 'carrierId' is set - if (carrierId == null) - { - throw new ArgumentNullException(nameof(carrierId)); - } - // verify the required parameter 'addFundsToCarrierRequestBody' is set if (addFundsToCarrierRequestBody == null) { throw new ArgumentNullException(nameof(addFundsToCarrierRequestBody)); } + // verify the required parameter 'carrierId' is set + if (carrierId == null) + { + throw new ArgumentNullException(nameof(carrierId)); + } + RequestOptions requestOptions = new("/v1/carriers/{carrier_id}/add_funds"); diff --git a/ShipEngineSDK/Api/DownloadsApi.cs b/ShipEngineSDK/Api/DownloadsApi.cs index b200c5cc..874704e8 100644 --- a/ShipEngineSDK/Api/DownloadsApi.cs +++ b/ShipEngineSDK/Api/DownloadsApi.cs @@ -34,11 +34,11 @@ public partial interface IShipEngine /// /// /// - /// (optional) /// (optional) + /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (System.IO.Stream) - Task DownloadFile(string subdir, string filename, string dir, string? download, int? rotation, CancellationToken cancellationToken = default); + Task DownloadFile(string subdir, string filename, string dir, int rotation, string download, CancellationToken cancellationToken = default); /// /// Download File Get File @@ -49,11 +49,11 @@ public partial interface IShipEngine /// /// /// - /// (optional) /// (optional) + /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (System.IO.Stream) - Task DownloadFile(HttpClient methodClient, string subdir, string filename, string dir, string? download, int? rotation, CancellationToken cancellationToken = default); + Task DownloadFile(HttpClient methodClient, string subdir, string filename, string dir, int rotation, string download, CancellationToken cancellationToken = default); } @@ -70,13 +70,13 @@ public partial class ShipEngine /// /// /// - /// (optional) /// (optional) + /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (System.IO.Stream) - public Task DownloadFile(string subdir, string filename, string dir, string? download = default, int? rotation = default, CancellationToken cancellationToken = default) + public Task DownloadFile(string subdir, string filename, string dir, int rotation = default, string download = default, CancellationToken cancellationToken = default) { - return DownloadFile(_client, subdir, filename, dir, download, rotation, cancellationToken); + return DownloadFile(_client, subdir, filename, dir, rotation, download, cancellationToken); } /// @@ -88,11 +88,11 @@ public partial class ShipEngine /// /// /// - /// (optional) /// (optional) + /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (System.IO.Stream) - public async Task DownloadFile(HttpClient methodClient, string subdir, string filename, string dir, string? download = default, int? rotation = default, CancellationToken cancellationToken = default) + public async Task DownloadFile(HttpClient methodClient, string subdir, string filename, string dir, int rotation = default, string download = default, CancellationToken cancellationToken = default) { // verify the required parameter 'subdir' is set if (subdir == null) @@ -118,14 +118,14 @@ public partial class ShipEngine requestOptions.PathParameters.Add("subdir", ShipEngineSDK.ClientUtils.ParameterToString(subdir)); // path parameter requestOptions.PathParameters.Add("filename", ShipEngineSDK.ClientUtils.ParameterToString(filename)); // path parameter requestOptions.PathParameters.Add("dir", ShipEngineSDK.ClientUtils.ParameterToString(dir)); // path parameter - if (download != null) - { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "download", download)); - } if (rotation != null) { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "rotation", rotation)); } + if (download != null) + { + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "download", download)); + } requestOptions.Operation = "DownloadsApi.DownloadFile"; diff --git a/ShipEngineSDK/Api/LabelsApi.cs b/ShipEngineSDK/Api/LabelsApi.cs index 5610ca2c..96002097 100644 --- a/ShipEngineSDK/Api/LabelsApi.cs +++ b/ShipEngineSDK/Api/LabelsApi.cs @@ -52,11 +52,11 @@ public partial interface IShipEngine /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Rate ID /// + /// Rate ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (CreateLabelFromRateResponseBody) - Task CreateLabelFromRate(string rateId, CreateLabelFromRateRequestBody createLabelFromRateRequestBody, CancellationToken cancellationToken = default); + Task CreateLabelFromRate(CreateLabelFromRateRequestBody createLabelFromRateRequestBody, string rateId, CancellationToken cancellationToken = default); /// /// Purchase Label with Rate ID When retrieving rates for shipments using the `/rates` endpoint, the returned information contains a `rate_id` property that can be used to generate a label without having to refill in the shipment information repeatedly. @@ -64,22 +64,22 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Rate ID /// + /// Rate ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (CreateLabelFromRateResponseBody) - Task CreateLabelFromRate(HttpClient methodClient, string rateId, CreateLabelFromRateRequestBody createLabelFromRateRequestBody, CancellationToken cancellationToken = default); + Task CreateLabelFromRate(HttpClient methodClient, CreateLabelFromRateRequestBody createLabelFromRateRequestBody, string rateId, CancellationToken cancellationToken = default); /// /// Purchase Label with Shipment ID Purchase a label using a shipment ID that has already been created with the desired address and package info. /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Shipment ID /// + /// Shipment ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (CreateLabelFromShipmentResponseBody) - Task CreateLabelFromShipment(string shipmentId, CreateLabelFromShipmentRequestBody createLabelFromShipmentRequestBody, CancellationToken cancellationToken = default); + Task CreateLabelFromShipment(CreateLabelFromShipmentRequestBody createLabelFromShipmentRequestBody, string shipmentId, CancellationToken cancellationToken = default); /// /// Purchase Label with Shipment ID Purchase a label using a shipment ID that has already been created with the desired address and package info. @@ -87,22 +87,22 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Shipment ID /// + /// Shipment ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (CreateLabelFromShipmentResponseBody) - Task CreateLabelFromShipment(HttpClient methodClient, string shipmentId, CreateLabelFromShipmentRequestBody createLabelFromShipmentRequestBody, CancellationToken cancellationToken = default); + Task CreateLabelFromShipment(HttpClient methodClient, CreateLabelFromShipmentRequestBody createLabelFromShipmentRequestBody, string shipmentId, CancellationToken cancellationToken = default); /// /// Create a return label Create a return label /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Label ID /// + /// Label ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (CreateReturnLabelResponseBody) - Task CreateReturnLabel(string labelId, CreateReturnLabelRequestBody createReturnLabelRequestBody, CancellationToken cancellationToken = default); + Task CreateReturnLabel(CreateReturnLabelRequestBody createReturnLabelRequestBody, string labelId, CancellationToken cancellationToken = default); /// /// Create a return label Create a return label @@ -110,11 +110,11 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Label ID /// + /// Label ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (CreateReturnLabelResponseBody) - Task CreateReturnLabel(HttpClient methodClient, string labelId, CreateReturnLabelRequestBody createReturnLabelRequestBody, CancellationToken cancellationToken = default); + Task CreateReturnLabel(HttpClient methodClient, CreateReturnLabelRequestBody createReturnLabelRequestBody, string labelId, CancellationToken cancellationToken = default); /// /// Get Label By External Shipment ID Find a label by using the external shipment id that was used during label creation @@ -125,7 +125,7 @@ public partial interface IShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetLabelByExternalShipmentIdResponseBody) - Task GetLabelByExternalShipmentId(string externalShipmentId, LabelDownloadType? labelDownloadType, CancellationToken cancellationToken = default); + Task GetLabelByExternalShipmentId(string externalShipmentId, LabelDownloadType labelDownloadType, CancellationToken cancellationToken = default); /// /// Get Label By External Shipment ID Find a label by using the external shipment id that was used during label creation @@ -137,7 +137,7 @@ public partial interface IShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetLabelByExternalShipmentIdResponseBody) - Task GetLabelByExternalShipmentId(HttpClient methodClient, string externalShipmentId, LabelDownloadType? labelDownloadType, CancellationToken cancellationToken = default); + Task GetLabelByExternalShipmentId(HttpClient methodClient, string externalShipmentId, LabelDownloadType labelDownloadType, CancellationToken cancellationToken = default); /// /// Get Label By ID Retrieve information for individual labels. @@ -148,7 +148,7 @@ public partial interface IShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetLabelByIdResponseBody) - Task GetLabelById(string labelId, LabelDownloadType? labelDownloadType, CancellationToken cancellationToken = default); + Task GetLabelById(string labelId, LabelDownloadType labelDownloadType, CancellationToken cancellationToken = default); /// /// Get Label By ID Retrieve information for individual labels. @@ -160,7 +160,7 @@ public partial interface IShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetLabelByIdResponseBody) - Task GetLabelById(HttpClient methodClient, string labelId, LabelDownloadType? labelDownloadType, CancellationToken cancellationToken = default); + Task GetLabelById(HttpClient methodClient, string labelId, LabelDownloadType labelDownloadType, CancellationToken cancellationToken = default); /// /// Get Label Tracking Information Retrieve the label's tracking information @@ -188,7 +188,10 @@ public partial interface IShipEngine /// /// Thrown when required argument is null /// Thrown when fails to make API call + /// Only return labels that were created on or after a specific date/time (optional) + /// Only return labels that were created on or before a specific date/time (optional) /// Only return labels that are currently in the specified status (optional) + /// Controls the sort order of the query. (optional) /// Only return labels for a specific [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) (optional) /// Only return labels for a specific [carrier account](https://www.shipengine.com/docs/carriers/setup/) (optional) /// Only return labels with a specific tracking number (optional) @@ -196,15 +199,12 @@ public partial interface IShipEngine /// Rate ID (optional) /// Shipment ID (optional) /// Only return labels that originate from a specific [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) (optional) - /// Only return labels that were created on or after a specific date/time (optional) - /// Only return labels that were created on or before a specific date/time (optional) /// 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) /// The number of results to return per response. (optional, default to 25) - /// Controls the sort order of the query. (optional) /// Controls which field the query is sorted by. (optional, default to created_at) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListLabelsResponseBody) - Task ListLabels(LabelStatus? labelStatus, string? serviceCode, string? carrierId, string? trackingNumber, string? batchId, string? rateId, string? shipmentId, string? warehouseId, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, int? page, int? pageSize, SortDir? sortDir, string? sortBy, CancellationToken cancellationToken = default); + Task ListLabels(DateTimeOffset createdAtStart, DateTimeOffset createdAtEnd, LabelStatus labelStatus, SortDir sortDir, string serviceCode, string carrierId, string trackingNumber, string batchId, string rateId, string shipmentId, string warehouseId, int page, int pageSize, string sortBy, CancellationToken cancellationToken = default); /// /// List labels This endpoint returns a list of labels that you've [created](https://www.shipengine.com/docs/labels/create-a-label/). You can optionally filter the results as well as control their sort order and the number of results returned at a time. By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want to get your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id` @@ -212,7 +212,10 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request + /// Only return labels that were created on or after a specific date/time (optional) + /// Only return labels that were created on or before a specific date/time (optional) /// Only return labels that are currently in the specified status (optional) + /// Controls the sort order of the query. (optional) /// Only return labels for a specific [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) (optional) /// Only return labels for a specific [carrier account](https://www.shipengine.com/docs/carriers/setup/) (optional) /// Only return labels with a specific tracking number (optional) @@ -220,15 +223,12 @@ public partial interface IShipEngine /// Rate ID (optional) /// Shipment ID (optional) /// Only return labels that originate from a specific [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) (optional) - /// Only return labels that were created on or after a specific date/time (optional) - /// Only return labels that were created on or before a specific date/time (optional) /// 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) /// The number of results to return per response. (optional, default to 25) - /// Controls the sort order of the query. (optional) /// Controls which field the query is sorted by. (optional, default to created_at) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListLabelsResponseBody) - Task ListLabels(HttpClient methodClient, LabelStatus? labelStatus, string? serviceCode, string? carrierId, string? trackingNumber, string? batchId, string? rateId, string? shipmentId, string? warehouseId, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, int? page, int? pageSize, SortDir? sortDir, string? sortBy, CancellationToken cancellationToken = default); + Task ListLabels(HttpClient methodClient, DateTimeOffset createdAtStart, DateTimeOffset createdAtEnd, LabelStatus labelStatus, SortDir sortDir, string serviceCode, string carrierId, string trackingNumber, string batchId, string rateId, string shipmentId, string warehouseId, int page, int pageSize, string sortBy, CancellationToken cancellationToken = default); /// /// Void a Label By ID Void a label by ID to get a refund. @@ -305,13 +305,13 @@ public async Task CreateLabel(HttpClient methodClient, /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Rate ID /// + /// Rate ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (CreateLabelFromRateResponseBody) - public Task CreateLabelFromRate(string rateId, CreateLabelFromRateRequestBody createLabelFromRateRequestBody, CancellationToken cancellationToken = default) + public Task CreateLabelFromRate(CreateLabelFromRateRequestBody createLabelFromRateRequestBody, string rateId, CancellationToken cancellationToken = default) { - return CreateLabelFromRate(_client, rateId, createLabelFromRateRequestBody, cancellationToken); + return CreateLabelFromRate(_client, createLabelFromRateRequestBody, rateId, cancellationToken); } /// @@ -320,24 +320,24 @@ public Task CreateLabelFromRate(string rateId, /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Rate ID /// + /// Rate ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (CreateLabelFromRateResponseBody) - public async Task CreateLabelFromRate(HttpClient methodClient, string rateId, CreateLabelFromRateRequestBody createLabelFromRateRequestBody, CancellationToken cancellationToken = default) + public async Task CreateLabelFromRate(HttpClient methodClient, CreateLabelFromRateRequestBody createLabelFromRateRequestBody, string rateId, CancellationToken cancellationToken = default) { - // verify the required parameter 'rateId' is set - if (rateId == null) - { - throw new ArgumentNullException(nameof(rateId)); - } - // verify the required parameter 'createLabelFromRateRequestBody' is set if (createLabelFromRateRequestBody == null) { throw new ArgumentNullException(nameof(createLabelFromRateRequestBody)); } + // verify the required parameter 'rateId' is set + if (rateId == null) + { + throw new ArgumentNullException(nameof(rateId)); + } + RequestOptions requestOptions = new("/v1/labels/rates/{rate_id}"); @@ -356,13 +356,13 @@ public async Task CreateLabelFromRate(HttpClien /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Shipment ID /// + /// Shipment ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (CreateLabelFromShipmentResponseBody) - public Task CreateLabelFromShipment(string shipmentId, CreateLabelFromShipmentRequestBody createLabelFromShipmentRequestBody, CancellationToken cancellationToken = default) + public Task CreateLabelFromShipment(CreateLabelFromShipmentRequestBody createLabelFromShipmentRequestBody, string shipmentId, CancellationToken cancellationToken = default) { - return CreateLabelFromShipment(_client, shipmentId, createLabelFromShipmentRequestBody, cancellationToken); + return CreateLabelFromShipment(_client, createLabelFromShipmentRequestBody, shipmentId, cancellationToken); } /// @@ -371,24 +371,24 @@ public Task CreateLabelFromShipment(string /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Shipment ID /// + /// Shipment ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (CreateLabelFromShipmentResponseBody) - public async Task CreateLabelFromShipment(HttpClient methodClient, string shipmentId, CreateLabelFromShipmentRequestBody createLabelFromShipmentRequestBody, CancellationToken cancellationToken = default) + public async Task CreateLabelFromShipment(HttpClient methodClient, CreateLabelFromShipmentRequestBody createLabelFromShipmentRequestBody, string shipmentId, CancellationToken cancellationToken = default) { - // verify the required parameter 'shipmentId' is set - if (shipmentId == null) - { - throw new ArgumentNullException(nameof(shipmentId)); - } - // verify the required parameter 'createLabelFromShipmentRequestBody' is set if (createLabelFromShipmentRequestBody == null) { throw new ArgumentNullException(nameof(createLabelFromShipmentRequestBody)); } + // verify the required parameter 'shipmentId' is set + if (shipmentId == null) + { + throw new ArgumentNullException(nameof(shipmentId)); + } + RequestOptions requestOptions = new("/v1/labels/shipment/{shipment_id}"); @@ -407,13 +407,13 @@ public async Task CreateLabelFromShipment(H /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Label ID /// + /// Label ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (CreateReturnLabelResponseBody) - public Task CreateReturnLabel(string labelId, CreateReturnLabelRequestBody createReturnLabelRequestBody, CancellationToken cancellationToken = default) + public Task CreateReturnLabel(CreateReturnLabelRequestBody createReturnLabelRequestBody, string labelId, CancellationToken cancellationToken = default) { - return CreateReturnLabel(_client, labelId, createReturnLabelRequestBody, cancellationToken); + return CreateReturnLabel(_client, createReturnLabelRequestBody, labelId, cancellationToken); } /// @@ -422,24 +422,24 @@ public Task CreateReturnLabel(string labelId, Cre /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Label ID /// + /// Label ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (CreateReturnLabelResponseBody) - public async Task CreateReturnLabel(HttpClient methodClient, string labelId, CreateReturnLabelRequestBody createReturnLabelRequestBody, CancellationToken cancellationToken = default) + public async Task CreateReturnLabel(HttpClient methodClient, CreateReturnLabelRequestBody createReturnLabelRequestBody, string labelId, CancellationToken cancellationToken = default) { - // verify the required parameter 'labelId' is set - if (labelId == null) - { - throw new ArgumentNullException(nameof(labelId)); - } - // verify the required parameter 'createReturnLabelRequestBody' is set if (createReturnLabelRequestBody == null) { throw new ArgumentNullException(nameof(createReturnLabelRequestBody)); } + // verify the required parameter 'labelId' is set + if (labelId == null) + { + throw new ArgumentNullException(nameof(labelId)); + } + RequestOptions requestOptions = new("/v1/labels/{label_id}/return"); @@ -462,7 +462,7 @@ public async Task CreateReturnLabel(HttpClient me /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetLabelByExternalShipmentIdResponseBody) - public Task GetLabelByExternalShipmentId(string externalShipmentId, LabelDownloadType? labelDownloadType = default, CancellationToken cancellationToken = default) + public Task GetLabelByExternalShipmentId(string externalShipmentId, LabelDownloadType labelDownloadType = default, CancellationToken cancellationToken = default) { return GetLabelByExternalShipmentId(_client, externalShipmentId, labelDownloadType, cancellationToken); } @@ -477,7 +477,7 @@ public Task GetLabelByExternalShipment /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetLabelByExternalShipmentIdResponseBody) - public async Task GetLabelByExternalShipmentId(HttpClient methodClient, string externalShipmentId, LabelDownloadType? labelDownloadType = default, CancellationToken cancellationToken = default) + public async Task GetLabelByExternalShipmentId(HttpClient methodClient, string externalShipmentId, LabelDownloadType labelDownloadType = default, CancellationToken cancellationToken = default) { // verify the required parameter 'externalShipmentId' is set if (externalShipmentId == null) @@ -510,7 +510,7 @@ public async Task GetLabelByExternalSh /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetLabelByIdResponseBody) - public Task GetLabelById(string labelId, LabelDownloadType? labelDownloadType = default, CancellationToken cancellationToken = default) + public Task GetLabelById(string labelId, LabelDownloadType labelDownloadType = default, CancellationToken cancellationToken = default) { return GetLabelById(_client, labelId, labelDownloadType, cancellationToken); } @@ -525,7 +525,7 @@ public Task GetLabelById(string labelId, LabelDownload /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetLabelByIdResponseBody) - public async Task GetLabelById(HttpClient methodClient, string labelId, LabelDownloadType? labelDownloadType = default, CancellationToken cancellationToken = default) + public async Task GetLabelById(HttpClient methodClient, string labelId, LabelDownloadType labelDownloadType = default, CancellationToken cancellationToken = default) { // verify the required parameter 'labelId' is set if (labelId == null) @@ -596,7 +596,10 @@ public async Task GetTrackingLogFromLabel(H /// /// Thrown when required argument is null /// Thrown when fails to make API call + /// Only return labels that were created on or after a specific date/time (optional) + /// Only return labels that were created on or before a specific date/time (optional) /// Only return labels that are currently in the specified status (optional) + /// Controls the sort order of the query. (optional) /// Only return labels for a specific [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) (optional) /// Only return labels for a specific [carrier account](https://www.shipengine.com/docs/carriers/setup/) (optional) /// Only return labels with a specific tracking number (optional) @@ -604,17 +607,14 @@ public async Task GetTrackingLogFromLabel(H /// Rate ID (optional) /// Shipment ID (optional) /// Only return labels that originate from a specific [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) (optional) - /// Only return labels that were created on or after a specific date/time (optional) - /// Only return labels that were created on or before a specific date/time (optional) /// 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) /// The number of results to return per response. (optional, default to 25) - /// Controls the sort order of the query. (optional) /// Controls which field the query is sorted by. (optional, default to created_at) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListLabelsResponseBody) - public Task ListLabels(LabelStatus? labelStatus = default, string? serviceCode = default, string? carrierId = default, string? trackingNumber = default, string? batchId = default, string? rateId = default, string? shipmentId = default, string? warehouseId = default, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, int? page = default, int? pageSize = default, SortDir? sortDir = default, string? sortBy = default, CancellationToken cancellationToken = default) + public Task ListLabels(DateTimeOffset createdAtStart = default, DateTimeOffset createdAtEnd = default, LabelStatus labelStatus = default, SortDir sortDir = default, string serviceCode = default, string carrierId = default, string trackingNumber = default, string batchId = default, string rateId = default, string shipmentId = default, string warehouseId = default, int page = default, int pageSize = default, string sortBy = default, CancellationToken cancellationToken = default) { - return ListLabels(_client, labelStatus, serviceCode, carrierId, trackingNumber, batchId, rateId, shipmentId, warehouseId, createdAtStart, createdAtEnd, page, pageSize, sortDir, sortBy, cancellationToken); + return ListLabels(_client, createdAtStart, createdAtEnd, labelStatus, sortDir, serviceCode, carrierId, trackingNumber, batchId, rateId, shipmentId, warehouseId, page, pageSize, sortBy, cancellationToken); } /// @@ -623,7 +623,10 @@ public Task ListLabels(LabelStatus? labelStatus = defaul /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request + /// Only return labels that were created on or after a specific date/time (optional) + /// Only return labels that were created on or before a specific date/time (optional) /// Only return labels that are currently in the specified status (optional) + /// Controls the sort order of the query. (optional) /// Only return labels for a specific [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) (optional) /// Only return labels for a specific [carrier account](https://www.shipengine.com/docs/carriers/setup/) (optional) /// Only return labels with a specific tracking number (optional) @@ -631,23 +634,32 @@ public Task ListLabels(LabelStatus? labelStatus = defaul /// Rate ID (optional) /// Shipment ID (optional) /// Only return labels that originate from a specific [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) (optional) - /// Only return labels that were created on or after a specific date/time (optional) - /// Only return labels that were created on or before a specific date/time (optional) /// 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) /// The number of results to return per response. (optional, default to 25) - /// Controls the sort order of the query. (optional) /// Controls which field the query is sorted by. (optional, default to created_at) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListLabelsResponseBody) - public async Task ListLabels(HttpClient methodClient, LabelStatus? labelStatus = default, string? serviceCode = default, string? carrierId = default, string? trackingNumber = default, string? batchId = default, string? rateId = default, string? shipmentId = default, string? warehouseId = default, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, int? page = default, int? pageSize = default, SortDir? sortDir = default, string? sortBy = default, CancellationToken cancellationToken = default) + public async Task ListLabels(HttpClient methodClient, DateTimeOffset createdAtStart = default, DateTimeOffset createdAtEnd = default, LabelStatus labelStatus = default, SortDir sortDir = default, string serviceCode = default, string carrierId = default, string trackingNumber = default, string batchId = default, string rateId = default, string shipmentId = default, string warehouseId = default, int page = default, int pageSize = default, string sortBy = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/labels"); + if (createdAtStart != null) + { + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "created_at_start", createdAtStart)); + } + if (createdAtEnd != null) + { + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "created_at_end", createdAtEnd)); + } if (labelStatus != null) { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "label_status", labelStatus)); } + if (sortDir != null) + { + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "sort_dir", sortDir)); + } if (serviceCode != null) { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "service_code", serviceCode)); @@ -676,14 +688,6 @@ public async Task ListLabels(HttpClient methodClient, La { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "warehouse_id", warehouseId)); } - if (createdAtStart != null) - { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "created_at_start", createdAtStart)); - } - if (createdAtEnd != null) - { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "created_at_end", createdAtEnd)); - } if (page != null) { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page", page)); @@ -692,10 +696,6 @@ public async Task ListLabels(HttpClient methodClient, La { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page_size", pageSize)); } - if (sortDir != null) - { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "sort_dir", sortDir)); - } if (sortBy != null) { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "sort_by", sortBy)); diff --git a/ShipEngineSDK/Api/ManifestsApi.cs b/ShipEngineSDK/Api/ManifestsApi.cs index 155f56f0..dc77b088 100644 --- a/ShipEngineSDK/Api/ManifestsApi.cs +++ b/ShipEngineSDK/Api/ManifestsApi.cs @@ -94,18 +94,18 @@ public partial interface IShipEngine /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Warehouse ID (optional) /// ship date start range (optional) /// ship date end range (optional) /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time) (optional) + /// (optional) + /// Warehouse ID (optional) /// Carrier ID (optional) /// 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) /// The number of results to return per response. (optional, default to 25) - /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListManifestsResponseBody) - Task ListManifests(string? warehouseId, DateTimeOffset? shipDateStart, DateTimeOffset? shipDateEnd, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, string? carrierId, int? page, int? pageSize, List? labelIds, CancellationToken cancellationToken = default); + Task ListManifests(DateTimeOffset shipDateStart, DateTimeOffset shipDateEnd, DateTimeOffset createdAtStart, DateTimeOffset createdAtEnd, List labelIds, string warehouseId, string carrierId, int page, int pageSize, CancellationToken cancellationToken = default); /// /// List Manifests Similar to querying shipments, we allow you to query manifests since there will likely be a large number over a long period of time. @@ -113,18 +113,18 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Warehouse ID (optional) /// ship date start range (optional) /// ship date end range (optional) /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time) (optional) + /// (optional) + /// Warehouse ID (optional) /// Carrier ID (optional) /// 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) /// The number of results to return per response. (optional, default to 25) - /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListManifestsResponseBody) - Task ListManifests(HttpClient methodClient, string? warehouseId, DateTimeOffset? shipDateStart, DateTimeOffset? shipDateEnd, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, string? carrierId, int? page, int? pageSize, List? labelIds, CancellationToken cancellationToken = default); + Task ListManifests(HttpClient methodClient, DateTimeOffset shipDateStart, DateTimeOffset shipDateEnd, DateTimeOffset createdAtStart, DateTimeOffset createdAtEnd, List labelIds, string warehouseId, string carrierId, int page, int pageSize, CancellationToken cancellationToken = default); } @@ -264,20 +264,20 @@ public async Task GetManifestRequestById(HttpClient /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Warehouse ID (optional) /// ship date start range (optional) /// ship date end range (optional) /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time) (optional) + /// (optional) + /// Warehouse ID (optional) /// Carrier ID (optional) /// 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) /// The number of results to return per response. (optional, default to 25) - /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListManifestsResponseBody) - public Task ListManifests(string? warehouseId = default, DateTimeOffset? shipDateStart = default, DateTimeOffset? shipDateEnd = default, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, string? carrierId = default, int? page = default, int? pageSize = default, List? labelIds = default, CancellationToken cancellationToken = default) + public Task ListManifests(DateTimeOffset shipDateStart = default, DateTimeOffset shipDateEnd = default, DateTimeOffset createdAtStart = default, DateTimeOffset createdAtEnd = default, List labelIds = default, string warehouseId = default, string carrierId = default, int page = default, int pageSize = default, CancellationToken cancellationToken = default) { - return ListManifests(_client, warehouseId, shipDateStart, shipDateEnd, createdAtStart, createdAtEnd, carrierId, page, pageSize, labelIds, cancellationToken); + return ListManifests(_client, shipDateStart, shipDateEnd, createdAtStart, createdAtEnd, labelIds, warehouseId, carrierId, page, pageSize, cancellationToken); } /// @@ -286,26 +286,22 @@ public Task ListManifests(string? warehouseId = defau /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Warehouse ID (optional) /// ship date start range (optional) /// ship date end range (optional) /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time) (optional) + /// (optional) + /// Warehouse ID (optional) /// Carrier ID (optional) /// 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) /// The number of results to return per response. (optional, default to 25) - /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListManifestsResponseBody) - public async Task ListManifests(HttpClient methodClient, string? warehouseId = default, DateTimeOffset? shipDateStart = default, DateTimeOffset? shipDateEnd = default, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, string? carrierId = default, int? page = default, int? pageSize = default, List? labelIds = default, CancellationToken cancellationToken = default) + public async Task ListManifests(HttpClient methodClient, DateTimeOffset shipDateStart = default, DateTimeOffset shipDateEnd = default, DateTimeOffset createdAtStart = default, DateTimeOffset createdAtEnd = default, List labelIds = default, string warehouseId = default, string carrierId = default, int page = default, int pageSize = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/manifests"); - if (warehouseId != null) - { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "warehouse_id", warehouseId)); - } if (shipDateStart != null) { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "ship_date_start", shipDateStart)); @@ -322,6 +318,14 @@ public async Task ListManifests(HttpClient methodClie { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "created_at_end", createdAtEnd)); } + if (labelIds != null) + { + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("multi", "label_ids", labelIds)); + } + if (warehouseId != null) + { + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "warehouse_id", warehouseId)); + } if (carrierId != null) { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "carrier_id", carrierId)); @@ -334,10 +338,6 @@ public async Task ListManifests(HttpClient methodClie { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page_size", pageSize)); } - if (labelIds != null) - { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("multi", "label_ids", labelIds)); - } requestOptions.Operation = "ManifestsApi.ListManifests"; diff --git a/ShipEngineSDK/Api/PackagePickupsApi.cs b/ShipEngineSDK/Api/PackagePickupsApi.cs index 6265ac0e..1e9458e0 100644 --- a/ShipEngineSDK/Api/PackagePickupsApi.cs +++ b/ShipEngineSDK/Api/PackagePickupsApi.cs @@ -73,15 +73,15 @@ public partial interface IShipEngine /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Carrier ID (optional) - /// Warehouse ID (optional) /// Only return scheduled pickups that were created on or after a specific date/time (optional) /// Only return scheduled pickups that were created on or before a specific date/time (optional) + /// Carrier ID (optional) + /// Warehouse ID (optional) /// 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) /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetPickupsResponseBody) - Task ListScheduledPickups(string? carrierId, string? warehouseId, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, int? page, int? pageSize, CancellationToken cancellationToken = default); + Task ListScheduledPickups(DateTimeOffset createdAtStart, DateTimeOffset createdAtEnd, string carrierId, string warehouseId, int page, int pageSize, CancellationToken cancellationToken = default); /// /// List Scheduled Pickups List all pickups that have been scheduled for this carrier @@ -89,15 +89,15 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Carrier ID (optional) - /// Warehouse ID (optional) /// Only return scheduled pickups that were created on or after a specific date/time (optional) /// Only return scheduled pickups that were created on or before a specific date/time (optional) + /// Carrier ID (optional) + /// Warehouse ID (optional) /// 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) /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetPickupsResponseBody) - Task ListScheduledPickups(HttpClient methodClient, string? carrierId, string? warehouseId, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, int? page, int? pageSize, CancellationToken cancellationToken = default); + Task ListScheduledPickups(HttpClient methodClient, DateTimeOffset createdAtStart, DateTimeOffset createdAtEnd, string carrierId, string warehouseId, int page, int pageSize, CancellationToken cancellationToken = default); /// /// Schedule a Pickup Schedule a package pickup with a carrier @@ -216,17 +216,17 @@ public async Task GetPickupById(HttpClient methodClie /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Carrier ID (optional) - /// Warehouse ID (optional) /// Only return scheduled pickups that were created on or after a specific date/time (optional) /// Only return scheduled pickups that were created on or before a specific date/time (optional) + /// Carrier ID (optional) + /// Warehouse ID (optional) /// 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) /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetPickupsResponseBody) - public Task ListScheduledPickups(string? carrierId = default, string? warehouseId = default, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, int? page = default, int? pageSize = default, CancellationToken cancellationToken = default) + public Task ListScheduledPickups(DateTimeOffset createdAtStart = default, DateTimeOffset createdAtEnd = default, string carrierId = default, string warehouseId = default, int page = default, int pageSize = default, CancellationToken cancellationToken = default) { - return ListScheduledPickups(_client, carrierId, warehouseId, createdAtStart, createdAtEnd, page, pageSize, cancellationToken); + return ListScheduledPickups(_client, createdAtStart, createdAtEnd, carrierId, warehouseId, page, pageSize, cancellationToken); } /// @@ -235,27 +235,19 @@ public Task ListScheduledPickups(string? carrierId = def /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Carrier ID (optional) - /// Warehouse ID (optional) /// Only return scheduled pickups that were created on or after a specific date/time (optional) /// Only return scheduled pickups that were created on or before a specific date/time (optional) + /// Carrier ID (optional) + /// Warehouse ID (optional) /// 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) /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetPickupsResponseBody) - public async Task ListScheduledPickups(HttpClient methodClient, string? carrierId = default, string? warehouseId = default, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, int? page = default, int? pageSize = default, CancellationToken cancellationToken = default) + public async Task ListScheduledPickups(HttpClient methodClient, DateTimeOffset createdAtStart = default, DateTimeOffset createdAtEnd = default, string carrierId = default, string warehouseId = default, int page = default, int pageSize = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/pickups"); - if (carrierId != null) - { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "carrier_id", carrierId)); - } - if (warehouseId != null) - { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "warehouse_id", warehouseId)); - } if (createdAtStart != null) { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "created_at_start", createdAtStart)); @@ -264,6 +256,14 @@ public async Task ListScheduledPickups(HttpClient method { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "created_at_end", createdAtEnd)); } + if (carrierId != null) + { + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "carrier_id", carrierId)); + } + if (warehouseId != null) + { + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "warehouse_id", warehouseId)); + } if (page != null) { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page", page)); diff --git a/ShipEngineSDK/Api/PackageTypesApi.cs b/ShipEngineSDK/Api/PackageTypesApi.cs index c39c0d96..1bcf4d35 100644 --- a/ShipEngineSDK/Api/PackageTypesApi.cs +++ b/ShipEngineSDK/Api/PackageTypesApi.cs @@ -113,11 +113,11 @@ public partial interface IShipEngine /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Package ID /// + /// Package ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task UpdatePackageType(string packageId, UpdatePackageTypeRequestBody updatePackageTypeRequestBody, CancellationToken cancellationToken = default); + Task UpdatePackageType(UpdatePackageTypeRequestBody updatePackageTypeRequestBody, string packageId, CancellationToken cancellationToken = default); /// /// Update Custom Package Type By ID Update the custom package type object by ID @@ -125,11 +125,11 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Package ID /// + /// Package ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task UpdatePackageType(HttpClient methodClient, string packageId, UpdatePackageTypeRequestBody updatePackageTypeRequestBody, CancellationToken cancellationToken = default); + Task UpdatePackageType(HttpClient methodClient, UpdatePackageTypeRequestBody updatePackageTypeRequestBody, string packageId, CancellationToken cancellationToken = default); } @@ -302,13 +302,13 @@ public async Task ListPackageTypes(HttpClient meth /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Package ID /// + /// Package ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public Task UpdatePackageType(string packageId, UpdatePackageTypeRequestBody updatePackageTypeRequestBody, CancellationToken cancellationToken = default) + public Task UpdatePackageType(UpdatePackageTypeRequestBody updatePackageTypeRequestBody, string packageId, CancellationToken cancellationToken = default) { - return UpdatePackageType(_client, packageId, updatePackageTypeRequestBody, cancellationToken); + return UpdatePackageType(_client, updatePackageTypeRequestBody, packageId, cancellationToken); } /// @@ -317,24 +317,24 @@ public Task UpdatePackageType(string packageId, UpdatePackageTypeRequest /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Package ID /// + /// Package ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public async Task UpdatePackageType(HttpClient methodClient, string packageId, UpdatePackageTypeRequestBody updatePackageTypeRequestBody, CancellationToken cancellationToken = default) + public async Task UpdatePackageType(HttpClient methodClient, UpdatePackageTypeRequestBody updatePackageTypeRequestBody, string packageId, CancellationToken cancellationToken = default) { - // verify the required parameter 'packageId' is set - if (packageId == null) - { - throw new ArgumentNullException(nameof(packageId)); - } - // verify the required parameter 'updatePackageTypeRequestBody' is set if (updatePackageTypeRequestBody == null) { throw new ArgumentNullException(nameof(updatePackageTypeRequestBody)); } + // verify the required parameter 'packageId' is set + if (packageId == null) + { + throw new ArgumentNullException(nameof(packageId)); + } + RequestOptions requestOptions = new("/v1/packages/{package_id}"); diff --git a/ShipEngineSDK/Api/ShipmentsApi.cs b/ShipEngineSDK/Api/ShipmentsApi.cs index 1dba8b32..ab599152 100644 --- a/ShipEngineSDK/Api/ShipmentsApi.cs +++ b/ShipEngineSDK/Api/ShipmentsApi.cs @@ -119,7 +119,7 @@ public partial interface IShipEngine /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentRatesResponseBody) - Task ListShipmentRates(string shipmentId, DateTimeOffset? createdAtStart, CancellationToken cancellationToken = default); + Task ListShipmentRates(string shipmentId, DateTimeOffset createdAtStart, CancellationToken cancellationToken = default); /// /// Get Shipment Rates Get Rates for the shipment information associated with the shipment ID @@ -131,28 +131,28 @@ public partial interface IShipEngine /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentRatesResponseBody) - Task ListShipmentRates(HttpClient methodClient, string shipmentId, DateTimeOffset? createdAtStart, CancellationToken cancellationToken = default); + Task ListShipmentRates(HttpClient methodClient, string shipmentId, DateTimeOffset createdAtStart, CancellationToken cancellationToken = default); /// /// List Shipments Get list of Shipments /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// (optional) - /// Batch ID (optional) - /// Search for shipments based on the custom tag added to the shipment object (optional) /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time) (optional) /// Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time) (optional) /// Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time) (optional) + /// (optional) + /// (optional) + /// Controls the sort order of the query. (optional) + /// Batch ID (optional) + /// Search for shipments based on the custom tag added to the shipment object (optional) + /// Sales Order ID (optional) /// 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) /// The number of results to return per response. (optional, default to 25) - /// Sales Order ID (optional) - /// Controls the sort order of the query. (optional) - /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentsResponseBody) - Task ListShipments(ShipmentStatus? shipmentStatus, string? batchId, string? tag, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, DateTimeOffset? modifiedAtStart, DateTimeOffset? modifiedAtEnd, int? page, int? pageSize, string? salesOrderId, SortDir? sortDir, ShipmentsSortBy? sortBy, CancellationToken cancellationToken = default); + Task ListShipments(DateTimeOffset createdAtStart, DateTimeOffset createdAtEnd, DateTimeOffset modifiedAtStart, DateTimeOffset modifiedAtEnd, ShipmentStatus shipmentStatus, ShipmentsSortBy sortBy, SortDir sortDir, string batchId, string tag, string salesOrderId, int page, int pageSize, CancellationToken cancellationToken = default); /// /// List Shipments Get list of Shipments @@ -160,21 +160,21 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// (optional) - /// Batch ID (optional) - /// Search for shipments based on the custom tag added to the shipment object (optional) /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time) (optional) /// Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time) (optional) /// Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time) (optional) + /// (optional) + /// (optional) + /// Controls the sort order of the query. (optional) + /// Batch ID (optional) + /// Search for shipments based on the custom tag added to the shipment object (optional) + /// Sales Order ID (optional) /// 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) /// The number of results to return per response. (optional, default to 25) - /// Sales Order ID (optional) - /// Controls the sort order of the query. (optional) - /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentsResponseBody) - Task ListShipments(HttpClient methodClient, ShipmentStatus? shipmentStatus, string? batchId, string? tag, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, DateTimeOffset? modifiedAtStart, DateTimeOffset? modifiedAtEnd, int? page, int? pageSize, string? salesOrderId, SortDir? sortDir, ShipmentsSortBy? sortBy, CancellationToken cancellationToken = default); + Task ListShipments(HttpClient methodClient, DateTimeOffset createdAtStart, DateTimeOffset createdAtEnd, DateTimeOffset modifiedAtStart, DateTimeOffset modifiedAtEnd, ShipmentStatus shipmentStatus, ShipmentsSortBy sortBy, SortDir sortDir, string batchId, string tag, string salesOrderId, int page, int pageSize, CancellationToken cancellationToken = default); /// /// Parse shipping info The shipment-recognition API makes it easy for you to extract shipping data from unstructured text, including people's names, addresses, package weights and dimensions, insurance and delivery requirements, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's shipment-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed shipment data is returned in the same structure that's used for other ShipEngine APIs, so you can easily use the parsed data to create a shipping label. > **Note:** Shipment recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland. @@ -290,11 +290,11 @@ public partial interface IShipEngine /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Shipment ID /// + /// Shipment ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (UpdateShipmentResponseBody) - Task UpdateShipment(string shipmentId, UpdateShipmentRequestBody updateShipmentRequestBody, CancellationToken cancellationToken = default); + Task UpdateShipment(UpdateShipmentRequestBody updateShipmentRequestBody, string shipmentId, CancellationToken cancellationToken = default); /// /// Update Shipment By ID Update a shipment object based on its ID @@ -302,11 +302,11 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Shipment ID /// + /// Shipment ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (UpdateShipmentResponseBody) - Task UpdateShipment(HttpClient methodClient, string shipmentId, UpdateShipmentRequestBody updateShipmentRequestBody, CancellationToken cancellationToken = default); + Task UpdateShipment(HttpClient methodClient, UpdateShipmentRequestBody updateShipmentRequestBody, string shipmentId, CancellationToken cancellationToken = default); } @@ -492,7 +492,7 @@ public async Task GetShipmentById(HttpClient method /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentRatesResponseBody) - public Task ListShipmentRates(string shipmentId, DateTimeOffset? createdAtStart = default, CancellationToken cancellationToken = default) + public Task ListShipmentRates(string shipmentId, DateTimeOffset createdAtStart = default, CancellationToken cancellationToken = default) { return ListShipmentRates(_client, shipmentId, createdAtStart, cancellationToken); } @@ -507,7 +507,7 @@ public Task ListShipmentRates(string shipmentId, /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentRatesResponseBody) - public async Task ListShipmentRates(HttpClient methodClient, string shipmentId, DateTimeOffset? createdAtStart = default, CancellationToken cancellationToken = default) + public async Task ListShipmentRates(HttpClient methodClient, string shipmentId, DateTimeOffset createdAtStart = default, CancellationToken cancellationToken = default) { // verify the required parameter 'shipmentId' is set if (shipmentId == null) @@ -536,23 +536,23 @@ public async Task ListShipmentRates(HttpClient me /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// (optional) - /// Batch ID (optional) - /// Search for shipments based on the custom tag added to the shipment object (optional) /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time) (optional) /// Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time) (optional) /// Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time) (optional) + /// (optional) + /// (optional) + /// Controls the sort order of the query. (optional) + /// Batch ID (optional) + /// Search for shipments based on the custom tag added to the shipment object (optional) + /// Sales Order ID (optional) /// 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) /// The number of results to return per response. (optional, default to 25) - /// Sales Order ID (optional) - /// Controls the sort order of the query. (optional) - /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentsResponseBody) - public Task ListShipments(ShipmentStatus? shipmentStatus = default, string? batchId = default, string? tag = default, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, DateTimeOffset? modifiedAtStart = default, DateTimeOffset? modifiedAtEnd = default, int? page = default, int? pageSize = default, string? salesOrderId = default, SortDir? sortDir = default, ShipmentsSortBy? sortBy = default, CancellationToken cancellationToken = default) + public Task ListShipments(DateTimeOffset createdAtStart = default, DateTimeOffset createdAtEnd = default, DateTimeOffset modifiedAtStart = default, DateTimeOffset modifiedAtEnd = default, ShipmentStatus shipmentStatus = default, ShipmentsSortBy sortBy = default, SortDir sortDir = default, string batchId = default, string tag = default, string salesOrderId = default, int page = default, int pageSize = default, CancellationToken cancellationToken = default) { - return ListShipments(_client, shipmentStatus, batchId, tag, createdAtStart, createdAtEnd, modifiedAtStart, modifiedAtEnd, page, pageSize, salesOrderId, sortDir, sortBy, cancellationToken); + return ListShipments(_client, createdAtStart, createdAtEnd, modifiedAtStart, modifiedAtEnd, shipmentStatus, sortBy, sortDir, batchId, tag, salesOrderId, page, pageSize, cancellationToken); } /// @@ -561,37 +561,25 @@ public Task ListShipments(ShipmentStatus? shipmentSta /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// (optional) - /// Batch ID (optional) - /// Search for shipments based on the custom tag added to the shipment object (optional) /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time) (optional) /// Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time) (optional) /// Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time) (optional) + /// (optional) + /// (optional) + /// Controls the sort order of the query. (optional) + /// Batch ID (optional) + /// Search for shipments based on the custom tag added to the shipment object (optional) + /// Sales Order ID (optional) /// 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) /// The number of results to return per response. (optional, default to 25) - /// Sales Order ID (optional) - /// Controls the sort order of the query. (optional) - /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentsResponseBody) - public async Task ListShipments(HttpClient methodClient, ShipmentStatus? shipmentStatus = default, string? batchId = default, string? tag = default, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, DateTimeOffset? modifiedAtStart = default, DateTimeOffset? modifiedAtEnd = default, int? page = default, int? pageSize = default, string? salesOrderId = default, SortDir? sortDir = default, ShipmentsSortBy? sortBy = default, CancellationToken cancellationToken = default) + public async Task ListShipments(HttpClient methodClient, DateTimeOffset createdAtStart = default, DateTimeOffset createdAtEnd = default, DateTimeOffset modifiedAtStart = default, DateTimeOffset modifiedAtEnd = default, ShipmentStatus shipmentStatus = default, ShipmentsSortBy sortBy = default, SortDir sortDir = default, string batchId = default, string tag = default, string salesOrderId = default, int page = default, int pageSize = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/shipments"); - if (shipmentStatus != null) - { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "shipment_status", shipmentStatus)); - } - if (batchId != null) - { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "batch_id", batchId)); - } - if (tag != null) - { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "tag", tag)); - } if (createdAtStart != null) { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "created_at_start", createdAtStart)); @@ -608,25 +596,37 @@ public async Task ListShipments(HttpClient methodClie { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "modified_at_end", modifiedAtEnd)); } - if (page != null) + if (shipmentStatus != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page", page)); + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "shipment_status", shipmentStatus)); } - if (pageSize != null) + if (sortBy != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page_size", pageSize)); + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "sort_by", sortBy)); + } + if (sortDir != null) + { + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "sort_dir", sortDir)); + } + if (batchId != null) + { + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "batch_id", batchId)); + } + if (tag != null) + { + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "tag", tag)); } if (salesOrderId != null) { requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "sales_order_id", salesOrderId)); } - if (sortDir != null) + if (page != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "sort_dir", sortDir)); + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page", page)); } - if (sortBy != null) + if (pageSize != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "sort_by", sortBy)); + requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page_size", pageSize)); } requestOptions.Operation = "ShipmentsApi.ListShipments"; @@ -869,13 +869,13 @@ public async Task UntagShipment(HttpClient methodClient, string shipment /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Shipment ID /// + /// Shipment ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (UpdateShipmentResponseBody) - public Task UpdateShipment(string shipmentId, UpdateShipmentRequestBody updateShipmentRequestBody, CancellationToken cancellationToken = default) + public Task UpdateShipment(UpdateShipmentRequestBody updateShipmentRequestBody, string shipmentId, CancellationToken cancellationToken = default) { - return UpdateShipment(_client, shipmentId, updateShipmentRequestBody, cancellationToken); + return UpdateShipment(_client, updateShipmentRequestBody, shipmentId, cancellationToken); } /// @@ -884,24 +884,24 @@ public Task UpdateShipment(string shipmentId, Update /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Shipment ID /// + /// Shipment ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (UpdateShipmentResponseBody) - public async Task UpdateShipment(HttpClient methodClient, string shipmentId, UpdateShipmentRequestBody updateShipmentRequestBody, CancellationToken cancellationToken = default) + public async Task UpdateShipment(HttpClient methodClient, UpdateShipmentRequestBody updateShipmentRequestBody, string shipmentId, CancellationToken cancellationToken = default) { - // verify the required parameter 'shipmentId' is set - if (shipmentId == null) - { - throw new ArgumentNullException(nameof(shipmentId)); - } - // verify the required parameter 'updateShipmentRequestBody' is set if (updateShipmentRequestBody == null) { throw new ArgumentNullException(nameof(updateShipmentRequestBody)); } + // verify the required parameter 'shipmentId' is set + if (shipmentId == null) + { + throw new ArgumentNullException(nameof(shipmentId)); + } + RequestOptions requestOptions = new("/v1/shipments/{shipment_id}"); diff --git a/ShipEngineSDK/Api/TokensApi.cs b/ShipEngineSDK/Api/TokensApi.cs index 0a3c3bfa..6edfdcd5 100644 --- a/ShipEngineSDK/Api/TokensApi.cs +++ b/ShipEngineSDK/Api/TokensApi.cs @@ -34,7 +34,7 @@ public partial interface IShipEngine /// Include a redirect url to the application formatted with the ephemeral token. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (TokensGetEphemeralTokenResponseBodyYaml) - Task TokensGetEphemeralToken(Redirect? redirect, CancellationToken cancellationToken = default); + Task TokensGetEphemeralToken(Redirect redirect, CancellationToken cancellationToken = default); /// /// Get Ephemeral Token This endpoint returns a token that can be passed to an application for authorized access. The lifetime of this token is 10 seconds. @@ -45,7 +45,7 @@ public partial interface IShipEngine /// Include a redirect url to the application formatted with the ephemeral token. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (TokensGetEphemeralTokenResponseBodyYaml) - Task TokensGetEphemeralToken(HttpClient methodClient, Redirect? redirect, CancellationToken cancellationToken = default); + Task TokensGetEphemeralToken(HttpClient methodClient, Redirect redirect, CancellationToken cancellationToken = default); } @@ -62,7 +62,7 @@ public partial class ShipEngine /// Include a redirect url to the application formatted with the ephemeral token. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (TokensGetEphemeralTokenResponseBodyYaml) - public Task TokensGetEphemeralToken(Redirect? redirect = default, CancellationToken cancellationToken = default) + public Task TokensGetEphemeralToken(Redirect redirect = default, CancellationToken cancellationToken = default) { return TokensGetEphemeralToken(_client, redirect, cancellationToken); } @@ -76,7 +76,7 @@ public Task TokensGetEphemeralToken(Red /// Include a redirect url to the application formatted with the ephemeral token. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (TokensGetEphemeralTokenResponseBodyYaml) - public async Task TokensGetEphemeralToken(HttpClient methodClient, Redirect? redirect = default, CancellationToken cancellationToken = default) + public async Task TokensGetEphemeralToken(HttpClient methodClient, Redirect redirect = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/tokens/ephemeral"); diff --git a/ShipEngineSDK/Api/TrackingApi.cs b/ShipEngineSDK/Api/TrackingApi.cs index b788627b..c3e211e4 100644 --- a/ShipEngineSDK/Api/TrackingApi.cs +++ b/ShipEngineSDK/Api/TrackingApi.cs @@ -35,7 +35,7 @@ public partial interface IShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetTrackingLogResponseBody) - Task GetTrackingLog(string? carrierCode, string? trackingNumber, CancellationToken cancellationToken = default); + Task GetTrackingLog(string carrierCode, string trackingNumber, CancellationToken cancellationToken = default); /// /// Get Tracking Information Retrieve package tracking information @@ -47,7 +47,7 @@ public partial interface IShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetTrackingLogResponseBody) - Task GetTrackingLog(HttpClient methodClient, string? carrierCode, string? trackingNumber, CancellationToken cancellationToken = default); + Task GetTrackingLog(HttpClient methodClient, string carrierCode, string trackingNumber, CancellationToken cancellationToken = default); /// /// Start Tracking a Package Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package, and receive notifications via webhooks whenever the shipping status changes. @@ -58,7 +58,7 @@ public partial interface IShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task StartTracking(string? carrierCode, string? trackingNumber, CancellationToken cancellationToken = default); + Task StartTracking(string carrierCode, string trackingNumber, CancellationToken cancellationToken = default); /// /// Start Tracking a Package Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package, and receive notifications via webhooks whenever the shipping status changes. @@ -70,7 +70,7 @@ public partial interface IShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task StartTracking(HttpClient methodClient, string? carrierCode, string? trackingNumber, CancellationToken cancellationToken = default); + Task StartTracking(HttpClient methodClient, string carrierCode, string trackingNumber, CancellationToken cancellationToken = default); /// /// Stop Tracking a Package Unsubscribe from tracking updates for a package. @@ -81,7 +81,7 @@ public partial interface IShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task StopTracking(string? carrierCode, string? trackingNumber, CancellationToken cancellationToken = default); + Task StopTracking(string carrierCode, string trackingNumber, CancellationToken cancellationToken = default); /// /// Stop Tracking a Package Unsubscribe from tracking updates for a package. @@ -93,7 +93,7 @@ public partial interface IShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task StopTracking(HttpClient methodClient, string? carrierCode, string? trackingNumber, CancellationToken cancellationToken = default); + Task StopTracking(HttpClient methodClient, string carrierCode, string trackingNumber, CancellationToken cancellationToken = default); } @@ -111,7 +111,7 @@ public partial class ShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetTrackingLogResponseBody) - public Task GetTrackingLog(string? carrierCode = default, string? trackingNumber = default, CancellationToken cancellationToken = default) + public Task GetTrackingLog(string carrierCode = default, string trackingNumber = default, CancellationToken cancellationToken = default) { return GetTrackingLog(_client, carrierCode, trackingNumber, cancellationToken); } @@ -126,7 +126,7 @@ public Task GetTrackingLog(string? carrierCode = def /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetTrackingLogResponseBody) - public async Task GetTrackingLog(HttpClient methodClient, string? carrierCode = default, string? trackingNumber = default, CancellationToken cancellationToken = default) + public async Task GetTrackingLog(HttpClient methodClient, string carrierCode = default, string trackingNumber = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/tracking"); @@ -156,7 +156,7 @@ public async Task GetTrackingLog(HttpClient methodCl /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public Task StartTracking(string? carrierCode = default, string? trackingNumber = default, CancellationToken cancellationToken = default) + public Task StartTracking(string carrierCode = default, string trackingNumber = default, CancellationToken cancellationToken = default) { return StartTracking(_client, carrierCode, trackingNumber, cancellationToken); } @@ -171,7 +171,7 @@ public Task StartTracking(string? carrierCode = default, string? trackin /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public async Task StartTracking(HttpClient methodClient, string? carrierCode = default, string? trackingNumber = default, CancellationToken cancellationToken = default) + public async Task StartTracking(HttpClient methodClient, string carrierCode = default, string trackingNumber = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/tracking/start"); @@ -201,7 +201,7 @@ public async Task StartTracking(HttpClient methodClient, string? carrier /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public Task StopTracking(string? carrierCode = default, string? trackingNumber = default, CancellationToken cancellationToken = default) + public Task StopTracking(string carrierCode = default, string trackingNumber = default, CancellationToken cancellationToken = default) { return StopTracking(_client, carrierCode, trackingNumber, cancellationToken); } @@ -216,7 +216,7 @@ public Task StopTracking(string? carrierCode = default, string? tracking /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public async Task StopTracking(HttpClient methodClient, string? carrierCode = default, string? trackingNumber = default, CancellationToken cancellationToken = default) + public async Task StopTracking(HttpClient methodClient, string carrierCode = default, string trackingNumber = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/tracking/stop"); diff --git a/ShipEngineSDK/Api/WarehousesApi.cs b/ShipEngineSDK/Api/WarehousesApi.cs index efde33f2..0d669ceb 100644 --- a/ShipEngineSDK/Api/WarehousesApi.cs +++ b/ShipEngineSDK/Api/WarehousesApi.cs @@ -113,11 +113,11 @@ public partial interface IShipEngine /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Warehouse ID /// + /// Warehouse ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task UpdateWarehouse(string warehouseId, UpdateWarehouseRequestBody updateWarehouseRequestBody, CancellationToken cancellationToken = default); + Task UpdateWarehouse(UpdateWarehouseRequestBody updateWarehouseRequestBody, string warehouseId, CancellationToken cancellationToken = default); /// /// Update Warehouse By Id Update Warehouse object information @@ -125,22 +125,22 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Warehouse ID /// + /// Warehouse ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task UpdateWarehouse(HttpClient methodClient, string warehouseId, UpdateWarehouseRequestBody updateWarehouseRequestBody, CancellationToken cancellationToken = default); + Task UpdateWarehouse(HttpClient methodClient, UpdateWarehouseRequestBody updateWarehouseRequestBody, string warehouseId, CancellationToken cancellationToken = default); /// /// Update Warehouse Settings Update Warehouse settings object information /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Warehouse ID /// + /// Warehouse ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task UpdateWarehouseSettings(string warehouseId, UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBody, CancellationToken cancellationToken = default); + Task UpdateWarehouseSettings(UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBody, string warehouseId, CancellationToken cancellationToken = default); /// /// Update Warehouse Settings Update Warehouse settings object information @@ -148,11 +148,11 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Warehouse ID /// + /// Warehouse ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task UpdateWarehouseSettings(HttpClient methodClient, string warehouseId, UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBody, CancellationToken cancellationToken = default); + Task UpdateWarehouseSettings(HttpClient methodClient, UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBody, string warehouseId, CancellationToken cancellationToken = default); } @@ -325,13 +325,13 @@ public async Task ListWarehouses(HttpClient methodCl /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Warehouse ID /// + /// Warehouse ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public Task UpdateWarehouse(string warehouseId, UpdateWarehouseRequestBody updateWarehouseRequestBody, CancellationToken cancellationToken = default) + public Task UpdateWarehouse(UpdateWarehouseRequestBody updateWarehouseRequestBody, string warehouseId, CancellationToken cancellationToken = default) { - return UpdateWarehouse(_client, warehouseId, updateWarehouseRequestBody, cancellationToken); + return UpdateWarehouse(_client, updateWarehouseRequestBody, warehouseId, cancellationToken); } /// @@ -340,24 +340,24 @@ public Task UpdateWarehouse(string warehouseId, UpdateWarehouseRequestBo /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Warehouse ID /// + /// Warehouse ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public async Task UpdateWarehouse(HttpClient methodClient, string warehouseId, UpdateWarehouseRequestBody updateWarehouseRequestBody, CancellationToken cancellationToken = default) + public async Task UpdateWarehouse(HttpClient methodClient, UpdateWarehouseRequestBody updateWarehouseRequestBody, string warehouseId, CancellationToken cancellationToken = default) { - // verify the required parameter 'warehouseId' is set - if (warehouseId == null) - { - throw new ArgumentNullException(nameof(warehouseId)); - } - // verify the required parameter 'updateWarehouseRequestBody' is set if (updateWarehouseRequestBody == null) { throw new ArgumentNullException(nameof(updateWarehouseRequestBody)); } + // verify the required parameter 'warehouseId' is set + if (warehouseId == null) + { + throw new ArgumentNullException(nameof(warehouseId)); + } + RequestOptions requestOptions = new("/v1/warehouses/{warehouse_id}"); @@ -376,13 +376,13 @@ public async Task UpdateWarehouse(HttpClient methodClient, string wareho /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Warehouse ID /// + /// Warehouse ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public Task UpdateWarehouseSettings(string warehouseId, UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBody, CancellationToken cancellationToken = default) + public Task UpdateWarehouseSettings(UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBody, string warehouseId, CancellationToken cancellationToken = default) { - return UpdateWarehouseSettings(_client, warehouseId, updateWarehouseSettingsRequestBody, cancellationToken); + return UpdateWarehouseSettings(_client, updateWarehouseSettingsRequestBody, warehouseId, cancellationToken); } /// @@ -391,24 +391,24 @@ public Task UpdateWarehouseSettings(string warehouseId, UpdateWarehouseS /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Warehouse ID /// + /// Warehouse ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public async Task UpdateWarehouseSettings(HttpClient methodClient, string warehouseId, UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBody, CancellationToken cancellationToken = default) + public async Task UpdateWarehouseSettings(HttpClient methodClient, UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBody, string warehouseId, CancellationToken cancellationToken = default) { - // verify the required parameter 'warehouseId' is set - if (warehouseId == null) - { - throw new ArgumentNullException(nameof(warehouseId)); - } - // verify the required parameter 'updateWarehouseSettingsRequestBody' is set if (updateWarehouseSettingsRequestBody == null) { throw new ArgumentNullException(nameof(updateWarehouseSettingsRequestBody)); } + // verify the required parameter 'warehouseId' is set + if (warehouseId == null) + { + throw new ArgumentNullException(nameof(warehouseId)); + } + RequestOptions requestOptions = new("/v1/warehouses/{warehouse_id}/settings"); diff --git a/ShipEngineSDK/Api/WebhooksApi.cs b/ShipEngineSDK/Api/WebhooksApi.cs index 501a06e6..e4c11726 100644 --- a/ShipEngineSDK/Api/WebhooksApi.cs +++ b/ShipEngineSDK/Api/WebhooksApi.cs @@ -113,11 +113,11 @@ public partial interface IShipEngine /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Webhook ID /// + /// Webhook ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task UpdateWebhook(string webhookId, UpdateWebhookRequestBody updateWebhookRequestBody, CancellationToken cancellationToken = default); + Task UpdateWebhook(UpdateWebhookRequestBody updateWebhookRequestBody, string webhookId, CancellationToken cancellationToken = default); /// /// Update a Webhook Update the webhook url property @@ -125,11 +125,11 @@ public partial interface IShipEngine /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Webhook ID /// + /// Webhook ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task UpdateWebhook(HttpClient methodClient, string webhookId, UpdateWebhookRequestBody updateWebhookRequestBody, CancellationToken cancellationToken = default); + Task UpdateWebhook(HttpClient methodClient, UpdateWebhookRequestBody updateWebhookRequestBody, string webhookId, CancellationToken cancellationToken = default); } @@ -302,13 +302,13 @@ public async Task> ListWebhooks(HttpClient methodClient, Cancellat /// /// Thrown when required argument is null /// Thrown when fails to make API call - /// Webhook ID /// + /// Webhook ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public Task UpdateWebhook(string webhookId, UpdateWebhookRequestBody updateWebhookRequestBody, CancellationToken cancellationToken = default) + public Task UpdateWebhook(UpdateWebhookRequestBody updateWebhookRequestBody, string webhookId, CancellationToken cancellationToken = default) { - return UpdateWebhook(_client, webhookId, updateWebhookRequestBody, cancellationToken); + return UpdateWebhook(_client, updateWebhookRequestBody, webhookId, cancellationToken); } /// @@ -317,24 +317,24 @@ public Task UpdateWebhook(string webhookId, UpdateWebhookRequestBody upd /// Thrown when required argument is null /// Thrown when fails to make API call /// HttpClient to use for the request - /// Webhook ID /// + /// Webhook ID /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public async Task UpdateWebhook(HttpClient methodClient, string webhookId, UpdateWebhookRequestBody updateWebhookRequestBody, CancellationToken cancellationToken = default) + public async Task UpdateWebhook(HttpClient methodClient, UpdateWebhookRequestBody updateWebhookRequestBody, string webhookId, CancellationToken cancellationToken = default) { - // verify the required parameter 'webhookId' is set - if (webhookId == null) - { - throw new ArgumentNullException(nameof(webhookId)); - } - // verify the required parameter 'updateWebhookRequestBody' is set if (updateWebhookRequestBody == null) { throw new ArgumentNullException(nameof(updateWebhookRequestBody)); } + // verify the required parameter 'webhookId' is set + if (webhookId == null) + { + throw new ArgumentNullException(nameof(webhookId)); + } + RequestOptions requestOptions = new("/v1/environment/webhooks/{webhook_id}"); diff --git a/ShipEngineSDK/Model/AccountSettingsImages.cs b/ShipEngineSDK/Model/AccountSettingsImages.cs index 8b0f9fed..028e7d3e 100644 --- a/ShipEngineSDK/Model/AccountSettingsImages.cs +++ b/ShipEngineSDK/Model/AccountSettingsImages.cs @@ -92,24 +92,24 @@ public override bool CanConvert(Type typeToConvert) => [JsonPropertyName("image_content_type")] public ImageContentTypeEnum? ImageContentType { get; set; } /// - /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. + /// The date and time that the image was created in ShipEngine. /// - /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. + /// The date and time that the image was created in ShipEngine. /// - /// img_DtBXupDBxREpHnwEXhTfgK + /// 2018-09-23T15:00Z /// - [JsonPropertyName("label_image_id")] - public string LabelImageId { get; set; } + [JsonPropertyName("created_at")] + public DateTimeOffset? CreatedAt { get; set; } /// - /// A human readable name for the image. + /// A base64 encoded string representation of the image. /// - /// A human readable name for the image. + /// A base64 encoded string representation of the image. /// - /// My logo + /// iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg== /// - [JsonPropertyName("name")] - public string Name { get; set; } + [JsonPropertyName("image_data")] + public string? ImageData { get; set; } /// /// Indicates whether this image is set as default. @@ -119,37 +119,37 @@ public override bool CanConvert(Type typeToConvert) => /// false /// [JsonPropertyName("is_default")] - public bool IsDefault { get; set; } + public bool? IsDefault { get; set; } /// - /// A base64 encoded string representation of the image. + /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. /// - /// A base64 encoded string representation of the image. + /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. /// - /// iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg== + /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("image_data")] - public string ImageData { get; set; } + [JsonPropertyName("label_image_id")] + public string? LabelImageId { get; set; } /// - /// The date and time that the image was created in ShipEngine. + /// The date and time that the image was modified in ShipEngine. /// - /// The date and time that the image was created in ShipEngine. + /// The date and time that the image was modified in ShipEngine. /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("modified_at")] + public DateTimeOffset? ModifiedAt { get; set; } /// - /// The date and time that the image was modified in ShipEngine. + /// A human readable name for the image. /// - /// The date and time that the image was modified in ShipEngine. + /// A human readable name for the image. /// - /// 2018-09-23T15:00Z + /// My logo /// - [JsonPropertyName("modified_at")] - public DateTimeOffset ModifiedAt { get; set; } + [JsonPropertyName("name")] + public string? Name { get; set; } /// @@ -161,13 +161,13 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class AccountSettingsImages {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); - sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" ImageContentType: ").Append(ImageContentType).Append("\n"); sb.Append(" ImageData: ").Append(ImageData).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); + sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs b/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs index 2b577292..6051dcad 100644 --- a/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs +++ b/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs @@ -28,14 +28,6 @@ namespace ShipEngineSDK.Model; public partial class AddFundsToCarrierRequestBody { - /// - /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - /// - /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("currency")] - [JsonRequired] - public string Currency { get; set; } - /// /// The monetary amount, in the specified currency. /// @@ -44,6 +36,14 @@ public partial class AddFundsToCarrierRequestBody [JsonRequired] public double Amount { get; set; } + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + [JsonPropertyName("currency")] + [JsonRequired] + public string Currency { get; set; } + /// /// Returns the string presentation of the object @@ -54,8 +54,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class AddFundsToCarrierRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Currency: ").Append(Currency).Append("\n"); sb.Append(" Amount: ").Append(Amount).Append("\n"); + sb.Append(" Currency: ").Append(Currency).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs b/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs index b8441d51..e06cbfc4 100644 --- a/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs +++ b/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs @@ -28,14 +28,6 @@ namespace ShipEngineSDK.Model; public partial class AddFundsToInsuranceRequestBody { - /// - /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - /// - /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("currency")] - [JsonRequired] - public string Currency { get; set; } - /// /// The monetary amount, in the specified currency. /// @@ -44,6 +36,14 @@ public partial class AddFundsToInsuranceRequestBody [JsonRequired] public double Amount { get; set; } + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + [JsonPropertyName("currency")] + [JsonRequired] + public string Currency { get; set; } + /// /// Returns the string presentation of the object @@ -54,8 +54,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class AddFundsToInsuranceRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Currency: ").Append(Currency).Append("\n"); sb.Append(" Amount: ").Append(Amount).Append("\n"); + sb.Append(" Currency: ").Append(Currency).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs b/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs index f2021847..0c7e0287 100644 --- a/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs +++ b/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs @@ -28,14 +28,6 @@ namespace ShipEngineSDK.Model; public partial class AddFundsToInsuranceResponseBody { - /// - /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - /// - /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("currency")] - [JsonRequired] - public string Currency { get; set; } - /// /// The monetary amount, in the specified currency. /// @@ -44,6 +36,14 @@ public partial class AddFundsToInsuranceResponseBody [JsonRequired] public double Amount { get; set; } + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + [JsonPropertyName("currency")] + [JsonRequired] + public string Currency { get; set; } + /// /// Returns the string presentation of the object @@ -54,8 +54,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class AddFundsToInsuranceResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Currency: ").Append(Currency).Append("\n"); sb.Append(" Amount: ").Append(Amount).Append("\n"); + sb.Append(" Currency: ").Append(Currency).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/AddToBatchRequestBody.cs b/ShipEngineSDK/Model/AddToBatchRequestBody.cs index 885b6e30..ab25f639 100644 --- a/ShipEngineSDK/Model/AddToBatchRequestBody.cs +++ b/ShipEngineSDK/Model/AddToBatchRequestBody.cs @@ -28,19 +28,19 @@ namespace ShipEngineSDK.Model; public partial class AddToBatchRequestBody { - /// - /// The Shipment Ids to be modified on the batch - /// - /// The Shipment Ids to be modified on the batch - [JsonPropertyName("shipment_ids")] - public List ShipmentIds { get; set; } - /// /// Array of Rate IDs to be modifed on the batch /// /// Array of Rate IDs to be modifed on the batch [JsonPropertyName("rate_ids")] - public List RateIds { get; set; } + public List? RateIds { get; set; } + + /// + /// The Shipment Ids to be modified on the batch + /// + /// The Shipment Ids to be modified on the batch + [JsonPropertyName("shipment_ids")] + public List? ShipmentIds { get; set; } /// @@ -52,8 +52,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class AddToBatchRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); sb.Append(" RateIds: ").Append(RateIds).Append("\n"); + sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/Address.cs b/ShipEngineSDK/Model/Address.cs index 65d99375..491391dd 100644 --- a/ShipEngineSDK/Model/Address.cs +++ b/ShipEngineSDK/Model/Address.cs @@ -37,6 +37,39 @@ public partial class Address public AddressResidentialIndicator AddressResidentialIndicator { get; set; } = new(); + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// 1999 Bishop Grandin Blvd. + /// + [JsonPropertyName("address_line1")] + [JsonRequired] + public string AddressLine1 { get; set; } + + /// + /// The name of the city or locality + /// + /// The name of the city or locality + /// + /// Winnipeg + /// + [JsonPropertyName("city_locality")] + [JsonRequired] + public string CityLocality { get; set; } + + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// CA + /// + [JsonPropertyName("country_code")] + [JsonRequired] + public string CountryCode { get; set; } + /// /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. /// @@ -60,35 +93,26 @@ public partial class Address public string Phone { get; set; } /// - /// Email for the address owner. - /// - /// Email for the address owner. - /// - /// example@example.com - /// - [JsonPropertyName("email")] - public string Email { get; set; } - - /// - /// If this is a business address, then the company name should be specified here. + /// postal code /// - /// If this is a business address, then the company name should be specified here. + /// postal code /// - /// The Home Depot + /// 78756-3717 /// - [JsonPropertyName("company_name")] - public string CompanyName { get; set; } + [JsonPropertyName("postal_code")] + [JsonRequired] + public string PostalCode { get; set; } /// - /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. /// - /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. /// - /// 1999 Bishop Grandin Blvd. + /// Manitoba /// - [JsonPropertyName("address_line1")] + [JsonPropertyName("state_province")] [JsonRequired] - public string AddressLine1 { get; set; } + public string StateProvince { get; set; } /// /// The second line of the street address. For some addresses, this line may not be needed. @@ -98,7 +122,7 @@ public partial class Address /// Unit 408 /// [JsonPropertyName("address_line2")] - public string AddressLine2 { get; set; } + public string? AddressLine2 { get; set; } /// /// The third line of the street address. For some addresses, this line may not be needed. @@ -108,51 +132,27 @@ public partial class Address /// Building #7 /// [JsonPropertyName("address_line3")] - public string AddressLine3 { get; set; } - - /// - /// The name of the city or locality - /// - /// The name of the city or locality - /// - /// Winnipeg - /// - [JsonPropertyName("city_locality")] - [JsonRequired] - public string CityLocality { get; set; } - - /// - /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. - /// - /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. - /// - /// Manitoba - /// - [JsonPropertyName("state_province")] - [JsonRequired] - public string StateProvince { get; set; } + public string? AddressLine3 { get; set; } /// - /// postal code + /// If this is a business address, then the company name should be specified here. /// - /// postal code + /// If this is a business address, then the company name should be specified here. /// - /// 78756-3717 + /// The Home Depot /// - [JsonPropertyName("postal_code")] - [JsonRequired] - public string PostalCode { get; set; } + [JsonPropertyName("company_name")] + public string? CompanyName { get; set; } /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// Email for the address owner. /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// Email for the address owner. /// - /// CA + /// example@example.com /// - [JsonPropertyName("country_code")] - [JsonRequired] - public string CountryCode { get; set; } + [JsonPropertyName("email")] + public string? Email { get; set; } /// @@ -164,18 +164,18 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class Address {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); + sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); + sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" Phone: ").Append(Phone).Append("\n"); - sb.Append(" Email: ").Append(Email).Append("\n"); - sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); - sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); - sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); - sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); - sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); - sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); - sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); + sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/AddressToValidate.cs b/ShipEngineSDK/Model/AddressToValidate.cs index c1e867b9..c46779d6 100644 --- a/ShipEngineSDK/Model/AddressToValidate.cs +++ b/ShipEngineSDK/Model/AddressToValidate.cs @@ -35,55 +35,48 @@ public partial class AddressToValidate [JsonPropertyName("address_residential_indicator")] public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } /// - /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. - /// - /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. - /// - /// John Doe - /// - [JsonPropertyName("name")] - public string Name { get; set; } - - /// - /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. /// - /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. /// - /// +1 204-253-9411 ext. 123 + /// 1999 Bishop Grandin Blvd. /// - [JsonPropertyName("phone")] - public string Phone { get; set; } + [JsonPropertyName("address_line1")] + [JsonRequired] + public string AddressLine1 { get; set; } /// - /// Email for the address owner. + /// The name of the city or locality /// - /// Email for the address owner. + /// The name of the city or locality /// - /// example@example.com + /// Winnipeg /// - [JsonPropertyName("email")] - public string Email { get; set; } + [JsonPropertyName("city_locality")] + [JsonRequired] + public string CityLocality { get; set; } /// - /// If this is a business address, then the company name should be specified here. + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) /// - /// If this is a business address, then the company name should be specified here. + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) /// - /// The Home Depot + /// CA /// - [JsonPropertyName("company_name")] - public string CompanyName { get; set; } + [JsonPropertyName("country_code")] + [JsonRequired] + public string CountryCode { get; set; } /// - /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. /// - /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. /// - /// 1999 Bishop Grandin Blvd. + /// Manitoba /// - [JsonPropertyName("address_line1")] + [JsonPropertyName("state_province")] [JsonRequired] - public string AddressLine1 { get; set; } + public string StateProvince { get; set; } /// /// The second line of the street address. For some addresses, this line may not be needed. @@ -93,7 +86,7 @@ public partial class AddressToValidate /// Unit 408 /// [JsonPropertyName("address_line2")] - public string AddressLine2 { get; set; } + public string? AddressLine2 { get; set; } /// /// The third line of the street address. For some addresses, this line may not be needed. @@ -103,50 +96,57 @@ public partial class AddressToValidate /// Building #7 /// [JsonPropertyName("address_line3")] - public string AddressLine3 { get; set; } + public string? AddressLine3 { get; set; } /// - /// The name of the city or locality + /// If this is a business address, then the company name should be specified here. /// - /// The name of the city or locality + /// If this is a business address, then the company name should be specified here. /// - /// Winnipeg + /// The Home Depot /// - [JsonPropertyName("city_locality")] - [JsonRequired] - public string CityLocality { get; set; } + [JsonPropertyName("company_name")] + public string? CompanyName { get; set; } /// - /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// Email for the address owner. /// - /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// Email for the address owner. /// - /// Manitoba + /// example@example.com /// - [JsonPropertyName("state_province")] - [JsonRequired] - public string StateProvince { get; set; } + [JsonPropertyName("email")] + public string? Email { get; set; } /// - /// postal code + /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. /// - /// postal code + /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. /// - /// 78756-3717 + /// John Doe /// - [JsonPropertyName("postal_code")] - public string PostalCode { get; set; } + [JsonPropertyName("name")] + public string? Name { get; set; } /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. /// - /// CA + /// +1 204-253-9411 ext. 123 /// - [JsonPropertyName("country_code")] - [JsonRequired] - public string CountryCode { get; set; } + [JsonPropertyName("phone")] + public string? Phone { get; set; } + + /// + /// postal code + /// + /// postal code + /// + /// 78756-3717 + /// + [JsonPropertyName("postal_code")] + public string? PostalCode { get; set; } /// @@ -158,18 +158,18 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class AddressToValidate {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Phone: ").Append(Phone).Append("\n"); - sb.Append(" Email: ").Append(Email).Append("\n"); - sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); - sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); - sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); - sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); - sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); + sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); + sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); + sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); + sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/AddressValidatingShipment.cs b/ShipEngineSDK/Model/AddressValidatingShipment.cs index aae27aff..0812f13d 100644 --- a/ShipEngineSDK/Model/AddressValidatingShipment.cs +++ b/ShipEngineSDK/Model/AddressValidatingShipment.cs @@ -28,17 +28,6 @@ namespace ShipEngineSDK.Model; public partial class AddressValidatingShipment { - /// - /// Gets or Sets ValidateAddress CLOVUS - /// - [JsonPropertyName("validate_address")] - public ValidateAddress? ValidateAddress { get; set; } - /// - /// The current status of the shipment CLOVUS - /// - /// The current status of the shipment - [JsonPropertyName("shipment_status")] - public ShipmentStatus? ShipmentStatus { get; set; } /// /// The type of delivery confirmation that is required for this shipment. CLOVUS /// @@ -57,16 +46,16 @@ public partial class AddressValidatingShipment [JsonPropertyName("order_source_code")] public OrderSourceName? OrderSourceCode { get; set; } /// - /// A string that uniquely identifies the shipment + /// The current status of the shipment CLOVUS /// - /// A string that uniquely identifies the shipment - /// - /// se-28529731 - /// - [JsonPropertyName("shipment_id")] - [JsonRequired] - public string ShipmentId { get; set; } - + /// The current status of the shipment + [JsonPropertyName("shipment_status")] + public ShipmentStatus? ShipmentStatus { get; set; } + /// + /// Gets or Sets ValidateAddress CLOVUS + /// + [JsonPropertyName("validate_address")] + public ValidateAddress? ValidateAddress { get; set; } /// /// The carrier account that is billed for the shipping charges /// @@ -90,58 +79,48 @@ public partial class AddressValidatingShipment public string ServiceCode { get; set; } /// - /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment - /// - /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment - /// - /// se-28529731 - /// - [JsonPropertyName("shipping_rule_id")] - public string ShippingRuleId { get; set; } - - /// - /// ID that the Order Source assigned - /// - /// ID that the Order Source assigned - [JsonPropertyName("external_order_id")] - public string ExternalOrderId { get; set; } - - /// - /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// - /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - [JsonPropertyName("items")] - public List Items { get; set; } + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. + [JsonPropertyName("ship_from")] + [JsonRequired] + public ShippingAddress ShipFrom { get; set; } /// - /// Gets or Sets TaxIdentifiers + /// The recipient's mailing address /// - [JsonPropertyName("tax_identifiers")] - public List TaxIdentifiers { get; set; } + /// The recipient's mailing address + [JsonPropertyName("ship_to")] + [JsonRequired] + public ShippingAddressTo ShipTo { get; set; } /// - /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. + /// A string that uniquely identifies the shipment /// - /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("external_shipment_id")] - public string ExternalShipmentId { get; set; } + /// A string that uniquely identifies the shipment + /// + /// se-28529731 + /// + [JsonPropertyName("shipment_id")] + [JsonRequired] + public string ShipmentId { get; set; } /// - /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. + /// Advanced shipment options. These are entirely optional. /// - /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("shipment_number")] - public string ShipmentNumber { get; set; } + /// Advanced shipment options. These are entirely optional. + [JsonPropertyName("advanced_options")] + public AdvancedShipmentOptions? AdvancedOptions { get; set; } /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. /// - /// 2018-09-23T00:00Z + /// retail /// - [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + [JsonPropertyName("comparison_rate_type")] + public string? ComparisonRateType { get; set; } /// /// The date and time that the shipment was created in ShipEngine. @@ -151,102 +130,123 @@ public partial class AddressValidatingShipment /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + public DateTimeOffset? CreatedAt { get; set; } /// - /// The date and time that the shipment was created or last modified. + /// Customs information. This is usually only needed for international shipments. /// - /// The date and time that the shipment was created or last modified. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("modified_at")] - public DateTimeOffset ModifiedAt { get; set; } + /// Customs information. This is usually only needed for international shipments. + [JsonPropertyName("customs")] + public InternationalShipmentOptions? Customs { get; set; } /// - /// The recipient's mailing address + /// ID that the Order Source assigned /// - /// The recipient's mailing address - [JsonPropertyName("ship_to")] - [JsonRequired] - public ShippingAddressTo ShipTo { get; set; } + /// ID that the Order Source assigned + [JsonPropertyName("external_order_id")] + public string? ExternalOrderId { get; set; } /// - /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. + /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. /// - /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from")] - [JsonRequired] - public ShippingAddress ShipFrom { get; set; } + /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. + [JsonPropertyName("external_shipment_id")] + public string? ExternalShipmentId { get; set; } /// - /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// - /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. + [JsonPropertyName("is_return")] + public bool? IsReturn { get; set; } + + /// + /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources + /// + /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources + [JsonPropertyName("items")] + public List? Items { get; set; } + + /// + /// The date and time that the shipment was created or last modified. + /// + /// The date and time that the shipment was created or last modified. /// - /// se-28529731 + /// 2018-09-23T15:00Z /// - [JsonPropertyName("warehouse_id")] - public string WarehouseId { get; set; } + [JsonPropertyName("modified_at")] + public DateTimeOffset? ModifiedAt { get; set; } + + /// + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + /// + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + [JsonPropertyName("packages")] + public List? Packages { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. /// /// The return address for this shipment. Defaults to the `ship_from` address. [JsonPropertyName("return_to")] - public ShippingAddress ReturnTo { get; set; } + public ShippingAddress? ReturnTo { get; set; } /// - /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. + /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. - [JsonPropertyName("is_return")] - public bool? IsReturn { get; set; } + /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// + /// 2018-09-23T00:00Z + /// + [JsonPropertyName("ship_date")] + public DateTimeOffset? ShipDate { get; set; } /// - /// Customs information. This is usually only needed for international shipments. + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// - /// Customs information. This is usually only needed for international shipments. - [JsonPropertyName("customs")] - public InternationalShipmentOptions Customs { get; set; } + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. + [JsonPropertyName("shipment_number")] + public string? ShipmentNumber { get; set; } /// - /// Advanced shipment options. These are entirely optional. + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment /// - /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options")] - public AdvancedShipmentOptions AdvancedOptions { get; set; } + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// + /// se-28529731 + /// + [JsonPropertyName("shipping_rule_id")] + public string? ShippingRuleId { get; set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. [JsonPropertyName("tags")] - public List Tags { get; set; } + public List? Tags { get; set; } /// - /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + /// Gets or Sets TaxIdentifiers /// - /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - public List Packages { get; set; } + [JsonPropertyName("tax_identifiers")] + public List? TaxIdentifiers { get; set; } /// /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment [JsonPropertyName("total_weight")] - public Weight TotalWeight { get; set; } + public Weight? TotalWeight { get; set; } /// - /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. /// - /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. /// - /// retail + /// se-28529731 /// - [JsonPropertyName("comparison_rate_type")] - public string ComparisonRateType { get; set; } + [JsonPropertyName("warehouse_id")] + public string? WarehouseId { get; set; } /// @@ -258,34 +258,34 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class AddressValidatingShipment {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); - sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); - sb.Append(" ShippingRuleId: ").Append(ShippingRuleId).Append("\n"); - sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); - sb.Append(" Items: ").Append(Items).Append("\n"); - sb.Append(" TaxIdentifiers: ").Append(TaxIdentifiers).Append("\n"); - sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); - sb.Append(" ShipmentNumber: ").Append(ShipmentNumber).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); - sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); - sb.Append(" ShipmentStatus: ").Append(ShipmentStatus).Append("\n"); - sb.Append(" ShipTo: ").Append(ShipTo).Append("\n"); sb.Append(" ShipFrom: ").Append(ShipFrom).Append("\n"); - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); - sb.Append(" ReturnTo: ").Append(ReturnTo).Append("\n"); - sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); + sb.Append(" ShipTo: ").Append(ShipTo).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); + sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" Customs: ").Append(Customs).Append("\n"); - sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); + sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); + sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); sb.Append(" InsuranceProvider: ").Append(InsuranceProvider).Append("\n"); - sb.Append(" Tags: ").Append(Tags).Append("\n"); + sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); + sb.Append(" Items: ").Append(Items).Append("\n"); + sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); sb.Append(" OrderSourceCode: ").Append(OrderSourceCode).Append("\n"); sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" ReturnTo: ").Append(ReturnTo).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" ShipmentNumber: ").Append(ShipmentNumber).Append("\n"); + sb.Append(" ShipmentStatus: ").Append(ShipmentStatus).Append("\n"); + sb.Append(" ShippingRuleId: ").Append(ShippingRuleId).Append("\n"); + sb.Append(" Tags: ").Append(Tags).Append("\n"); + sb.Append(" TaxIdentifiers: ").Append(TaxIdentifiers).Append("\n"); sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); - sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); + sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/AddressValidationResult.cs b/ShipEngineSDK/Model/AddressValidationResult.cs index 4ef8a11b..223b9ccc 100644 --- a/ShipEngineSDK/Model/AddressValidationResult.cs +++ b/ShipEngineSDK/Model/AddressValidationResult.cs @@ -36,6 +36,14 @@ public partial class AddressValidationResult public AddressValidationStatus Status { get; set; } = new(); + /// + /// The list of messages that were generated during the address validation request. + /// + /// The list of messages that were generated during the address validation request. + [JsonPropertyName("messages")] + [JsonRequired] + public List Messages { get; set; } + /// /// The original address that was sent for validation /// @@ -52,14 +60,6 @@ public partial class AddressValidationResult [JsonRequired] public Address MatchedAddress { get; set; } - /// - /// The list of messages that were generated during the address validation request. - /// - /// The list of messages that were generated during the address validation request. - [JsonPropertyName("messages")] - [JsonRequired] - public List Messages { get; set; } - /// /// Returns the string presentation of the object @@ -70,10 +70,10 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class AddressValidationResult {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Status: ").Append(Status).Append("\n"); + sb.Append(" Messages: ").Append(Messages).Append("\n"); sb.Append(" OriginalAddress: ").Append(OriginalAddress).Append("\n"); + sb.Append(" Status: ").Append(Status).Append("\n"); sb.Append(" MatchedAddress: ").Append(MatchedAddress).Append("\n"); - sb.Append(" Messages: ").Append(Messages).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptions.cs b/ShipEngineSDK/Model/AdvancedShipmentOptions.cs index 9b4fc56e..0a18c11b 100644 --- a/ShipEngineSDK/Model/AdvancedShipmentOptions.cs +++ b/ShipEngineSDK/Model/AdvancedShipmentOptions.cs @@ -39,12 +39,19 @@ public partial class AdvancedShipmentOptions /// [JsonPropertyName("origin_type")] public OriginType? OriginType { get; set; } + /// + /// Indicate to the carrier that this shipment requires additional handling. + /// + /// Indicate to the carrier that this shipment requires additional handling. + [JsonPropertyName("additional_handling")] + public bool? AdditionalHandling { get; set; } + /// /// This field is used to [bill shipping costs to a third party](https://www.shipengine.com/docs/shipping/bill-to-third-party/). This field must be used in conjunction with the `bill_to_country_code`, `bill_to_party`, and `bill_to_postal_code` fields. /// /// This field is used to [bill shipping costs to a third party](https://www.shipengine.com/docs/shipping/bill-to-third-party/). This field must be used in conjunction with the `bill_to_country_code`, `bill_to_party`, and `bill_to_postal_code` fields. [JsonPropertyName("bill_to_account")] - public string BillToAccount { get; set; } + public string? BillToAccount { get; set; } /// /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the third-party that is responsible for shipping costs. @@ -54,69 +61,88 @@ public partial class AdvancedShipmentOptions /// CA /// [JsonPropertyName("bill_to_country_code")] - public string BillToCountryCode { get; set; } + public string? BillToCountryCode { get; set; } /// /// The postal code of the third-party that is responsible for shipping costs. /// /// The postal code of the third-party that is responsible for shipping costs. [JsonPropertyName("bill_to_postal_code")] - public string BillToPostalCode { get; set; } + public string? BillToPostalCode { get; set; } + + /// + /// Gets or Sets CollectOnDelivery + /// + [JsonPropertyName("collect_on_delivery")] + public CollectOnDelivery? CollectOnDelivery { get; set; } /// /// Indicates that the shipment contains alcohol. /// /// Indicates that the shipment contains alcohol. [JsonPropertyName("contains_alcohol")] - public bool ContainsAlcohol { get; set; } + public bool? ContainsAlcohol { get; set; } + + /// + /// An arbitrary field that can be used to store information about the shipment. + /// + /// An arbitrary field that can be used to store information about the shipment. + [JsonPropertyName("custom_field1")] + public string? CustomField1 { get; set; } + + /// + /// An arbitrary field that can be used to store information about the shipment. + /// + /// An arbitrary field that can be used to store information about the shipment. + [JsonPropertyName("custom_field2")] + public string? CustomField2 { get; set; } + + /// + /// An arbitrary field that can be used to store information about the shipment. + /// + /// An arbitrary field that can be used to store information about the shipment. + [JsonPropertyName("custom_field3")] + public string? CustomField3 { get; set; } + + /// + /// Indicates if the Dangerous goods are present in the shipment + /// + /// Indicates if the Dangerous goods are present in the shipment + [JsonPropertyName("dangerous_goods")] + public bool? DangerousGoods { get; set; } + + /// + /// Gets or Sets DangerousGoodsContact + /// + [JsonPropertyName("dangerous_goods_contact")] + public AdvancedShipmentOptionsDangerousGoodsContact? DangerousGoodsContact { get; set; } /// /// Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express. /// /// Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express. [JsonPropertyName("delivered_duty_paid")] - public bool DeliveredDutyPaid { get; set; } + public bool? DeliveredDutyPaid { get; set; } /// /// Indicates if the shipment contain dry ice /// /// Indicates if the shipment contain dry ice [JsonPropertyName("dry_ice")] - public bool DryIce { get; set; } + public bool? DryIce { get; set; } /// /// The weight of the dry ice in the shipment /// /// The weight of the dry ice in the shipment [JsonPropertyName("dry_ice_weight")] - public Weight DryIceWeight { get; set; } - - /// - /// Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details. - /// - /// Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details. - [JsonPropertyName("non_machinable")] - public bool NonMachinable { get; set; } - - /// - /// Enables Saturday delivery, if supported by the carrier. - /// - /// Enables Saturday delivery, if supported by the carrier. - [JsonPropertyName("saturday_delivery")] - public bool SaturdayDelivery { get; set; } + public Weight? DryIceWeight { get; set; } /// /// Gets or Sets FedexFreight /// [JsonPropertyName("fedex_freight")] - public AdvancedShipmentOptionsFedexFreight FedexFreight { get; set; } - - /// - /// Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified. - /// - /// Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified. - [JsonPropertyName("use_ups_ground_freight_pricing")] - public bool? UseUpsGroundFreightPricing { get; set; } + public AdvancedShipmentOptionsFedexFreight? FedexFreight { get; set; } /// /// The National Motor Freight Traffic Association [freight class](http://www.nmfta.org/pages/nmfc?AspxAutoDetectCookieSupport=1), such as \"77.5\", \"110\", or \"250\". @@ -126,35 +152,21 @@ public partial class AdvancedShipmentOptions /// 77.5 /// [JsonPropertyName("freight_class")] - public string FreightClass { get; set; } - - /// - /// An arbitrary field that can be used to store information about the shipment. - /// - /// An arbitrary field that can be used to store information about the shipment. - [JsonPropertyName("custom_field1")] - public string CustomField1 { get; set; } - - /// - /// An arbitrary field that can be used to store information about the shipment. - /// - /// An arbitrary field that can be used to store information about the shipment. - [JsonPropertyName("custom_field2")] - public string CustomField2 { get; set; } + public string? FreightClass { get; set; } /// - /// An arbitrary field that can be used to store information about the shipment. + /// Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details. /// - /// An arbitrary field that can be used to store information about the shipment. - [JsonPropertyName("custom_field3")] - public string CustomField3 { get; set; } + /// Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details. + [JsonPropertyName("non_machinable")] + public bool? NonMachinable { get; set; } /// - /// Indicate to the carrier that this shipment requires additional handling. + /// Enables Saturday delivery, if supported by the carrier. /// - /// Indicate to the carrier that this shipment requires additional handling. - [JsonPropertyName("additional_handling")] - public bool? AdditionalHandling { get; set; } + /// Enables Saturday delivery, if supported by the carrier. + [JsonPropertyName("saturday_delivery")] + public bool? SaturdayDelivery { get; set; } /// /// Gets or Sets ShipperRelease @@ -162,31 +174,19 @@ public partial class AdvancedShipmentOptions [JsonPropertyName("shipper_release")] public bool? ShipperRelease { get; set; } - /// - /// Gets or Sets CollectOnDelivery - /// - [JsonPropertyName("collect_on_delivery")] - public CollectOnDelivery CollectOnDelivery { get; set; } - /// /// Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached /// /// Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached [JsonPropertyName("third_party_consignee")] - public bool ThirdPartyConsignee { get; set; } + public bool? ThirdPartyConsignee { get; set; } /// - /// Indicates if the Dangerous goods are present in the shipment - /// - /// Indicates if the Dangerous goods are present in the shipment - [JsonPropertyName("dangerous_goods")] - public bool DangerousGoods { get; set; } - - /// - /// Gets or Sets DangerousGoodsContact + /// Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified. /// - [JsonPropertyName("dangerous_goods_contact")] - public AdvancedShipmentOptionsDangerousGoodsContact DangerousGoodsContact { get; set; } + /// Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified. + [JsonPropertyName("use_ups_ground_freight_pricing")] + public bool? UseUpsGroundFreightPricing { get; set; } /// @@ -198,29 +198,29 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class AdvancedShipmentOptions {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" AdditionalHandling: ").Append(AdditionalHandling).Append("\n"); sb.Append(" BillToAccount: ").Append(BillToAccount).Append("\n"); sb.Append(" BillToCountryCode: ").Append(BillToCountryCode).Append("\n"); sb.Append(" BillToParty: ").Append(BillToParty).Append("\n"); sb.Append(" BillToPostalCode: ").Append(BillToPostalCode).Append("\n"); + sb.Append(" CollectOnDelivery: ").Append(CollectOnDelivery).Append("\n"); sb.Append(" ContainsAlcohol: ").Append(ContainsAlcohol).Append("\n"); + sb.Append(" CustomField1: ").Append(CustomField1).Append("\n"); + sb.Append(" CustomField2: ").Append(CustomField2).Append("\n"); + sb.Append(" CustomField3: ").Append(CustomField3).Append("\n"); + sb.Append(" DangerousGoods: ").Append(DangerousGoods).Append("\n"); + sb.Append(" DangerousGoodsContact: ").Append(DangerousGoodsContact).Append("\n"); sb.Append(" DeliveredDutyPaid: ").Append(DeliveredDutyPaid).Append("\n"); sb.Append(" DryIce: ").Append(DryIce).Append("\n"); sb.Append(" DryIceWeight: ").Append(DryIceWeight).Append("\n"); - sb.Append(" NonMachinable: ").Append(NonMachinable).Append("\n"); - sb.Append(" SaturdayDelivery: ").Append(SaturdayDelivery).Append("\n"); sb.Append(" FedexFreight: ").Append(FedexFreight).Append("\n"); - sb.Append(" UseUpsGroundFreightPricing: ").Append(UseUpsGroundFreightPricing).Append("\n"); sb.Append(" FreightClass: ").Append(FreightClass).Append("\n"); - sb.Append(" CustomField1: ").Append(CustomField1).Append("\n"); - sb.Append(" CustomField2: ").Append(CustomField2).Append("\n"); - sb.Append(" CustomField3: ").Append(CustomField3).Append("\n"); + sb.Append(" NonMachinable: ").Append(NonMachinable).Append("\n"); sb.Append(" OriginType: ").Append(OriginType).Append("\n"); - sb.Append(" AdditionalHandling: ").Append(AdditionalHandling).Append("\n"); + sb.Append(" SaturdayDelivery: ").Append(SaturdayDelivery).Append("\n"); sb.Append(" ShipperRelease: ").Append(ShipperRelease).Append("\n"); - sb.Append(" CollectOnDelivery: ").Append(CollectOnDelivery).Append("\n"); sb.Append(" ThirdPartyConsignee: ").Append(ThirdPartyConsignee).Append("\n"); - sb.Append(" DangerousGoods: ").Append(DangerousGoods).Append("\n"); - sb.Append(" DangerousGoodsContact: ").Append(DangerousGoodsContact).Append("\n"); + sb.Append(" UseUpsGroundFreightPricing: ").Append(UseUpsGroundFreightPricing).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs b/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs index f0a5df25..68d8ee64 100644 --- a/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs +++ b/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs @@ -33,14 +33,14 @@ public partial class AdvancedShipmentOptionsDangerousGoodsContact /// /// Name of the contact [JsonPropertyName("name")] - public string Name { get; set; } + public string? Name { get; set; } /// /// Phone number of the contact /// /// Phone number of the contact [JsonPropertyName("phone")] - public string Phone { get; set; } + public string? Phone { get; set; } /// diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs b/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs index 7477ac56..fc37c4ce 100644 --- a/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs +++ b/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs @@ -29,16 +29,16 @@ public partial class AdvancedShipmentOptionsFedexFreight { /// - /// Gets or Sets ShipperLoadAndCount + /// Gets or Sets BookingConfirmation /// - [JsonPropertyName("shipper_load_and_count")] - public string ShipperLoadAndCount { get; set; } + [JsonPropertyName("booking_confirmation")] + public string? BookingConfirmation { get; set; } /// - /// Gets or Sets BookingConfirmation + /// Gets or Sets ShipperLoadAndCount /// - [JsonPropertyName("booking_confirmation")] - public string BookingConfirmation { get; set; } + [JsonPropertyName("shipper_load_and_count")] + public string? ShipperLoadAndCount { get; set; } /// @@ -50,8 +50,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class AdvancedShipmentOptionsFedexFreight {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ShipperLoadAndCount: ").Append(ShipperLoadAndCount).Append("\n"); sb.Append(" BookingConfirmation: ").Append(BookingConfirmation).Append("\n"); + sb.Append(" ShipperLoadAndCount: ").Append(ShipperLoadAndCount).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/AlternativeIdentifier.cs b/ShipEngineSDK/Model/AlternativeIdentifier.cs index 946aa902..df6f3b67 100644 --- a/ShipEngineSDK/Model/AlternativeIdentifier.cs +++ b/ShipEngineSDK/Model/AlternativeIdentifier.cs @@ -36,7 +36,7 @@ public partial class AlternativeIdentifier /// last_mile_tracking_number /// [JsonPropertyName("type")] - public string Type { get; set; } + public string? Type { get; set; } /// /// The value of the alternative_identifier. @@ -46,7 +46,7 @@ public partial class AlternativeIdentifier /// 12345678912345678912 /// [JsonPropertyName("value")] - public string Value { get; set; } + public string? Value { get; set; } /// diff --git a/ShipEngineSDK/Model/AlternativeIdentifiers.cs b/ShipEngineSDK/Model/AlternativeIdentifiers.cs index 7dd456eb..f3fc1886 100644 --- a/ShipEngineSDK/Model/AlternativeIdentifiers.cs +++ b/ShipEngineSDK/Model/AlternativeIdentifiers.cs @@ -33,7 +33,7 @@ public partial class AlternativeIdentifiers /// /// Alternative identifiers associated with this package. [JsonPropertyName("alternative_identifiers")] - public List VarAlternativeIdentifiers { get; set; } + public List? VarAlternativeIdentifiers { get; set; } /// diff --git a/ShipEngineSDK/Model/Batch.cs b/ShipEngineSDK/Model/Batch.cs index 27b0f661..a0ecc41b 100644 --- a/ShipEngineSDK/Model/Batch.cs +++ b/ShipEngineSDK/Model/Batch.cs @@ -29,20 +29,20 @@ public partial class Batch { /// - /// label layout CLOVUS + /// Gets or Sets LabelFormat CLOVUS /// - /// label layout - [JsonPropertyName("label_layout")] + [JsonPropertyName("label_format")] [JsonRequired] - public LabelLayout LabelLayout { get; set; } = new(); + public LabelFormat LabelFormat { get; set; } = new(); /// - /// Gets or Sets LabelFormat CLOVUS + /// label layout CLOVUS /// - [JsonPropertyName("label_format")] + /// label layout + [JsonPropertyName("label_layout")] [JsonRequired] - public LabelFormat LabelFormat { get; set; } = new(); + public LabelLayout LabelLayout { get; set; } = new(); /// @@ -53,6 +53,14 @@ public partial class Batch public BatchStatus Status { get; set; } = new(); + /// + /// Link to batch errors endpoint + /// + /// Link to batch errors endpoint + [JsonPropertyName("batch_errors_url")] + [JsonRequired] + public OptionalLink BatchErrorsUrl { get; set; } + /// /// A string that uniquely identifies the batch /// @@ -64,6 +72,14 @@ public partial class Batch [JsonRequired] public string BatchId { get; set; } + /// + /// Link to batch labels query + /// + /// Link to batch labels query + [JsonPropertyName("batch_labels_url")] + [JsonRequired] + public OptionalLink BatchLabelsUrl { get; set; } + /// /// The batch number. /// @@ -73,45 +89,45 @@ public partial class Batch public string BatchNumber { get; set; } /// - /// A string that uniquely identifies the external batch + /// The batch shipments endpoint /// - /// A string that uniquely identifies the external batch - [JsonPropertyName("external_batch_id")] + /// The batch shipments endpoint + [JsonPropertyName("batch_shipments_url")] [JsonRequired] - public string ExternalBatchId { get; set; } + public OptionalLink BatchShipmentsUrl { get; set; } /// - /// Custom notes you can add for each created batch + /// The number of labels generated in the batch /// - /// Custom notes you can add for each created batch + /// The number of labels generated in the batch /// - /// Batch for morning shipment + /// 1 /// - [JsonPropertyName("batch_notes")] + [JsonPropertyName("completed")] [JsonRequired] - public string BatchNotes { get; set; } + public int Completed { get; set; } /// - /// The date and time the batch was created in ShipEngine + /// The total of errors, warnings, and completed properties /// - /// The date and time the batch was created in ShipEngine + /// The total of errors, warnings, and completed properties /// - /// 2018-09-23T15:00Z + /// 2 /// - [JsonPropertyName("created_at")] + [JsonPropertyName("count")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public int Count { get; set; } /// - /// The date and time the batch was processed in ShipEngine + /// The date and time the batch was created in ShipEngine /// - /// The date and time the batch was processed in ShipEngine + /// The date and time the batch was created in ShipEngine /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("processed_at")] + [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset ProcessedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The number of errors that occurred while generating the batch @@ -125,34 +141,12 @@ public partial class Batch public int Errors { get; set; } /// - /// The errors associated with the failed API call - /// - /// The errors associated with the failed API call - [JsonPropertyName("process_errors")] - [JsonRequired] - public List ProcessErrors { get; set; } - - /// - /// The number of warnings that occurred while generating the batch - /// - /// The number of warnings that occurred while generating the batch - /// - /// 1 - /// - [JsonPropertyName("warnings")] - [JsonRequired] - public int Warnings { get; set; } - - /// - /// The number of labels generated in the batch + /// The form download for any customs that are needed /// - /// The number of labels generated in the batch - /// - /// 1 - /// - [JsonPropertyName("completed")] + /// The form download for any customs that are needed + [JsonPropertyName("form_download")] [JsonRequired] - public int Completed { get; set; } + public OptionalLink FormDownload { get; set; } /// /// The number of forms for customs that are available for download @@ -166,63 +160,69 @@ public partial class Batch public int Forms { get; set; } /// - /// The total of errors, warnings, and completed properties + /// The label download for the batch /// - /// The total of errors, warnings, and completed properties - /// - /// 2 - /// - [JsonPropertyName("count")] + /// The label download for the batch + [JsonPropertyName("label_download")] [JsonRequired] - public int Count { get; set; } + public LabelDownload LabelDownload { get; set; } /// - /// The batch shipments endpoint + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// - /// The batch shipments endpoint - [JsonPropertyName("batch_shipments_url")] + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + [JsonPropertyName("paperless_download")] [JsonRequired] - public OptionalLink BatchShipmentsUrl { get; set; } + public PaperlessDownload PaperlessDownload { get; set; } /// - /// Link to batch labels query + /// The errors associated with the failed API call /// - /// Link to batch labels query - [JsonPropertyName("batch_labels_url")] + /// The errors associated with the failed API call + [JsonPropertyName("process_errors")] [JsonRequired] - public OptionalLink BatchLabelsUrl { get; set; } + public List ProcessErrors { get; set; } /// - /// Link to batch errors endpoint + /// The number of warnings that occurred while generating the batch /// - /// Link to batch errors endpoint - [JsonPropertyName("batch_errors_url")] + /// The number of warnings that occurred while generating the batch + /// + /// 1 + /// + [JsonPropertyName("warnings")] [JsonRequired] - public OptionalLink BatchErrorsUrl { get; set; } + public int Warnings { get; set; } /// - /// The label download for the batch + /// Custom notes you can add for each created batch /// - /// The label download for the batch - [JsonPropertyName("label_download")] + /// Custom notes you can add for each created batch + /// + /// Batch for morning shipment + /// + [JsonPropertyName("batch_notes")] [JsonRequired] - public LabelDownload LabelDownload { get; set; } + public string BatchNotes { get; set; } /// - /// The form download for any customs that are needed + /// A string that uniquely identifies the external batch /// - /// The form download for any customs that are needed - [JsonPropertyName("form_download")] + /// A string that uniquely identifies the external batch + [JsonPropertyName("external_batch_id")] [JsonRequired] - public OptionalLink FormDownload { get; set; } + public string ExternalBatchId { get; set; } /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// The date and time the batch was processed in ShipEngine /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] + /// The date and time the batch was processed in ShipEngine + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("processed_at")] [JsonRequired] - public PaperlessDownload PaperlessDownload { get; set; } + public DateTimeOffset ProcessedAt { get; set; } /// @@ -234,27 +234,27 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class Batch {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); - sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" BatchErrorsUrl: ").Append(BatchErrorsUrl).Append("\n"); sb.Append(" BatchId: ").Append(BatchId).Append("\n"); + sb.Append(" BatchLabelsUrl: ").Append(BatchLabelsUrl).Append("\n"); sb.Append(" BatchNumber: ").Append(BatchNumber).Append("\n"); - sb.Append(" ExternalBatchId: ").Append(ExternalBatchId).Append("\n"); - sb.Append(" BatchNotes: ").Append(BatchNotes).Append("\n"); + sb.Append(" BatchShipmentsUrl: ").Append(BatchShipmentsUrl).Append("\n"); + sb.Append(" Completed: ").Append(Completed).Append("\n"); + sb.Append(" Count: ").Append(Count).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); - sb.Append(" ProcessedAt: ").Append(ProcessedAt).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); - sb.Append(" ProcessErrors: ").Append(ProcessErrors).Append("\n"); - sb.Append(" Warnings: ").Append(Warnings).Append("\n"); - sb.Append(" Completed: ").Append(Completed).Append("\n"); + sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); sb.Append(" Forms: ").Append(Forms).Append("\n"); - sb.Append(" Count: ").Append(Count).Append("\n"); - sb.Append(" BatchShipmentsUrl: ").Append(BatchShipmentsUrl).Append("\n"); - sb.Append(" BatchLabelsUrl: ").Append(BatchLabelsUrl).Append("\n"); - sb.Append(" BatchErrorsUrl: ").Append(BatchErrorsUrl).Append("\n"); sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); - sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); + sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" ProcessErrors: ").Append(ProcessErrors).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); + sb.Append(" Warnings: ").Append(Warnings).Append("\n"); + sb.Append(" BatchNotes: ").Append(BatchNotes).Append("\n"); + sb.Append(" ExternalBatchId: ").Append(ExternalBatchId).Append("\n"); + sb.Append(" ProcessedAt: ").Append(ProcessedAt).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/BatchResponseError.cs b/ShipEngineSDK/Model/BatchResponseError.cs index b93ff9f0..f6694f54 100644 --- a/ShipEngineSDK/Model/BatchResponseError.cs +++ b/ShipEngineSDK/Model/BatchResponseError.cs @@ -36,7 +36,14 @@ public partial class BatchResponseError /// Recipient address has not been verified. /// [JsonPropertyName("error")] - public string Error { get; set; } + public string? Error { get; set; } + + /// + /// An external shipment id associated with the shipment + /// + /// An external shipment id associated with the shipment + [JsonPropertyName("external_shipment_id")] + public string? ExternalShipmentId { get; set; } /// /// A string that uniquely identifies the shipment @@ -46,14 +53,7 @@ public partial class BatchResponseError /// se-28529731 /// [JsonPropertyName("shipment_id")] - public string ShipmentId { get; set; } - - /// - /// An external shipment id associated with the shipment - /// - /// An external shipment id associated with the shipment - [JsonPropertyName("external_shipment_id")] - public string ExternalShipmentId { get; set; } + public string? ShipmentId { get; set; } /// @@ -66,8 +66,8 @@ public override string ToString() sb.Append("class BatchResponseError {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Error: ").Append(Error).Append("\n"); - sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/BulkRate.cs b/ShipEngineSDK/Model/BulkRate.cs index b7e8b7bc..c7afbbaa 100644 --- a/ShipEngineSDK/Model/BulkRate.cs +++ b/ShipEngineSDK/Model/BulkRate.cs @@ -36,6 +36,25 @@ public partial class BulkRate public RateResponseStatus Status { get; set; } = new(); + /// + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. + /// + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("created_at")] + [JsonRequired] + public DateTimeOffset CreatedAt { get; set; } + + /// + /// An array of errors that were returned while retrieving the bulk rate + /// + /// An array of errors that were returned while retrieving the bulk rate + [JsonPropertyName("errors")] + [JsonRequired] + public List Errors { get; set; } + /// /// A string that uniquely identifies the rate request /// @@ -58,25 +77,6 @@ public partial class BulkRate [JsonRequired] public string ShipmentId { get; set; } - /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. - /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("created_at")] - [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } - - /// - /// An array of errors that were returned while retrieving the bulk rate - /// - /// An array of errors that were returned while retrieving the bulk rate - [JsonPropertyName("errors")] - [JsonRequired] - public List Errors { get; set; } - /// /// Returns the string presentation of the object @@ -87,11 +87,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class BulkRate {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); sb.Append(" RateRequestId: ").Append(RateRequestId).Append("\n"); sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); - sb.Append(" Errors: ").Append(Errors).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CalculateRatesRequestBody.cs b/ShipEngineSDK/Model/CalculateRatesRequestBody.cs index b7f1b2a6..a513a3f2 100644 --- a/ShipEngineSDK/Model/CalculateRatesRequestBody.cs +++ b/ShipEngineSDK/Model/CalculateRatesRequestBody.cs @@ -36,7 +36,7 @@ public partial class CalculateRatesRequestBody : AbstractOpenAPISchema /// /// The rate options [JsonPropertyName("rate_options")] - public RateRequestBody RateOptions { get; set; } + public RateRequestBody? RateOptions { get; set; } /// diff --git a/ShipEngineSDK/Model/CalculateRatesResponseBody.cs b/ShipEngineSDK/Model/CalculateRatesResponseBody.cs index a2674308..97f0b880 100644 --- a/ShipEngineSDK/Model/CalculateRatesResponseBody.cs +++ b/ShipEngineSDK/Model/CalculateRatesResponseBody.cs @@ -28,15 +28,6 @@ namespace ShipEngineSDK.Model; public partial class CalculateRatesResponseBody { - /// - /// The current status of the shipment CLOVUS - /// - /// The current status of the shipment - [JsonPropertyName("shipment_status")] - [JsonRequired] - public ShipmentStatus ShipmentStatus { get; set; } = new(); - - /// /// The type of delivery confirmation that is required for this shipment. CLOVUS /// @@ -55,85 +46,73 @@ public partial class CalculateRatesResponseBody public InsuranceProvider InsuranceProvider { get; set; } = new(); + /// + /// The current status of the shipment CLOVUS + /// + /// The current status of the shipment + [JsonPropertyName("shipment_status")] + [JsonRequired] + public ShipmentStatus ShipmentStatus { get; set; } = new(); + + /// /// Gets or Sets OrderSourceCode CLOVUS /// [JsonPropertyName("order_source_code")] public OrderSourceName? OrderSourceCode { get; set; } /// - /// A string that uniquely identifies the shipment + /// Advanced shipment options. These are entirely optional. /// - /// A string that uniquely identifies the shipment - /// - /// se-28529731 - /// - [JsonPropertyName("shipment_id")] + /// Advanced shipment options. These are entirely optional. + [JsonPropertyName("advanced_options")] [JsonRequired] - public string ShipmentId { get; set; } - - /// - /// The carrier account that is billed for the shipping charges - /// - /// The carrier account that is billed for the shipping charges - /// - /// se-28529731 - /// - [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + public AdvancedShipmentOptions AdvancedOptions { get; set; } /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// The date and time that the shipment was created in ShipEngine. /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// The date and time that the shipment was created in ShipEngine. /// - /// usps_first_class_mail + /// 2018-09-23T15:00Z /// - [JsonPropertyName("service_code")] - public string ServiceCode { get; set; } + [JsonPropertyName("created_at")] + [JsonRequired] + public DateTimeOffset CreatedAt { get; set; } /// - /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// The date and time that the shipment was created or last modified. /// - /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// The date and time that the shipment was created or last modified. /// - /// se-28529731 + /// 2018-09-23T15:00Z /// - [JsonPropertyName("shipping_rule_id")] - public string ShippingRuleId { get; set; } - - /// - /// ID that the Order Source assigned - /// - /// ID that the Order Source assigned - [JsonPropertyName("external_order_id")] - public string ExternalOrderId { get; set; } - - /// - /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - /// - /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - [JsonPropertyName("items")] - public List Items { get; set; } + [JsonPropertyName("modified_at")] + [JsonRequired] + public DateTimeOffset ModifiedAt { get; set; } /// - /// Gets or Sets TaxIdentifiers + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// - [JsonPropertyName("tax_identifiers")] - public List TaxIdentifiers { get; set; } + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + [JsonPropertyName("packages")] + [JsonRequired] + public List Packages { get; set; } /// - /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. + /// The rates response /// - /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("external_shipment_id")] - public string ExternalShipmentId { get; set; } + /// The rates response + [JsonPropertyName("rate_response")] + [JsonRequired] + public RatesInformation RateResponse { get; set; } /// - /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. + /// The return address for this shipment. Defaults to the `ship_from` address. /// - /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("shipment_number")] - public string ShipmentNumber { get; set; } + /// The return address for this shipment. Defaults to the `ship_from` address. + [JsonPropertyName("return_to")] + [JsonRequired] + public ShippingAddress ReturnTo { get; set; } /// /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -147,58 +126,73 @@ public partial class CalculateRatesResponseBody public DateTimeOffset ShipDate { get; set; } /// - /// The date and time that the shipment was created in ShipEngine. + /// A string that uniquely identifies the shipment /// - /// The date and time that the shipment was created in ShipEngine. + /// A string that uniquely identifies the shipment /// - /// 2018-09-23T15:00Z + /// se-28529731 /// - [JsonPropertyName("created_at")] + [JsonPropertyName("shipment_id")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public string ShipmentId { get; set; } /// - /// The date and time that the shipment was created or last modified. + /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// - /// The date and time that the shipment was created or last modified. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("modified_at")] + /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. + [JsonPropertyName("tags")] [JsonRequired] - public DateTimeOffset ModifiedAt { get; set; } + public List Tags { get; set; } /// - /// The recipient's mailing address + /// The combined weight of all packages in the shipment /// - /// The recipient's mailing address - [JsonPropertyName("ship_to")] - public ShippingAddressTo ShipTo { get; set; } + /// The combined weight of all packages in the shipment + [JsonPropertyName("total_weight")] + [JsonRequired] + public Weight TotalWeight { get; set; } /// - /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. + /// The carrier account that is billed for the shipping charges /// - /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from")] - public ShippingAddress ShipFrom { get; set; } + /// The carrier account that is billed for the shipping charges + /// + /// se-28529731 + /// + [JsonPropertyName("carrier_id")] + public string? CarrierId { get; set; } /// - /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. /// - /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. /// - /// se-28529731 + /// retail /// - [JsonPropertyName("warehouse_id")] - public string WarehouseId { get; set; } + [JsonPropertyName("comparison_rate_type")] + public string? ComparisonRateType { get; set; } /// - /// The return address for this shipment. Defaults to the `ship_from` address. + /// Customs information. This is usually only needed for international shipments. /// - /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to")] + /// Customs information. This is usually only needed for international shipments. + [JsonPropertyName("customs")] [JsonRequired] - public ShippingAddress ReturnTo { get; set; } + public InternationalShipmentOptions Customs { get; set; } + + /// + /// ID that the Order Source assigned + /// + /// ID that the Order Source assigned + [JsonPropertyName("external_order_id")] + public string? ExternalOrderId { get; set; } + + /// + /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. + /// + /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. + [JsonPropertyName("external_shipment_id")] + public string? ExternalShipmentId { get; set; } /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. @@ -208,62 +202,68 @@ public partial class CalculateRatesResponseBody public bool? IsReturn { get; set; } /// - /// Customs information. This is usually only needed for international shipments. + /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources /// - /// Customs information. This is usually only needed for international shipments. - [JsonPropertyName("customs")] - [JsonRequired] - public InternationalShipmentOptions Customs { get; set; } + /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources + [JsonPropertyName("items")] + public List? Items { get; set; } /// - /// Advanced shipment options. These are entirely optional. + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// - /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options")] - [JsonRequired] - public AdvancedShipmentOptions AdvancedOptions { get; set; } + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// usps_first_class_mail + /// + [JsonPropertyName("service_code")] + public string? ServiceCode { get; set; } /// - /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// - /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. - [JsonPropertyName("tags")] - [JsonRequired] - public List Tags { get; set; } + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. + [JsonPropertyName("ship_from")] + public ShippingAddress? ShipFrom { get; set; } /// - /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + /// The recipient's mailing address /// - /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - [JsonRequired] - public List Packages { get; set; } + /// The recipient's mailing address + [JsonPropertyName("ship_to")] + public ShippingAddressTo? ShipTo { get; set; } /// - /// The combined weight of all packages in the shipment + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// - /// The combined weight of all packages in the shipment - [JsonPropertyName("total_weight")] - [JsonRequired] - public Weight TotalWeight { get; set; } + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. + [JsonPropertyName("shipment_number")] + public string? ShipmentNumber { get; set; } /// - /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment /// - /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment /// - /// retail + /// se-28529731 /// - [JsonPropertyName("comparison_rate_type")] - public string ComparisonRateType { get; set; } + [JsonPropertyName("shipping_rule_id")] + public string? ShippingRuleId { get; set; } /// - /// The rates response + /// Gets or Sets TaxIdentifiers /// - /// The rates response - [JsonPropertyName("rate_response")] - [JsonRequired] - public RatesInformation RateResponse { get; set; } + [JsonPropertyName("tax_identifiers")] + public List? TaxIdentifiers { get; set; } + + /// + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// + /// se-28529731 + /// + [JsonPropertyName("warehouse_id")] + public string? WarehouseId { get; set; } /// @@ -275,34 +275,34 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CalculateRatesResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); - sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); - sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); - sb.Append(" ShippingRuleId: ").Append(ShippingRuleId).Append("\n"); - sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); - sb.Append(" Items: ").Append(Items).Append("\n"); - sb.Append(" TaxIdentifiers: ").Append(TaxIdentifiers).Append("\n"); - sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); - sb.Append(" ShipmentNumber: ").Append(ShipmentNumber).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); + sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" InsuranceProvider: ").Append(InsuranceProvider).Append("\n"); sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); - sb.Append(" ShipmentStatus: ").Append(ShipmentStatus).Append("\n"); - sb.Append(" ShipTo: ").Append(ShipTo).Append("\n"); - sb.Append(" ShipFrom: ").Append(ShipFrom).Append("\n"); - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" RateResponse: ").Append(RateResponse).Append("\n"); sb.Append(" ReturnTo: ").Append(ReturnTo).Append("\n"); - sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); - sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); - sb.Append(" Customs: ").Append(Customs).Append("\n"); - sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); - sb.Append(" InsuranceProvider: ").Append(InsuranceProvider).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" ShipmentStatus: ").Append(ShipmentStatus).Append("\n"); sb.Append(" Tags: ").Append(Tags).Append("\n"); - sb.Append(" OrderSourceCode: ").Append(OrderSourceCode).Append("\n"); - sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); - sb.Append(" RateResponse: ").Append(RateResponse).Append("\n"); + sb.Append(" Customs: ").Append(Customs).Append("\n"); + sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); + sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); + sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); + sb.Append(" Items: ").Append(Items).Append("\n"); + sb.Append(" OrderSourceCode: ").Append(OrderSourceCode).Append("\n"); + sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" ShipFrom: ").Append(ShipFrom).Append("\n"); + sb.Append(" ShipTo: ").Append(ShipTo).Append("\n"); + sb.Append(" ShipmentNumber: ").Append(ShipmentNumber).Append("\n"); + sb.Append(" ShippingRuleId: ").Append(ShippingRuleId).Append("\n"); + sb.Append(" TaxIdentifiers: ").Append(TaxIdentifiers).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/Carrier.cs b/ShipEngineSDK/Model/Carrier.cs index a6eac9f7..1413a236 100644 --- a/ShipEngineSDK/Model/Carrier.cs +++ b/ShipEngineSDK/Model/Carrier.cs @@ -29,14 +29,24 @@ public partial class Carrier { /// - /// A string that uniquely identifies the carrier. + /// The account number that the carrier is connected to. /// - /// A string that uniquely identifies the carrier. + /// The account number that the carrier is connected to. /// - /// se-28529731 + /// account_570827 /// - [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + [JsonPropertyName("account_number")] + public string? AccountNumber { get; set; } + + /// + /// Current available balance + /// + /// Current available balance + /// + /// 3799.52 + /// + [JsonPropertyName("balance")] + public double? Balance { get; set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. @@ -46,34 +56,41 @@ public partial class Carrier /// dhl_express /// [JsonPropertyName("carrier_code")] - public string CarrierCode { get; set; } + public string? CarrierCode { get; set; } /// - /// The account number that the carrier is connected to. + /// A string that uniquely identifies the carrier. /// - /// The account number that the carrier is connected to. + /// A string that uniquely identifies the carrier. /// - /// account_570827 + /// se-28529731 /// - [JsonPropertyName("account_number")] - public string AccountNumber { get; set; } + [JsonPropertyName("carrier_id")] + public string? CarrierId { get; set; } /// - /// Indicates whether the carrier requires funding to use its services + /// The carrier is disabled by the current ShipEngine account's billing plan. /// - /// Indicates whether the carrier requires funding to use its services - [JsonPropertyName("requires_funded_amount")] - public bool RequiresFundedAmount { get; set; } + /// The carrier is disabled by the current ShipEngine account's billing plan. + [JsonPropertyName("disabled_by_billing_plan")] + public bool? DisabledByBillingPlan { get; set; } /// - /// Current available balance + /// Screen readable name /// - /// Current available balance + /// Screen readable name /// - /// 3799.52 + /// Stamps.com /// - [JsonPropertyName("balance")] - public double Balance { get; set; } + [JsonPropertyName("friendly_name")] + public string? FriendlyName { get; set; } + + /// + /// Carrier supports multiple packages per shipment + /// + /// Carrier supports multiple packages per shipment + [JsonPropertyName("has_multi_package_supporting_services")] + public bool? HasMultiPackageSupportingServices { get; set; } /// /// Nickname given to the account when initially setting up the carrier. @@ -83,66 +100,49 @@ public partial class Carrier /// ShipEngine Account - Stamps.com /// [JsonPropertyName("nickname")] - public string Nickname { get; set; } - - /// - /// Screen readable name - /// - /// Screen readable name - /// - /// Stamps.com - /// - [JsonPropertyName("friendly_name")] - public string FriendlyName { get; set; } + public string? Nickname { get; set; } /// - /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation + /// A list of options that are available to that carrier /// - /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation - [JsonPropertyName("primary")] - public bool Primary { get; set; } + /// A list of options that are available to that carrier + [JsonPropertyName("options")] + public List? Options { get; set; } /// - /// Carrier supports multiple packages per shipment + /// A list of package types that are supported by the carrier /// - /// Carrier supports multiple packages per shipment - [JsonPropertyName("has_multi_package_supporting_services")] - public bool HasMultiPackageSupportingServices { get; set; } + /// A list of package types that are supported by the carrier + [JsonPropertyName("packages")] + public List? Packages { get; set; } /// - /// The carrier supports adding custom label messages to an order. + /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation /// - /// The carrier supports adding custom label messages to an order. - [JsonPropertyName("supports_label_messages")] - public bool SupportsLabelMessages { get; set; } + /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation + [JsonPropertyName("primary")] + public bool? Primary { get; set; } /// - /// The carrier is disabled by the current ShipEngine account's billing plan. + /// Indicates whether the carrier requires funding to use its services /// - /// The carrier is disabled by the current ShipEngine account's billing plan. - [JsonPropertyName("disabled_by_billing_plan")] - public bool DisabledByBillingPlan { get; set; } + /// Indicates whether the carrier requires funding to use its services + [JsonPropertyName("requires_funded_amount")] + public bool? RequiresFundedAmount { get; set; } /// /// A list of services that are offered by the carrier /// /// A list of services that are offered by the carrier [JsonPropertyName("services")] - public List Services { get; set; } - - /// - /// A list of package types that are supported by the carrier - /// - /// A list of package types that are supported by the carrier - [JsonPropertyName("packages")] - public List Packages { get; set; } + public List? Services { get; set; } /// - /// A list of options that are available to that carrier + /// The carrier supports adding custom label messages to an order. /// - /// A list of options that are available to that carrier - [JsonPropertyName("options")] - public List Options { get; set; } + /// The carrier supports adding custom label messages to an order. + [JsonPropertyName("supports_label_messages")] + public bool? SupportsLabelMessages { get; set; } /// @@ -154,20 +154,20 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class Carrier {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); - sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); - sb.Append(" RequiresFundedAmount: ").Append(RequiresFundedAmount).Append("\n"); sb.Append(" Balance: ").Append(Balance).Append("\n"); - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); + sb.Append(" DisabledByBillingPlan: ").Append(DisabledByBillingPlan).Append("\n"); sb.Append(" FriendlyName: ").Append(FriendlyName).Append("\n"); - sb.Append(" Primary: ").Append(Primary).Append("\n"); sb.Append(" HasMultiPackageSupportingServices: ").Append(HasMultiPackageSupportingServices).Append("\n"); - sb.Append(" SupportsLabelMessages: ").Append(SupportsLabelMessages).Append("\n"); - sb.Append(" DisabledByBillingPlan: ").Append(DisabledByBillingPlan).Append("\n"); - sb.Append(" Services: ").Append(Services).Append("\n"); - sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" Options: ").Append(Options).Append("\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" Primary: ").Append(Primary).Append("\n"); + sb.Append(" RequiresFundedAmount: ").Append(RequiresFundedAmount).Append("\n"); + sb.Append(" Services: ").Append(Services).Append("\n"); + sb.Append(" SupportsLabelMessages: ").Append(SupportsLabelMessages).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CarrierAdvancedOption.cs b/ShipEngineSDK/Model/CarrierAdvancedOption.cs index a1e4f42f..85aecf6c 100644 --- a/ShipEngineSDK/Model/CarrierAdvancedOption.cs +++ b/ShipEngineSDK/Model/CarrierAdvancedOption.cs @@ -28,16 +28,6 @@ namespace ShipEngineSDK.Model; public partial class CarrierAdvancedOption { - /// - /// Name of advanced option - /// - /// Name of advanced option - /// - /// contains_alcohol - /// - [JsonPropertyName("name")] - public string Name { get; set; } - /// /// Default value of option /// @@ -46,14 +36,24 @@ public partial class CarrierAdvancedOption /// false /// [JsonPropertyName("default_value")] - public string DefaultValue { get; set; } + public string? DefaultValue { get; set; } /// /// Description of option /// /// Description of option [JsonPropertyName("description")] - public string Description { get; set; } + public string? Description { get; set; } + + /// + /// Name of advanced option + /// + /// Name of advanced option + /// + /// contains_alcohol + /// + [JsonPropertyName("name")] + public string? Name { get; set; } /// @@ -65,9 +65,9 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CarrierAdvancedOption {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" DefaultValue: ").Append(DefaultValue).Append("\n"); sb.Append(" Description: ").Append(Description).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CollectOnDelivery.cs b/ShipEngineSDK/Model/CollectOnDelivery.cs index 5a9f3954..90a3642d 100644 --- a/ShipEngineSDK/Model/CollectOnDelivery.cs +++ b/ShipEngineSDK/Model/CollectOnDelivery.cs @@ -37,7 +37,7 @@ public partial class CollectOnDelivery /// Gets or Sets PaymentAmount /// [JsonPropertyName("payment_amount")] - public PaymentAmount PaymentAmount { get; set; } + public PaymentAmount? PaymentAmount { get; set; } /// @@ -49,8 +49,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CollectOnDelivery {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" PaymentType: ").Append(PaymentType).Append("\n"); sb.Append(" PaymentAmount: ").Append(PaymentAmount).Append("\n"); + sb.Append(" PaymentType: ").Append(PaymentType).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs b/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs index 4c3f604e..a829f414 100644 --- a/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs @@ -39,14 +39,6 @@ public partial class ConnectAccessWorldwideRequestBody [JsonRequired] public string Nickname { get; set; } - /// - /// Access Worldwide Username - /// - /// Access Worldwide Username - [JsonPropertyName("username")] - [JsonRequired] - public string Username { get; set; } - /// /// Access Worldwide Password /// @@ -55,6 +47,14 @@ public partial class ConnectAccessWorldwideRequestBody [JsonRequired] public string Password { get; set; } + /// + /// Access Worldwide Username + /// + /// Access Worldwide Username + [JsonPropertyName("username")] + [JsonRequired] + public string Username { get; set; } + /// /// Returns the string presentation of the object @@ -66,8 +66,8 @@ public override string ToString() sb.Append("class ConnectAccessWorldwideRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); - sb.Append(" Username: ").Append(Username).Append("\n"); sb.Append(" Password: ").Append(Password).Append("\n"); + sb.Append(" Username: ").Append(Username).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs b/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs index ecd46bea..d9bd39ba 100644 --- a/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs @@ -29,15 +29,15 @@ public partial class ConnectAmazonBuyShippingRequestBody { /// - /// Nickname to be associated with the account connection + /// An email address. /// - /// Nickname to be associated with the account connection + /// An email address. /// - /// Test Amazon Buy Shipping + /// john.doe@example.com /// - [JsonPropertyName("nickname")] + [JsonPropertyName("email")] [JsonRequired] - public string Nickname { get; set; } + public string Email { get; set; } /// /// Gets or Sets MerchantSellerId @@ -54,15 +54,15 @@ public partial class ConnectAmazonBuyShippingRequestBody public string MwsAuthToken { get; set; } /// - /// An email address. + /// Nickname to be associated with the account connection /// - /// An email address. + /// Nickname to be associated with the account connection /// - /// john.doe@example.com + /// Test Amazon Buy Shipping /// - [JsonPropertyName("email")] + [JsonPropertyName("nickname")] [JsonRequired] - public string Email { get; set; } + public string Nickname { get; set; } /// @@ -74,10 +74,10 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ConnectAmazonBuyShippingRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); sb.Append(" MerchantSellerId: ").Append(MerchantSellerId).Append("\n"); sb.Append(" MwsAuthToken: ").Append(MwsAuthToken).Append("\n"); - sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs b/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs index 49f6cf68..bcde3d67 100644 --- a/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs +++ b/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs @@ -28,6 +28,14 @@ namespace ShipEngineSDK.Model; public partial class ConnectAmazonShippingUk { + /// + /// Amazon UK Shipping auth code. + /// + /// Amazon UK Shipping auth code. + [JsonPropertyName("auth_code")] + [JsonRequired] + public string AuthCode { get; set; } + /// /// The nickname associated with the carrier connection /// @@ -39,14 +47,6 @@ public partial class ConnectAmazonShippingUk [JsonRequired] public string Nickname { get; set; } - /// - /// Amazon UK Shipping auth code. - /// - /// Amazon UK Shipping auth code. - [JsonPropertyName("auth_code")] - [JsonRequired] - public string AuthCode { get; set; } - /// /// Returns the string presentation of the object @@ -57,8 +57,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ConnectAmazonShippingUk {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" AuthCode: ").Append(AuthCode).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectApcRequestBody.cs b/ShipEngineSDK/Model/ConnectApcRequestBody.cs index ce173f2c..1750efb2 100644 --- a/ShipEngineSDK/Model/ConnectApcRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectApcRequestBody.cs @@ -40,26 +40,26 @@ public partial class ConnectApcRequestBody public string Nickname { get; set; } /// - /// The username for the APC account + /// The password for the APC account /// - /// The username for the APC account + /// The password for the APC account /// - /// john_doe + /// 12345 /// - [JsonPropertyName("username")] + [JsonPropertyName("password")] [JsonRequired] - public string Username { get; set; } + public string Password { get; set; } /// - /// The password for the APC account + /// The username for the APC account /// - /// The password for the APC account + /// The username for the APC account /// - /// 12345 + /// john_doe /// - [JsonPropertyName("password")] + [JsonPropertyName("username")] [JsonRequired] - public string Password { get; set; } + public string Username { get; set; } /// @@ -72,8 +72,8 @@ public override string ToString() sb.Append("class ConnectApcRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); - sb.Append(" Username: ").Append(Username).Append("\n"); sb.Append(" Password: ").Append(Password).Append("\n"); + sb.Append(" Username: ").Append(Username).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs b/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs index a8267cb3..f5b29708 100644 --- a/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs @@ -28,17 +28,6 @@ namespace ShipEngineSDK.Model; public partial class ConnectAsendiaRequestBody { - /// - /// The nickname of the Asendia account - /// - /// The nickname of the Asendia account - /// - /// Asendia account - /// - [JsonPropertyName("nickname")] - [JsonRequired] - public string Nickname { get; set; } - /// /// Asendia account number /// @@ -47,6 +36,14 @@ public partial class ConnectAsendiaRequestBody [JsonRequired] public string AccountNumber { get; set; } + /// + /// FTP password + /// + /// FTP password + [JsonPropertyName("ftp_password")] + [JsonRequired] + public string FtpPassword { get; set; } + /// /// FTP username /// @@ -56,12 +53,15 @@ public partial class ConnectAsendiaRequestBody public string FtpUsername { get; set; } /// - /// FTP password + /// The nickname of the Asendia account /// - /// FTP password - [JsonPropertyName("ftp_password")] + /// The nickname of the Asendia account + /// + /// Asendia account + /// + [JsonPropertyName("nickname")] [JsonRequired] - public string FtpPassword { get; set; } + public string Nickname { get; set; } /// @@ -73,10 +73,10 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ConnectAsendiaRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); - sb.Append(" FtpUsername: ").Append(FtpUsername).Append("\n"); sb.Append(" FtpPassword: ").Append(FtpPassword).Append("\n"); + sb.Append(" FtpUsername: ").Append(FtpUsername).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs b/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs index 9faef3ac..f4dc55fd 100644 --- a/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs @@ -29,12 +29,12 @@ public partial class ConnectCanadaPostRequestBody { /// - /// Nickname + /// Canada Post Account Number /// - /// Nickname - [JsonPropertyName("nickname")] + /// Canada Post Account Number + [JsonPropertyName("account_number")] [JsonRequired] - public string Nickname { get; set; } + public string AccountNumber { get; set; } /// /// Canada Post Account API Key @@ -52,14 +52,6 @@ public partial class ConnectCanadaPostRequestBody [JsonRequired] public string ApiSecret { get; set; } - /// - /// Canada Post Account Number - /// - /// Canada Post Account Number - [JsonPropertyName("account_number")] - [JsonRequired] - public string AccountNumber { get; set; } - /// /// Canada Post Account Contract ID /// @@ -68,6 +60,14 @@ public partial class ConnectCanadaPostRequestBody [JsonRequired] public string ContractId { get; set; } + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + /// /// Returns the string presentation of the object @@ -78,11 +78,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ConnectCanadaPostRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); sb.Append(" ApiKey: ").Append(ApiKey).Append("\n"); sb.Append(" ApiSecret: ").Append(ApiSecret).Append("\n"); - sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); sb.Append(" ContractId: ").Append(ContractId).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs index 93e592ae..8a6ef903 100644 --- a/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs @@ -33,14 +33,6 @@ public partial class ConnectDhlEcommerceRequestBody /// [JsonPropertyName("ancillary_endorsement")] public AncillaryServiceEndorsement? AncillaryEndorsement { get; set; } - /// - /// A nickname to help you identify this account - /// - /// A nickname to help you identify this account - [JsonPropertyName("nickname")] - [JsonRequired] - public string Nickname { get; set; } - /// /// The client id /// @@ -50,12 +42,20 @@ public partial class ConnectDhlEcommerceRequestBody public string ClientId { get; set; } /// - /// The account username + /// The distribution center /// - /// The account username - [JsonPropertyName("username")] + /// The distribution center + [JsonPropertyName("distribution_center")] [JsonRequired] - public string Username { get; set; } + public string DistributionCenter { get; set; } + + /// + /// A nickname to help you identify this account + /// + /// A nickname to help you identify this account + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } /// /// The account password @@ -74,34 +74,42 @@ public partial class ConnectDhlEcommerceRequestBody public string PickupNumber { get; set; } /// - /// The distribution center + /// The account username /// - /// The distribution center - [JsonPropertyName("distribution_center")] + /// The account username + [JsonPropertyName("username")] [JsonRequired] - public string DistributionCenter { get; set; } + public string Username { get; set; } + + /// + /// Account number + /// + /// Account number + [JsonPropertyName("account_number")] + [Obsolete] + public string? AccountNumber { get; set; } /// /// The DHL E-Commerce API key. This field is optional, but if not set you will not be able to get rates for this account. /// /// The DHL E-Commerce API key. This field is optional, but if not set you will not be able to get rates for this account. [JsonPropertyName("api_key")] - public string ApiKey { get; set; } + public string? ApiKey { get; set; } /// /// The DHL E-Commerce API secret. This field is optional, but if not set you will not be able to get rates for this account. /// /// The DHL E-Commerce API secret. This field is optional, but if not set you will not be able to get rates for this account. [JsonPropertyName("api_secret")] - public string ApiSecret { get; set; } + public string? ApiSecret { get; set; } /// - /// Account number + /// FTP password /// - /// Account number - [JsonPropertyName("account_number")] + /// FTP password + [JsonPropertyName("ftp_password")] [Obsolete] - public string AccountNumber { get; set; } + public string? FtpPassword { get; set; } /// /// FTP username @@ -109,34 +117,26 @@ public partial class ConnectDhlEcommerceRequestBody /// FTP username [JsonPropertyName("ftp_username")] [Obsolete] - public string FtpUsername { get; set; } - - /// - /// FTP password - /// - /// FTP password - [JsonPropertyName("ftp_password")] - [Obsolete] - public string FtpPassword { get; set; } - - /// - /// Sold To field - /// - /// Sold To field - [JsonPropertyName("sold_to")] - public string SoldTo { get; set; } + public string? FtpUsername { get; set; } /// /// Gets or Sets RegistrationId /// [JsonPropertyName("registration_id")] - public string RegistrationId { get; set; } + public string? RegistrationId { get; set; } /// /// Gets or Sets SoftwareName /// [JsonPropertyName("software_name")] - public string SoftwareName { get; set; } + public string? SoftwareName { get; set; } + + /// + /// Sold To field + /// + /// Sold To field + [JsonPropertyName("sold_to")] + public string? SoldTo { get; set; } /// @@ -148,21 +148,21 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ConnectDhlEcommerceRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" ClientId: ").Append(ClientId).Append("\n"); - sb.Append(" Username: ").Append(Username).Append("\n"); + sb.Append(" DistributionCenter: ").Append(DistributionCenter).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" Password: ").Append(Password).Append("\n"); sb.Append(" PickupNumber: ").Append(PickupNumber).Append("\n"); - sb.Append(" DistributionCenter: ").Append(DistributionCenter).Append("\n"); + sb.Append(" Username: ").Append(Username).Append("\n"); + sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" AncillaryEndorsement: ").Append(AncillaryEndorsement).Append("\n"); sb.Append(" ApiKey: ").Append(ApiKey).Append("\n"); sb.Append(" ApiSecret: ").Append(ApiSecret).Append("\n"); - sb.Append(" AncillaryEndorsement: ").Append(AncillaryEndorsement).Append("\n"); - sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); - sb.Append(" FtpUsername: ").Append(FtpUsername).Append("\n"); sb.Append(" FtpPassword: ").Append(FtpPassword).Append("\n"); - sb.Append(" SoldTo: ").Append(SoldTo).Append("\n"); + sb.Append(" FtpUsername: ").Append(FtpUsername).Append("\n"); sb.Append(" RegistrationId: ").Append(RegistrationId).Append("\n"); sb.Append(" SoftwareName: ").Append(SoftwareName).Append("\n"); + sb.Append(" SoldTo: ").Append(SoldTo).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs index af3dc808..9dbb0bdb 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs @@ -28,14 +28,6 @@ namespace ShipEngineSDK.Model; public partial class ConnectDhlExpressAuRequestBody { - /// - /// Nickname - /// - /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] - public string Nickname { get; set; } - /// /// Account number /// @@ -44,6 +36,14 @@ public partial class ConnectDhlExpressAuRequestBody [JsonRequired] public string AccountNumber { get; set; } + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + /// /// Returns the string presentation of the object @@ -54,8 +54,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ConnectDhlExpressAuRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs index aeaa0a65..3c30f101 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs @@ -28,14 +28,6 @@ namespace ShipEngineSDK.Model; public partial class ConnectDhlExpressCaRequestBody { - /// - /// Nickname - /// - /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] - public string Nickname { get; set; } - /// /// Account number /// @@ -44,6 +36,14 @@ public partial class ConnectDhlExpressCaRequestBody [JsonRequired] public string AccountNumber { get; set; } + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + /// /// Returns the string presentation of the object @@ -54,8 +54,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ConnectDhlExpressCaRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs index c2257d54..b2657d21 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs @@ -28,14 +28,6 @@ namespace ShipEngineSDK.Model; public partial class ConnectDhlExpressRequestBody { - /// - /// Nickname - /// - /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] - public string Nickname { get; set; } - /// /// Account number /// @@ -45,18 +37,12 @@ public partial class ConnectDhlExpressRequestBody public string AccountNumber { get; set; } /// - /// Required if password is provided - /// - /// Required if password is provided - [JsonPropertyName("site_id")] - public string SiteId { get; set; } - - /// - /// Required if site id is provided + /// Nickname /// - /// Required if site id is provided - [JsonPropertyName("password")] - public string Password { get; set; } + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } /// /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) @@ -66,7 +52,21 @@ public partial class ConnectDhlExpressRequestBody /// CA /// [JsonPropertyName("country_code")] - public string CountryCode { get; set; } + public string? CountryCode { get; set; } + + /// + /// Required if site id is provided + /// + /// Required if site id is provided + [JsonPropertyName("password")] + public string? Password { get; set; } + + /// + /// Required if password is provided + /// + /// Required if password is provided + [JsonPropertyName("site_id")] + public string? SiteId { get; set; } /// @@ -78,11 +78,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ConnectDhlExpressRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); - sb.Append(" SiteId: ").Append(SiteId).Append("\n"); - sb.Append(" Password: ").Append(Password).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); + sb.Append(" Password: ").Append(Password).Append("\n"); + sb.Append(" SiteId: ").Append(SiteId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs index 333235e4..9ec70e6b 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs @@ -37,15 +37,12 @@ public partial class ConnectDhlExpressUkRequestBody public string AccountNumber { get; set; } /// - /// A string that uniquely identifies the site + /// Nickname /// - /// A string that uniquely identifies the site - /// - /// se-28529731 - /// - [JsonPropertyName("site_id")] + /// Nickname + [JsonPropertyName("nickname")] [JsonRequired] - public string SiteId { get; set; } + public string Nickname { get; set; } /// /// Password @@ -56,12 +53,15 @@ public partial class ConnectDhlExpressUkRequestBody public string Password { get; set; } /// - /// Nickname + /// A string that uniquely identifies the site /// - /// Nickname - [JsonPropertyName("nickname")] + /// A string that uniquely identifies the site + /// + /// se-28529731 + /// + [JsonPropertyName("site_id")] [JsonRequired] - public string Nickname { get; set; } + public string SiteId { get; set; } /// @@ -74,9 +74,9 @@ public override string ToString() sb.Append("class ConnectDhlExpressUkRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); - sb.Append(" SiteId: ").Append(SiteId).Append("\n"); - sb.Append(" Password: ").Append(Password).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" Password: ").Append(Password).Append("\n"); + sb.Append(" SiteId: ").Append(SiteId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectDpdRequestBody.cs b/ShipEngineSDK/Model/ConnectDpdRequestBody.cs index d4937639..58a2f2fe 100644 --- a/ShipEngineSDK/Model/ConnectDpdRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDpdRequestBody.cs @@ -36,14 +36,6 @@ public partial class ConnectDpdRequestBody [JsonRequired] public string AccountNumber { get; set; } - /// - /// Password - /// - /// Password - [JsonPropertyName("password")] - [JsonRequired] - public string Password { get; set; } - /// /// Nickname /// @@ -52,6 +44,14 @@ public partial class ConnectDpdRequestBody [JsonRequired] public string Nickname { get; set; } + /// + /// Password + /// + /// Password + [JsonPropertyName("password")] + [JsonRequired] + public string Password { get; set; } + /// /// Returns the string presentation of the object @@ -63,8 +63,8 @@ public override string ToString() sb.Append("class ConnectDpdRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); - sb.Append(" Password: ").Append(Password).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" Password: ").Append(Password).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs b/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs index a961cf34..34d86e1b 100644 --- a/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs @@ -28,14 +28,6 @@ namespace ShipEngineSDK.Model; public partial class ConnectEndiciaRequestBody { - /// - /// Nickname - /// - /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] - public string Nickname { get; set; } - /// /// Account /// @@ -44,6 +36,14 @@ public partial class ConnectEndiciaRequestBody [JsonRequired] public string Account { get; set; } + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + /// /// Passphrase /// @@ -62,8 +62,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ConnectEndiciaRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" Account: ").Append(Account).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" Passphrase: ").Append(Passphrase).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/ConnectFedexRequestBody.cs b/ShipEngineSDK/Model/ConnectFedexRequestBody.cs index d2bb64c3..f640474c 100644 --- a/ShipEngineSDK/Model/ConnectFedexRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectFedexRequestBody.cs @@ -45,11 +45,12 @@ public partial class ConnectFedexRequestBody public string Address1 { get; set; } /// - /// Address + /// Boolean signaling agreement to the Fedex End User License Agreement /// - /// Address - [JsonPropertyName("address2")] - public string Address2 { get; set; } + /// Boolean signaling agreement to the Fedex End User License Agreement + [JsonPropertyName("agree_to_eula")] + [JsonRequired] + public bool AgreeToEula { get; set; } /// /// The city @@ -59,13 +60,6 @@ public partial class ConnectFedexRequestBody [JsonRequired] public string City { get; set; } - /// - /// The company - /// - /// The company - [JsonPropertyName("company")] - public string Company { get; set; } - /// /// Country code /// @@ -101,6 +95,14 @@ public partial class ConnectFedexRequestBody [JsonRequired] public string LastName { get; set; } + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + /// /// Phone number /// @@ -126,27 +128,25 @@ public partial class ConnectFedexRequestBody public string State { get; set; } /// - /// Nickname + /// Address /// - /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] - public string Nickname { get; set; } + /// Address + [JsonPropertyName("address2")] + public string? Address2 { get; set; } /// - /// Boolean signaling agreement to the Fedex End User License Agreement + /// The company /// - /// Boolean signaling agreement to the Fedex End User License Agreement - [JsonPropertyName("agree_to_eula")] - [JsonRequired] - public bool AgreeToEula { get; set; } + /// The company + [JsonPropertyName("company")] + public string? Company { get; set; } /// /// Meter number /// /// Meter number [JsonPropertyName("meter_number")] - public string MeterNumber { get; set; } + public string? MeterNumber { get; set; } /// @@ -160,18 +160,18 @@ public override string ToString() #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); sb.Append(" Address1: ").Append(Address1).Append("\n"); - sb.Append(" Address2: ").Append(Address2).Append("\n"); + sb.Append(" AgreeToEula: ").Append(AgreeToEula).Append("\n"); sb.Append(" City: ").Append(City).Append("\n"); - sb.Append(" Company: ").Append(Company).Append("\n"); sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); sb.Append(" Email: ").Append(Email).Append("\n"); sb.Append(" FirstName: ").Append(FirstName).Append("\n"); sb.Append(" LastName: ").Append(LastName).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" Phone: ").Append(Phone).Append("\n"); sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); sb.Append(" State: ").Append(State).Append("\n"); - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); - sb.Append(" AgreeToEula: ").Append(AgreeToEula).Append("\n"); + sb.Append(" Address2: ").Append(Address2).Append("\n"); + sb.Append(" Company: ").Append(Company).Append("\n"); sb.Append(" MeterNumber: ").Append(MeterNumber).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs b/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs index 088181f6..c0facadc 100644 --- a/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs @@ -45,11 +45,12 @@ public partial class ConnectFedexUkRequestBody public string Address1 { get; set; } /// - /// Address + /// Boolean signaling agreement to the Fedex End User License Agreement /// - /// Address - [JsonPropertyName("address2")] - public string Address2 { get; set; } + /// Boolean signaling agreement to the Fedex End User License Agreement + [JsonPropertyName("agree_to_eula")] + [JsonRequired] + public bool AgreeToEula { get; set; } /// /// The city @@ -59,13 +60,6 @@ public partial class ConnectFedexUkRequestBody [JsonRequired] public string City { get; set; } - /// - /// The company - /// - /// The company - [JsonPropertyName("company")] - public string Company { get; set; } - /// /// Country code /// @@ -101,6 +95,14 @@ public partial class ConnectFedexUkRequestBody [JsonRequired] public string LastName { get; set; } + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + /// /// Phone number /// @@ -126,27 +128,25 @@ public partial class ConnectFedexUkRequestBody public string State { get; set; } /// - /// Nickname + /// Address /// - /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] - public string Nickname { get; set; } + /// Address + [JsonPropertyName("address2")] + public string? Address2 { get; set; } /// - /// Boolean signaling agreement to the Fedex End User License Agreement + /// The company /// - /// Boolean signaling agreement to the Fedex End User License Agreement - [JsonPropertyName("agree_to_eula")] - [JsonRequired] - public bool AgreeToEula { get; set; } + /// The company + [JsonPropertyName("company")] + public string? Company { get; set; } /// /// Meter number /// /// Meter number [JsonPropertyName("meter_number")] - public string MeterNumber { get; set; } + public string? MeterNumber { get; set; } /// @@ -160,18 +160,18 @@ public override string ToString() #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); sb.Append(" Address1: ").Append(Address1).Append("\n"); - sb.Append(" Address2: ").Append(Address2).Append("\n"); + sb.Append(" AgreeToEula: ").Append(AgreeToEula).Append("\n"); sb.Append(" City: ").Append(City).Append("\n"); - sb.Append(" Company: ").Append(Company).Append("\n"); sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); sb.Append(" Email: ").Append(Email).Append("\n"); sb.Append(" FirstName: ").Append(FirstName).Append("\n"); sb.Append(" LastName: ").Append(LastName).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" Phone: ").Append(Phone).Append("\n"); sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); sb.Append(" State: ").Append(State).Append("\n"); - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); - sb.Append(" AgreeToEula: ").Append(AgreeToEula).Append("\n"); + sb.Append(" Address2: ").Append(Address2).Append("\n"); + sb.Append(" Company: ").Append(Company).Append("\n"); sb.Append(" MeterNumber: ").Append(MeterNumber).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs b/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs index fa5b7c06..61703c38 100644 --- a/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs @@ -28,14 +28,6 @@ namespace ShipEngineSDK.Model; public partial class ConnectFirstmileRequestBody { - /// - /// Nickname - /// - /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] - public string Nickname { get; set; } - /// /// A string that uniquely identifies the mailer /// @@ -48,11 +40,12 @@ public partial class ConnectFirstmileRequestBody public string MailerId { get; set; } /// - /// Profile name + /// Nickname /// - /// Profile name - [JsonPropertyName("profile_name")] - public string ProfileName { get; set; } + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } /// /// Password @@ -62,6 +55,13 @@ public partial class ConnectFirstmileRequestBody [JsonRequired] public string Password { get; set; } + /// + /// Profile name + /// + /// Profile name + [JsonPropertyName("profile_name")] + public string? ProfileName { get; set; } + /// /// Returns the string presentation of the object @@ -72,10 +72,10 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ConnectFirstmileRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" MailerId: ").Append(MailerId).Append("\n"); - sb.Append(" ProfileName: ").Append(ProfileName).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" Password: ").Append(Password).Append("\n"); + sb.Append(" ProfileName: ").Append(ProfileName).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectImexRequestBody.cs b/ShipEngineSDK/Model/ConnectImexRequestBody.cs index 52d73920..1dc72dd8 100644 --- a/ShipEngineSDK/Model/ConnectImexRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectImexRequestBody.cs @@ -36,14 +36,6 @@ public partial class ConnectImexRequestBody [JsonRequired] public string Nickname { get; set; } - /// - /// Username - /// - /// Username - [JsonPropertyName("username")] - [JsonRequired] - public string Username { get; set; } - /// /// Password /// @@ -52,6 +44,14 @@ public partial class ConnectImexRequestBody [JsonRequired] public string Password { get; set; } + /// + /// Username + /// + /// Username + [JsonPropertyName("username")] + [JsonRequired] + public string Username { get; set; } + /// /// Returns the string presentation of the object @@ -63,8 +63,8 @@ public override string ToString() sb.Append("class ConnectImexRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); - sb.Append(" Username: ").Append(Username).Append("\n"); sb.Append(" Password: ").Append(Password).Append("\n"); + sb.Append(" Username: ").Append(Username).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs b/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs index 788e4f0d..ed7e7d12 100644 --- a/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs @@ -29,28 +29,20 @@ public partial class ConnectLasershipRequestBody { /// - /// Nickname - /// - /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] - public string Nickname { get; set; } - - /// - /// Web Service ID (WSID) + /// Address /// - /// Web Service ID (WSID) - [JsonPropertyName("web_services_id")] + /// Address + [JsonPropertyName("Address")] [JsonRequired] - public string WebServicesId { get; set; } + public string Address { get; set; } /// - /// Web Service Key (WSKey) + /// City /// - /// Web Service Key (WSKey) - [JsonPropertyName("web_services_key")] + /// City + [JsonPropertyName("City")] [JsonRequired] - public string WebServicesKey { get; set; } + public string City { get; set; } /// /// Customer Branch @@ -61,35 +53,36 @@ public partial class ConnectLasershipRequestBody public string CustomerBranch { get; set; } /// - /// Address + /// Critical Entry Time (local time) /// - /// Address - [JsonPropertyName("Address")] + /// Critical Entry Time (local time) + [JsonPropertyName("lasership_critical_entry_time")] [JsonRequired] - public String Address { get; set; } + public string LasershipCriticalEntryTime { get; set; } /// - /// Address2 + /// Critical Pull Time (local time) /// - /// Address2 - [JsonPropertyName("Address2")] - public String Address2 { get; set; } + /// Critical Pull Time (local time) + [JsonPropertyName("lasership_critical_pull_time")] + [JsonRequired] + public string LasershipCriticalPullTime { get; set; } /// - /// PostalCode + /// Nickname /// - /// PostalCode - [JsonPropertyName("PostalCode")] + /// Nickname + [JsonPropertyName("nickname")] [JsonRequired] - public String PostalCode { get; set; } + public string Nickname { get; set; } /// - /// City + /// PostalCode /// - /// City - [JsonPropertyName("City")] + /// PostalCode + [JsonPropertyName("PostalCode")] [JsonRequired] - public String City { get; set; } + public string PostalCode { get; set; } /// /// State @@ -97,128 +90,135 @@ public partial class ConnectLasershipRequestBody /// State [JsonPropertyName("State")] [JsonRequired] - public String State { get; set; } + public string State { get; set; } /// - /// Country + /// Web Service ID (WSID) /// - /// Country - [JsonPropertyName("country")] - public String Country { get; set; } + /// Web Service ID (WSID) + [JsonPropertyName("web_services_id")] + [JsonRequired] + public string WebServicesId { get; set; } /// - /// Phone + /// Web Service Key (WSKey) /// - /// Phone - [JsonPropertyName("Phone")] - public String Phone { get; set; } + /// Web Service Key (WSKey) + [JsonPropertyName("web_services_key")] + [JsonRequired] + public string WebServicesKey { get; set; } /// - /// Email + /// Address2 /// - /// Email - [JsonPropertyName("Email")] - public String Email { get; set; } + /// Address2 + [JsonPropertyName("Address2")] + public string? Address2 { get; set; } /// - /// Instructions + /// Set this to true if your shipments will always contain Alcohol /// - /// Instructions - [JsonPropertyName("instructions")] - public String Instructions { get; set; } + /// Set this to true if your shipments will always contain Alcohol + [JsonPropertyName("AttrAlcohol")] + public bool? AttrAlcohol { get; set; } /// - /// Facility Code + /// Set this to true if your shipments will always contain Controlled Substances /// - /// Facility Code - [JsonPropertyName("facility_code")] - public String FacilityCode { get; set; } + /// Set this to true if your shipments will always contain Controlled Substances + [JsonPropertyName("AttrControlledSubstance")] + public bool? AttrControlledSubstance { get; set; } /// - /// Critical Pull Time (local time) + /// Set this to true if your shipments will always contain DryIce /// - /// Critical Pull Time (local time) - [JsonPropertyName("lasership_critical_pull_time")] - [JsonRequired] - public String LasershipCriticalPullTime { get; set; } + /// Set this to true if your shipments will always contain DryIce + [JsonPropertyName("AttrDryIce")] + public bool? AttrDryIce { get; set; } /// - /// Critical Entry Time (local time) + /// Set this to true if your shipments will always contain Explosives /// - /// Critical Entry Time (local time) - [JsonPropertyName("lasership_critical_entry_time")] - [JsonRequired] - public String LasershipCriticalEntryTime { get; set; } + /// Set this to true if your shipments will always contain Explosives + [JsonPropertyName("AttrExplosive")] + public bool? AttrExplosive { get; set; } /// - /// Declare piece attributes separately for every shipment, overrides individual attribute below. + /// Set this to true if your shipments will always contain Hazmat /// - /// Declare piece attributes separately for every shipment, overrides individual attribute below. - [JsonPropertyName("declare_piece_attributes_separately_for_every_shipment")] - public Boolean DeclarePieceAttributesSeparatelyForEveryShipment { get; set; } + /// Set this to true if your shipments will always contain Hazmat + [JsonPropertyName("AttrHazmat")] + public bool? AttrHazmat { get; set; } /// - /// Set this to true if your shipments will always contain Alcohol + /// Set this to true if your shipments will always use \"No Return To Sender\" /// - /// Set this to true if your shipments will always contain Alcohol - [JsonPropertyName("AttrAlcohol")] - public Boolean AttrAlcohol { get; set; } + /// Set this to true if your shipments will always use \"No Return To Sender\" + [JsonPropertyName("AttrNoRTS")] + public bool? AttrNoRTS { get; set; } /// - /// Set this to true if your shipments will always contain DryIce + /// Set this to true if your shipments will always be Perishable /// - /// Set this to true if your shipments will always contain DryIce - [JsonPropertyName("AttrDryIce")] - public Boolean AttrDryIce { get; set; } + /// Set this to true if your shipments will always be Perishable + [JsonPropertyName("AttrPerishable")] + public bool? AttrPerishable { get; set; } /// - /// Set this to true if your shipments will always contain Hazmat + /// Set this to true if your shipments will always require Refrigeration /// - /// Set this to true if your shipments will always contain Hazmat - [JsonPropertyName("AttrHazmat")] - public Boolean AttrHazmat { get; set; } + /// Set this to true if your shipments will always require Refrigeration + [JsonPropertyName("AttrRefrigerated")] + public bool? AttrRefrigerated { get; set; } /// /// Set this to true if your shipments will always require Two Persons /// /// Set this to true if your shipments will always require Two Persons [JsonPropertyName("AttrTwoPersons")] - public Boolean AttrTwoPersons { get; set; } + public bool? AttrTwoPersons { get; set; } /// - /// Set this to true if your shipments will always contain Explosives + /// Country /// - /// Set this to true if your shipments will always contain Explosives - [JsonPropertyName("AttrExplosive")] - public Boolean AttrExplosive { get; set; } + /// Country + [JsonPropertyName("country")] + public string? Country { get; set; } /// - /// Set this to true if your shipments will always contain Controlled Substances + /// Declare piece attributes separately for every shipment, overrides individual attribute below. /// - /// Set this to true if your shipments will always contain Controlled Substances - [JsonPropertyName("AttrControlledSubstance")] - public Boolean AttrControlledSubstance { get; set; } + /// Declare piece attributes separately for every shipment, overrides individual attribute below. + [JsonPropertyName("declare_piece_attributes_separately_for_every_shipment")] + public bool? DeclarePieceAttributesSeparatelyForEveryShipment { get; set; } /// - /// Set this to true if your shipments will always require Refrigeration + /// Email /// - /// Set this to true if your shipments will always require Refrigeration - [JsonPropertyName("AttrRefrigerated")] - public Boolean AttrRefrigerated { get; set; } + /// Email + [JsonPropertyName("Email")] + public string? Email { get; set; } /// - /// Set this to true if your shipments will always be Perishable + /// Facility Code /// - /// Set this to true if your shipments will always be Perishable - [JsonPropertyName("AttrPerishable")] - public Boolean AttrPerishable { get; set; } + /// Facility Code + [JsonPropertyName("facility_code")] + public string? FacilityCode { get; set; } /// - /// Set this to true if your shipments will always use \"No Return To Sender\" + /// Instructions /// - /// Set this to true if your shipments will always use \"No Return To Sender\" - [JsonPropertyName("AttrNoRTS")] - public Boolean AttrNoRTS { get; set; } + /// Instructions + [JsonPropertyName("instructions")] + public string? Instructions { get; set; } + + /// + /// Phone + /// + /// Phone + [JsonPropertyName("Phone")] + public string? Phone { get; set; } /// @@ -230,32 +230,32 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ConnectLasershipRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" Address: ").Append(Address).Append("\n"); + sb.Append(" City: ").Append(City).Append("\n"); + sb.Append(" CustomerBranch: ").Append(CustomerBranch).Append("\n"); + sb.Append(" LasershipCriticalEntryTime: ").Append(LasershipCriticalEntryTime).Append("\n"); + sb.Append(" LasershipCriticalPullTime: ").Append(LasershipCriticalPullTime).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" State: ").Append(State).Append("\n"); sb.Append(" WebServicesId: ").Append(WebServicesId).Append("\n"); sb.Append(" WebServicesKey: ").Append(WebServicesKey).Append("\n"); - sb.Append(" CustomerBranch: ").Append(CustomerBranch).Append("\n"); - sb.Append(" Address: ").Append(Address).Append("\n"); sb.Append(" Address2: ").Append(Address2).Append("\n"); - sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); - sb.Append(" City: ").Append(City).Append("\n"); - sb.Append(" State: ").Append(State).Append("\n"); - sb.Append(" Country: ").Append(Country).Append("\n"); - sb.Append(" Phone: ").Append(Phone).Append("\n"); - sb.Append(" Email: ").Append(Email).Append("\n"); - sb.Append(" Instructions: ").Append(Instructions).Append("\n"); - sb.Append(" FacilityCode: ").Append(FacilityCode).Append("\n"); - sb.Append(" LasershipCriticalPullTime: ").Append(LasershipCriticalPullTime).Append("\n"); - sb.Append(" LasershipCriticalEntryTime: ").Append(LasershipCriticalEntryTime).Append("\n"); - sb.Append(" DeclarePieceAttributesSeparatelyForEveryShipment: ").Append(DeclarePieceAttributesSeparatelyForEveryShipment).Append("\n"); sb.Append(" AttrAlcohol: ").Append(AttrAlcohol).Append("\n"); + sb.Append(" AttrControlledSubstance: ").Append(AttrControlledSubstance).Append("\n"); sb.Append(" AttrDryIce: ").Append(AttrDryIce).Append("\n"); - sb.Append(" AttrHazmat: ").Append(AttrHazmat).Append("\n"); - sb.Append(" AttrTwoPersons: ").Append(AttrTwoPersons).Append("\n"); sb.Append(" AttrExplosive: ").Append(AttrExplosive).Append("\n"); - sb.Append(" AttrControlledSubstance: ").Append(AttrControlledSubstance).Append("\n"); - sb.Append(" AttrRefrigerated: ").Append(AttrRefrigerated).Append("\n"); - sb.Append(" AttrPerishable: ").Append(AttrPerishable).Append("\n"); + sb.Append(" AttrHazmat: ").Append(AttrHazmat).Append("\n"); sb.Append(" AttrNoRTS: ").Append(AttrNoRTS).Append("\n"); + sb.Append(" AttrPerishable: ").Append(AttrPerishable).Append("\n"); + sb.Append(" AttrRefrigerated: ").Append(AttrRefrigerated).Append("\n"); + sb.Append(" AttrTwoPersons: ").Append(AttrTwoPersons).Append("\n"); + sb.Append(" Country: ").Append(Country).Append("\n"); + sb.Append(" DeclarePieceAttributesSeparatelyForEveryShipment: ").Append(DeclarePieceAttributesSeparatelyForEveryShipment).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" FacilityCode: ").Append(FacilityCode).Append("\n"); + sb.Append(" Instructions: ").Append(Instructions).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs b/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs index 6a10e7eb..01c67203 100644 --- a/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs @@ -28,20 +28,6 @@ namespace ShipEngineSDK.Model; public partial class ConnectNewgisticsRequestBody { - /// - /// Merchant id - /// - /// Merchant id - [JsonPropertyName("merchant_id")] - public int MerchantId { get; set; } - - /// - /// Mailer id - /// - /// Mailer id - [JsonPropertyName("mailer_id")] - public int MailerId { get; set; } - /// /// Induction site /// @@ -58,6 +44,20 @@ public partial class ConnectNewgisticsRequestBody [JsonRequired] public string Nickname { get; set; } + /// + /// Mailer id + /// + /// Mailer id + [JsonPropertyName("mailer_id")] + public int? MailerId { get; set; } + + /// + /// Merchant id + /// + /// Merchant id + [JsonPropertyName("merchant_id")] + public int? MerchantId { get; set; } + /// /// Returns the string presentation of the object @@ -68,10 +68,10 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ConnectNewgisticsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" MerchantId: ").Append(MerchantId).Append("\n"); - sb.Append(" MailerId: ").Append(MailerId).Append("\n"); sb.Append(" InductionSite: ").Append(InductionSite).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" MailerId: ").Append(MailerId).Append("\n"); + sb.Append(" MerchantId: ").Append(MerchantId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectOntracRequestBody.cs b/ShipEngineSDK/Model/ConnectOntracRequestBody.cs index 546572a8..10674810 100644 --- a/ShipEngineSDK/Model/ConnectOntracRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectOntracRequestBody.cs @@ -28,14 +28,6 @@ namespace ShipEngineSDK.Model; public partial class ConnectOntracRequestBody { - /// - /// Nickname - /// - /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] - public string Nickname { get; set; } - /// /// Account number /// @@ -44,6 +36,14 @@ public partial class ConnectOntracRequestBody [JsonRequired] public string AccountNumber { get; set; } + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + /// /// Password /// @@ -62,8 +62,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ConnectOntracRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" Password: ").Append(Password).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs b/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs index 90214400..b92d5953 100644 --- a/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs @@ -37,14 +37,12 @@ public partial class ConnectRoyalMailRequestBody public string AccountNumber { get; set; } /// - /// The oba email address + /// City /// - /// The oba email address - /// - /// john.doe@example.com - /// - [JsonPropertyName("oba_email")] - public string ObaEmail { get; set; } + /// City + [JsonPropertyName("city")] + [JsonRequired] + public string City { get; set; } /// /// Contact name @@ -54,6 +52,29 @@ public partial class ConnectRoyalMailRequestBody [JsonRequired] public string ContactName { get; set; } + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + + /// + /// Postal code + /// + /// Postal code + [JsonPropertyName("postal_code")] + [JsonRequired] + public string PostalCode { get; set; } + + /// + /// Company name + /// + /// Company name + [JsonPropertyName("company_name")] + public string? CompanyName { get; set; } + /// /// The email address /// @@ -62,66 +83,45 @@ public partial class ConnectRoyalMailRequestBody /// john.doe@example.com /// [JsonPropertyName("email")] - public string Email { get; set; } + public string? Email { get; set; } /// - /// Company name + /// The oba email address /// - /// Company name - [JsonPropertyName("company_name")] - public string CompanyName { get; set; } + /// The oba email address + /// + /// john.doe@example.com + /// + [JsonPropertyName("oba_email")] + public string? ObaEmail { get; set; } + + /// + /// Phone + /// + /// Phone + [JsonPropertyName("phone")] + public string? Phone { get; set; } /// /// Street line1 /// /// Street line1 [JsonPropertyName("street_line1")] - public string StreetLine1 { get; set; } + public string? StreetLine1 { get; set; } /// /// Street line2 /// /// Street line2 [JsonPropertyName("street_line2")] - public string StreetLine2 { get; set; } + public string? StreetLine2 { get; set; } /// /// Street line3 /// /// Street line3 [JsonPropertyName("street_line3")] - public string StreetLine3 { get; set; } - - /// - /// City - /// - /// City - [JsonPropertyName("city")] - [JsonRequired] - public string City { get; set; } - - /// - /// Postal code - /// - /// Postal code - [JsonPropertyName("postal_code")] - [JsonRequired] - public string PostalCode { get; set; } - - /// - /// Phone - /// - /// Phone - [JsonPropertyName("phone")] - public string Phone { get; set; } - - /// - /// Nickname - /// - /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] - public string Nickname { get; set; } + public string? StreetLine3 { get; set; } /// @@ -134,17 +134,17 @@ public override string ToString() sb.Append("class ConnectRoyalMailRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); - sb.Append(" ObaEmail: ").Append(ObaEmail).Append("\n"); + sb.Append(" City: ").Append(City).Append("\n"); sb.Append(" ContactName: ").Append(ContactName).Append("\n"); - sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" ObaEmail: ").Append(ObaEmail).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); sb.Append(" StreetLine1: ").Append(StreetLine1).Append("\n"); sb.Append(" StreetLine2: ").Append(StreetLine2).Append("\n"); sb.Append(" StreetLine3: ").Append(StreetLine3).Append("\n"); - sb.Append(" City: ").Append(City).Append("\n"); - sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); - sb.Append(" Phone: ").Append(Phone).Append("\n"); - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs b/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs index e1e0d6e2..f38e6de6 100644 --- a/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs @@ -36,14 +36,6 @@ public partial class ConnectRrDonnelleyRequestBody [JsonRequired] public string Nickname { get; set; } - /// - /// Username - /// - /// Username - [JsonPropertyName("username")] - [JsonRequired] - public string Username { get; set; } - /// /// Password /// @@ -52,6 +44,14 @@ public partial class ConnectRrDonnelleyRequestBody [JsonRequired] public string Password { get; set; } + /// + /// Username + /// + /// Username + [JsonPropertyName("username")] + [JsonRequired] + public string Username { get; set; } + /// /// Returns the string presentation of the object @@ -63,8 +63,8 @@ public override string ToString() sb.Append("class ConnectRrDonnelleyRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); - sb.Append(" Username: ").Append(Username).Append("\n"); sb.Append(" Password: ").Append(Password).Append("\n"); + sb.Append(" Username: ").Append(Username).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectSekoRequestBody.cs b/ShipEngineSDK/Model/ConnectSekoRequestBody.cs index 1e32b40a..d275288c 100644 --- a/ShipEngineSDK/Model/ConnectSekoRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectSekoRequestBody.cs @@ -28,14 +28,6 @@ namespace ShipEngineSDK.Model; public partial class ConnectSekoRequestBody { - /// - /// Nickname - /// - /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] - public string Nickname { get; set; } - /// /// Seko Account Access Key /// @@ -44,6 +36,14 @@ public partial class ConnectSekoRequestBody [JsonRequired] public string AccessKey { get; set; } + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + /// /// Returns the string presentation of the object @@ -54,8 +54,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ConnectSekoRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" AccessKey: ").Append(AccessKey).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectSendleRequestBody.cs b/ShipEngineSDK/Model/ConnectSendleRequestBody.cs index a3505c9f..1eaa360f 100644 --- a/ShipEngineSDK/Model/ConnectSendleRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectSendleRequestBody.cs @@ -28,6 +28,14 @@ namespace ShipEngineSDK.Model; public partial class ConnectSendleRequestBody { + /// + /// API key + /// + /// API key + [JsonPropertyName("api_key")] + [JsonRequired] + public string ApiKey { get; set; } + /// /// Nickname /// @@ -47,14 +55,6 @@ public partial class ConnectSendleRequestBody [JsonRequired] public string SendleId { get; set; } - /// - /// API key - /// - /// API key - [JsonPropertyName("api_key")] - [JsonRequired] - public string ApiKey { get; set; } - /// /// Returns the string presentation of the object @@ -65,9 +65,9 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ConnectSendleRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" ApiKey: ").Append(ApiKey).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" SendleId: ").Append(SendleId).Append("\n"); - sb.Append(" ApiKey: ").Append(ApiKey).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectStampsRequestBody.cs b/ShipEngineSDK/Model/ConnectStampsRequestBody.cs index 4c8020e8..a0a429c7 100644 --- a/ShipEngineSDK/Model/ConnectStampsRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectStampsRequestBody.cs @@ -36,14 +36,6 @@ public partial class ConnectStampsRequestBody [JsonRequired] public string Nickname { get; set; } - /// - /// Username - /// - /// Username - [JsonPropertyName("username")] - [JsonRequired] - public string Username { get; set; } - /// /// Password /// @@ -52,6 +44,14 @@ public partial class ConnectStampsRequestBody [JsonRequired] public string Password { get; set; } + /// + /// Username + /// + /// Username + [JsonPropertyName("username")] + [JsonRequired] + public string Username { get; set; } + /// /// Returns the string presentation of the object @@ -63,8 +63,8 @@ public override string ToString() sb.Append("class ConnectStampsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); - sb.Append(" Username: ").Append(Username).Append("\n"); sb.Append(" Password: ").Append(Password).Append("\n"); + sb.Append(" Username: ").Append(Username).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectUpsRequestBody.cs b/ShipEngineSDK/Model/ConnectUpsRequestBody.cs index f4208cfa..9fd30709 100644 --- a/ShipEngineSDK/Model/ConnectUpsRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectUpsRequestBody.cs @@ -28,14 +28,6 @@ namespace ShipEngineSDK.Model; public partial class ConnectUpsRequestBody { - /// - /// Nickname - /// - /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] - public string Nickname { get; set; } - /// /// Account number /// @@ -44,6 +36,14 @@ public partial class ConnectUpsRequestBody [JsonRequired] public string AccountNumber { get; set; } + /// + /// Nickname + /// + /// Nickname + [JsonPropertyName("nickname")] + [JsonRequired] + public string Nickname { get; set; } + /// /// Returns the string presentation of the object @@ -54,8 +54,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ConnectUpsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ContactDetails.cs b/ShipEngineSDK/Model/ContactDetails.cs index 16d0b139..b726f08e 100644 --- a/ShipEngineSDK/Model/ContactDetails.cs +++ b/ShipEngineSDK/Model/ContactDetails.cs @@ -28,13 +28,6 @@ namespace ShipEngineSDK.Model; public partial class ContactDetails { - /// - /// Gets or Sets Name - /// - [JsonPropertyName("name")] - [JsonRequired] - public string Name { get; set; } - /// /// An email address. /// @@ -46,6 +39,13 @@ public partial class ContactDetails [JsonRequired] public string Email { get; set; } + /// + /// Gets or Sets Name + /// + [JsonPropertyName("name")] + [JsonRequired] + public string Name { get; set; } + /// /// Phone number associated /// @@ -64,8 +64,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ContactDetails {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" Phone: ").Append(Phone).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs index a3024026..841f85d2 100644 --- a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs @@ -95,14 +95,15 @@ public override bool CanConvert(Type typeToConvert) => /// - /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. + /// A base64 encoded string representation of the image. /// - /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. + /// A base64 encoded string representation of the image. /// - /// img_DtBXupDBxREpHnwEXhTfgK + /// iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg== /// - [JsonPropertyName("label_image_id")] - public string LabelImageId { get; set; } + [JsonPropertyName("image_data")] + [JsonRequired] + public string ImageData { get; set; } /// /// A human readable name for the image. @@ -116,35 +117,34 @@ public override bool CanConvert(Type typeToConvert) => public string Name { get; set; } /// - /// Indicates whether this image is set as default. + /// The date and time that the image was created in ShipEngine. /// - /// Indicates whether this image is set as default. + /// The date and time that the image was created in ShipEngine. /// - /// false + /// 2018-09-23T15:00Z /// - [JsonPropertyName("is_default")] - public bool IsDefault { get; set; } + [JsonPropertyName("created_at")] + public DateTimeOffset? CreatedAt { get; set; } /// - /// A base64 encoded string representation of the image. + /// Indicates whether this image is set as default. /// - /// A base64 encoded string representation of the image. + /// Indicates whether this image is set as default. /// - /// iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg== + /// false /// - [JsonPropertyName("image_data")] - [JsonRequired] - public string ImageData { get; set; } + [JsonPropertyName("is_default")] + public bool? IsDefault { get; set; } /// - /// The date and time that the image was created in ShipEngine. + /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. /// - /// The date and time that the image was created in ShipEngine. + /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. /// - /// 2018-09-23T15:00Z + /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("label_image_id")] + public string? LabelImageId { get; set; } /// /// The date and time that the image was modified in ShipEngine. @@ -154,7 +154,7 @@ public override bool CanConvert(Type typeToConvert) => /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at")] - public DateTimeOffset ModifiedAt { get; set; } + public DateTimeOffset? ModifiedAt { get; set; } /// @@ -166,12 +166,12 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreateAccountSettingsImageRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); - sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); sb.Append(" ImageContentType: ").Append(ImageContentType).Append("\n"); sb.Append(" ImageData: ").Append(ImageData).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); + sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs index 18976f87..242f45f8 100644 --- a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs +++ b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs @@ -29,44 +29,44 @@ public partial class CreateAndProcessBatchRequestBody { /// - /// A string that uniquely identifies the external batch + /// Add custom messages for a particular batch /// - /// A string that uniquely identifies the external batch + /// Add custom messages for a particular batch /// - /// se-28529731 + /// This is my batch /// - [JsonPropertyName("external_batch_id")] - public string ExternalBatchId { get; set; } + [JsonPropertyName("batch_notes")] + public string? BatchNotes { get; set; } /// - /// Add custom messages for a particular batch + /// A string that uniquely identifies the external batch /// - /// Add custom messages for a particular batch + /// A string that uniquely identifies the external batch /// - /// This is my batch + /// se-28529731 /// - [JsonPropertyName("batch_notes")] - public string BatchNotes { get; set; } + [JsonPropertyName("external_batch_id")] + public string? ExternalBatchId { get; set; } /// - /// Array of shipment IDs used in the batch + /// Gets or Sets ProcessLabels /// - /// Array of shipment IDs used in the batch - [JsonPropertyName("shipment_ids")] - public List ShipmentIds { get; set; } + [JsonPropertyName("process_labels")] + public CreateAndProcessBatchRequestBodyProcessLabels? ProcessLabels { get; set; } /// /// Array of rate IDs used in the batch /// /// Array of rate IDs used in the batch [JsonPropertyName("rate_ids")] - public List RateIds { get; set; } + public List? RateIds { get; set; } /// - /// Gets or Sets ProcessLabels + /// Array of shipment IDs used in the batch /// - [JsonPropertyName("process_labels")] - public CreateAndProcessBatchRequestBodyProcessLabels ProcessLabels { get; set; } + /// Array of shipment IDs used in the batch + [JsonPropertyName("shipment_ids")] + public List? ShipmentIds { get; set; } /// @@ -78,11 +78,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreateAndProcessBatchRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ExternalBatchId: ").Append(ExternalBatchId).Append("\n"); sb.Append(" BatchNotes: ").Append(BatchNotes).Append("\n"); - sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); - sb.Append(" RateIds: ").Append(RateIds).Append("\n"); + sb.Append(" ExternalBatchId: ").Append(ExternalBatchId).Append("\n"); sb.Append(" ProcessLabels: ").Append(ProcessLabels).Append("\n"); + sb.Append(" RateIds: ").Append(RateIds).Append("\n"); + sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs index c47588d9..06fece9b 100644 --- a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs +++ b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs @@ -29,27 +29,27 @@ public partial class CreateAndProcessBatchRequestBodyProcessLabels { /// - /// Gets or Sets LabelLayout CLOVUS + /// The display format that the label should be shown in. CLOVUS /// - [JsonPropertyName("label_layout")] - public LabelLayout? LabelLayout { get; set; } + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme")] + public DisplayScheme? DisplayScheme { get; set; } /// /// Gets or Sets LabelFormat CLOVUS /// [JsonPropertyName("label_format")] public LabelFormat? LabelFormat { get; set; } /// - /// The display format that the label should be shown in. CLOVUS + /// Gets or Sets LabelLayout CLOVUS /// - /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] - public DisplayScheme? DisplayScheme { get; set; } + [JsonPropertyName("label_layout")] + public LabelLayout? LabelLayout { get; set; } /// /// When 'true', the batch will be enqueued for processing /// /// When 'true', the batch will be enqueued for processing [JsonPropertyName("create_batch_and_process_labels")] - public bool CreateBatchAndProcessLabels { get; set; } + public bool? CreateBatchAndProcessLabels { get; set; } /// /// The Ship date the batch is being processed for @@ -59,7 +59,7 @@ public partial class CreateAndProcessBatchRequestBodyProcessLabels /// 2018-09-23T15:00Z /// [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + public DateTimeOffset? ShipDate { get; set; } /// @@ -72,10 +72,10 @@ public override string ToString() sb.Append("class CreateAndProcessBatchRequestBodyProcessLabels {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CreateBatchAndProcessLabels: ").Append(CreateBatchAndProcessLabels).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); - sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); - sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreateAndValidateShipment.cs b/ShipEngineSDK/Model/CreateAndValidateShipment.cs index 1e12804b..3c0d257e 100644 --- a/ShipEngineSDK/Model/CreateAndValidateShipment.cs +++ b/ShipEngineSDK/Model/CreateAndValidateShipment.cs @@ -28,12 +28,6 @@ namespace ShipEngineSDK.Model; public partial class CreateAndValidateShipment { - /// - /// The current status of the shipment CLOVUS - /// - /// The current status of the shipment - [JsonPropertyName("shipment_status")] - public ShipmentStatus? ShipmentStatus { get; set; } /// /// The type of delivery confirmation that is required for this shipment. CLOVUS /// @@ -52,14 +46,24 @@ public partial class CreateAndValidateShipment [JsonPropertyName("order_source_code")] public OrderSourceName? OrderSourceCode { get; set; } /// - /// A string that uniquely identifies the shipment + /// The current status of the shipment CLOVUS /// - /// A string that uniquely identifies the shipment - /// - /// se-28529731 - /// - [JsonPropertyName("shipment_id")] - public string ShipmentId { get; set; } + /// The current status of the shipment + [JsonPropertyName("shipment_status")] + public ShipmentStatus? ShipmentStatus { get; set; } + /// + /// The address validation + /// + /// The address validation + [JsonPropertyName("address_validation")] + public AddressValidationResult? AddressValidation { get; set; } + + /// + /// Advanced shipment options. These are entirely optional. + /// + /// Advanced shipment options. These are entirely optional. + [JsonPropertyName("advanced_options")] + public AdvancedShipmentOptions? AdvancedOptions { get; set; } /// /// The carrier account that is billed for the shipping charges @@ -69,81 +73,70 @@ public partial class CreateAndValidateShipment /// se-28529731 /// [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + public string? CarrierId { get; set; } /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. /// - /// usps_first_class_mail + /// retail /// - [JsonPropertyName("service_code")] - public string ServiceCode { get; set; } + [JsonPropertyName("comparison_rate_type")] + public string? ComparisonRateType { get; set; } /// - /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// The date and time that the shipment was created in ShipEngine. /// - /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// The date and time that the shipment was created in ShipEngine. /// - /// se-28529731 + /// 2018-09-23T15:00Z /// - [JsonPropertyName("shipping_rule_id")] - public string ShippingRuleId { get; set; } + [JsonPropertyName("created_at")] + public DateTimeOffset? CreatedAt { get; set; } /// - /// ID that the Order Source assigned + /// Customs information. This is usually only needed for international shipments. /// - /// ID that the Order Source assigned - [JsonPropertyName("external_order_id")] - public string ExternalOrderId { get; set; } + /// Customs information. This is usually only needed for international shipments. + [JsonPropertyName("customs")] + public InternationalShipmentOptions? Customs { get; set; } /// - /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources + /// An array of errors that occurred while creating shipment. /// - /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - [JsonPropertyName("items")] - public List Items { get; set; } + /// An array of errors that occurred while creating shipment. + [JsonPropertyName("errors")] + [Obsolete] + public List? Errors { get; set; } /// - /// Gets or Sets TaxIdentifiers + /// ID that the Order Source assigned /// - [JsonPropertyName("tax_identifiers")] - public List TaxIdentifiers { get; set; } + /// ID that the Order Source assigned + [JsonPropertyName("external_order_id")] + public string? ExternalOrderId { get; set; } /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. [JsonPropertyName("external_shipment_id")] - public string ExternalShipmentId { get; set; } - - /// - /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - /// - /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("shipment_number")] - public string ShipmentNumber { get; set; } + public string? ExternalShipmentId { get; set; } /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. - /// - /// 2018-09-23T00:00Z - /// - [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. + [JsonPropertyName("is_return")] + public bool? IsReturn { get; set; } /// - /// The date and time that the shipment was created in ShipEngine. + /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources /// - /// The date and time that the shipment was created in ShipEngine. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources + [JsonPropertyName("items")] + public List? Items { get; set; } /// /// The date and time that the shipment was created or last modified. @@ -153,105 +146,112 @@ public partial class CreateAndValidateShipment /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at")] - public DateTimeOffset ModifiedAt { get; set; } + public DateTimeOffset? ModifiedAt { get; set; } /// - /// The recipient's mailing address + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// - /// The recipient's mailing address - [JsonPropertyName("ship_to")] - public ShippingAddressTo ShipTo { get; set; } + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + [JsonPropertyName("packages")] + public List? Packages { get; set; } /// - /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. + /// The return address for this shipment. Defaults to the `ship_from` address. /// - /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from")] - public ShippingAddress ShipFrom { get; set; } + /// The return address for this shipment. Defaults to the `ship_from` address. + [JsonPropertyName("return_to")] + public ShippingAddress? ReturnTo { get; set; } /// - /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// - /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// - /// se-28529731 + /// usps_first_class_mail /// - [JsonPropertyName("warehouse_id")] - public string WarehouseId { get; set; } + [JsonPropertyName("service_code")] + public string? ServiceCode { get; set; } /// - /// The return address for this shipment. Defaults to the `ship_from` address. + /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to")] - public ShippingAddress ReturnTo { get; set; } + /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// + /// 2018-09-23T00:00Z + /// + [JsonPropertyName("ship_date")] + public DateTimeOffset? ShipDate { get; set; } /// - /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// - /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. - [JsonPropertyName("is_return")] - public bool? IsReturn { get; set; } + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. + [JsonPropertyName("ship_from")] + public ShippingAddress? ShipFrom { get; set; } /// - /// Customs information. This is usually only needed for international shipments. + /// The recipient's mailing address /// - /// Customs information. This is usually only needed for international shipments. - [JsonPropertyName("customs")] - public InternationalShipmentOptions Customs { get; set; } + /// The recipient's mailing address + [JsonPropertyName("ship_to")] + public ShippingAddressTo? ShipTo { get; set; } /// - /// Advanced shipment options. These are entirely optional. + /// A string that uniquely identifies the shipment /// - /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options")] - public AdvancedShipmentOptions AdvancedOptions { get; set; } + /// A string that uniquely identifies the shipment + /// + /// se-28529731 + /// + [JsonPropertyName("shipment_id")] + public string? ShipmentId { get; set; } + + /// + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. + /// + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. + [JsonPropertyName("shipment_number")] + public string? ShipmentNumber { get; set; } + + /// + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// + /// se-28529731 + /// + [JsonPropertyName("shipping_rule_id")] + public string? ShippingRuleId { get; set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. [JsonPropertyName("tags")] - public List Tags { get; set; } + public List? Tags { get; set; } /// - /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + /// Gets or Sets TaxIdentifiers /// - /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - public List Packages { get; set; } + [JsonPropertyName("tax_identifiers")] + public List? TaxIdentifiers { get; set; } /// /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment [JsonPropertyName("total_weight")] - public Weight TotalWeight { get; set; } + public Weight? TotalWeight { get; set; } /// - /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. /// - /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. /// - /// retail + /// se-28529731 /// - [JsonPropertyName("comparison_rate_type")] - public string ComparisonRateType { get; set; } - - /// - /// An array of errors that occurred while creating shipment. - /// - /// An array of errors that occurred while creating shipment. - [JsonPropertyName("errors")] - [Obsolete] - public List Errors { get; set; } - - /// - /// The address validation - /// - /// The address validation - [JsonPropertyName("address_validation")] - public AddressValidationResult AddressValidation { get; set; } + [JsonPropertyName("warehouse_id")] + public string? WarehouseId { get; set; } /// @@ -263,35 +263,35 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreateAndValidateShipment {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" AddressValidation: ").Append(AddressValidation).Append("\n"); + sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); - sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); - sb.Append(" ShippingRuleId: ").Append(ShippingRuleId).Append("\n"); - sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); - sb.Append(" Items: ").Append(Items).Append("\n"); - sb.Append(" TaxIdentifiers: ").Append(TaxIdentifiers).Append("\n"); - sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); - sb.Append(" ShipmentNumber: ").Append(ShipmentNumber).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); - sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); - sb.Append(" ShipmentStatus: ").Append(ShipmentStatus).Append("\n"); - sb.Append(" ShipTo: ").Append(ShipTo).Append("\n"); - sb.Append(" ShipFrom: ").Append(ShipFrom).Append("\n"); - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); - sb.Append(" ReturnTo: ").Append(ReturnTo).Append("\n"); - sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); + sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" Customs: ").Append(Customs).Append("\n"); - sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); + sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); + sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); sb.Append(" InsuranceProvider: ").Append(InsuranceProvider).Append("\n"); - sb.Append(" Tags: ").Append(Tags).Append("\n"); + sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); + sb.Append(" Items: ").Append(Items).Append("\n"); + sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); sb.Append(" OrderSourceCode: ").Append(OrderSourceCode).Append("\n"); sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" ReturnTo: ").Append(ReturnTo).Append("\n"); + sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" ShipFrom: ").Append(ShipFrom).Append("\n"); + sb.Append(" ShipTo: ").Append(ShipTo).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" ShipmentNumber: ").Append(ShipmentNumber).Append("\n"); + sb.Append(" ShipmentStatus: ").Append(ShipmentStatus).Append("\n"); + sb.Append(" ShippingRuleId: ").Append(ShippingRuleId).Append("\n"); + sb.Append(" Tags: ").Append(Tags).Append("\n"); + sb.Append(" TaxIdentifiers: ").Append(TaxIdentifiers).Append("\n"); sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); - sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); - sb.Append(" Errors: ").Append(Errors).Append("\n"); - sb.Append(" AddressValidation: ").Append(AddressValidation).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreateBatchRequestBody.cs b/ShipEngineSDK/Model/CreateBatchRequestBody.cs index 871e4067..205afa55 100644 --- a/ShipEngineSDK/Model/CreateBatchRequestBody.cs +++ b/ShipEngineSDK/Model/CreateBatchRequestBody.cs @@ -28,16 +28,6 @@ namespace ShipEngineSDK.Model; public partial class CreateBatchRequestBody { - /// - /// A string that uniquely identifies the external batch - /// - /// A string that uniquely identifies the external batch - /// - /// se-28529731 - /// - [JsonPropertyName("external_batch_id")] - public string ExternalBatchId { get; set; } - /// /// Add custom messages for a particular batch /// @@ -46,21 +36,31 @@ public partial class CreateBatchRequestBody /// This is my batch /// [JsonPropertyName("batch_notes")] - public string BatchNotes { get; set; } + public string? BatchNotes { get; set; } /// - /// Array of shipment IDs used in the batch + /// A string that uniquely identifies the external batch /// - /// Array of shipment IDs used in the batch - [JsonPropertyName("shipment_ids")] - public List ShipmentIds { get; set; } + /// A string that uniquely identifies the external batch + /// + /// se-28529731 + /// + [JsonPropertyName("external_batch_id")] + public string? ExternalBatchId { get; set; } /// /// Array of rate IDs used in the batch /// /// Array of rate IDs used in the batch [JsonPropertyName("rate_ids")] - public List RateIds { get; set; } + public List? RateIds { get; set; } + + /// + /// Array of shipment IDs used in the batch + /// + /// Array of shipment IDs used in the batch + [JsonPropertyName("shipment_ids")] + public List? ShipmentIds { get; set; } /// @@ -72,10 +72,10 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreateBatchRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ExternalBatchId: ").Append(ExternalBatchId).Append("\n"); sb.Append(" BatchNotes: ").Append(BatchNotes).Append("\n"); - sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); + sb.Append(" ExternalBatchId: ").Append(ExternalBatchId).Append("\n"); sb.Append(" RateIds: ").Append(RateIds).Append("\n"); + sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreateBatchResponseBody.cs b/ShipEngineSDK/Model/CreateBatchResponseBody.cs index c536bd99..753253dc 100644 --- a/ShipEngineSDK/Model/CreateBatchResponseBody.cs +++ b/ShipEngineSDK/Model/CreateBatchResponseBody.cs @@ -29,20 +29,20 @@ public partial class CreateBatchResponseBody { /// - /// label layout CLOVUS + /// Gets or Sets LabelFormat CLOVUS /// - /// label layout - [JsonPropertyName("label_layout")] + [JsonPropertyName("label_format")] [JsonRequired] - public LabelLayout LabelLayout { get; set; } = new(); + public LabelFormat LabelFormat { get; set; } = new(); /// - /// Gets or Sets LabelFormat CLOVUS + /// label layout CLOVUS /// - [JsonPropertyName("label_format")] + /// label layout + [JsonPropertyName("label_layout")] [JsonRequired] - public LabelFormat LabelFormat { get; set; } = new(); + public LabelLayout LabelLayout { get; set; } = new(); /// @@ -53,6 +53,14 @@ public partial class CreateBatchResponseBody public BatchStatus Status { get; set; } = new(); + /// + /// Link to batch errors endpoint + /// + /// Link to batch errors endpoint + [JsonPropertyName("batch_errors_url")] + [JsonRequired] + public OptionalLink BatchErrorsUrl { get; set; } + /// /// A string that uniquely identifies the batch /// @@ -64,6 +72,14 @@ public partial class CreateBatchResponseBody [JsonRequired] public string BatchId { get; set; } + /// + /// Link to batch labels query + /// + /// Link to batch labels query + [JsonPropertyName("batch_labels_url")] + [JsonRequired] + public OptionalLink BatchLabelsUrl { get; set; } + /// /// The batch number. /// @@ -73,45 +89,45 @@ public partial class CreateBatchResponseBody public string BatchNumber { get; set; } /// - /// A string that uniquely identifies the external batch + /// The batch shipments endpoint /// - /// A string that uniquely identifies the external batch - [JsonPropertyName("external_batch_id")] + /// The batch shipments endpoint + [JsonPropertyName("batch_shipments_url")] [JsonRequired] - public string ExternalBatchId { get; set; } + public OptionalLink BatchShipmentsUrl { get; set; } /// - /// Custom notes you can add for each created batch + /// The number of labels generated in the batch /// - /// Custom notes you can add for each created batch + /// The number of labels generated in the batch /// - /// Batch for morning shipment + /// 1 /// - [JsonPropertyName("batch_notes")] + [JsonPropertyName("completed")] [JsonRequired] - public string BatchNotes { get; set; } + public int Completed { get; set; } /// - /// The date and time the batch was created in ShipEngine + /// The total of errors, warnings, and completed properties /// - /// The date and time the batch was created in ShipEngine + /// The total of errors, warnings, and completed properties /// - /// 2018-09-23T15:00Z + /// 2 /// - [JsonPropertyName("created_at")] + [JsonPropertyName("count")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public int Count { get; set; } /// - /// The date and time the batch was processed in ShipEngine + /// The date and time the batch was created in ShipEngine /// - /// The date and time the batch was processed in ShipEngine + /// The date and time the batch was created in ShipEngine /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("processed_at")] + [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset ProcessedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The number of errors that occurred while generating the batch @@ -125,34 +141,12 @@ public partial class CreateBatchResponseBody public int Errors { get; set; } /// - /// The errors associated with the failed API call - /// - /// The errors associated with the failed API call - [JsonPropertyName("process_errors")] - [JsonRequired] - public List ProcessErrors { get; set; } - - /// - /// The number of warnings that occurred while generating the batch - /// - /// The number of warnings that occurred while generating the batch - /// - /// 1 - /// - [JsonPropertyName("warnings")] - [JsonRequired] - public int Warnings { get; set; } - - /// - /// The number of labels generated in the batch + /// The form download for any customs that are needed /// - /// The number of labels generated in the batch - /// - /// 1 - /// - [JsonPropertyName("completed")] + /// The form download for any customs that are needed + [JsonPropertyName("form_download")] [JsonRequired] - public int Completed { get; set; } + public OptionalLink FormDownload { get; set; } /// /// The number of forms for customs that are available for download @@ -166,63 +160,69 @@ public partial class CreateBatchResponseBody public int Forms { get; set; } /// - /// The total of errors, warnings, and completed properties + /// The label download for the batch /// - /// The total of errors, warnings, and completed properties - /// - /// 2 - /// - [JsonPropertyName("count")] + /// The label download for the batch + [JsonPropertyName("label_download")] [JsonRequired] - public int Count { get; set; } + public LabelDownload LabelDownload { get; set; } /// - /// The batch shipments endpoint + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// - /// The batch shipments endpoint - [JsonPropertyName("batch_shipments_url")] + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + [JsonPropertyName("paperless_download")] [JsonRequired] - public OptionalLink BatchShipmentsUrl { get; set; } + public PaperlessDownload PaperlessDownload { get; set; } /// - /// Link to batch labels query + /// The errors associated with the failed API call /// - /// Link to batch labels query - [JsonPropertyName("batch_labels_url")] + /// The errors associated with the failed API call + [JsonPropertyName("process_errors")] [JsonRequired] - public OptionalLink BatchLabelsUrl { get; set; } + public List ProcessErrors { get; set; } /// - /// Link to batch errors endpoint + /// The number of warnings that occurred while generating the batch /// - /// Link to batch errors endpoint - [JsonPropertyName("batch_errors_url")] + /// The number of warnings that occurred while generating the batch + /// + /// 1 + /// + [JsonPropertyName("warnings")] [JsonRequired] - public OptionalLink BatchErrorsUrl { get; set; } + public int Warnings { get; set; } /// - /// The label download for the batch + /// Custom notes you can add for each created batch /// - /// The label download for the batch - [JsonPropertyName("label_download")] + /// Custom notes you can add for each created batch + /// + /// Batch for morning shipment + /// + [JsonPropertyName("batch_notes")] [JsonRequired] - public LabelDownload LabelDownload { get; set; } + public string BatchNotes { get; set; } /// - /// The form download for any customs that are needed + /// A string that uniquely identifies the external batch /// - /// The form download for any customs that are needed - [JsonPropertyName("form_download")] + /// A string that uniquely identifies the external batch + [JsonPropertyName("external_batch_id")] [JsonRequired] - public OptionalLink FormDownload { get; set; } + public string ExternalBatchId { get; set; } /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// The date and time the batch was processed in ShipEngine /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] + /// The date and time the batch was processed in ShipEngine + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("processed_at")] [JsonRequired] - public PaperlessDownload PaperlessDownload { get; set; } + public DateTimeOffset ProcessedAt { get; set; } /// @@ -234,27 +234,27 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreateBatchResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); - sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" BatchErrorsUrl: ").Append(BatchErrorsUrl).Append("\n"); sb.Append(" BatchId: ").Append(BatchId).Append("\n"); + sb.Append(" BatchLabelsUrl: ").Append(BatchLabelsUrl).Append("\n"); sb.Append(" BatchNumber: ").Append(BatchNumber).Append("\n"); - sb.Append(" ExternalBatchId: ").Append(ExternalBatchId).Append("\n"); - sb.Append(" BatchNotes: ").Append(BatchNotes).Append("\n"); + sb.Append(" BatchShipmentsUrl: ").Append(BatchShipmentsUrl).Append("\n"); + sb.Append(" Completed: ").Append(Completed).Append("\n"); + sb.Append(" Count: ").Append(Count).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); - sb.Append(" ProcessedAt: ").Append(ProcessedAt).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); - sb.Append(" ProcessErrors: ").Append(ProcessErrors).Append("\n"); - sb.Append(" Warnings: ").Append(Warnings).Append("\n"); - sb.Append(" Completed: ").Append(Completed).Append("\n"); + sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); sb.Append(" Forms: ").Append(Forms).Append("\n"); - sb.Append(" Count: ").Append(Count).Append("\n"); - sb.Append(" BatchShipmentsUrl: ").Append(BatchShipmentsUrl).Append("\n"); - sb.Append(" BatchLabelsUrl: ").Append(BatchLabelsUrl).Append("\n"); - sb.Append(" BatchErrorsUrl: ").Append(BatchErrorsUrl).Append("\n"); sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); - sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); + sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" ProcessErrors: ").Append(ProcessErrors).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); + sb.Append(" Warnings: ").Append(Warnings).Append("\n"); + sb.Append(" BatchNotes: ").Append(BatchNotes).Append("\n"); + sb.Append(" ExternalBatchId: ").Append(ExternalBatchId).Append("\n"); + sb.Append(" ProcessedAt: ").Append(ProcessedAt).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs b/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs index 557ff48d..a7b18813 100644 --- a/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs @@ -29,31 +29,31 @@ public partial class CreateLabelFromRateRequestBody { /// - /// Gets or Sets ValidateAddress CLOVUS + /// The display format that the label should be shown in. CLOVUS /// - [JsonPropertyName("validate_address")] - public ValidateAddress? ValidateAddress { get; set; } + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme")] + public DisplayScheme? DisplayScheme { get; set; } /// - /// Gets or Sets LabelLayout CLOVUS + /// Gets or Sets LabelDownloadType CLOVUS /// - [JsonPropertyName("label_layout")] - public LabelLayout? LabelLayout { get; set; } + [JsonPropertyName("label_download_type")] + public LabelDownloadType? LabelDownloadType { get; set; } /// /// Gets or Sets LabelFormat CLOVUS /// [JsonPropertyName("label_format")] public LabelFormat? LabelFormat { get; set; } /// - /// Gets or Sets LabelDownloadType CLOVUS + /// Gets or Sets LabelLayout CLOVUS /// - [JsonPropertyName("label_download_type")] - public LabelDownloadType? LabelDownloadType { get; set; } + [JsonPropertyName("label_layout")] + public LabelLayout? LabelLayout { get; set; } /// - /// The display format that the label should be shown in. CLOVUS + /// Gets or Sets ValidateAddress CLOVUS /// - /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] - public DisplayScheme? DisplayScheme { get; set; } + [JsonPropertyName("validate_address")] + public ValidateAddress? ValidateAddress { get; set; } /// /// Returns the string presentation of the object @@ -64,11 +64,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreateLabelFromRateRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); - sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); - sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); - sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); + sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); + sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs index 7e7d2980..2087f798 100644 --- a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs @@ -28,11 +28,6 @@ namespace ShipEngineSDK.Model; public partial class CreateLabelFromRateResponseBody { - /// - /// Gets or Sets Status CLOVUS - /// - [JsonPropertyName("status")] - public LabelStatus? Status { get; set; } /// /// The label charge event. CLOVUS /// @@ -40,10 +35,11 @@ public partial class CreateLabelFromRateResponseBody [JsonPropertyName("charge_event")] public LabelChargeEvent? ChargeEvent { get; set; } /// - /// Gets or Sets ValidateAddress CLOVUS + /// The display format that the label should be shown in. CLOVUS /// - [JsonPropertyName("validate_address")] - public ValidateAddress? ValidateAddress { get; set; } + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme")] + public DisplayScheme? DisplayScheme { get; set; } /// /// Gets or Sets LabelDownloadType CLOVUS /// @@ -56,59 +52,63 @@ public partial class CreateLabelFromRateResponseBody [JsonPropertyName("label_format")] public LabelFormat? LabelFormat { get; set; } /// - /// The display format that the label should be shown in. CLOVUS - /// - /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] - public DisplayScheme? DisplayScheme { 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. CLOVUS /// /// 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")] public LabelLayout? LabelLayout { get; set; } /// + /// Gets or Sets Status CLOVUS + /// + [JsonPropertyName("status")] + public LabelStatus? Status { get; set; } + /// /// The current status of the package, such as `in_transit` or `delivered` CLOVUS /// /// The current status of the package, such as `in_transit` or `delivered` [JsonPropertyName("tracking_status")] public TrackingStatus? TrackingStatus { get; set; } /// - /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. + /// Gets or Sets ValidateAddress CLOVUS /// - /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. - /// - /// se-28529731 - /// - [JsonPropertyName("label_id")] - public string LabelId { get; set; } + [JsonPropertyName("validate_address")] + public ValidateAddress? ValidateAddress { get; set; } + /// + /// Additional information some carriers may provide by which to identify a given label in their system. + /// + /// Additional information some carriers may provide by which to identify a given label in their system. + [JsonPropertyName("alternative_identifiers")] + public List? AlternativeIdentifiers { get; set; } /// - /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// - /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string ShipmentId { get; set; } + [JsonPropertyName("batch_id")] + public string? BatchId { get; set; } /// - /// The shipment information used to generate the label + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. /// - /// The shipment information used to generate the label - [JsonPropertyName("shipment")] - public Shipment Shipment { get; set; } + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// dhl_express + /// + [JsonPropertyName("carrier_code")] + public string? CarrierCode { get; set; } /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// - /// 2018-09-23T00:00Z + /// se-28529731 /// - [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + [JsonPropertyName("carrier_id")] + public string? CarrierId { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -118,79 +118,68 @@ public partial class CreateLabelFromRateResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + public DateTimeOffset? CreatedAt { get; set; } /// - /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + /// 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. /// - /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - [JsonPropertyName("shipment_cost")] - public MonetaryValue ShipmentCost { 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. + [JsonPropertyName("form_download")] + public Link? FormDownload { get; set; } /// - /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + /// 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. /// - /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. - [JsonPropertyName("insurance_cost")] - public MonetaryValue InsuranceCost { get; set; } + /// 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. + [JsonPropertyName("insurance_claim")] + public Link? InsuranceClaim { get; set; } /// - /// The total shipping cost for the specified comparison_rate_type. + /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// - /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue RequestedComparisonAmount { get; set; } + /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + [JsonPropertyName("insurance_cost")] + public MonetaryValue? InsuranceCost { get; set; } /// - /// The tracking number for the package. Tracking number formats vary across carriers. + /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// - /// The tracking number for the package. Tracking number formats vary across carriers. - /// - /// 782758401696 - /// - [JsonPropertyName("tracking_number")] - public string TrackingNumber { get; set; } + /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + [JsonPropertyName("is_international")] + public bool? IsInternational { get; set; } /// /// 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")] - public bool IsReturnLabel { get; set; } - - /// - /// 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")] - public string RmaNumber { get; set; } + public bool? IsReturnLabel { get; set; } /// - /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + /// Gets or Sets LabelDownload /// - /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. - [JsonPropertyName("is_international")] - public bool IsInternational { get; set; } + [JsonPropertyName("label_download")] + public LabelDownload? LabelDownload { get; set; } /// - /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// - /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - public string BatchId { get; set; } + [JsonPropertyName("label_id")] + public string? LabelId { get; set; } /// - /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// The label image resource that was used to create a custom label image. /// - /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// The label image resource that was used to create a custom label image. /// - /// se-28529731 + /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + [JsonPropertyName("label_image_id")] + public string? LabelImageId { get; set; } /// /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. @@ -200,25 +189,7 @@ public partial class CreateLabelFromRateResponseBody /// se-28529731 /// [JsonPropertyName("outbound_label_id")] - public string OutboundLabelId { get; set; } - - /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. - /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. - /// - /// usps_first_class_mail - /// - [JsonPropertyName("service_code")] - public string ServiceCode { 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")] - [Obsolete] - public bool TestLabel { get; set; } + public string? OutboundLabelId { get; set; } /// /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. @@ -228,92 +199,104 @@ public partial class CreateLabelFromRateResponseBody /// small_flat_rate_box /// [JsonPropertyName("package_code")] - public string PackageCode { get; set; } + public string? PackageCode { get; set; } /// - /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// - /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) - [JsonPropertyName("voided")] - public bool Voided { get; set; } + /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + [JsonPropertyName("packages")] + public List? Packages { get; set; } /// - /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// - /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("voided_at")] - public DateTimeOffset VoidedAt { get; set; } + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + [JsonPropertyName("paperless_download")] + public PaperlessDownload? PaperlessDownload { get; set; } /// - /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + /// The total shipping cost for the specified comparison_rate_type. /// - /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. - [JsonPropertyName("trackable")] - public bool Trackable { get; set; } + /// The total shipping cost for the specified comparison_rate_type. + [JsonPropertyName("requested_comparison_amount")] + public MonetaryValue? RequestedComparisonAmount { get; set; } /// - /// The label image resource that was used to create a custom label image. + /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. /// - /// The label image resource that was used to create a custom label image. + /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. + [JsonPropertyName("rma_number")] + public string? RmaNumber { get; set; } + + /// + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// - /// img_DtBXupDBxREpHnwEXhTfgK + /// usps_first_class_mail /// - [JsonPropertyName("label_image_id")] - public string LabelImageId { get; set; } + [JsonPropertyName("service_code")] + public string? ServiceCode { get; set; } /// - /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// dhl_express + /// 2018-09-23T00:00Z /// - [JsonPropertyName("carrier_code")] - public string CarrierCode { get; set; } + [JsonPropertyName("ship_date")] + public DateTimeOffset? ShipDate { get; set; } /// - /// Gets or Sets LabelDownload + /// The shipment information used to generate the label /// - [JsonPropertyName("label_download")] - public LabelDownload LabelDownload { get; set; } + /// The shipment information used to generate the label + [JsonPropertyName("shipment")] + public Shipment? Shipment { 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. + /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// - /// 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. - [JsonPropertyName("form_download")] - public Link FormDownload { get; set; } + /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + [JsonPropertyName("shipment_cost")] + public MonetaryValue? ShipmentCost { get; set; } /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - public PaperlessDownload PaperlessDownload { get; set; } + /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// + /// se-28529731 + /// + [JsonPropertyName("shipment_id")] + public string? ShipmentId { get; set; } /// - /// 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. + /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. /// - /// 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. - [JsonPropertyName("insurance_claim")] - public Link InsuranceClaim { get; set; } + /// 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")] + [Obsolete] + public bool? TestLabel { get; set; } /// - /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// - /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - public List Packages { get; set; } + /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + [JsonPropertyName("trackable")] + public bool? Trackable { get; set; } /// - /// Additional information some carriers may provide by which to identify a given label in their system. + /// The tracking number for the package. Tracking number formats vary across carriers. /// - /// Additional information some carriers may provide by which to identify a given label in their system. - [JsonPropertyName("alternative_identifiers")] - public List AlternativeIdentifiers { get; set; } + /// The tracking number for the package. Tracking number formats vary across carriers. + /// + /// 782758401696 + /// + [JsonPropertyName("tracking_number")] + public string? TrackingNumber { get; set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. @@ -323,7 +306,24 @@ public partial class CreateLabelFromRateResponseBody /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url")] - public string TrackingUrl { get; set; } + public string? TrackingUrl { get; set; } + + /// + /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// + /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + [JsonPropertyName("voided")] + public bool? Voided { get; set; } + + /// + /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("voided_at")] + public DateTimeOffset? VoidedAt { get; set; } /// @@ -335,44 +335,44 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreateLabelFromRateResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" LabelId: ").Append(LabelId).Append("\n"); - sb.Append(" Status: ").Append(Status).Append("\n"); - sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); - sb.Append(" Shipment: ").Append(Shipment).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); - sb.Append(" ShipmentCost: ").Append(ShipmentCost).Append("\n"); - sb.Append(" InsuranceCost: ").Append(InsuranceCost).Append("\n"); - sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); - sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); - sb.Append(" IsReturnLabel: ").Append(IsReturnLabel).Append("\n"); - sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); - sb.Append(" IsInternational: ").Append(IsInternational).Append("\n"); + sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" BatchId: ").Append(BatchId).Append("\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); - sb.Append(" OutboundLabelId: ").Append(OutboundLabelId).Append("\n"); - sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); - sb.Append(" TestLabel: ").Append(TestLabel).Append("\n"); - sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); - sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); - sb.Append(" Voided: ").Append(Voided).Append("\n"); - sb.Append(" VoidedAt: ").Append(VoidedAt).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); + sb.Append(" InsuranceClaim: ").Append(InsuranceClaim).Append("\n"); + sb.Append(" InsuranceCost: ").Append(InsuranceCost).Append("\n"); + sb.Append(" IsInternational: ").Append(IsInternational).Append("\n"); + sb.Append(" IsReturnLabel: ").Append(IsReturnLabel).Append("\n"); + sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); - sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" LabelId: ").Append(LabelId).Append("\n"); + sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); + sb.Append(" OutboundLabelId: ").Append(OutboundLabelId).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); + sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); + sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" Shipment: ").Append(Shipment).Append("\n"); + sb.Append(" ShipmentCost: ").Append(ShipmentCost).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" Status: ").Append(Status).Append("\n"); + sb.Append(" TestLabel: ").Append(TestLabel).Append("\n"); sb.Append(" Trackable: ").Append(Trackable).Append("\n"); - sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); - sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); sb.Append(" TrackingStatus: ").Append(TrackingStatus).Append("\n"); - sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); - sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); - sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); - sb.Append(" InsuranceClaim: ").Append(InsuranceClaim).Append("\n"); - sb.Append(" Packages: ").Append(Packages).Append("\n"); - sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); + sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); + sb.Append(" Voided: ").Append(Voided).Append("\n"); + sb.Append(" VoidedAt: ").Append(VoidedAt).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs b/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs index e6de6353..31a161d0 100644 --- a/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs @@ -29,31 +29,31 @@ public partial class CreateLabelFromShipmentRequestBody { /// - /// Gets or Sets ValidateAddress CLOVUS + /// The display format that the label should be shown in. CLOVUS /// - [JsonPropertyName("validate_address")] - public ValidateAddress? ValidateAddress { get; set; } + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme")] + public DisplayScheme? DisplayScheme { get; set; } /// - /// Gets or Sets LabelLayout CLOVUS + /// Gets or Sets LabelDownloadType CLOVUS /// - [JsonPropertyName("label_layout")] - public LabelLayout? LabelLayout { get; set; } + [JsonPropertyName("label_download_type")] + public LabelDownloadType? LabelDownloadType { get; set; } /// /// Gets or Sets LabelFormat CLOVUS /// [JsonPropertyName("label_format")] public LabelFormat? LabelFormat { get; set; } /// - /// Gets or Sets LabelDownloadType CLOVUS + /// Gets or Sets LabelLayout CLOVUS /// - [JsonPropertyName("label_download_type")] - public LabelDownloadType? LabelDownloadType { get; set; } + [JsonPropertyName("label_layout")] + public LabelLayout? LabelLayout { get; set; } /// - /// The display format that the label should be shown in. CLOVUS + /// Gets or Sets ValidateAddress CLOVUS /// - /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] - public DisplayScheme? DisplayScheme { get; set; } + [JsonPropertyName("validate_address")] + public ValidateAddress? ValidateAddress { get; set; } /// /// Returns the string presentation of the object @@ -64,11 +64,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreateLabelFromShipmentRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); - sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); - sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); - sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); + sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); + sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs index 92a14139..5df4d081 100644 --- a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs @@ -28,11 +28,6 @@ namespace ShipEngineSDK.Model; public partial class CreateLabelFromShipmentResponseBody { - /// - /// Gets or Sets Status CLOVUS - /// - [JsonPropertyName("status")] - public LabelStatus? Status { get; set; } /// /// The label charge event. CLOVUS /// @@ -40,10 +35,11 @@ public partial class CreateLabelFromShipmentResponseBody [JsonPropertyName("charge_event")] public LabelChargeEvent? ChargeEvent { get; set; } /// - /// Gets or Sets ValidateAddress CLOVUS + /// The display format that the label should be shown in. CLOVUS /// - [JsonPropertyName("validate_address")] - public ValidateAddress? ValidateAddress { get; set; } + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme")] + public DisplayScheme? DisplayScheme { get; set; } /// /// Gets or Sets LabelDownloadType CLOVUS /// @@ -56,59 +52,63 @@ public partial class CreateLabelFromShipmentResponseBody [JsonPropertyName("label_format")] public LabelFormat? LabelFormat { get; set; } /// - /// The display format that the label should be shown in. CLOVUS - /// - /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] - public DisplayScheme? DisplayScheme { 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. CLOVUS /// /// 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")] public LabelLayout? LabelLayout { get; set; } /// + /// Gets or Sets Status CLOVUS + /// + [JsonPropertyName("status")] + public LabelStatus? Status { get; set; } + /// /// The current status of the package, such as `in_transit` or `delivered` CLOVUS /// /// The current status of the package, such as `in_transit` or `delivered` [JsonPropertyName("tracking_status")] public TrackingStatus? TrackingStatus { get; set; } /// - /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. + /// Gets or Sets ValidateAddress CLOVUS /// - /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. - /// - /// se-28529731 - /// - [JsonPropertyName("label_id")] - public string LabelId { get; set; } + [JsonPropertyName("validate_address")] + public ValidateAddress? ValidateAddress { get; set; } + /// + /// Additional information some carriers may provide by which to identify a given label in their system. + /// + /// Additional information some carriers may provide by which to identify a given label in their system. + [JsonPropertyName("alternative_identifiers")] + public List? AlternativeIdentifiers { get; set; } /// - /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// - /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string ShipmentId { get; set; } + [JsonPropertyName("batch_id")] + public string? BatchId { get; set; } /// - /// The shipment information used to generate the label + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. /// - /// The shipment information used to generate the label - [JsonPropertyName("shipment")] - public Shipment Shipment { get; set; } + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// dhl_express + /// + [JsonPropertyName("carrier_code")] + public string? CarrierCode { get; set; } /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// - /// 2018-09-23T00:00Z + /// se-28529731 /// - [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + [JsonPropertyName("carrier_id")] + public string? CarrierId { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -118,79 +118,68 @@ public partial class CreateLabelFromShipmentResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + public DateTimeOffset? CreatedAt { get; set; } /// - /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + /// 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. /// - /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - [JsonPropertyName("shipment_cost")] - public MonetaryValue ShipmentCost { 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. + [JsonPropertyName("form_download")] + public Link? FormDownload { get; set; } /// - /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + /// 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. /// - /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. - [JsonPropertyName("insurance_cost")] - public MonetaryValue InsuranceCost { get; set; } + /// 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. + [JsonPropertyName("insurance_claim")] + public Link? InsuranceClaim { get; set; } /// - /// The total shipping cost for the specified comparison_rate_type. + /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// - /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue RequestedComparisonAmount { get; set; } + /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + [JsonPropertyName("insurance_cost")] + public MonetaryValue? InsuranceCost { get; set; } /// - /// The tracking number for the package. Tracking number formats vary across carriers. + /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// - /// The tracking number for the package. Tracking number formats vary across carriers. - /// - /// 782758401696 - /// - [JsonPropertyName("tracking_number")] - public string TrackingNumber { get; set; } + /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + [JsonPropertyName("is_international")] + public bool? IsInternational { get; set; } /// /// 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")] - public bool IsReturnLabel { get; set; } - - /// - /// 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")] - public string RmaNumber { get; set; } + public bool? IsReturnLabel { get; set; } /// - /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + /// Gets or Sets LabelDownload /// - /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. - [JsonPropertyName("is_international")] - public bool IsInternational { get; set; } + [JsonPropertyName("label_download")] + public LabelDownload? LabelDownload { get; set; } /// - /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// - /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - public string BatchId { get; set; } + [JsonPropertyName("label_id")] + public string? LabelId { get; set; } /// - /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// The label image resource that was used to create a custom label image. /// - /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// The label image resource that was used to create a custom label image. /// - /// se-28529731 + /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + [JsonPropertyName("label_image_id")] + public string? LabelImageId { get; set; } /// /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. @@ -200,25 +189,7 @@ public partial class CreateLabelFromShipmentResponseBody /// se-28529731 /// [JsonPropertyName("outbound_label_id")] - public string OutboundLabelId { get; set; } - - /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. - /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. - /// - /// usps_first_class_mail - /// - [JsonPropertyName("service_code")] - public string ServiceCode { 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")] - [Obsolete] - public bool TestLabel { get; set; } + public string? OutboundLabelId { get; set; } /// /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. @@ -228,92 +199,104 @@ public partial class CreateLabelFromShipmentResponseBody /// small_flat_rate_box /// [JsonPropertyName("package_code")] - public string PackageCode { get; set; } + public string? PackageCode { get; set; } /// - /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// - /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) - [JsonPropertyName("voided")] - public bool Voided { get; set; } + /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + [JsonPropertyName("packages")] + public List? Packages { get; set; } /// - /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// - /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("voided_at")] - public DateTimeOffset VoidedAt { get; set; } + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + [JsonPropertyName("paperless_download")] + public PaperlessDownload? PaperlessDownload { get; set; } /// - /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + /// The total shipping cost for the specified comparison_rate_type. /// - /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. - [JsonPropertyName("trackable")] - public bool Trackable { get; set; } + /// The total shipping cost for the specified comparison_rate_type. + [JsonPropertyName("requested_comparison_amount")] + public MonetaryValue? RequestedComparisonAmount { get; set; } /// - /// The label image resource that was used to create a custom label image. + /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. /// - /// The label image resource that was used to create a custom label image. + /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. + [JsonPropertyName("rma_number")] + public string? RmaNumber { get; set; } + + /// + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// - /// img_DtBXupDBxREpHnwEXhTfgK + /// usps_first_class_mail /// - [JsonPropertyName("label_image_id")] - public string LabelImageId { get; set; } + [JsonPropertyName("service_code")] + public string? ServiceCode { get; set; } /// - /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// dhl_express + /// 2018-09-23T00:00Z /// - [JsonPropertyName("carrier_code")] - public string CarrierCode { get; set; } + [JsonPropertyName("ship_date")] + public DateTimeOffset? ShipDate { get; set; } /// - /// Gets or Sets LabelDownload + /// The shipment information used to generate the label /// - [JsonPropertyName("label_download")] - public LabelDownload LabelDownload { get; set; } + /// The shipment information used to generate the label + [JsonPropertyName("shipment")] + public Shipment? Shipment { 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. + /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// - /// 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. - [JsonPropertyName("form_download")] - public Link FormDownload { get; set; } + /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + [JsonPropertyName("shipment_cost")] + public MonetaryValue? ShipmentCost { get; set; } /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - public PaperlessDownload PaperlessDownload { get; set; } + /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// + /// se-28529731 + /// + [JsonPropertyName("shipment_id")] + public string? ShipmentId { get; set; } /// - /// 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. + /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. /// - /// 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. - [JsonPropertyName("insurance_claim")] - public Link InsuranceClaim { get; set; } + /// 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")] + [Obsolete] + public bool? TestLabel { get; set; } /// - /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// - /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - public List Packages { get; set; } + /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + [JsonPropertyName("trackable")] + public bool? Trackable { get; set; } /// - /// Additional information some carriers may provide by which to identify a given label in their system. + /// The tracking number for the package. Tracking number formats vary across carriers. /// - /// Additional information some carriers may provide by which to identify a given label in their system. - [JsonPropertyName("alternative_identifiers")] - public List AlternativeIdentifiers { get; set; } + /// The tracking number for the package. Tracking number formats vary across carriers. + /// + /// 782758401696 + /// + [JsonPropertyName("tracking_number")] + public string? TrackingNumber { get; set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. @@ -323,7 +306,24 @@ public partial class CreateLabelFromShipmentResponseBody /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url")] - public string TrackingUrl { get; set; } + public string? TrackingUrl { get; set; } + + /// + /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// + /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + [JsonPropertyName("voided")] + public bool? Voided { get; set; } + + /// + /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("voided_at")] + public DateTimeOffset? VoidedAt { get; set; } /// @@ -335,44 +335,44 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreateLabelFromShipmentResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" LabelId: ").Append(LabelId).Append("\n"); - sb.Append(" Status: ").Append(Status).Append("\n"); - sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); - sb.Append(" Shipment: ").Append(Shipment).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); - sb.Append(" ShipmentCost: ").Append(ShipmentCost).Append("\n"); - sb.Append(" InsuranceCost: ").Append(InsuranceCost).Append("\n"); - sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); - sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); - sb.Append(" IsReturnLabel: ").Append(IsReturnLabel).Append("\n"); - sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); - sb.Append(" IsInternational: ").Append(IsInternational).Append("\n"); + sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" BatchId: ").Append(BatchId).Append("\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); - sb.Append(" OutboundLabelId: ").Append(OutboundLabelId).Append("\n"); - sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); - sb.Append(" TestLabel: ").Append(TestLabel).Append("\n"); - sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); - sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); - sb.Append(" Voided: ").Append(Voided).Append("\n"); - sb.Append(" VoidedAt: ").Append(VoidedAt).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); + sb.Append(" InsuranceClaim: ").Append(InsuranceClaim).Append("\n"); + sb.Append(" InsuranceCost: ").Append(InsuranceCost).Append("\n"); + sb.Append(" IsInternational: ").Append(IsInternational).Append("\n"); + sb.Append(" IsReturnLabel: ").Append(IsReturnLabel).Append("\n"); + sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); - sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" LabelId: ").Append(LabelId).Append("\n"); + sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); + sb.Append(" OutboundLabelId: ").Append(OutboundLabelId).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); + sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); + sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" Shipment: ").Append(Shipment).Append("\n"); + sb.Append(" ShipmentCost: ").Append(ShipmentCost).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" Status: ").Append(Status).Append("\n"); + sb.Append(" TestLabel: ").Append(TestLabel).Append("\n"); sb.Append(" Trackable: ").Append(Trackable).Append("\n"); - sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); - sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); sb.Append(" TrackingStatus: ").Append(TrackingStatus).Append("\n"); - sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); - sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); - sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); - sb.Append(" InsuranceClaim: ").Append(InsuranceClaim).Append("\n"); - sb.Append(" Packages: ").Append(Packages).Append("\n"); - sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); + sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); + sb.Append(" Voided: ").Append(Voided).Append("\n"); + sb.Append(" VoidedAt: ").Append(VoidedAt).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreateLabelRequestBody.cs b/ShipEngineSDK/Model/CreateLabelRequestBody.cs index 368e1282..3d59d0a9 100644 --- a/ShipEngineSDK/Model/CreateLabelRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelRequestBody.cs @@ -28,11 +28,6 @@ namespace ShipEngineSDK.Model; public partial class CreateLabelRequestBody { - /// - /// Gets or Sets Status CLOVUS - /// - [JsonPropertyName("status")] - public LabelStatus? Status { get; set; } /// /// The label charge event. CLOVUS /// @@ -40,10 +35,11 @@ public partial class CreateLabelRequestBody [JsonPropertyName("charge_event")] public LabelChargeEvent? ChargeEvent { get; set; } /// - /// Gets or Sets ValidateAddress CLOVUS + /// The display format that the label should be shown in. CLOVUS /// - [JsonPropertyName("validate_address")] - public ValidateAddress? ValidateAddress { get; set; } + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme")] + public DisplayScheme? DisplayScheme { get; set; } /// /// Gets or Sets LabelDownloadType CLOVUS /// @@ -56,80 +52,71 @@ public partial class CreateLabelRequestBody [JsonPropertyName("label_format")] public LabelFormat? LabelFormat { get; set; } /// - /// The display format that the label should be shown in. CLOVUS - /// - /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] - public DisplayScheme? DisplayScheme { 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. CLOVUS /// /// 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")] public LabelLayout? LabelLayout { get; set; } /// + /// Gets or Sets Status CLOVUS + /// + [JsonPropertyName("status")] + public LabelStatus? Status { get; set; } + /// /// The current status of the package, such as `in_transit` or `delivered` CLOVUS /// /// The current status of the package, such as `in_transit` or `delivered` [JsonPropertyName("tracking_status")] public TrackingStatus? TrackingStatus { get; set; } /// - /// A unique identifier for a carrier service point where the shipment will be delivered by the carrier. This will take precedence over a shipment's ship to address. + /// Gets or Sets ValidateAddress CLOVUS /// - /// A unique identifier for a carrier service point where the shipment will be delivered by the carrier. This will take precedence over a shipment's ship to address. - /// - /// 614940 - /// - [JsonPropertyName("ship_to_service_point_id")] - public string ShipToServicePointId { get; set; } - + [JsonPropertyName("validate_address")] + public ValidateAddress? ValidateAddress { get; set; } /// - /// A unique identifier for a carrier drop off point where a merchant plans to deliver packages. This will take precedence over a shipment's ship from address. + /// The shipment information used to generate the label /// - /// A unique identifier for a carrier drop off point where a merchant plans to deliver packages. This will take precedence over a shipment's ship from address. - /// - /// 614940 - /// - [JsonPropertyName("ship_from_service_point_id")] - public string ShipFromServicePointId { get; set; } + /// The shipment information used to generate the label + [JsonPropertyName("shipment")] + [JsonRequired] + public Shipment Shipment { get; set; } /// - /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. + /// Additional information some carriers may provide by which to identify a given label in their system. /// - /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. - /// - /// se-28529731 - /// - [JsonPropertyName("label_id")] - public string LabelId { get; set; } + /// Additional information some carriers may provide by which to identify a given label in their system. + [JsonPropertyName("alternative_identifiers")] + public List? AlternativeIdentifiers { get; set; } /// - /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// - /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string ShipmentId { get; set; } + [JsonPropertyName("batch_id")] + public string? BatchId { get; set; } /// - /// The shipment information used to generate the label + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. /// - /// The shipment information used to generate the label - [JsonPropertyName("shipment")] - [JsonRequired] - public Shipment Shipment { get; set; } + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// dhl_express + /// + [JsonPropertyName("carrier_code")] + public string? CarrierCode { get; set; } /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// - /// 2018-09-23T00:00Z + /// se-28529731 /// - [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + [JsonPropertyName("carrier_id")] + public string? CarrierId { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -139,79 +126,68 @@ public partial class CreateLabelRequestBody /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + public DateTimeOffset? CreatedAt { get; set; } /// - /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + /// 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. /// - /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - [JsonPropertyName("shipment_cost")] - public MonetaryValue ShipmentCost { 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. + [JsonPropertyName("form_download")] + public Link? FormDownload { get; set; } /// - /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + /// 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. /// - /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. - [JsonPropertyName("insurance_cost")] - public MonetaryValue InsuranceCost { get; set; } + /// 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. + [JsonPropertyName("insurance_claim")] + public Link? InsuranceClaim { get; set; } /// - /// The total shipping cost for the specified comparison_rate_type. + /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// - /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue RequestedComparisonAmount { get; set; } + /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + [JsonPropertyName("insurance_cost")] + public MonetaryValue? InsuranceCost { get; set; } /// - /// The tracking number for the package. Tracking number formats vary across carriers. + /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// - /// The tracking number for the package. Tracking number formats vary across carriers. - /// - /// 782758401696 - /// - [JsonPropertyName("tracking_number")] - public string TrackingNumber { get; set; } + /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + [JsonPropertyName("is_international")] + public bool? IsInternational { get; set; } /// /// 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")] - public bool IsReturnLabel { get; set; } + public bool? IsReturnLabel { get; set; } /// - /// 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")] - public string RmaNumber { get; set; } - - /// - /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + /// Gets or Sets LabelDownload /// - /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. - [JsonPropertyName("is_international")] - public bool IsInternational { get; set; } + [JsonPropertyName("label_download")] + public LabelDownload? LabelDownload { get; set; } /// - /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// - /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - public string BatchId { get; set; } + [JsonPropertyName("label_id")] + public string? LabelId { get; set; } /// - /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// The label image resource that was used to create a custom label image. /// - /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// The label image resource that was used to create a custom label image. /// - /// se-28529731 + /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + [JsonPropertyName("label_image_id")] + public string? LabelImageId { get; set; } /// /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. @@ -221,120 +197,127 @@ public partial class CreateLabelRequestBody /// se-28529731 /// [JsonPropertyName("outbound_label_id")] - public string OutboundLabelId { get; set; } + public string? OutboundLabelId { get; set; } /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. /// - /// usps_first_class_mail + /// small_flat_rate_box /// - [JsonPropertyName("service_code")] - public string ServiceCode { get; set; } + [JsonPropertyName("package_code")] + public string? PackageCode { get; set; } /// - /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. + /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// - /// 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")] - [Obsolete] - public bool TestLabel { get; set; } + /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + [JsonPropertyName("packages")] + public List? Packages { get; set; } /// - /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// - /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. - /// - /// small_flat_rate_box - /// - [JsonPropertyName("package_code")] - public string PackageCode { get; set; } + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + [JsonPropertyName("paperless_download")] + public PaperlessDownload? PaperlessDownload { get; set; } /// - /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// The total shipping cost for the specified comparison_rate_type. /// - /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) - [JsonPropertyName("voided")] - public bool Voided { get; set; } + /// The total shipping cost for the specified comparison_rate_type. + [JsonPropertyName("requested_comparison_amount")] + public MonetaryValue? RequestedComparisonAmount { get; set; } /// - /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. /// - /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("voided_at")] - public DateTimeOffset VoidedAt { get; set; } + /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. + [JsonPropertyName("rma_number")] + public string? RmaNumber { get; set; } /// - /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// - /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. - [JsonPropertyName("trackable")] - public bool Trackable { get; set; } + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// usps_first_class_mail + /// + [JsonPropertyName("service_code")] + public string? ServiceCode { get; set; } /// - /// The label image resource that was used to create a custom label image. + /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The label image resource that was used to create a custom label image. + /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// img_DtBXupDBxREpHnwEXhTfgK + /// 2018-09-23T00:00Z /// - [JsonPropertyName("label_image_id")] - public string LabelImageId { get; set; } + [JsonPropertyName("ship_date")] + public DateTimeOffset? ShipDate { get; set; } /// - /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// A unique identifier for a carrier drop off point where a merchant plans to deliver packages. This will take precedence over a shipment's ship from address. /// - /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// A unique identifier for a carrier drop off point where a merchant plans to deliver packages. This will take precedence over a shipment's ship from address. /// - /// dhl_express + /// 614940 /// - [JsonPropertyName("carrier_code")] - public string CarrierCode { get; set; } + [JsonPropertyName("ship_from_service_point_id")] + public string? ShipFromServicePointId { get; set; } /// - /// Gets or Sets LabelDownload + /// A unique identifier for a carrier service point where the shipment will be delivered by the carrier. This will take precedence over a shipment's ship to address. /// - [JsonPropertyName("label_download")] - public LabelDownload LabelDownload { get; set; } + /// A unique identifier for a carrier service point where the shipment will be delivered by the carrier. This will take precedence over a shipment's ship to address. + /// + /// 614940 + /// + [JsonPropertyName("ship_to_service_point_id")] + public string? ShipToServicePointId { 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. + /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// - /// 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. - [JsonPropertyName("form_download")] - public Link FormDownload { get; set; } + /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + [JsonPropertyName("shipment_cost")] + public MonetaryValue? ShipmentCost { get; set; } /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - public PaperlessDownload PaperlessDownload { get; set; } + /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// + /// se-28529731 + /// + [JsonPropertyName("shipment_id")] + public string? ShipmentId { get; set; } /// - /// 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. + /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. /// - /// 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. - [JsonPropertyName("insurance_claim")] - public Link InsuranceClaim { get; set; } + /// 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")] + [Obsolete] + public bool? TestLabel { get; set; } /// - /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// - /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - public List Packages { get; set; } + /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + [JsonPropertyName("trackable")] + public bool? Trackable { get; set; } /// - /// Additional information some carriers may provide by which to identify a given label in their system. + /// The tracking number for the package. Tracking number formats vary across carriers. /// - /// Additional information some carriers may provide by which to identify a given label in their system. - [JsonPropertyName("alternative_identifiers")] - public List AlternativeIdentifiers { get; set; } + /// The tracking number for the package. Tracking number formats vary across carriers. + /// + /// 782758401696 + /// + [JsonPropertyName("tracking_number")] + public string? TrackingNumber { get; set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. @@ -344,7 +327,24 @@ public partial class CreateLabelRequestBody /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url")] - public string TrackingUrl { get; set; } + public string? TrackingUrl { get; set; } + + /// + /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// + /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + [JsonPropertyName("voided")] + public bool? Voided { get; set; } + + /// + /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("voided_at")] + public DateTimeOffset? VoidedAt { get; set; } /// @@ -356,46 +356,46 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreateLabelRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ShipToServicePointId: ").Append(ShipToServicePointId).Append("\n"); - sb.Append(" ShipFromServicePointId: ").Append(ShipFromServicePointId).Append("\n"); - sb.Append(" LabelId: ").Append(LabelId).Append("\n"); - sb.Append(" Status: ").Append(Status).Append("\n"); - sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); sb.Append(" Shipment: ").Append(Shipment).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); - sb.Append(" ShipmentCost: ").Append(ShipmentCost).Append("\n"); - sb.Append(" InsuranceCost: ").Append(InsuranceCost).Append("\n"); - sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); - sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); - sb.Append(" IsReturnLabel: ").Append(IsReturnLabel).Append("\n"); - sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); - sb.Append(" IsInternational: ").Append(IsInternational).Append("\n"); + sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" BatchId: ").Append(BatchId).Append("\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); - sb.Append(" OutboundLabelId: ").Append(OutboundLabelId).Append("\n"); - sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); - sb.Append(" TestLabel: ").Append(TestLabel).Append("\n"); - sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); - sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); - sb.Append(" Voided: ").Append(Voided).Append("\n"); - sb.Append(" VoidedAt: ").Append(VoidedAt).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); + sb.Append(" InsuranceClaim: ").Append(InsuranceClaim).Append("\n"); + sb.Append(" InsuranceCost: ").Append(InsuranceCost).Append("\n"); + sb.Append(" IsInternational: ").Append(IsInternational).Append("\n"); + sb.Append(" IsReturnLabel: ").Append(IsReturnLabel).Append("\n"); + sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); - sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" LabelId: ").Append(LabelId).Append("\n"); + sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); + sb.Append(" OutboundLabelId: ").Append(OutboundLabelId).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); + sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); + sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" ShipFromServicePointId: ").Append(ShipFromServicePointId).Append("\n"); + sb.Append(" ShipToServicePointId: ").Append(ShipToServicePointId).Append("\n"); + sb.Append(" ShipmentCost: ").Append(ShipmentCost).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" Status: ").Append(Status).Append("\n"); + sb.Append(" TestLabel: ").Append(TestLabel).Append("\n"); sb.Append(" Trackable: ").Append(Trackable).Append("\n"); - sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); - sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); sb.Append(" TrackingStatus: ").Append(TrackingStatus).Append("\n"); - sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); - sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); - sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); - sb.Append(" InsuranceClaim: ").Append(InsuranceClaim).Append("\n"); - sb.Append(" Packages: ").Append(Packages).Append("\n"); - sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); + sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); + sb.Append(" Voided: ").Append(Voided).Append("\n"); + sb.Append(" VoidedAt: ").Append(VoidedAt).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreateLabelResponseBody.cs b/ShipEngineSDK/Model/CreateLabelResponseBody.cs index 449556b1..a1578f37 100644 --- a/ShipEngineSDK/Model/CreateLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelResponseBody.cs @@ -28,14 +28,6 @@ namespace ShipEngineSDK.Model; public partial class CreateLabelResponseBody { - /// - /// Gets or Sets Status CLOVUS - /// - [JsonPropertyName("status")] - [JsonRequired] - public LabelStatus Status { get; set; } = new(); - - /// /// The label charge event. CLOVUS /// @@ -46,15 +38,14 @@ public partial class CreateLabelResponseBody /// - /// Gets or Sets ValidateAddress CLOVUS - /// - [JsonPropertyName("validate_address")] - public ValidateAddress? ValidateAddress { get; set; } - /// - /// Gets or Sets LabelDownloadType CLOVUS + /// The display format that the label should be shown in. CLOVUS /// - [JsonPropertyName("label_download_type")] - public LabelDownloadType? LabelDownloadType { get; set; } + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme")] + [JsonRequired] + public DisplayScheme DisplayScheme { get; set; } = new(); + + /// /// 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. CLOVUS /// @@ -65,21 +56,20 @@ public partial class CreateLabelResponseBody /// - /// The display format that the label should be shown in. CLOVUS + /// 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. CLOVUS /// - /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] + /// 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")] [JsonRequired] - public DisplayScheme DisplayScheme { get; set; } = new(); + public LabelLayout LabelLayout { get; set; } = new(); /// - /// 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. CLOVUS + /// Gets or Sets Status CLOVUS /// - /// 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")] + [JsonPropertyName("status")] [JsonRequired] - public LabelLayout LabelLayout { get; set; } = new(); + public LabelStatus Status { get; set; } = new(); /// @@ -92,44 +82,47 @@ public partial class CreateLabelResponseBody /// - /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. + /// Gets or Sets LabelDownloadType CLOVUS /// - /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. + [JsonPropertyName("label_download_type")] + public LabelDownloadType? LabelDownloadType { get; set; } + /// + /// Gets or Sets ValidateAddress CLOVUS + /// + [JsonPropertyName("validate_address")] + public ValidateAddress? ValidateAddress { get; set; } + /// + /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// + /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// /// se-28529731 /// - [JsonPropertyName("label_id")] + [JsonPropertyName("batch_id")] [JsonRequired] - public string LabelId { get; set; } + public string BatchId { get; set; } /// - /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. /// - /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. /// - /// se-28529731 + /// dhl_express /// - [JsonPropertyName("shipment_id")] + [JsonPropertyName("carrier_code")] [JsonRequired] - public string ShipmentId { get; set; } - - /// - /// The shipment information used to generate the label - /// - /// The shipment information used to generate the label - [JsonPropertyName("shipment")] - public Shipment Shipment { get; set; } + public string CarrierCode { get; set; } /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// - /// 2018-09-23T00:00Z + /// se-28529731 /// - [JsonPropertyName("ship_date")] + [JsonPropertyName("carrier_id")] [JsonRequired] - public DateTimeOffset ShipDate { get; set; } + public string CarrierId { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -142,14 +135,6 @@ public partial class CreateLabelResponseBody [JsonRequired] public DateTimeOffset CreatedAt { get; set; } - /// - /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - /// - /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - [JsonPropertyName("shipment_cost")] - [JsonRequired] - public MonetaryValue ShipmentCost { get; set; } - /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// @@ -159,22 +144,12 @@ public partial class CreateLabelResponseBody public MonetaryValue InsuranceCost { get; set; } /// - /// The total shipping cost for the specified comparison_rate_type. - /// - /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue RequestedComparisonAmount { get; set; } - - /// - /// The tracking number for the package. Tracking number formats vary across carriers. + /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// - /// The tracking number for the package. Tracking number formats vary across carriers. - /// - /// 782758401696 - /// - [JsonPropertyName("tracking_number")] + /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + [JsonPropertyName("is_international")] [JsonRequired] - public string TrackingNumber { get; set; } + public bool IsInternational { get; set; } /// /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. @@ -185,52 +160,41 @@ public partial class CreateLabelResponseBody public bool IsReturnLabel { get; set; } /// - /// 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")] - [JsonRequired] - public string RmaNumber { get; set; } - - /// - /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + /// Gets or Sets LabelDownload /// - /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. - [JsonPropertyName("is_international")] + [JsonPropertyName("label_download")] [JsonRequired] - public bool IsInternational { get; set; } + public LabelDownload LabelDownload { get; set; } /// - /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// - /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// /// se-28529731 /// - [JsonPropertyName("batch_id")] + [JsonPropertyName("label_id")] [JsonRequired] - public string BatchId { get; set; } + public string LabelId { get; set; } /// - /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. /// - /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. /// - /// se-28529731 + /// small_flat_rate_box /// - [JsonPropertyName("carrier_id")] + [JsonPropertyName("package_code")] [JsonRequired] - public string CarrierId { get; set; } + public string PackageCode { get; set; } /// - /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. + /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// - /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. - /// - /// se-28529731 - /// - [JsonPropertyName("outbound_label_id")] - public string OutboundLabelId { get; set; } + /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + [JsonPropertyName("packages")] + [JsonRequired] + public List Packages { get; set; } /// /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. @@ -244,42 +208,34 @@ public partial class CreateLabelResponseBody public string ServiceCode { 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")] - [Obsolete] - public bool TestLabel { get; set; } - - /// - /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// small_flat_rate_box + /// 2018-09-23T00:00Z /// - [JsonPropertyName("package_code")] + [JsonPropertyName("ship_date")] [JsonRequired] - public string PackageCode { get; set; } + public DateTimeOffset ShipDate { get; set; } /// - /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// - /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) - [JsonPropertyName("voided")] + /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + [JsonPropertyName("shipment_cost")] [JsonRequired] - public bool Voided { get; set; } + public MonetaryValue ShipmentCost { get; set; } /// - /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) /// - /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) /// - /// 2018-09-23T15:00Z + /// se-28529731 /// - [JsonPropertyName("voided_at")] + [JsonPropertyName("shipment_id")] [JsonRequired] - public DateTimeOffset VoidedAt { get; set; } + public string ShipmentId { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. @@ -290,33 +246,30 @@ public partial class CreateLabelResponseBody public bool Trackable { get; set; } /// - /// The label image resource that was used to create a custom label image. + /// The tracking number for the package. Tracking number formats vary across carriers. /// - /// The label image resource that was used to create a custom label image. + /// The tracking number for the package. Tracking number formats vary across carriers. /// - /// img_DtBXupDBxREpHnwEXhTfgK + /// 782758401696 /// - [JsonPropertyName("label_image_id")] + [JsonPropertyName("tracking_number")] [JsonRequired] - public string LabelImageId { get; set; } + public string TrackingNumber { get; set; } /// - /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// - /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. - /// - /// dhl_express - /// - [JsonPropertyName("carrier_code")] + /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + [JsonPropertyName("voided")] [JsonRequired] - public string CarrierCode { get; set; } + public bool Voided { get; set; } /// - /// Gets or Sets LabelDownload + /// Additional information some carriers may provide by which to identify a given label in their system. /// - [JsonPropertyName("label_download")] - [JsonRequired] - public LabelDownload LabelDownload { get; set; } + /// Additional information some carriers may provide by which to identify a given label in their system. + [JsonPropertyName("alternative_identifiers")] + public List? AlternativeIdentifiers { 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. @@ -326,6 +279,35 @@ public partial class CreateLabelResponseBody [JsonRequired] public Link FormDownload { get; set; } + /// + /// 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. + /// + /// 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. + [JsonPropertyName("insurance_claim")] + [JsonRequired] + public Link InsuranceClaim { get; set; } + + /// + /// The label image resource that was used to create a custom label image. + /// + /// The label image resource that was used to create a custom label image. + /// + /// img_DtBXupDBxREpHnwEXhTfgK + /// + [JsonPropertyName("label_image_id")] + [JsonRequired] + public string LabelImageId { get; set; } + + /// + /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. + /// + /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. + /// + /// se-28529731 + /// + [JsonPropertyName("outbound_label_id")] + public string? OutboundLabelId { get; set; } + /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// @@ -335,27 +317,34 @@ public partial class CreateLabelResponseBody public PaperlessDownload PaperlessDownload { get; set; } /// - /// 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. + /// The total shipping cost for the specified comparison_rate_type. /// - /// 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. - [JsonPropertyName("insurance_claim")] - [JsonRequired] - public Link InsuranceClaim { get; set; } + /// The total shipping cost for the specified comparison_rate_type. + [JsonPropertyName("requested_comparison_amount")] + public MonetaryValue? RequestedComparisonAmount { get; set; } /// - /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. /// - /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] + /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. + [JsonPropertyName("rma_number")] [JsonRequired] - public List Packages { get; set; } + public string RmaNumber { get; set; } /// - /// Additional information some carriers may provide by which to identify a given label in their system. + /// The shipment information used to generate the label /// - /// Additional information some carriers may provide by which to identify a given label in their system. - [JsonPropertyName("alternative_identifiers")] - public List AlternativeIdentifiers { get; set; } + /// The shipment information used to generate the label + [JsonPropertyName("shipment")] + 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")] + [Obsolete] + public bool? TestLabel { get; set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. @@ -365,7 +354,18 @@ public partial class CreateLabelResponseBody /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url")] - public string TrackingUrl { get; set; } + public string? TrackingUrl { get; set; } + + /// + /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("voided_at")] + [JsonRequired] + public DateTimeOffset VoidedAt { get; set; } /// @@ -377,44 +377,44 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreateLabelResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" LabelId: ").Append(LabelId).Append("\n"); - sb.Append(" Status: ").Append(Status).Append("\n"); - sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); - sb.Append(" Shipment: ").Append(Shipment).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); - sb.Append(" ShipmentCost: ").Append(ShipmentCost).Append("\n"); - sb.Append(" InsuranceCost: ").Append(InsuranceCost).Append("\n"); - sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); - sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); - sb.Append(" IsReturnLabel: ").Append(IsReturnLabel).Append("\n"); - sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); - sb.Append(" IsInternational: ").Append(IsInternational).Append("\n"); sb.Append(" BatchId: ").Append(BatchId).Append("\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); - sb.Append(" OutboundLabelId: ").Append(OutboundLabelId).Append("\n"); - sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); - sb.Append(" TestLabel: ").Append(TestLabel).Append("\n"); - sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); - sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); - sb.Append(" Voided: ").Append(Voided).Append("\n"); - sb.Append(" VoidedAt: ").Append(VoidedAt).Append("\n"); - sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); - sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" InsuranceCost: ").Append(InsuranceCost).Append("\n"); + sb.Append(" IsInternational: ").Append(IsInternational).Append("\n"); + sb.Append(" IsReturnLabel: ").Append(IsReturnLabel).Append("\n"); + sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); + sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" LabelId: ").Append(LabelId).Append("\n"); sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" ShipmentCost: ").Append(ShipmentCost).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" Status: ").Append(Status).Append("\n"); sb.Append(" Trackable: ").Append(Trackable).Append("\n"); - sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); - sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); sb.Append(" TrackingStatus: ").Append(TrackingStatus).Append("\n"); - sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); + sb.Append(" Voided: ").Append(Voided).Append("\n"); + sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); - sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); sb.Append(" InsuranceClaim: ").Append(InsuranceClaim).Append("\n"); - sb.Append(" Packages: ").Append(Packages).Append("\n"); - sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); + sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); + sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); + sb.Append(" OutboundLabelId: ").Append(OutboundLabelId).Append("\n"); + sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); + sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); + sb.Append(" Shipment: ").Append(Shipment).Append("\n"); + sb.Append(" TestLabel: ").Append(TestLabel).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); + sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); + sb.Append(" VoidedAt: ").Append(VoidedAt).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs b/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs index b74b6734..98c44874 100644 --- a/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs +++ b/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs @@ -40,18 +40,15 @@ public partial class CreateManifestByObjectRequestBody public string CarrierId { get; set; } /// - /// The list of label ids to exclude from the manifest - /// - /// The list of label ids to exclude from the manifest - [JsonPropertyName("excluded_label_ids")] - public List ExcludedLabelIds { get; set; } - - /// - /// The list of label ids to include for the manifest + /// The ship date that the shipment will be sent out on /// - /// The list of label ids to include for the manifest - [JsonPropertyName("label_ids")] - public List LabelIds { get; set; } + /// The ship date that the shipment will be sent out on + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("ship_date")] + [JsonRequired] + public DateTimeOffset ShipDate { get; set; } /// /// A string that uniquely identifies the warehouse @@ -65,15 +62,18 @@ public partial class CreateManifestByObjectRequestBody public string WarehouseId { get; set; } /// - /// The ship date that the shipment will be sent out on + /// The list of label ids to exclude from the manifest /// - /// The ship date that the shipment will be sent out on - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("ship_date")] - [JsonRequired] - public DateTimeOffset ShipDate { get; set; } + /// The list of label ids to exclude from the manifest + [JsonPropertyName("excluded_label_ids")] + public List? ExcludedLabelIds { get; set; } + + /// + /// The list of label ids to include for the manifest + /// + /// The list of label ids to include for the manifest + [JsonPropertyName("label_ids")] + public List? LabelIds { get; set; } /// @@ -86,10 +86,10 @@ public override string ToString() sb.Append("class CreateManifestByObjectRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); sb.Append(" ExcludedLabelIds: ").Append(ExcludedLabelIds).Append("\n"); sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreateManifestResponseBody.cs b/ShipEngineSDK/Model/CreateManifestResponseBody.cs index a8142e30..115ef417 100644 --- a/ShipEngineSDK/Model/CreateManifestResponseBody.cs +++ b/ShipEngineSDK/Model/CreateManifestResponseBody.cs @@ -29,30 +29,36 @@ public partial class CreateManifestResponseBody { /// - /// Resulting Manifests - /// - /// Resulting Manifests - [JsonPropertyName("manifests")] - public List Manifests { get; set; } - - /// - /// Resulting manifest requests with statuses + /// A string that uniquely identifies the carrier /// - /// Resulting manifest requests with statuses - [JsonPropertyName("manifest_requests")] - public List ManifestRequests { get; set; } + /// A string that uniquely identifies the carrier + /// + /// se-28529731 + /// + [JsonPropertyName("carrier_id")] + [JsonRequired] + [Obsolete] + public string CarrierId { get; set; } /// - /// A string that uniquely identifies the manifest + /// The date-time that the manifest was created /// - /// A string that uniquely identifies the manifest + /// The date-time that the manifest was created /// - /// se-28529731 + /// 2019-07-12T13:37:39.050Z /// - [JsonPropertyName("manifest_id")] + [JsonPropertyName("created_at")] [JsonRequired] [Obsolete] - public string ManifestId { get; set; } + public DateTimeOffset CreatedAt { get; set; } + + /// + /// The errors associated with the failed API call + /// + /// The errors associated with the failed API call + [JsonPropertyName("errors")] + [JsonRequired] + public List Errors { get; set; } /// /// A string that uniquely identifies the form @@ -67,16 +73,35 @@ public partial class CreateManifestResponseBody public string FormId { get; set; } /// - /// The date-time that the manifest was created + /// Gets or Sets ManifestDownload /// - /// The date-time that the manifest was created + [JsonPropertyName("manifest_download")] + [JsonRequired] + [Obsolete] + public ManifestDownload ManifestDownload { get; set; } + + /// + /// A string that uniquely identifies the manifest + /// + /// A string that uniquely identifies the manifest /// - /// 2019-07-12T13:37:39.050Z + /// se-28529731 /// - [JsonPropertyName("created_at")] + [JsonPropertyName("manifest_id")] [JsonRequired] [Obsolete] - public DateTimeOffset CreatedAt { get; set; } + public string ManifestId { get; set; } + + /// + /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur + /// + /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur + /// + /// aa3d8e8e-462b-4476-9618-72db7f7b7009 + /// + [JsonPropertyName("request_id")] + [JsonRequired] + public Guid RequestId { get; set; } /// /// The date-time that the manifests shipments will be picked up @@ -102,18 +127,6 @@ public partial class CreateManifestResponseBody [Obsolete] public int Shipments { get; set; } - /// - /// A string that uniquely identifies the warehouse - /// - /// A string that uniquely identifies the warehouse - /// - /// se-28529731 - /// - [JsonPropertyName("warehouse_id")] - [JsonRequired] - [Obsolete] - public string WarehouseId { get; set; } - /// /// A string that uniquely identifies the submission /// @@ -127,24 +140,16 @@ public partial class CreateManifestResponseBody public string SubmissionId { get; set; } /// - /// A string that uniquely identifies the carrier + /// A string that uniquely identifies the warehouse /// - /// A string that uniquely identifies the carrier + /// A string that uniquely identifies the warehouse /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [JsonRequired] - [Obsolete] - public string CarrierId { get; set; } - - /// - /// Gets or Sets ManifestDownload - /// - [JsonPropertyName("manifest_download")] + [JsonPropertyName("warehouse_id")] [JsonRequired] [Obsolete] - public ManifestDownload ManifestDownload { get; set; } + public string WarehouseId { get; set; } /// /// An array of the label ids used in this manifest. @@ -152,26 +157,21 @@ public partial class CreateManifestResponseBody /// An array of the label ids used in this manifest. [JsonPropertyName("label_ids")] [Obsolete] - public List LabelIds { get; set; } + public List? LabelIds { get; set; } /// - /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur + /// Resulting manifest requests with statuses /// - /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur - /// - /// aa3d8e8e-462b-4476-9618-72db7f7b7009 - /// - [JsonPropertyName("request_id")] - [JsonRequired] - public Guid RequestId { get; set; } + /// Resulting manifest requests with statuses + [JsonPropertyName("manifest_requests")] + public List? ManifestRequests { get; set; } /// - /// The errors associated with the failed API call + /// Resulting Manifests /// - /// The errors associated with the failed API call - [JsonPropertyName("errors")] - [JsonRequired] - public List Errors { get; set; } + /// Resulting Manifests + [JsonPropertyName("manifests")] + public List? Manifests { get; set; } /// @@ -183,20 +183,20 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreateManifestResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Manifests: ").Append(Manifests).Append("\n"); - sb.Append(" ManifestRequests: ").Append(ManifestRequests).Append("\n"); - sb.Append(" ManifestId: ").Append(ManifestId).Append("\n"); - sb.Append(" FormId: ").Append(FormId).Append("\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); + sb.Append(" FormId: ").Append(FormId).Append("\n"); + sb.Append(" ManifestDownload: ").Append(ManifestDownload).Append("\n"); + sb.Append(" ManifestId: ").Append(ManifestId).Append("\n"); + sb.Append(" RequestId: ").Append(RequestId).Append("\n"); sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); sb.Append(" Shipments: ").Append(Shipments).Append("\n"); - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); sb.Append(" SubmissionId: ").Append(SubmissionId).Append("\n"); - sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); - sb.Append(" ManifestDownload: ").Append(ManifestDownload).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); - sb.Append(" RequestId: ").Append(RequestId).Append("\n"); - sb.Append(" Errors: ").Append(Errors).Append("\n"); + sb.Append(" ManifestRequests: ").Append(ManifestRequests).Append("\n"); + sb.Append(" Manifests: ").Append(Manifests).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs b/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs index 4cc0340e..2ad3ed4f 100644 --- a/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs +++ b/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs @@ -29,14 +29,14 @@ public partial class CreatePackageTypeRequestBody { /// - /// A string that uniquely identifies the package. + /// Gets or Sets Name /// - /// A string that uniquely identifies the package. /// - /// se-28529731 + /// laptop_box /// - [JsonPropertyName("package_id")] - public string PackageId { get; set; } + [JsonPropertyName("name")] + [JsonRequired] + public string Name { get; set; } /// /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. @@ -50,31 +50,31 @@ public partial class CreatePackageTypeRequestBody public string PackageCode { get; set; } /// - /// Gets or Sets Name + /// Provides a helpful description for the custom package. /// + /// Provides a helpful description for the custom package. /// - /// laptop_box + /// Packaging for laptops /// - [JsonPropertyName("name")] - [JsonRequired] - public string Name { get; set; } + [JsonPropertyName("description")] + public string? Description { get; set; } /// /// The custom dimensions for the package. /// /// The custom dimensions for the package. [JsonPropertyName("dimensions")] - public Dimensions Dimensions { get; set; } + public Dimensions? Dimensions { get; set; } /// - /// Provides a helpful description for the custom package. + /// A string that uniquely identifies the package. /// - /// Provides a helpful description for the custom package. + /// A string that uniquely identifies the package. /// - /// Packaging for laptops + /// se-28529731 /// - [JsonPropertyName("description")] - public string Description { get; set; } + [JsonPropertyName("package_id")] + public string? PackageId { get; set; } /// @@ -86,11 +86,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreatePackageTypeRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" PackageId: ").Append(PackageId).Append("\n"); - sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Description: ").Append(Description).Append("\n"); + sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); + sb.Append(" PackageId: ").Append(PackageId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs b/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs index a1953b4a..307fac4e 100644 --- a/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs +++ b/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs @@ -29,14 +29,14 @@ public partial class CreatePackageTypeResponseBody { /// - /// A string that uniquely identifies the package. + /// Gets or Sets Name /// - /// A string that uniquely identifies the package. /// - /// se-28529731 + /// laptop_box /// - [JsonPropertyName("package_id")] - public string PackageId { get; set; } + [JsonPropertyName("name")] + [JsonRequired] + public string Name { get; set; } /// /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. @@ -50,31 +50,31 @@ public partial class CreatePackageTypeResponseBody public string PackageCode { get; set; } /// - /// Gets or Sets Name + /// Provides a helpful description for the custom package. /// + /// Provides a helpful description for the custom package. /// - /// laptop_box + /// Packaging for laptops /// - [JsonPropertyName("name")] - [JsonRequired] - public string Name { get; set; } + [JsonPropertyName("description")] + public string? Description { get; set; } /// /// The custom dimensions for the package. /// /// The custom dimensions for the package. [JsonPropertyName("dimensions")] - public Dimensions Dimensions { get; set; } + public Dimensions? Dimensions { get; set; } /// - /// Provides a helpful description for the custom package. + /// A string that uniquely identifies the package. /// - /// Provides a helpful description for the custom package. + /// A string that uniquely identifies the package. /// - /// Packaging for laptops + /// se-28529731 /// - [JsonPropertyName("description")] - public string Description { get; set; } + [JsonPropertyName("package_id")] + public string? PackageId { get; set; } /// @@ -86,11 +86,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreatePackageTypeResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" PackageId: ").Append(PackageId).Append("\n"); - sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Description: ").Append(Description).Append("\n"); + sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); + sb.Append(" PackageId: ").Append(PackageId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs b/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs index 031539b6..21436975 100644 --- a/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs +++ b/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs @@ -35,11 +35,16 @@ public partial class CreateReturnLabelRequestBody [JsonPropertyName("charge_event")] public LabelChargeEvent? ChargeEvent { 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. CLOVUS + /// The display format that the label should be shown in. CLOVUS /// - /// 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")] - public LabelLayout? LabelLayout { get; set; } + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme")] + public DisplayScheme? DisplayScheme { get; set; } + /// + /// Gets or Sets LabelDownloadType CLOVUS + /// + [JsonPropertyName("label_download_type")] + 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. CLOVUS /// @@ -47,16 +52,11 @@ public partial class CreateReturnLabelRequestBody [JsonPropertyName("label_format")] public LabelFormat? LabelFormat { get; set; } /// - /// Gets or Sets LabelDownloadType CLOVUS - /// - [JsonPropertyName("label_download_type")] - public LabelDownloadType? LabelDownloadType { get; set; } - /// - /// The display format that the label should be shown in. CLOVUS + /// 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. CLOVUS /// - /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] - public DisplayScheme? DisplayScheme { 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. + [JsonPropertyName("label_layout")] + public LabelLayout? LabelLayout { get; set; } /// /// The label image resource that was used to create a custom label image. /// @@ -65,7 +65,7 @@ public partial class CreateReturnLabelRequestBody /// img_DtBXupDBxREpHnwEXhTfgK /// [JsonPropertyName("label_image_id")] - public string LabelImageId { get; set; } + public string? LabelImageId { get; set; } /// @@ -78,11 +78,11 @@ public override string ToString() sb.Append("class CreateReturnLabelRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); - sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); - sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); - sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); + sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); + sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs index acc0703e..84bfb2c1 100644 --- a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs @@ -28,11 +28,6 @@ namespace ShipEngineSDK.Model; public partial class CreateReturnLabelResponseBody { - /// - /// Gets or Sets Status CLOVUS - /// - [JsonPropertyName("status")] - public LabelStatus? Status { get; set; } /// /// The label charge event. CLOVUS /// @@ -40,10 +35,11 @@ public partial class CreateReturnLabelResponseBody [JsonPropertyName("charge_event")] public LabelChargeEvent? ChargeEvent { get; set; } /// - /// Gets or Sets ValidateAddress CLOVUS + /// The display format that the label should be shown in. CLOVUS /// - [JsonPropertyName("validate_address")] - public ValidateAddress? ValidateAddress { get; set; } + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme")] + public DisplayScheme? DisplayScheme { get; set; } /// /// Gets or Sets LabelDownloadType CLOVUS /// @@ -56,59 +52,63 @@ public partial class CreateReturnLabelResponseBody [JsonPropertyName("label_format")] public LabelFormat? LabelFormat { get; set; } /// - /// The display format that the label should be shown in. CLOVUS - /// - /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] - public DisplayScheme? DisplayScheme { 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. CLOVUS /// /// 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")] public LabelLayout? LabelLayout { get; set; } /// + /// Gets or Sets Status CLOVUS + /// + [JsonPropertyName("status")] + public LabelStatus? Status { get; set; } + /// /// The current status of the package, such as `in_transit` or `delivered` CLOVUS /// /// The current status of the package, such as `in_transit` or `delivered` [JsonPropertyName("tracking_status")] public TrackingStatus? TrackingStatus { get; set; } /// - /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. + /// Gets or Sets ValidateAddress CLOVUS /// - /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. - /// - /// se-28529731 - /// - [JsonPropertyName("label_id")] - public string LabelId { get; set; } + [JsonPropertyName("validate_address")] + public ValidateAddress? ValidateAddress { get; set; } + /// + /// Additional information some carriers may provide by which to identify a given label in their system. + /// + /// Additional information some carriers may provide by which to identify a given label in their system. + [JsonPropertyName("alternative_identifiers")] + public List? AlternativeIdentifiers { get; set; } /// - /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// - /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string ShipmentId { get; set; } + [JsonPropertyName("batch_id")] + public string? BatchId { get; set; } /// - /// The shipment information used to generate the label + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. /// - /// The shipment information used to generate the label - [JsonPropertyName("shipment")] - public Shipment Shipment { get; set; } + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// dhl_express + /// + [JsonPropertyName("carrier_code")] + public string? CarrierCode { get; set; } /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// - /// 2018-09-23T00:00Z + /// se-28529731 /// - [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + [JsonPropertyName("carrier_id")] + public string? CarrierId { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -118,79 +118,68 @@ public partial class CreateReturnLabelResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + public DateTimeOffset? CreatedAt { get; set; } /// - /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + /// 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. /// - /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - [JsonPropertyName("shipment_cost")] - public MonetaryValue ShipmentCost { 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. + [JsonPropertyName("form_download")] + public Link? FormDownload { get; set; } /// - /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + /// 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. /// - /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. - [JsonPropertyName("insurance_cost")] - public MonetaryValue InsuranceCost { get; set; } + /// 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. + [JsonPropertyName("insurance_claim")] + public Link? InsuranceClaim { get; set; } /// - /// The total shipping cost for the specified comparison_rate_type. + /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// - /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue RequestedComparisonAmount { get; set; } + /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + [JsonPropertyName("insurance_cost")] + public MonetaryValue? InsuranceCost { get; set; } /// - /// The tracking number for the package. Tracking number formats vary across carriers. + /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// - /// The tracking number for the package. Tracking number formats vary across carriers. - /// - /// 782758401696 - /// - [JsonPropertyName("tracking_number")] - public string TrackingNumber { get; set; } + /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + [JsonPropertyName("is_international")] + public bool? IsInternational { get; set; } /// /// 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")] - public bool IsReturnLabel { get; set; } - - /// - /// 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")] - public string RmaNumber { get; set; } + public bool? IsReturnLabel { get; set; } /// - /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + /// Gets or Sets LabelDownload /// - /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. - [JsonPropertyName("is_international")] - public bool IsInternational { get; set; } + [JsonPropertyName("label_download")] + public LabelDownload? LabelDownload { get; set; } /// - /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// - /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - public string BatchId { get; set; } + [JsonPropertyName("label_id")] + public string? LabelId { get; set; } /// - /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// The label image resource that was used to create a custom label image. /// - /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// The label image resource that was used to create a custom label image. /// - /// se-28529731 + /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + [JsonPropertyName("label_image_id")] + public string? LabelImageId { get; set; } /// /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. @@ -200,25 +189,7 @@ public partial class CreateReturnLabelResponseBody /// se-28529731 /// [JsonPropertyName("outbound_label_id")] - public string OutboundLabelId { get; set; } - - /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. - /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. - /// - /// usps_first_class_mail - /// - [JsonPropertyName("service_code")] - public string ServiceCode { 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")] - [Obsolete] - public bool TestLabel { get; set; } + public string? OutboundLabelId { get; set; } /// /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. @@ -228,92 +199,104 @@ public partial class CreateReturnLabelResponseBody /// small_flat_rate_box /// [JsonPropertyName("package_code")] - public string PackageCode { get; set; } + public string? PackageCode { get; set; } /// - /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// - /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) - [JsonPropertyName("voided")] - public bool Voided { get; set; } + /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + [JsonPropertyName("packages")] + public List? Packages { get; set; } /// - /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// - /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("voided_at")] - public DateTimeOffset VoidedAt { get; set; } + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + [JsonPropertyName("paperless_download")] + public PaperlessDownload? PaperlessDownload { get; set; } /// - /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + /// The total shipping cost for the specified comparison_rate_type. /// - /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. - [JsonPropertyName("trackable")] - public bool Trackable { get; set; } + /// The total shipping cost for the specified comparison_rate_type. + [JsonPropertyName("requested_comparison_amount")] + public MonetaryValue? RequestedComparisonAmount { get; set; } /// - /// The label image resource that was used to create a custom label image. + /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. /// - /// The label image resource that was used to create a custom label image. + /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. + [JsonPropertyName("rma_number")] + public string? RmaNumber { get; set; } + + /// + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// - /// img_DtBXupDBxREpHnwEXhTfgK + /// usps_first_class_mail /// - [JsonPropertyName("label_image_id")] - public string LabelImageId { get; set; } + [JsonPropertyName("service_code")] + public string? ServiceCode { get; set; } /// - /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// dhl_express + /// 2018-09-23T00:00Z /// - [JsonPropertyName("carrier_code")] - public string CarrierCode { get; set; } + [JsonPropertyName("ship_date")] + public DateTimeOffset? ShipDate { get; set; } /// - /// Gets or Sets LabelDownload + /// The shipment information used to generate the label /// - [JsonPropertyName("label_download")] - public LabelDownload LabelDownload { get; set; } + /// The shipment information used to generate the label + [JsonPropertyName("shipment")] + public Shipment? Shipment { 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. + /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// - /// 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. - [JsonPropertyName("form_download")] - public Link FormDownload { get; set; } + /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + [JsonPropertyName("shipment_cost")] + public MonetaryValue? ShipmentCost { get; set; } /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - public PaperlessDownload PaperlessDownload { get; set; } + /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// + /// se-28529731 + /// + [JsonPropertyName("shipment_id")] + public string? ShipmentId { get; set; } /// - /// 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. + /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. /// - /// 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. - [JsonPropertyName("insurance_claim")] - public Link InsuranceClaim { get; set; } + /// 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")] + [Obsolete] + public bool? TestLabel { get; set; } /// - /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// - /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - public List Packages { get; set; } + /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + [JsonPropertyName("trackable")] + public bool? Trackable { get; set; } /// - /// Additional information some carriers may provide by which to identify a given label in their system. + /// The tracking number for the package. Tracking number formats vary across carriers. /// - /// Additional information some carriers may provide by which to identify a given label in their system. - [JsonPropertyName("alternative_identifiers")] - public List AlternativeIdentifiers { get; set; } + /// The tracking number for the package. Tracking number formats vary across carriers. + /// + /// 782758401696 + /// + [JsonPropertyName("tracking_number")] + public string? TrackingNumber { get; set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. @@ -323,7 +306,24 @@ public partial class CreateReturnLabelResponseBody /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url")] - public string TrackingUrl { get; set; } + public string? TrackingUrl { get; set; } + + /// + /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// + /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + [JsonPropertyName("voided")] + public bool? Voided { get; set; } + + /// + /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("voided_at")] + public DateTimeOffset? VoidedAt { get; set; } /// @@ -335,44 +335,44 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreateReturnLabelResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" LabelId: ").Append(LabelId).Append("\n"); - sb.Append(" Status: ").Append(Status).Append("\n"); - sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); - sb.Append(" Shipment: ").Append(Shipment).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); - sb.Append(" ShipmentCost: ").Append(ShipmentCost).Append("\n"); - sb.Append(" InsuranceCost: ").Append(InsuranceCost).Append("\n"); - sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); - sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); - sb.Append(" IsReturnLabel: ").Append(IsReturnLabel).Append("\n"); - sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); - sb.Append(" IsInternational: ").Append(IsInternational).Append("\n"); + sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" BatchId: ").Append(BatchId).Append("\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); - sb.Append(" OutboundLabelId: ").Append(OutboundLabelId).Append("\n"); - sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); - sb.Append(" TestLabel: ").Append(TestLabel).Append("\n"); - sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); - sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); - sb.Append(" Voided: ").Append(Voided).Append("\n"); - sb.Append(" VoidedAt: ").Append(VoidedAt).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); + sb.Append(" InsuranceClaim: ").Append(InsuranceClaim).Append("\n"); + sb.Append(" InsuranceCost: ").Append(InsuranceCost).Append("\n"); + sb.Append(" IsInternational: ").Append(IsInternational).Append("\n"); + sb.Append(" IsReturnLabel: ").Append(IsReturnLabel).Append("\n"); + sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); - sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" LabelId: ").Append(LabelId).Append("\n"); + sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); + sb.Append(" OutboundLabelId: ").Append(OutboundLabelId).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); + sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); + sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" Shipment: ").Append(Shipment).Append("\n"); + sb.Append(" ShipmentCost: ").Append(ShipmentCost).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" Status: ").Append(Status).Append("\n"); + sb.Append(" TestLabel: ").Append(TestLabel).Append("\n"); sb.Append(" Trackable: ").Append(Trackable).Append("\n"); - sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); - sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); sb.Append(" TrackingStatus: ").Append(TrackingStatus).Append("\n"); - sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); - sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); - sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); - sb.Append(" InsuranceClaim: ").Append(InsuranceClaim).Append("\n"); - sb.Append(" Packages: ").Append(Packages).Append("\n"); - sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); + sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); + sb.Append(" Voided: ").Append(Voided).Append("\n"); + sb.Append(" VoidedAt: ").Append(VoidedAt).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs b/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs index f4c788d2..11e42c0a 100644 --- a/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs +++ b/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs @@ -28,20 +28,20 @@ namespace ShipEngineSDK.Model; public partial class CreateShipmentResponseBodyFields { + /// + /// The address validation + /// + /// The address validation + [JsonPropertyName("address_validation")] + public AddressValidationResult? AddressValidation { get; set; } + /// /// An array of errors that occurred while creating shipment. /// /// An array of errors that occurred while creating shipment. [JsonPropertyName("errors")] [Obsolete] - public List Errors { get; set; } - - /// - /// The address validation - /// - /// The address validation - [JsonPropertyName("address_validation")] - public AddressValidationResult AddressValidation { get; set; } + public List? Errors { get; set; } /// @@ -53,8 +53,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreateShipmentResponseBodyFields {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Errors: ").Append(Errors).Append("\n"); sb.Append(" AddressValidation: ").Append(AddressValidation).Append("\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs b/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs index 3e65a225..e7dc4676 100644 --- a/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs +++ b/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs @@ -28,14 +28,6 @@ namespace ShipEngineSDK.Model; public partial class CreateShipmentsResponseBody { - /// - /// Indicates if errors occured while creating the shipments - /// - /// Indicates if errors occured while creating the shipments - [JsonPropertyName("has_errors")] - [JsonRequired] - public bool HasErrors { get; set; } - /// /// An array of shipments that were created. /// @@ -44,6 +36,14 @@ public partial class CreateShipmentsResponseBody [JsonRequired] public List Shipments { get; set; } + /// + /// Indicates if errors occured while creating the shipments + /// + /// Indicates if errors occured while creating the shipments + [JsonPropertyName("has_errors")] + [JsonRequired] + public bool HasErrors { get; set; } + /// /// Returns the string presentation of the object @@ -54,8 +54,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreateShipmentsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" HasErrors: ").Append(HasErrors).Append("\n"); sb.Append(" Shipments: ").Append(Shipments).Append("\n"); + sb.Append(" HasErrors: ").Append(HasErrors).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs b/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs index d88f9697..7eee7cda 100644 --- a/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs +++ b/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs @@ -28,23 +28,6 @@ namespace ShipEngineSDK.Model; public partial class CreateWarehouseRequestBody { - /// - /// A string that uniquely identifies the warehouse - /// - /// A string that uniquely identifies the warehouse - /// - /// se-28529731 - /// - [JsonPropertyName("warehouse_id")] - public string WarehouseId { get; set; } - - /// - /// Designates which single warehouse is the default on the account - /// - /// Designates which single warehouse is the default on the account - [JsonPropertyName("is_default")] - public bool? IsDefault { get; set; } - /// /// Name of the warehouse /// @@ -56,6 +39,14 @@ public partial class CreateWarehouseRequestBody [JsonRequired] public string Name { get; set; } + /// + /// The origin address of the warehouse + /// + /// The origin address of the warehouse + [JsonPropertyName("origin_address")] + [JsonRequired] + public Address OriginAddress { get; set; } + /// /// Timestamp that indicates when the warehouse was created /// @@ -64,22 +55,31 @@ public partial class CreateWarehouseRequestBody /// 2019-06-25T18:12:35.583Z /// [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + public DateTimeOffset? CreatedAt { get; set; } /// - /// The origin address of the warehouse + /// Designates which single warehouse is the default on the account /// - /// The origin address of the warehouse - [JsonPropertyName("origin_address")] - [JsonRequired] - public Address OriginAddress { get; set; } + /// Designates which single warehouse is the default on the account + [JsonPropertyName("is_default")] + public bool? IsDefault { get; set; } /// /// The return address associated with the warehouse /// /// The return address associated with the warehouse [JsonPropertyName("return_address")] - public Address ReturnAddress { get; set; } + public Address? ReturnAddress { get; set; } + + /// + /// A string that uniquely identifies the warehouse + /// + /// A string that uniquely identifies the warehouse + /// + /// se-28529731 + /// + [JsonPropertyName("warehouse_id")] + public string? WarehouseId { get; set; } /// @@ -91,12 +91,12 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreateWarehouseRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); - sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" OriginAddress: ").Append(OriginAddress).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); sb.Append(" ReturnAddress: ").Append(ReturnAddress).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs b/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs index a696df92..f8691c2d 100644 --- a/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs +++ b/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs @@ -29,22 +29,15 @@ public partial class CreateWarehouseResponseBody { /// - /// A string that uniquely identifies the warehouse + /// Timestamp that indicates when the warehouse was created /// - /// A string that uniquely identifies the warehouse + /// Timestamp that indicates when the warehouse was created /// - /// se-28529731 + /// 2019-06-25T18:12:35.583Z /// - [JsonPropertyName("warehouse_id")] + [JsonPropertyName("created_at")] [JsonRequired] - public string WarehouseId { get; set; } - - /// - /// Designates which single warehouse is the default on the account - /// - /// Designates which single warehouse is the default on the account - [JsonPropertyName("is_default")] - public bool? IsDefault { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// Name of the warehouse @@ -57,17 +50,6 @@ public partial class CreateWarehouseResponseBody [JsonRequired] public string Name { get; set; } - /// - /// Timestamp that indicates when the warehouse was created - /// - /// Timestamp that indicates when the warehouse was created - /// - /// 2019-06-25T18:12:35.583Z - /// - [JsonPropertyName("created_at")] - [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } - /// /// The origin address of the warehouse /// @@ -84,6 +66,24 @@ public partial class CreateWarehouseResponseBody [JsonRequired] public Address ReturnAddress { get; set; } + /// + /// A string that uniquely identifies the warehouse + /// + /// A string that uniquely identifies the warehouse + /// + /// se-28529731 + /// + [JsonPropertyName("warehouse_id")] + [JsonRequired] + public string WarehouseId { get; set; } + + /// + /// Designates which single warehouse is the default on the account + /// + /// Designates which single warehouse is the default on the account + [JsonPropertyName("is_default")] + public bool? IsDefault { get; set; } + /// /// Returns the string presentation of the object @@ -94,12 +94,12 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreateWarehouseResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); - sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); - sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" OriginAddress: ").Append(OriginAddress).Append("\n"); sb.Append(" ReturnAddress: ").Append(ReturnAddress).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); + sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CreateWebhookRequestBody.cs b/ShipEngineSDK/Model/CreateWebhookRequestBody.cs index 571c7bfe..84f42e3c 100644 --- a/ShipEngineSDK/Model/CreateWebhookRequestBody.cs +++ b/ShipEngineSDK/Model/CreateWebhookRequestBody.cs @@ -52,7 +52,7 @@ public partial class CreateWebhookRequestBody /// /// Array of custom webhook headers [JsonPropertyName("headers")] - public List Headers { get; set; } + public List? Headers { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateWebhookResponseBody.cs b/ShipEngineSDK/Model/CreateWebhookResponseBody.cs index e938e549..f984855e 100644 --- a/ShipEngineSDK/Model/CreateWebhookResponseBody.cs +++ b/ShipEngineSDK/Model/CreateWebhookResponseBody.cs @@ -37,33 +37,33 @@ public partial class CreateWebhookResponseBody /// - /// A string that uniquely identifies the webhook + /// The url that the webhook sends the request to /// - /// A string that uniquely identifies the webhook + /// The url that the webhook sends the request to /// - /// se-28529731 + /// http://api.shipengine.com/v1/labels/se-28529731 /// - [JsonPropertyName("webhook_id")] + [JsonPropertyName("url")] [JsonRequired] - public string WebhookId { get; set; } + public string Url { get; set; } /// - /// The url that the webhook sends the request to + /// A string that uniquely identifies the webhook /// - /// The url that the webhook sends the request to + /// A string that uniquely identifies the webhook /// - /// http://api.shipengine.com/v1/labels/se-28529731 + /// se-28529731 /// - [JsonPropertyName("url")] + [JsonPropertyName("webhook_id")] [JsonRequired] - public string Url { get; set; } + public string WebhookId { get; set; } /// /// Array of custom webhook headers /// /// Array of custom webhook headers [JsonPropertyName("headers")] - public List Headers { get; set; } + public List? Headers { get; set; } /// @@ -75,9 +75,9 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class CreateWebhookResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" WebhookId: ").Append(WebhookId).Append("\n"); - sb.Append(" Url: ").Append(Url).Append("\n"); sb.Append(" Event: ").Append(Event).Append("\n"); + sb.Append(" Url: ").Append(Url).Append("\n"); + sb.Append(" WebhookId: ").Append(WebhookId).Append("\n"); sb.Append(" Headers: ").Append(Headers).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/CustomsItem.cs b/ShipEngineSDK/Model/CustomsItem.cs index a9a52eb3..6115188e 100644 --- a/ShipEngineSDK/Model/CustomsItem.cs +++ b/ShipEngineSDK/Model/CustomsItem.cs @@ -40,39 +40,21 @@ public partial class CustomsItem public string CustomsItemId { get; set; } /// - /// A description of the item - /// - /// A description of the item - [JsonPropertyName("description")] - public string Description { get; set; } - - /// - /// The quantity of this item in the shipment. - /// - /// The quantity of this item in the shipment. - [JsonPropertyName("quantity")] - public int Quantity { get; set; } - - /// - /// The monetary amount, in the specified currency. - /// - /// The monetary amount, in the specified currency. - [JsonPropertyName("value")] - public double Value { get; set; } - - /// - /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated /// - /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("value_currency")] - public string ValueCurrency { get; set; } + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated + /// + /// CA + /// + [JsonPropertyName("country_of_origin")] + public string? CountryOfOrigin { get; set; } /// - /// The item weight + /// A description of the item /// - /// The item weight - [JsonPropertyName("weight")] - public Weight Weight { get; set; } + /// A description of the item + [JsonPropertyName("description")] + public string? Description { get; set; } /// /// The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item. @@ -82,37 +64,55 @@ public partial class CustomsItem /// 3926.1 /// [JsonPropertyName("harmonized_tariff_code")] - public string HarmonizedTariffCode { get; set; } - - /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated - /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated - /// - /// CA - /// - [JsonPropertyName("country_of_origin")] - public string CountryOfOrigin { get; set; } + public string? HarmonizedTariffCode { get; set; } /// - /// Gets or Sets UnitOfMeasure + /// The quantity of this item in the shipment. /// - [JsonPropertyName("unit_of_measure")] - public string UnitOfMeasure { get; set; } + /// The quantity of this item in the shipment. + [JsonPropertyName("quantity")] + public int? Quantity { get; set; } /// /// The SKU (Stock Keeping Unit) of the customs item /// /// The SKU (Stock Keeping Unit) of the customs item [JsonPropertyName("sku")] - public string Sku { get; set; } + public string? Sku { get; set; } /// /// Description of the Custom Item's SKU /// /// Description of the Custom Item's SKU [JsonPropertyName("sku_description")] - public string SkuDescription { get; set; } + public string? SkuDescription { get; set; } + + /// + /// Gets or Sets UnitOfMeasure + /// + [JsonPropertyName("unit_of_measure")] + public string? UnitOfMeasure { get; set; } + + /// + /// The monetary amount, in the specified currency. + /// + /// The monetary amount, in the specified currency. + [JsonPropertyName("value")] + public double? Value { get; set; } + + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + [JsonPropertyName("value_currency")] + public string? ValueCurrency { get; set; } + + /// + /// The item weight + /// + /// The item weight + [JsonPropertyName("weight")] + public Weight? Weight { get; set; } /// @@ -125,16 +125,16 @@ public override string ToString() sb.Append("class CustomsItem {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CustomsItemId: ").Append(CustomsItemId).Append("\n"); + sb.Append(" CountryOfOrigin: ").Append(CountryOfOrigin).Append("\n"); sb.Append(" Description: ").Append(Description).Append("\n"); + sb.Append(" HarmonizedTariffCode: ").Append(HarmonizedTariffCode).Append("\n"); sb.Append(" Quantity: ").Append(Quantity).Append("\n"); + sb.Append(" Sku: ").Append(Sku).Append("\n"); + sb.Append(" SkuDescription: ").Append(SkuDescription).Append("\n"); + sb.Append(" UnitOfMeasure: ").Append(UnitOfMeasure).Append("\n"); sb.Append(" Value: ").Append(Value).Append("\n"); sb.Append(" ValueCurrency: ").Append(ValueCurrency).Append("\n"); sb.Append(" Weight: ").Append(Weight).Append("\n"); - sb.Append(" HarmonizedTariffCode: ").Append(HarmonizedTariffCode).Append("\n"); - sb.Append(" CountryOfOrigin: ").Append(CountryOfOrigin).Append("\n"); - sb.Append(" UnitOfMeasure: ").Append(UnitOfMeasure).Append("\n"); - sb.Append(" Sku: ").Append(Sku).Append("\n"); - sb.Append(" SkuDescription: ").Append(SkuDescription).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/DangerousAmount.cs b/ShipEngineSDK/Model/DangerousAmount.cs index ecfeb166..d81ac2a2 100644 --- a/ShipEngineSDK/Model/DangerousAmount.cs +++ b/ShipEngineSDK/Model/DangerousAmount.cs @@ -33,14 +33,14 @@ public partial class DangerousAmount /// /// The amount of dangerous goods. [JsonPropertyName("amount")] - public double Amount { get; set; } + public double? Amount { get; set; } /// /// The unit of dangerous goods. /// /// The unit of dangerous goods. [JsonPropertyName("unit")] - public string Unit { get; set; } + public string? Unit { get; set; } /// diff --git a/ShipEngineSDK/Model/DangerousGoods.cs b/ShipEngineSDK/Model/DangerousGoods.cs index 041d2f5d..bf2e5e7d 100644 --- a/ShipEngineSDK/Model/DangerousGoods.cs +++ b/ShipEngineSDK/Model/DangerousGoods.cs @@ -39,91 +39,70 @@ public partial class DangerousGoods [JsonPropertyName("packaging_instruction_section")] public PackagingInstructionSection? PackagingInstructionSection { get; set; } /// - /// Gets or Sets TransportMean CLOVUS - /// - [JsonPropertyName("transport_mean")] - public TransportMean? TransportMean { get; set; } - /// /// Gets or Sets RegulationLevel CLOVUS /// [JsonPropertyName("regulation_level")] public RegulationLevel? RegulationLevel { get; set; } /// - /// UN number to identify the dangerous goods. - /// - /// UN number to identify the dangerous goods. - [JsonPropertyName("id_number")] - public string IdNumber { get; set; } - - /// - /// Trade description of the dangerous goods. - /// - /// Trade description of the dangerous goods. - [JsonPropertyName("shipping_name")] - public string ShippingName { get; set; } - - /// - /// Recognized Technical or chemical name of dangerous goods. - /// - /// Recognized Technical or chemical name of dangerous goods. - [JsonPropertyName("technical_name")] - public string TechnicalName { get; set; } - - /// - /// Dangerous goods product class based on regulation. + /// Gets or Sets TransportMean CLOVUS /// - /// Dangerous goods product class based on regulation. - [JsonPropertyName("product_class")] - public string ProductClass { get; set; } - + [JsonPropertyName("transport_mean")] + public TransportMean? TransportMean { get; set; } /// - /// A secondary of product class for substances presenting more than one particular hazard + /// Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier /// - /// A secondary of product class for substances presenting more than one particular hazard - [JsonPropertyName("product_class_subsidiary")] - public string ProductClassSubsidiary { get; set; } + /// Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier + [JsonPropertyName("additional_description")] + public string? AdditionalDescription { get; set; } /// /// This model represents the amount of the dangerous goods. /// /// This model represents the amount of the dangerous goods. [JsonPropertyName("dangerous_amount")] - public DangerousAmount DangerousAmount { get; set; } + public DangerousAmount? DangerousAmount { get; set; } /// - /// Quantity of dangerous goods. + /// UN number to identify the dangerous goods. /// - /// Quantity of dangerous goods. - [JsonPropertyName("quantity")] - public int Quantity { get; set; } + /// UN number to identify the dangerous goods. + [JsonPropertyName("id_number")] + public string? IdNumber { get; set; } /// /// The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container. /// /// The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container. [JsonPropertyName("packaging_instruction")] - public string PackagingInstruction { get; set; } + public string? PackagingInstruction { get; set; } /// /// The type of exterior packaging used to contain the dangerous good. /// /// The type of exterior packaging used to contain the dangerous good. [JsonPropertyName("packaging_type")] - public string PackagingType { get; set; } + public string? PackagingType { get; set; } /// - /// Transport category assign to dangerous goods for the transport purpose. + /// Dangerous goods product class based on regulation. /// - /// Transport category assign to dangerous goods for the transport purpose. - [JsonPropertyName("transport_category")] - public string TransportCategory { get; set; } + /// Dangerous goods product class based on regulation. + [JsonPropertyName("product_class")] + public string? ProductClass { get; set; } /// - /// Name of the regulatory authority. + /// A secondary of product class for substances presenting more than one particular hazard /// - /// Name of the regulatory authority. - [JsonPropertyName("regulation_authority")] - public string RegulationAuthority { get; set; } + /// A secondary of product class for substances presenting more than one particular hazard + [JsonPropertyName("product_class_subsidiary")] + public string? ProductClassSubsidiary { get; set; } + + /// + /// Quantity of dangerous goods. + /// + /// Quantity of dangerous goods. + [JsonPropertyName("quantity")] + public int? Quantity { get; set; } /// /// Indication if the substance is radioactive. @@ -135,6 +114,13 @@ public partial class DangerousGoods [JsonPropertyName("radioactive")] public bool? Radioactive { get; set; } + /// + /// Name of the regulatory authority. + /// + /// Name of the regulatory authority. + [JsonPropertyName("regulation_authority")] + public string? RegulationAuthority { get; set; } + /// /// Indication if the substance needs to be reported to regulatory authority based on the quantity. /// @@ -146,18 +132,32 @@ public partial class DangerousGoods public bool? ReportableQuantity { get; set; } /// - /// Defines which types of tunnels the shipment is allowed to go through + /// Trade description of the dangerous goods. /// - /// Defines which types of tunnels the shipment is allowed to go through - [JsonPropertyName("tunnel_code")] - public string TunnelCode { get; set; } + /// Trade description of the dangerous goods. + [JsonPropertyName("shipping_name")] + public string? ShippingName { get; set; } /// - /// Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier + /// Recognized Technical or chemical name of dangerous goods. /// - /// Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier - [JsonPropertyName("additional_description")] - public string AdditionalDescription { get; set; } + /// Recognized Technical or chemical name of dangerous goods. + [JsonPropertyName("technical_name")] + public string? TechnicalName { get; set; } + + /// + /// Transport category assign to dangerous goods for the transport purpose. + /// + /// Transport category assign to dangerous goods for the transport purpose. + [JsonPropertyName("transport_category")] + public string? TransportCategory { get; set; } + + /// + /// Defines which types of tunnels the shipment is allowed to go through + /// + /// Defines which types of tunnels the shipment is allowed to go through + [JsonPropertyName("tunnel_code")] + public string? TunnelCode { get; set; } /// @@ -169,25 +169,25 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class DangerousGoods {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" AdditionalDescription: ").Append(AdditionalDescription).Append("\n"); + sb.Append(" DangerousAmount: ").Append(DangerousAmount).Append("\n"); sb.Append(" IdNumber: ").Append(IdNumber).Append("\n"); - sb.Append(" ShippingName: ").Append(ShippingName).Append("\n"); - sb.Append(" TechnicalName: ").Append(TechnicalName).Append("\n"); - sb.Append(" ProductClass: ").Append(ProductClass).Append("\n"); - sb.Append(" ProductClassSubsidiary: ").Append(ProductClassSubsidiary).Append("\n"); sb.Append(" PackagingGroup: ").Append(PackagingGroup).Append("\n"); - sb.Append(" DangerousAmount: ").Append(DangerousAmount).Append("\n"); - sb.Append(" Quantity: ").Append(Quantity).Append("\n"); sb.Append(" PackagingInstruction: ").Append(PackagingInstruction).Append("\n"); sb.Append(" PackagingInstructionSection: ").Append(PackagingInstructionSection).Append("\n"); sb.Append(" PackagingType: ").Append(PackagingType).Append("\n"); - sb.Append(" TransportMean: ").Append(TransportMean).Append("\n"); - sb.Append(" TransportCategory: ").Append(TransportCategory).Append("\n"); + sb.Append(" ProductClass: ").Append(ProductClass).Append("\n"); + sb.Append(" ProductClassSubsidiary: ").Append(ProductClassSubsidiary).Append("\n"); + sb.Append(" Quantity: ").Append(Quantity).Append("\n"); + sb.Append(" Radioactive: ").Append(Radioactive).Append("\n"); sb.Append(" RegulationAuthority: ").Append(RegulationAuthority).Append("\n"); sb.Append(" RegulationLevel: ").Append(RegulationLevel).Append("\n"); - sb.Append(" Radioactive: ").Append(Radioactive).Append("\n"); sb.Append(" ReportableQuantity: ").Append(ReportableQuantity).Append("\n"); + sb.Append(" ShippingName: ").Append(ShippingName).Append("\n"); + sb.Append(" TechnicalName: ").Append(TechnicalName).Append("\n"); + sb.Append(" TransportCategory: ").Append(TransportCategory).Append("\n"); + sb.Append(" TransportMean: ").Append(TransportMean).Append("\n"); sb.Append(" TunnelCode: ").Append(TunnelCode).Append("\n"); - sb.Append(" AdditionalDescription: ").Append(AdditionalDescription).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs b/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs index 10c9ce36..56a81c82 100644 --- a/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs +++ b/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs @@ -28,17 +28,6 @@ namespace ShipEngineSDK.Model; public partial class DeletePickupByIdResponseBody { - /// - /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur - /// - /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur - /// - /// aa3d8e8e-462b-4476-9618-72db7f7b7009 - /// - [JsonPropertyName("request_id")] - [JsonRequired] - public Guid RequestId { get; set; } - /// /// The errors associated with the failed API call /// @@ -58,6 +47,17 @@ public partial class DeletePickupByIdResponseBody [JsonRequired] public string PickupId { get; set; } + /// + /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur + /// + /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur + /// + /// aa3d8e8e-462b-4476-9618-72db7f7b7009 + /// + [JsonPropertyName("request_id")] + [JsonRequired] + public Guid RequestId { get; set; } + /// /// Returns the string presentation of the object @@ -68,9 +68,9 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class DeletePickupByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" RequestId: ").Append(RequestId).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); sb.Append(" PickupId: ").Append(PickupId).Append("\n"); + sb.Append(" RequestId: ").Append(RequestId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/DeprecatedManifest.cs b/ShipEngineSDK/Model/DeprecatedManifest.cs index 80ef19d5..fa2cd827 100644 --- a/ShipEngineSDK/Model/DeprecatedManifest.cs +++ b/ShipEngineSDK/Model/DeprecatedManifest.cs @@ -29,15 +29,26 @@ public partial class DeprecatedManifest { /// - /// A string that uniquely identifies the manifest + /// A string that uniquely identifies the carrier /// - /// A string that uniquely identifies the manifest + /// A string that uniquely identifies the carrier /// /// se-28529731 /// - [JsonPropertyName("manifest_id")] + [JsonPropertyName("carrier_id")] + [Obsolete] + public string? CarrierId { get; set; } + + /// + /// The date-time that the manifest was created + /// + /// The date-time that the manifest was created + /// + /// 2019-07-12T13:37:39.050Z + /// + [JsonPropertyName("created_at")] [Obsolete] - public string ManifestId { get; set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// A string that uniquely identifies the form @@ -48,18 +59,33 @@ public partial class DeprecatedManifest /// [JsonPropertyName("form_id")] [Obsolete] - public string FormId { get; set; } + public string? FormId { get; set; } /// - /// The date-time that the manifest was created + /// An array of the label ids used in this manifest. /// - /// The date-time that the manifest was created + /// An array of the label ids used in this manifest. + [JsonPropertyName("label_ids")] + [Obsolete] + public List? LabelIds { get; set; } + + /// + /// Gets or Sets ManifestDownload + /// + [JsonPropertyName("manifest_download")] + [Obsolete] + public ManifestDownload? ManifestDownload { get; set; } + + /// + /// A string that uniquely identifies the manifest + /// + /// A string that uniquely identifies the manifest /// - /// 2019-07-12T13:37:39.050Z + /// se-28529731 /// - [JsonPropertyName("created_at")] + [JsonPropertyName("manifest_id")] [Obsolete] - public DateTimeOffset CreatedAt { get; set; } + public string? ManifestId { get; set; } /// /// The date-time that the manifests shipments will be picked up @@ -70,7 +96,7 @@ public partial class DeprecatedManifest /// [JsonPropertyName("ship_date")] [Obsolete] - public DateTimeOffset ShipDate { get; set; } + public DateTimeOffset? ShipDate { get; set; } /// /// The number of shipments that are included in this manifest @@ -81,18 +107,7 @@ public partial class DeprecatedManifest /// [JsonPropertyName("shipments")] [Obsolete] - public int Shipments { get; set; } - - /// - /// A string that uniquely identifies the warehouse - /// - /// A string that uniquely identifies the warehouse - /// - /// se-28529731 - /// - [JsonPropertyName("warehouse_id")] - [Obsolete] - public string WarehouseId { get; set; } + public int? Shipments { get; set; } /// /// A string that uniquely identifies the submission @@ -103,33 +118,18 @@ public partial class DeprecatedManifest /// [JsonPropertyName("submission_id")] [Obsolete] - public string SubmissionId { get; set; } + public string? SubmissionId { get; set; } /// - /// A string that uniquely identifies the carrier + /// A string that uniquely identifies the warehouse /// - /// A string that uniquely identifies the carrier + /// A string that uniquely identifies the warehouse /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [Obsolete] - public string CarrierId { get; set; } - - /// - /// Gets or Sets ManifestDownload - /// - [JsonPropertyName("manifest_download")] - [Obsolete] - public ManifestDownload ManifestDownload { get; set; } - - /// - /// An array of the label ids used in this manifest. - /// - /// An array of the label ids used in this manifest. - [JsonPropertyName("label_ids")] + [JsonPropertyName("warehouse_id")] [Obsolete] - public List LabelIds { get; set; } + public string? WarehouseId { get; set; } /// @@ -141,16 +141,16 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class DeprecatedManifest {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ManifestId: ").Append(ManifestId).Append("\n"); - sb.Append(" FormId: ").Append(FormId).Append("\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" FormId: ").Append(FormId).Append("\n"); + sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); + sb.Append(" ManifestDownload: ").Append(ManifestDownload).Append("\n"); + sb.Append(" ManifestId: ").Append(ManifestId).Append("\n"); sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); sb.Append(" Shipments: ").Append(Shipments).Append("\n"); - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); sb.Append(" SubmissionId: ").Append(SubmissionId).Append("\n"); - sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); - sb.Append(" ManifestDownload: ").Append(ManifestDownload).Append("\n"); - sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/DhlExpressAccountSettings.cs b/ShipEngineSDK/Model/DhlExpressAccountSettings.cs index 74cf1713..92e6cb5f 100644 --- a/ShipEngineSDK/Model/DhlExpressAccountSettings.cs +++ b/ShipEngineSDK/Model/DhlExpressAccountSettings.cs @@ -28,26 +28,26 @@ namespace ShipEngineSDK.Model; public partial class DhlExpressAccountSettings { + /// + /// Indicates if this is primary account + /// + /// Indicates if this is primary account + [JsonPropertyName("is_primary_account")] + public bool? IsPrimaryAccount { get; set; } + /// /// Account nickname /// /// Account nickname [JsonPropertyName("nickname")] - public string Nickname { get; set; } + public string? Nickname { get; set; } /// /// Indicates if the account number should be hidden on the archive documentation /// /// Indicates if the account number should be hidden on the archive documentation [JsonPropertyName("should_hide_account_number_on_archive_doc")] - public bool ShouldHideAccountNumberOnArchiveDoc { get; set; } - - /// - /// Indicates if this is primary account - /// - /// Indicates if this is primary account - [JsonPropertyName("is_primary_account")] - public bool IsPrimaryAccount { get; set; } + public bool? ShouldHideAccountNumberOnArchiveDoc { get; set; } /// @@ -59,9 +59,9 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class DhlExpressAccountSettings {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" ShouldHideAccountNumberOnArchiveDoc: ").Append(ShouldHideAccountNumberOnArchiveDoc).Append("\n"); - sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs b/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs index 2568c425..6d278de5 100644 --- a/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs @@ -28,26 +28,26 @@ namespace ShipEngineSDK.Model; public partial class DhlExpressSettingsResponseBody { + /// + /// Indicates if this is primary account + /// + /// Indicates if this is primary account + [JsonPropertyName("is_primary_account")] + public bool? IsPrimaryAccount { get; set; } + /// /// Account nickname /// /// Account nickname [JsonPropertyName("nickname")] - public string Nickname { get; set; } + public string? Nickname { get; set; } /// /// Indicates if the account number should be hidden on the archive documentation /// /// Indicates if the account number should be hidden on the archive documentation [JsonPropertyName("should_hide_account_number_on_archive_doc")] - public bool ShouldHideAccountNumberOnArchiveDoc { get; set; } - - /// - /// Indicates if this is primary account - /// - /// Indicates if this is primary account - [JsonPropertyName("is_primary_account")] - public bool IsPrimaryAccount { get; set; } + public bool? ShouldHideAccountNumberOnArchiveDoc { get; set; } /// @@ -59,9 +59,9 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class DhlExpressSettingsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" ShouldHideAccountNumberOnArchiveDoc: ").Append(ShouldHideAccountNumberOnArchiveDoc).Append("\n"); - sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/Dimensions.cs b/ShipEngineSDK/Model/Dimensions.cs index ca0fe759..92861e9a 100644 --- a/ShipEngineSDK/Model/Dimensions.cs +++ b/ShipEngineSDK/Model/Dimensions.cs @@ -36,6 +36,14 @@ public partial class Dimensions public DimensionUnit Unit { get; set; } = new(); + /// + /// The height of the package, in the specified unit + /// + /// The height of the package, in the specified unit + [JsonPropertyName("height")] + [JsonRequired] + public double Height { get; set; } + /// /// The length of the package, in the specified unit /// @@ -52,14 +60,6 @@ public partial class Dimensions [JsonRequired] public double Width { get; set; } - /// - /// The height of the package, in the specified unit - /// - /// The height of the package, in the specified unit - [JsonPropertyName("height")] - [JsonRequired] - public double Height { get; set; } - /// /// Returns the string presentation of the object @@ -71,9 +71,9 @@ public override string ToString() sb.Append("class Dimensions {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Unit: ").Append(Unit).Append("\n"); + sb.Append(" Height: ").Append(Height).Append("\n"); sb.Append(" Length: ").Append(Length).Append("\n"); sb.Append(" Width: ").Append(Width).Append("\n"); - sb.Append(" Height: ").Append(Height).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/Error.cs b/ShipEngineSDK/Model/Error.cs index cde7aa03..e1dde68e 100644 --- a/ShipEngineSDK/Model/Error.cs +++ b/ShipEngineSDK/Model/Error.cs @@ -28,6 +28,14 @@ namespace ShipEngineSDK.Model; public partial class Error { + /// + /// Gets or Sets ErrorCode CLOVUS + /// + [JsonPropertyName("error_code")] + [JsonRequired] + public ErrorCode ErrorCode { get; set; } = new(); + + /// /// Gets or Sets ErrorSource CLOVUS /// @@ -44,14 +52,6 @@ public partial class Error public ErrorType ErrorType { get; set; } = new(); - /// - /// Gets or Sets ErrorCode CLOVUS - /// - [JsonPropertyName("error_code")] - [JsonRequired] - public ErrorCode ErrorCode { get; set; } = new(); - - /// /// An error message associated with the failed API call /// @@ -73,9 +73,9 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class Error {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" ErrorCode: ").Append(ErrorCode).Append("\n"); sb.Append(" ErrorSource: ").Append(ErrorSource).Append("\n"); sb.Append(" ErrorType: ").Append(ErrorType).Append("\n"); - sb.Append(" ErrorCode: ").Append(ErrorCode).Append("\n"); sb.Append(" Message: ").Append(Message).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/ErrorResponseBody.cs b/ShipEngineSDK/Model/ErrorResponseBody.cs index 0cd5d0c9..3980d505 100644 --- a/ShipEngineSDK/Model/ErrorResponseBody.cs +++ b/ShipEngineSDK/Model/ErrorResponseBody.cs @@ -28,6 +28,14 @@ namespace ShipEngineSDK.Model; public partial class ErrorResponseBody { + /// + /// The errors associated with the failed API call + /// + /// The errors associated with the failed API call + [JsonPropertyName("errors")] + [JsonRequired] + public List Errors { get; set; } + /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur /// @@ -39,14 +47,6 @@ public partial class ErrorResponseBody [JsonRequired] public Guid RequestId { get; set; } - /// - /// The errors associated with the failed API call - /// - /// The errors associated with the failed API call - [JsonPropertyName("errors")] - [JsonRequired] - public List Errors { get; set; } - /// /// Returns the string presentation of the object @@ -57,8 +57,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ErrorResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" RequestId: ").Append(RequestId).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); + sb.Append(" RequestId: ").Append(RequestId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs b/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs index f91f1a36..9ee23263 100644 --- a/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs +++ b/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs @@ -28,6 +28,14 @@ namespace ShipEngineSDK.Model; public partial class ErrorWithLabelIdResponseBody { + /// + /// The errors associated with the failed API call + /// + /// The errors associated with the failed API call + [JsonPropertyName("errors")] + [JsonRequired] + public List Errors { get; set; } + /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur /// @@ -39,14 +47,6 @@ public partial class ErrorWithLabelIdResponseBody [JsonRequired] public Guid RequestId { get; set; } - /// - /// The errors associated with the failed API call - /// - /// The errors associated with the failed API call - [JsonPropertyName("errors")] - [JsonRequired] - public List Errors { get; set; } - /// /// Returns the string presentation of the object @@ -57,8 +57,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ErrorWithLabelIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" RequestId: ").Append(RequestId).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); + sb.Append(" RequestId: ").Append(RequestId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/EstimateRatesRequestBody.cs b/ShipEngineSDK/Model/EstimateRatesRequestBody.cs index ca9bbd89..150fb923 100644 --- a/ShipEngineSDK/Model/EstimateRatesRequestBody.cs +++ b/ShipEngineSDK/Model/EstimateRatesRequestBody.cs @@ -31,16 +31,27 @@ namespace ShipEngineSDK.Model; public partial class EstimateRatesRequestBody : AbstractOpenAPISchema { + /// + /// Gets or Sets AddressResidentialIndicator + /// + [JsonPropertyName("address_residential_indicator")] + public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } /// /// Gets or Sets Confirmation /// [JsonPropertyName("confirmation")] public DeliveryConfirmation? Confirmation { get; set; } /// - /// Gets or Sets AddressResidentialIndicator + /// from postal code /// - [JsonPropertyName("address_residential_indicator")] - public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } + /// from postal code + /// + /// Austin + /// + [JsonPropertyName("from_city_locality")] + [JsonRequired] + public string FromCityLocality { get; set; } + /// /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) /// @@ -64,26 +75,37 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema public string FromPostalCode { get; set; } /// - /// from postal code + /// From state province /// - /// from postal code + /// From state province /// /// Austin /// - [JsonPropertyName("from_city_locality")] + [JsonPropertyName("from_state_province")] [JsonRequired] - public string FromCityLocality { get; set; } + public string FromStateProvince { get; set; } /// - /// From state province + /// ship date /// - /// From state province + /// ship date + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("ship_date")] + [JsonRequired] + public DateTimeOffset ShipDate { get; set; } + + /// + /// The city locality the package is being shipped to + /// + /// The city locality the package is being shipped to /// /// Austin /// - [JsonPropertyName("from_state_province")] + [JsonPropertyName("to_city_locality")] [JsonRequired] - public string FromStateProvince { get; set; } + public string ToCityLocality { get; set; } /// /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) @@ -107,17 +129,6 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema [JsonRequired] public string ToPostalCode { get; set; } - /// - /// The city locality the package is being shipped to - /// - /// The city locality the package is being shipped to - /// - /// Austin - /// - [JsonPropertyName("to_city_locality")] - [JsonRequired] - public string ToCityLocality { get; set; } - /// /// To state province /// @@ -142,18 +153,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// The dimensions of the package [JsonPropertyName("dimensions")] - public Dimensions Dimensions { get; set; } - - /// - /// ship date - /// - /// ship date - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("ship_date")] - [JsonRequired] - public DateTimeOffset ShipDate { get; set; } + public Dimensions? Dimensions { get; set; } /// @@ -237,19 +237,19 @@ public override string ToString() sb.Append("class EstimateRatesRequestBody {\n"); sb.Append(" ActualInstance: ").Append(this.ActualInstance).Append("\n"); + sb.Append(" FromCityLocality: ").Append(this.FromCityLocality).Append("\n"); sb.Append(" FromCountryCode: ").Append(this.FromCountryCode).Append("\n"); sb.Append(" FromPostalCode: ").Append(this.FromPostalCode).Append("\n"); - sb.Append(" FromCityLocality: ").Append(this.FromCityLocality).Append("\n"); sb.Append(" FromStateProvince: ").Append(this.FromStateProvince).Append("\n"); + sb.Append(" ShipDate: ").Append(this.ShipDate).Append("\n"); + sb.Append(" ToCityLocality: ").Append(this.ToCityLocality).Append("\n"); sb.Append(" ToCountryCode: ").Append(this.ToCountryCode).Append("\n"); sb.Append(" ToPostalCode: ").Append(this.ToPostalCode).Append("\n"); - sb.Append(" ToCityLocality: ").Append(this.ToCityLocality).Append("\n"); sb.Append(" ToStateProvince: ").Append(this.ToStateProvince).Append("\n"); sb.Append(" Weight: ").Append(this.Weight).Append("\n"); - sb.Append(" Dimensions: ").Append(this.Dimensions).Append("\n"); - sb.Append(" Confirmation: ").Append(this.Confirmation).Append("\n"); sb.Append(" AddressResidentialIndicator: ").Append(this.AddressResidentialIndicator).Append("\n"); - sb.Append(" ShipDate: ").Append(this.ShipDate).Append("\n"); + sb.Append(" Confirmation: ").Append(this.Confirmation).Append("\n"); + sb.Append(" Dimensions: ").Append(this.Dimensions).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -311,32 +311,32 @@ public override void Write(Utf8JsonWriter writer, EstimateRatesRequestBody value { writer.WriteStartObject(); + writer.WritePropertyName("from_city_locality"); + JsonSerializer.Serialize(writer, value.FromCityLocality, options); writer.WritePropertyName("from_country_code"); JsonSerializer.Serialize(writer, value.FromCountryCode, options); writer.WritePropertyName("from_postal_code"); JsonSerializer.Serialize(writer, value.FromPostalCode, options); - writer.WritePropertyName("from_city_locality"); - JsonSerializer.Serialize(writer, value.FromCityLocality, options); writer.WritePropertyName("from_state_province"); JsonSerializer.Serialize(writer, value.FromStateProvince, options); + writer.WritePropertyName("ship_date"); + JsonSerializer.Serialize(writer, value.ShipDate, options); + writer.WritePropertyName("to_city_locality"); + JsonSerializer.Serialize(writer, value.ToCityLocality, options); writer.WritePropertyName("to_country_code"); JsonSerializer.Serialize(writer, value.ToCountryCode, options); writer.WritePropertyName("to_postal_code"); JsonSerializer.Serialize(writer, value.ToPostalCode, options); - writer.WritePropertyName("to_city_locality"); - JsonSerializer.Serialize(writer, value.ToCityLocality, options); writer.WritePropertyName("to_state_province"); JsonSerializer.Serialize(writer, value.ToStateProvince, options); writer.WritePropertyName("weight"); JsonSerializer.Serialize(writer, value.Weight, options); - writer.WritePropertyName("dimensions"); - JsonSerializer.Serialize(writer, value.Dimensions, options); - writer.WritePropertyName("confirmation"); - JsonSerializer.Serialize(writer, value.Confirmation, options); writer.WritePropertyName("address_residential_indicator"); JsonSerializer.Serialize(writer, value.AddressResidentialIndicator, options); - writer.WritePropertyName("ship_date"); - JsonSerializer.Serialize(writer, value.ShipDate, options); + writer.WritePropertyName("confirmation"); + JsonSerializer.Serialize(writer, value.Confirmation, options); + writer.WritePropertyName("dimensions"); + JsonSerializer.Serialize(writer, value.Dimensions, options); var node = JsonSerializer.SerializeToNode(value.ActualInstance, options); foreach (var prop in node?.AsObject() ?? []) @@ -407,19 +407,19 @@ public override void Write(Utf8JsonWriter writer, EstimateRatesRequestBody value throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); } + newEstimateRatesRequestBody!.FromCityLocality = jsonDoc.RootElement.GetProperty("from_city_locality").Deserialize(DeserializingOptions)!; newEstimateRatesRequestBody!.FromCountryCode = jsonDoc.RootElement.GetProperty("from_country_code").Deserialize(DeserializingOptions)!; newEstimateRatesRequestBody!.FromPostalCode = jsonDoc.RootElement.GetProperty("from_postal_code").Deserialize(DeserializingOptions)!; - newEstimateRatesRequestBody!.FromCityLocality = jsonDoc.RootElement.GetProperty("from_city_locality").Deserialize(DeserializingOptions)!; newEstimateRatesRequestBody!.FromStateProvince = jsonDoc.RootElement.GetProperty("from_state_province").Deserialize(DeserializingOptions)!; + newEstimateRatesRequestBody!.ShipDate = jsonDoc.RootElement.GetProperty("ship_date").Deserialize(DeserializingOptions)!; + newEstimateRatesRequestBody!.ToCityLocality = jsonDoc.RootElement.GetProperty("to_city_locality").Deserialize(DeserializingOptions)!; newEstimateRatesRequestBody!.ToCountryCode = jsonDoc.RootElement.GetProperty("to_country_code").Deserialize(DeserializingOptions)!; newEstimateRatesRequestBody!.ToPostalCode = jsonDoc.RootElement.GetProperty("to_postal_code").Deserialize(DeserializingOptions)!; - newEstimateRatesRequestBody!.ToCityLocality = jsonDoc.RootElement.GetProperty("to_city_locality").Deserialize(DeserializingOptions)!; newEstimateRatesRequestBody!.ToStateProvince = jsonDoc.RootElement.GetProperty("to_state_province").Deserialize(DeserializingOptions)!; newEstimateRatesRequestBody!.Weight = jsonDoc.RootElement.GetProperty("weight").Deserialize(DeserializingOptions)!; - newEstimateRatesRequestBody!.Dimensions = jsonDoc.RootElement.GetProperty("dimensions").Deserialize(DeserializingOptions)!; - newEstimateRatesRequestBody!.Confirmation = jsonDoc.RootElement.GetProperty("confirmation").Deserialize(DeserializingOptions)!; newEstimateRatesRequestBody!.AddressResidentialIndicator = jsonDoc.RootElement.GetProperty("address_residential_indicator").Deserialize(DeserializingOptions)!; - newEstimateRatesRequestBody!.ShipDate = jsonDoc.RootElement.GetProperty("ship_date").Deserialize(DeserializingOptions)!; + newEstimateRatesRequestBody!.Confirmation = jsonDoc.RootElement.GetProperty("confirmation").Deserialize(DeserializingOptions)!; + newEstimateRatesRequestBody!.Dimensions = jsonDoc.RootElement.GetProperty("dimensions").Deserialize(DeserializingOptions)!; // deserialization is considered successful at this point if no exception has been thrown. return newEstimateRatesRequestBody; diff --git a/ShipEngineSDK/Model/FedexAccountSettings.cs b/ShipEngineSDK/Model/FedexAccountSettings.cs index fecfd972..ec7e6caf 100644 --- a/ShipEngineSDK/Model/FedexAccountSettings.cs +++ b/ShipEngineSDK/Model/FedexAccountSettings.cs @@ -34,39 +34,39 @@ public partial class FedexAccountSettings [JsonPropertyName("pickup_type")] public FedexPickupType? PickupType { get; set; } /// - /// Gets or Sets SmartPostHub CLOVUS - /// - [JsonPropertyName("smart_post_hub")] - public SmartPostHub? SmartPostHub { get; set; } - /// /// Gets or Sets SmartPostEndorsement CLOVUS /// [JsonPropertyName("smart_post_endorsement")] public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } /// - /// Account nickname + /// Gets or Sets SmartPostHub CLOVUS /// - /// Account nickname - [JsonPropertyName("nickname")] - public string Nickname { get; set; } - + [JsonPropertyName("smart_post_hub")] + public SmartPostHub? SmartPostHub { get; set; } /// /// Gets or Sets IsPrimaryAccount /// [JsonPropertyName("is_primary_account")] - public bool IsPrimaryAccount { get; set; } + public bool? IsPrimaryAccount { get; set; } /// - /// Gets or Sets SignatureImage + /// Gets or Sets LetterheadImage /// - [JsonPropertyName("signature_image")] - public string SignatureImage { get; set; } + [JsonPropertyName("letterhead_image")] + public string? LetterheadImage { get; set; } /// - /// Gets or Sets LetterheadImage + /// Account nickname /// - [JsonPropertyName("letterhead_image")] - public string LetterheadImage { get; set; } + /// Account nickname + [JsonPropertyName("nickname")] + public string? Nickname { get; set; } + + /// + /// Gets or Sets SignatureImage + /// + [JsonPropertyName("signature_image")] + public string? SignatureImage { get; set; } /// @@ -78,13 +78,13 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class FedexAccountSettings {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); + sb.Append(" LetterheadImage: ").Append(LetterheadImage).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" PickupType: ").Append(PickupType).Append("\n"); - sb.Append(" SmartPostHub: ").Append(SmartPostHub).Append("\n"); - sb.Append(" SmartPostEndorsement: ").Append(SmartPostEndorsement).Append("\n"); - sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); sb.Append(" SignatureImage: ").Append(SignatureImage).Append("\n"); - sb.Append(" LetterheadImage: ").Append(LetterheadImage).Append("\n"); + sb.Append(" SmartPostEndorsement: ").Append(SmartPostEndorsement).Append("\n"); + sb.Append(" SmartPostHub: ").Append(SmartPostHub).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs b/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs index 45cb0d22..a4179a67 100644 --- a/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs @@ -34,39 +34,39 @@ public partial class FedexAccountSettingsRequestBody [JsonPropertyName("pickup_type")] public FedexPickupType? PickupType { get; set; } /// - /// Gets or Sets SmartPostHub CLOVUS - /// - [JsonPropertyName("smart_post_hub")] - public SmartPostHub? SmartPostHub { get; set; } - /// /// Gets or Sets SmartPostEndorsement CLOVUS /// [JsonPropertyName("smart_post_endorsement")] public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } /// - /// Account nickname + /// Gets or Sets SmartPostHub CLOVUS /// - /// Account nickname - [JsonPropertyName("nickname")] - public string Nickname { get; set; } - + [JsonPropertyName("smart_post_hub")] + public SmartPostHub? SmartPostHub { get; set; } /// /// Gets or Sets IsPrimaryAccount /// [JsonPropertyName("is_primary_account")] - public bool IsPrimaryAccount { get; set; } + public bool? IsPrimaryAccount { get; set; } /// - /// Gets or Sets SignatureImage + /// Gets or Sets LetterheadImage /// - [JsonPropertyName("signature_image")] - public string SignatureImage { get; set; } + [JsonPropertyName("letterhead_image")] + public string? LetterheadImage { get; set; } /// - /// Gets or Sets LetterheadImage + /// Account nickname /// - [JsonPropertyName("letterhead_image")] - public string LetterheadImage { get; set; } + /// Account nickname + [JsonPropertyName("nickname")] + public string? Nickname { get; set; } + + /// + /// Gets or Sets SignatureImage + /// + [JsonPropertyName("signature_image")] + public string? SignatureImage { get; set; } /// @@ -78,13 +78,13 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class FedexAccountSettingsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); + sb.Append(" LetterheadImage: ").Append(LetterheadImage).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" PickupType: ").Append(PickupType).Append("\n"); - sb.Append(" SmartPostHub: ").Append(SmartPostHub).Append("\n"); - sb.Append(" SmartPostEndorsement: ").Append(SmartPostEndorsement).Append("\n"); - sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); sb.Append(" SignatureImage: ").Append(SignatureImage).Append("\n"); - sb.Append(" LetterheadImage: ").Append(LetterheadImage).Append("\n"); + sb.Append(" SmartPostEndorsement: ").Append(SmartPostEndorsement).Append("\n"); + sb.Append(" SmartPostHub: ").Append(SmartPostHub).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/FedexSettingsResponseBody.cs b/ShipEngineSDK/Model/FedexSettingsResponseBody.cs index da788999..e6c217e0 100644 --- a/ShipEngineSDK/Model/FedexSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/FedexSettingsResponseBody.cs @@ -34,39 +34,39 @@ public partial class FedexSettingsResponseBody [JsonPropertyName("pickup_type")] public FedexPickupType? PickupType { get; set; } /// - /// Gets or Sets SmartPostHub CLOVUS - /// - [JsonPropertyName("smart_post_hub")] - public SmartPostHub? SmartPostHub { get; set; } - /// /// Gets or Sets SmartPostEndorsement CLOVUS /// [JsonPropertyName("smart_post_endorsement")] public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } /// - /// Account nickname + /// Gets or Sets SmartPostHub CLOVUS /// - /// Account nickname - [JsonPropertyName("nickname")] - public string Nickname { get; set; } - + [JsonPropertyName("smart_post_hub")] + public SmartPostHub? SmartPostHub { get; set; } /// /// Gets or Sets IsPrimaryAccount /// [JsonPropertyName("is_primary_account")] - public bool IsPrimaryAccount { get; set; } + public bool? IsPrimaryAccount { get; set; } /// - /// Gets or Sets SignatureImage + /// Gets or Sets LetterheadImage /// - [JsonPropertyName("signature_image")] - public string SignatureImage { get; set; } + [JsonPropertyName("letterhead_image")] + public string? LetterheadImage { get; set; } /// - /// Gets or Sets LetterheadImage + /// Account nickname /// - [JsonPropertyName("letterhead_image")] - public string LetterheadImage { get; set; } + /// Account nickname + [JsonPropertyName("nickname")] + public string? Nickname { get; set; } + + /// + /// Gets or Sets SignatureImage + /// + [JsonPropertyName("signature_image")] + public string? SignatureImage { get; set; } /// @@ -78,13 +78,13 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class FedexSettingsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); + sb.Append(" LetterheadImage: ").Append(LetterheadImage).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" PickupType: ").Append(PickupType).Append("\n"); - sb.Append(" SmartPostHub: ").Append(SmartPostHub).Append("\n"); - sb.Append(" SmartPostEndorsement: ").Append(SmartPostEndorsement).Append("\n"); - sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); sb.Append(" SignatureImage: ").Append(SignatureImage).Append("\n"); - sb.Append(" LetterheadImage: ").Append(LetterheadImage).Append("\n"); + sb.Append(" SmartPostEndorsement: ").Append(SmartPostEndorsement).Append("\n"); + sb.Append(" SmartPostHub: ").Append(SmartPostHub).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs b/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs index 6eddc0ad..0c0c5049 100644 --- a/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs +++ b/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs @@ -92,24 +92,24 @@ public override bool CanConvert(Type typeToConvert) => [JsonPropertyName("image_content_type")] public ImageContentTypeEnum? ImageContentType { get; set; } /// - /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. + /// The date and time that the image was created in ShipEngine. /// - /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. + /// The date and time that the image was created in ShipEngine. /// - /// img_DtBXupDBxREpHnwEXhTfgK + /// 2018-09-23T15:00Z /// - [JsonPropertyName("label_image_id")] - public string LabelImageId { get; set; } + [JsonPropertyName("created_at")] + public DateTimeOffset? CreatedAt { get; set; } /// - /// A human readable name for the image. + /// A base64 encoded string representation of the image. /// - /// A human readable name for the image. + /// A base64 encoded string representation of the image. /// - /// My logo + /// iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg== /// - [JsonPropertyName("name")] - public string Name { get; set; } + [JsonPropertyName("image_data")] + public string? ImageData { get; set; } /// /// Indicates whether this image is set as default. @@ -119,37 +119,37 @@ public override bool CanConvert(Type typeToConvert) => /// false /// [JsonPropertyName("is_default")] - public bool IsDefault { get; set; } + public bool? IsDefault { get; set; } /// - /// A base64 encoded string representation of the image. + /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. /// - /// A base64 encoded string representation of the image. + /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. /// - /// iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg== + /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("image_data")] - public string ImageData { get; set; } + [JsonPropertyName("label_image_id")] + public string? LabelImageId { get; set; } /// - /// The date and time that the image was created in ShipEngine. + /// The date and time that the image was modified in ShipEngine. /// - /// The date and time that the image was created in ShipEngine. + /// The date and time that the image was modified in ShipEngine. /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("modified_at")] + public DateTimeOffset? ModifiedAt { get; set; } /// - /// The date and time that the image was modified in ShipEngine. + /// A human readable name for the image. /// - /// The date and time that the image was modified in ShipEngine. + /// A human readable name for the image. /// - /// 2018-09-23T15:00Z + /// My logo /// - [JsonPropertyName("modified_at")] - public DateTimeOffset ModifiedAt { get; set; } + [JsonPropertyName("name")] + public string? Name { get; set; } /// @@ -161,13 +161,13 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetAccountSettingsImagesResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); - sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" ImageContentType: ").Append(ImageContentType).Append("\n"); sb.Append(" ImageData: ").Append(ImageData).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); + sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs b/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs index c8bc28fa..eaab75df 100644 --- a/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs @@ -29,20 +29,20 @@ public partial class GetBatchByExternalIdResponseBody { /// - /// label layout CLOVUS + /// Gets or Sets LabelFormat CLOVUS /// - /// label layout - [JsonPropertyName("label_layout")] + [JsonPropertyName("label_format")] [JsonRequired] - public LabelLayout LabelLayout { get; set; } = new(); + public LabelFormat LabelFormat { get; set; } = new(); /// - /// Gets or Sets LabelFormat CLOVUS + /// label layout CLOVUS /// - [JsonPropertyName("label_format")] + /// label layout + [JsonPropertyName("label_layout")] [JsonRequired] - public LabelFormat LabelFormat { get; set; } = new(); + public LabelLayout LabelLayout { get; set; } = new(); /// @@ -53,6 +53,14 @@ public partial class GetBatchByExternalIdResponseBody public BatchStatus Status { get; set; } = new(); + /// + /// Link to batch errors endpoint + /// + /// Link to batch errors endpoint + [JsonPropertyName("batch_errors_url")] + [JsonRequired] + public OptionalLink BatchErrorsUrl { get; set; } + /// /// A string that uniquely identifies the batch /// @@ -64,6 +72,14 @@ public partial class GetBatchByExternalIdResponseBody [JsonRequired] public string BatchId { get; set; } + /// + /// Link to batch labels query + /// + /// Link to batch labels query + [JsonPropertyName("batch_labels_url")] + [JsonRequired] + public OptionalLink BatchLabelsUrl { get; set; } + /// /// The batch number. /// @@ -73,45 +89,45 @@ public partial class GetBatchByExternalIdResponseBody public string BatchNumber { get; set; } /// - /// A string that uniquely identifies the external batch + /// The batch shipments endpoint /// - /// A string that uniquely identifies the external batch - [JsonPropertyName("external_batch_id")] + /// The batch shipments endpoint + [JsonPropertyName("batch_shipments_url")] [JsonRequired] - public string ExternalBatchId { get; set; } + public OptionalLink BatchShipmentsUrl { get; set; } /// - /// Custom notes you can add for each created batch + /// The number of labels generated in the batch /// - /// Custom notes you can add for each created batch + /// The number of labels generated in the batch /// - /// Batch for morning shipment + /// 1 /// - [JsonPropertyName("batch_notes")] + [JsonPropertyName("completed")] [JsonRequired] - public string BatchNotes { get; set; } + public int Completed { get; set; } /// - /// The date and time the batch was created in ShipEngine + /// The total of errors, warnings, and completed properties /// - /// The date and time the batch was created in ShipEngine + /// The total of errors, warnings, and completed properties /// - /// 2018-09-23T15:00Z + /// 2 /// - [JsonPropertyName("created_at")] + [JsonPropertyName("count")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public int Count { get; set; } /// - /// The date and time the batch was processed in ShipEngine + /// The date and time the batch was created in ShipEngine /// - /// The date and time the batch was processed in ShipEngine + /// The date and time the batch was created in ShipEngine /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("processed_at")] + [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset ProcessedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The number of errors that occurred while generating the batch @@ -125,34 +141,12 @@ public partial class GetBatchByExternalIdResponseBody public int Errors { get; set; } /// - /// The errors associated with the failed API call - /// - /// The errors associated with the failed API call - [JsonPropertyName("process_errors")] - [JsonRequired] - public List ProcessErrors { get; set; } - - /// - /// The number of warnings that occurred while generating the batch - /// - /// The number of warnings that occurred while generating the batch - /// - /// 1 - /// - [JsonPropertyName("warnings")] - [JsonRequired] - public int Warnings { get; set; } - - /// - /// The number of labels generated in the batch + /// The form download for any customs that are needed /// - /// The number of labels generated in the batch - /// - /// 1 - /// - [JsonPropertyName("completed")] + /// The form download for any customs that are needed + [JsonPropertyName("form_download")] [JsonRequired] - public int Completed { get; set; } + public OptionalLink FormDownload { get; set; } /// /// The number of forms for customs that are available for download @@ -166,63 +160,69 @@ public partial class GetBatchByExternalIdResponseBody public int Forms { get; set; } /// - /// The total of errors, warnings, and completed properties + /// The label download for the batch /// - /// The total of errors, warnings, and completed properties - /// - /// 2 - /// - [JsonPropertyName("count")] + /// The label download for the batch + [JsonPropertyName("label_download")] [JsonRequired] - public int Count { get; set; } + public LabelDownload LabelDownload { get; set; } /// - /// The batch shipments endpoint + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// - /// The batch shipments endpoint - [JsonPropertyName("batch_shipments_url")] + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + [JsonPropertyName("paperless_download")] [JsonRequired] - public OptionalLink BatchShipmentsUrl { get; set; } + public PaperlessDownload PaperlessDownload { get; set; } /// - /// Link to batch labels query + /// The errors associated with the failed API call /// - /// Link to batch labels query - [JsonPropertyName("batch_labels_url")] + /// The errors associated with the failed API call + [JsonPropertyName("process_errors")] [JsonRequired] - public OptionalLink BatchLabelsUrl { get; set; } + public List ProcessErrors { get; set; } /// - /// Link to batch errors endpoint + /// The number of warnings that occurred while generating the batch /// - /// Link to batch errors endpoint - [JsonPropertyName("batch_errors_url")] + /// The number of warnings that occurred while generating the batch + /// + /// 1 + /// + [JsonPropertyName("warnings")] [JsonRequired] - public OptionalLink BatchErrorsUrl { get; set; } + public int Warnings { get; set; } /// - /// The label download for the batch + /// Custom notes you can add for each created batch /// - /// The label download for the batch - [JsonPropertyName("label_download")] + /// Custom notes you can add for each created batch + /// + /// Batch for morning shipment + /// + [JsonPropertyName("batch_notes")] [JsonRequired] - public LabelDownload LabelDownload { get; set; } + public string BatchNotes { get; set; } /// - /// The form download for any customs that are needed + /// A string that uniquely identifies the external batch /// - /// The form download for any customs that are needed - [JsonPropertyName("form_download")] + /// A string that uniquely identifies the external batch + [JsonPropertyName("external_batch_id")] [JsonRequired] - public OptionalLink FormDownload { get; set; } + public string ExternalBatchId { get; set; } /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// The date and time the batch was processed in ShipEngine /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] + /// The date and time the batch was processed in ShipEngine + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("processed_at")] [JsonRequired] - public PaperlessDownload PaperlessDownload { get; set; } + public DateTimeOffset ProcessedAt { get; set; } /// @@ -234,27 +234,27 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetBatchByExternalIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); - sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" BatchErrorsUrl: ").Append(BatchErrorsUrl).Append("\n"); sb.Append(" BatchId: ").Append(BatchId).Append("\n"); + sb.Append(" BatchLabelsUrl: ").Append(BatchLabelsUrl).Append("\n"); sb.Append(" BatchNumber: ").Append(BatchNumber).Append("\n"); - sb.Append(" ExternalBatchId: ").Append(ExternalBatchId).Append("\n"); - sb.Append(" BatchNotes: ").Append(BatchNotes).Append("\n"); + sb.Append(" BatchShipmentsUrl: ").Append(BatchShipmentsUrl).Append("\n"); + sb.Append(" Completed: ").Append(Completed).Append("\n"); + sb.Append(" Count: ").Append(Count).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); - sb.Append(" ProcessedAt: ").Append(ProcessedAt).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); - sb.Append(" ProcessErrors: ").Append(ProcessErrors).Append("\n"); - sb.Append(" Warnings: ").Append(Warnings).Append("\n"); - sb.Append(" Completed: ").Append(Completed).Append("\n"); + sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); sb.Append(" Forms: ").Append(Forms).Append("\n"); - sb.Append(" Count: ").Append(Count).Append("\n"); - sb.Append(" BatchShipmentsUrl: ").Append(BatchShipmentsUrl).Append("\n"); - sb.Append(" BatchLabelsUrl: ").Append(BatchLabelsUrl).Append("\n"); - sb.Append(" BatchErrorsUrl: ").Append(BatchErrorsUrl).Append("\n"); sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); - sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); + sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" ProcessErrors: ").Append(ProcessErrors).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); + sb.Append(" Warnings: ").Append(Warnings).Append("\n"); + sb.Append(" BatchNotes: ").Append(BatchNotes).Append("\n"); + sb.Append(" ExternalBatchId: ").Append(ExternalBatchId).Append("\n"); + sb.Append(" ProcessedAt: ").Append(ProcessedAt).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs b/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs index 43f66802..bd387689 100644 --- a/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs @@ -29,20 +29,20 @@ public partial class GetBatchByIdResponseBody { /// - /// label layout CLOVUS + /// Gets or Sets LabelFormat CLOVUS /// - /// label layout - [JsonPropertyName("label_layout")] + [JsonPropertyName("label_format")] [JsonRequired] - public LabelLayout LabelLayout { get; set; } = new(); + public LabelFormat LabelFormat { get; set; } = new(); /// - /// Gets or Sets LabelFormat CLOVUS + /// label layout CLOVUS /// - [JsonPropertyName("label_format")] + /// label layout + [JsonPropertyName("label_layout")] [JsonRequired] - public LabelFormat LabelFormat { get; set; } = new(); + public LabelLayout LabelLayout { get; set; } = new(); /// @@ -53,6 +53,14 @@ public partial class GetBatchByIdResponseBody public BatchStatus Status { get; set; } = new(); + /// + /// Link to batch errors endpoint + /// + /// Link to batch errors endpoint + [JsonPropertyName("batch_errors_url")] + [JsonRequired] + public OptionalLink BatchErrorsUrl { get; set; } + /// /// A string that uniquely identifies the batch /// @@ -64,6 +72,14 @@ public partial class GetBatchByIdResponseBody [JsonRequired] public string BatchId { get; set; } + /// + /// Link to batch labels query + /// + /// Link to batch labels query + [JsonPropertyName("batch_labels_url")] + [JsonRequired] + public OptionalLink BatchLabelsUrl { get; set; } + /// /// The batch number. /// @@ -73,45 +89,45 @@ public partial class GetBatchByIdResponseBody public string BatchNumber { get; set; } /// - /// A string that uniquely identifies the external batch + /// The batch shipments endpoint /// - /// A string that uniquely identifies the external batch - [JsonPropertyName("external_batch_id")] + /// The batch shipments endpoint + [JsonPropertyName("batch_shipments_url")] [JsonRequired] - public string ExternalBatchId { get; set; } + public OptionalLink BatchShipmentsUrl { get; set; } /// - /// Custom notes you can add for each created batch + /// The number of labels generated in the batch /// - /// Custom notes you can add for each created batch + /// The number of labels generated in the batch /// - /// Batch for morning shipment + /// 1 /// - [JsonPropertyName("batch_notes")] + [JsonPropertyName("completed")] [JsonRequired] - public string BatchNotes { get; set; } + public int Completed { get; set; } /// - /// The date and time the batch was created in ShipEngine + /// The total of errors, warnings, and completed properties /// - /// The date and time the batch was created in ShipEngine + /// The total of errors, warnings, and completed properties /// - /// 2018-09-23T15:00Z + /// 2 /// - [JsonPropertyName("created_at")] + [JsonPropertyName("count")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public int Count { get; set; } /// - /// The date and time the batch was processed in ShipEngine + /// The date and time the batch was created in ShipEngine /// - /// The date and time the batch was processed in ShipEngine + /// The date and time the batch was created in ShipEngine /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("processed_at")] + [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset ProcessedAt { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// The number of errors that occurred while generating the batch @@ -125,34 +141,12 @@ public partial class GetBatchByIdResponseBody public int Errors { get; set; } /// - /// The errors associated with the failed API call - /// - /// The errors associated with the failed API call - [JsonPropertyName("process_errors")] - [JsonRequired] - public List ProcessErrors { get; set; } - - /// - /// The number of warnings that occurred while generating the batch - /// - /// The number of warnings that occurred while generating the batch - /// - /// 1 - /// - [JsonPropertyName("warnings")] - [JsonRequired] - public int Warnings { get; set; } - - /// - /// The number of labels generated in the batch + /// The form download for any customs that are needed /// - /// The number of labels generated in the batch - /// - /// 1 - /// - [JsonPropertyName("completed")] + /// The form download for any customs that are needed + [JsonPropertyName("form_download")] [JsonRequired] - public int Completed { get; set; } + public OptionalLink FormDownload { get; set; } /// /// The number of forms for customs that are available for download @@ -166,63 +160,69 @@ public partial class GetBatchByIdResponseBody public int Forms { get; set; } /// - /// The total of errors, warnings, and completed properties + /// The label download for the batch /// - /// The total of errors, warnings, and completed properties - /// - /// 2 - /// - [JsonPropertyName("count")] + /// The label download for the batch + [JsonPropertyName("label_download")] [JsonRequired] - public int Count { get; set; } + public LabelDownload LabelDownload { get; set; } /// - /// The batch shipments endpoint + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// - /// The batch shipments endpoint - [JsonPropertyName("batch_shipments_url")] + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + [JsonPropertyName("paperless_download")] [JsonRequired] - public OptionalLink BatchShipmentsUrl { get; set; } + public PaperlessDownload PaperlessDownload { get; set; } /// - /// Link to batch labels query + /// The errors associated with the failed API call /// - /// Link to batch labels query - [JsonPropertyName("batch_labels_url")] + /// The errors associated with the failed API call + [JsonPropertyName("process_errors")] [JsonRequired] - public OptionalLink BatchLabelsUrl { get; set; } + public List ProcessErrors { get; set; } /// - /// Link to batch errors endpoint + /// The number of warnings that occurred while generating the batch /// - /// Link to batch errors endpoint - [JsonPropertyName("batch_errors_url")] + /// The number of warnings that occurred while generating the batch + /// + /// 1 + /// + [JsonPropertyName("warnings")] [JsonRequired] - public OptionalLink BatchErrorsUrl { get; set; } + public int Warnings { get; set; } /// - /// The label download for the batch + /// Custom notes you can add for each created batch /// - /// The label download for the batch - [JsonPropertyName("label_download")] + /// Custom notes you can add for each created batch + /// + /// Batch for morning shipment + /// + [JsonPropertyName("batch_notes")] [JsonRequired] - public LabelDownload LabelDownload { get; set; } + public string BatchNotes { get; set; } /// - /// The form download for any customs that are needed + /// A string that uniquely identifies the external batch /// - /// The form download for any customs that are needed - [JsonPropertyName("form_download")] + /// A string that uniquely identifies the external batch + [JsonPropertyName("external_batch_id")] [JsonRequired] - public OptionalLink FormDownload { get; set; } + public string ExternalBatchId { get; set; } /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// The date and time the batch was processed in ShipEngine /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] + /// The date and time the batch was processed in ShipEngine + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("processed_at")] [JsonRequired] - public PaperlessDownload PaperlessDownload { get; set; } + public DateTimeOffset ProcessedAt { get; set; } /// @@ -234,27 +234,27 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetBatchByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); - sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" BatchErrorsUrl: ").Append(BatchErrorsUrl).Append("\n"); sb.Append(" BatchId: ").Append(BatchId).Append("\n"); + sb.Append(" BatchLabelsUrl: ").Append(BatchLabelsUrl).Append("\n"); sb.Append(" BatchNumber: ").Append(BatchNumber).Append("\n"); - sb.Append(" ExternalBatchId: ").Append(ExternalBatchId).Append("\n"); - sb.Append(" BatchNotes: ").Append(BatchNotes).Append("\n"); + sb.Append(" BatchShipmentsUrl: ").Append(BatchShipmentsUrl).Append("\n"); + sb.Append(" Completed: ").Append(Completed).Append("\n"); + sb.Append(" Count: ").Append(Count).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); - sb.Append(" ProcessedAt: ").Append(ProcessedAt).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); - sb.Append(" ProcessErrors: ").Append(ProcessErrors).Append("\n"); - sb.Append(" Warnings: ").Append(Warnings).Append("\n"); - sb.Append(" Completed: ").Append(Completed).Append("\n"); + sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); sb.Append(" Forms: ").Append(Forms).Append("\n"); - sb.Append(" Count: ").Append(Count).Append("\n"); - sb.Append(" BatchShipmentsUrl: ").Append(BatchShipmentsUrl).Append("\n"); - sb.Append(" BatchLabelsUrl: ").Append(BatchLabelsUrl).Append("\n"); - sb.Append(" BatchErrorsUrl: ").Append(BatchErrorsUrl).Append("\n"); sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); - sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); + sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" ProcessErrors: ").Append(ProcessErrors).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); + sb.Append(" Warnings: ").Append(Warnings).Append("\n"); + sb.Append(" BatchNotes: ").Append(BatchNotes).Append("\n"); + sb.Append(" ExternalBatchId: ").Append(ExternalBatchId).Append("\n"); + sb.Append(" ProcessedAt: ").Append(ProcessedAt).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs b/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs index 0b7faca8..f6532fbb 100644 --- a/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs @@ -29,14 +29,24 @@ public partial class GetCarrierByIdResponseBody { /// - /// A string that uniquely identifies the carrier. + /// The account number that the carrier is connected to. /// - /// A string that uniquely identifies the carrier. + /// The account number that the carrier is connected to. /// - /// se-28529731 + /// account_570827 /// - [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + [JsonPropertyName("account_number")] + public string? AccountNumber { get; set; } + + /// + /// Current available balance + /// + /// Current available balance + /// + /// 3799.52 + /// + [JsonPropertyName("balance")] + public double? Balance { get; set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. @@ -46,34 +56,41 @@ public partial class GetCarrierByIdResponseBody /// dhl_express /// [JsonPropertyName("carrier_code")] - public string CarrierCode { get; set; } + public string? CarrierCode { get; set; } /// - /// The account number that the carrier is connected to. + /// A string that uniquely identifies the carrier. /// - /// The account number that the carrier is connected to. + /// A string that uniquely identifies the carrier. /// - /// account_570827 + /// se-28529731 /// - [JsonPropertyName("account_number")] - public string AccountNumber { get; set; } + [JsonPropertyName("carrier_id")] + public string? CarrierId { get; set; } /// - /// Indicates whether the carrier requires funding to use its services + /// The carrier is disabled by the current ShipEngine account's billing plan. /// - /// Indicates whether the carrier requires funding to use its services - [JsonPropertyName("requires_funded_amount")] - public bool RequiresFundedAmount { get; set; } + /// The carrier is disabled by the current ShipEngine account's billing plan. + [JsonPropertyName("disabled_by_billing_plan")] + public bool? DisabledByBillingPlan { get; set; } /// - /// Current available balance + /// Screen readable name /// - /// Current available balance + /// Screen readable name /// - /// 3799.52 + /// Stamps.com /// - [JsonPropertyName("balance")] - public double Balance { get; set; } + [JsonPropertyName("friendly_name")] + public string? FriendlyName { get; set; } + + /// + /// Carrier supports multiple packages per shipment + /// + /// Carrier supports multiple packages per shipment + [JsonPropertyName("has_multi_package_supporting_services")] + public bool? HasMultiPackageSupportingServices { get; set; } /// /// Nickname given to the account when initially setting up the carrier. @@ -83,66 +100,49 @@ public partial class GetCarrierByIdResponseBody /// ShipEngine Account - Stamps.com /// [JsonPropertyName("nickname")] - public string Nickname { get; set; } - - /// - /// Screen readable name - /// - /// Screen readable name - /// - /// Stamps.com - /// - [JsonPropertyName("friendly_name")] - public string FriendlyName { get; set; } + public string? Nickname { get; set; } /// - /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation + /// A list of options that are available to that carrier /// - /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation - [JsonPropertyName("primary")] - public bool Primary { get; set; } + /// A list of options that are available to that carrier + [JsonPropertyName("options")] + public List? Options { get; set; } /// - /// Carrier supports multiple packages per shipment + /// A list of package types that are supported by the carrier /// - /// Carrier supports multiple packages per shipment - [JsonPropertyName("has_multi_package_supporting_services")] - public bool HasMultiPackageSupportingServices { get; set; } + /// A list of package types that are supported by the carrier + [JsonPropertyName("packages")] + public List? Packages { get; set; } /// - /// The carrier supports adding custom label messages to an order. + /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation /// - /// The carrier supports adding custom label messages to an order. - [JsonPropertyName("supports_label_messages")] - public bool SupportsLabelMessages { get; set; } + /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation + [JsonPropertyName("primary")] + public bool? Primary { get; set; } /// - /// The carrier is disabled by the current ShipEngine account's billing plan. + /// Indicates whether the carrier requires funding to use its services /// - /// The carrier is disabled by the current ShipEngine account's billing plan. - [JsonPropertyName("disabled_by_billing_plan")] - public bool DisabledByBillingPlan { get; set; } + /// Indicates whether the carrier requires funding to use its services + [JsonPropertyName("requires_funded_amount")] + public bool? RequiresFundedAmount { get; set; } /// /// A list of services that are offered by the carrier /// /// A list of services that are offered by the carrier [JsonPropertyName("services")] - public List Services { get; set; } - - /// - /// A list of package types that are supported by the carrier - /// - /// A list of package types that are supported by the carrier - [JsonPropertyName("packages")] - public List Packages { get; set; } + public List? Services { get; set; } /// - /// A list of options that are available to that carrier + /// The carrier supports adding custom label messages to an order. /// - /// A list of options that are available to that carrier - [JsonPropertyName("options")] - public List Options { get; set; } + /// The carrier supports adding custom label messages to an order. + [JsonPropertyName("supports_label_messages")] + public bool? SupportsLabelMessages { get; set; } /// @@ -154,20 +154,20 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetCarrierByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); - sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); - sb.Append(" RequiresFundedAmount: ").Append(RequiresFundedAmount).Append("\n"); sb.Append(" Balance: ").Append(Balance).Append("\n"); - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); + sb.Append(" DisabledByBillingPlan: ").Append(DisabledByBillingPlan).Append("\n"); sb.Append(" FriendlyName: ").Append(FriendlyName).Append("\n"); - sb.Append(" Primary: ").Append(Primary).Append("\n"); sb.Append(" HasMultiPackageSupportingServices: ").Append(HasMultiPackageSupportingServices).Append("\n"); - sb.Append(" SupportsLabelMessages: ").Append(SupportsLabelMessages).Append("\n"); - sb.Append(" DisabledByBillingPlan: ").Append(DisabledByBillingPlan).Append("\n"); - sb.Append(" Services: ").Append(Services).Append("\n"); - sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" Options: ").Append(Options).Append("\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" Primary: ").Append(Primary).Append("\n"); + sb.Append(" RequiresFundedAmount: ").Append(RequiresFundedAmount).Append("\n"); + sb.Append(" Services: ").Append(Services).Append("\n"); + sb.Append(" SupportsLabelMessages: ").Append(SupportsLabelMessages).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs b/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs index 6ddb66d7..42b00199 100644 --- a/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs @@ -33,7 +33,7 @@ public partial class GetCarrierOptionsResponseBody /// /// AN array of carrier options [JsonPropertyName("options")] - public List Options { get; set; } + public List? Options { get; set; } /// diff --git a/ShipEngineSDK/Model/GetCarriersResponseBody.cs b/ShipEngineSDK/Model/GetCarriersResponseBody.cs index 5cd42046..2f98bb4b 100644 --- a/ShipEngineSDK/Model/GetCarriersResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarriersResponseBody.cs @@ -36,6 +36,14 @@ public partial class GetCarriersResponseBody [JsonRequired] public List Carriers { get; set; } + /// + /// The errors associated with the failed API call + /// + /// The errors associated with the failed API call + [JsonPropertyName("errors")] + [JsonRequired] + public List Errors { get; set; } + /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur /// @@ -47,14 +55,6 @@ public partial class GetCarriersResponseBody [JsonRequired] public Guid RequestId { get; set; } - /// - /// The errors associated with the failed API call - /// - /// The errors associated with the failed API call - [JsonPropertyName("errors")] - [JsonRequired] - public List Errors { get; set; } - /// /// Returns the string presentation of the object @@ -66,8 +66,8 @@ public override string ToString() sb.Append("class GetCarriersResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Carriers: ").Append(Carriers).Append("\n"); - sb.Append(" RequestId: ").Append(RequestId).Append("\n"); sb.Append(" Errors: ").Append(Errors).Append("\n"); + sb.Append(" RequestId: ").Append(RequestId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs b/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs index 0bea8563..cdee4650 100644 --- a/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs +++ b/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs @@ -28,14 +28,6 @@ namespace ShipEngineSDK.Model; public partial class GetInsuranceBalanceResponseBody { - /// - /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - /// - /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("currency")] - [JsonRequired] - public string Currency { get; set; } - /// /// The monetary amount, in the specified currency. /// @@ -44,6 +36,14 @@ public partial class GetInsuranceBalanceResponseBody [JsonRequired] public double Amount { get; set; } + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + [JsonPropertyName("currency")] + [JsonRequired] + public string Currency { get; set; } + /// /// Returns the string presentation of the object @@ -54,8 +54,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetInsuranceBalanceResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Currency: ").Append(Currency).Append("\n"); sb.Append(" Amount: ").Append(Amount).Append("\n"); + sb.Append(" Currency: ").Append(Currency).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs index eedddfde..070f724d 100644 --- a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs @@ -28,11 +28,6 @@ namespace ShipEngineSDK.Model; public partial class GetLabelByExternalShipmentIdResponseBody { - /// - /// Gets or Sets Status CLOVUS - /// - [JsonPropertyName("status")] - public LabelStatus? Status { get; set; } /// /// The label charge event. CLOVUS /// @@ -40,10 +35,11 @@ public partial class GetLabelByExternalShipmentIdResponseBody [JsonPropertyName("charge_event")] public LabelChargeEvent? ChargeEvent { get; set; } /// - /// Gets or Sets ValidateAddress CLOVUS + /// The display format that the label should be shown in. CLOVUS /// - [JsonPropertyName("validate_address")] - public ValidateAddress? ValidateAddress { get; set; } + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme")] + public DisplayScheme? DisplayScheme { get; set; } /// /// Gets or Sets LabelDownloadType CLOVUS /// @@ -56,59 +52,63 @@ public partial class GetLabelByExternalShipmentIdResponseBody [JsonPropertyName("label_format")] public LabelFormat? LabelFormat { get; set; } /// - /// The display format that the label should be shown in. CLOVUS - /// - /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] - public DisplayScheme? DisplayScheme { 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. CLOVUS /// /// 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")] public LabelLayout? LabelLayout { get; set; } /// + /// Gets or Sets Status CLOVUS + /// + [JsonPropertyName("status")] + public LabelStatus? Status { get; set; } + /// /// The current status of the package, such as `in_transit` or `delivered` CLOVUS /// /// The current status of the package, such as `in_transit` or `delivered` [JsonPropertyName("tracking_status")] public TrackingStatus? TrackingStatus { get; set; } /// - /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. + /// Gets or Sets ValidateAddress CLOVUS /// - /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. - /// - /// se-28529731 - /// - [JsonPropertyName("label_id")] - public string LabelId { get; set; } + [JsonPropertyName("validate_address")] + public ValidateAddress? ValidateAddress { get; set; } + /// + /// Additional information some carriers may provide by which to identify a given label in their system. + /// + /// Additional information some carriers may provide by which to identify a given label in their system. + [JsonPropertyName("alternative_identifiers")] + public List? AlternativeIdentifiers { get; set; } /// - /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// - /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string ShipmentId { get; set; } + [JsonPropertyName("batch_id")] + public string? BatchId { get; set; } /// - /// The shipment information used to generate the label + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. /// - /// The shipment information used to generate the label - [JsonPropertyName("shipment")] - public Shipment Shipment { get; set; } + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// dhl_express + /// + [JsonPropertyName("carrier_code")] + public string? CarrierCode { get; set; } /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// - /// 2018-09-23T00:00Z + /// se-28529731 /// - [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + [JsonPropertyName("carrier_id")] + public string? CarrierId { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -118,79 +118,68 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + public DateTimeOffset? CreatedAt { get; set; } /// - /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + /// 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. /// - /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - [JsonPropertyName("shipment_cost")] - public MonetaryValue ShipmentCost { 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. + [JsonPropertyName("form_download")] + public Link? FormDownload { get; set; } /// - /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + /// 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. /// - /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. - [JsonPropertyName("insurance_cost")] - public MonetaryValue InsuranceCost { get; set; } + /// 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. + [JsonPropertyName("insurance_claim")] + public Link? InsuranceClaim { get; set; } /// - /// The total shipping cost for the specified comparison_rate_type. + /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// - /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue RequestedComparisonAmount { get; set; } + /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + [JsonPropertyName("insurance_cost")] + public MonetaryValue? InsuranceCost { get; set; } /// - /// The tracking number for the package. Tracking number formats vary across carriers. + /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// - /// The tracking number for the package. Tracking number formats vary across carriers. - /// - /// 782758401696 - /// - [JsonPropertyName("tracking_number")] - public string TrackingNumber { get; set; } + /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + [JsonPropertyName("is_international")] + public bool? IsInternational { get; set; } /// /// 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")] - public bool IsReturnLabel { get; set; } - - /// - /// 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")] - public string RmaNumber { get; set; } + public bool? IsReturnLabel { get; set; } /// - /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + /// Gets or Sets LabelDownload /// - /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. - [JsonPropertyName("is_international")] - public bool IsInternational { get; set; } + [JsonPropertyName("label_download")] + public LabelDownload? LabelDownload { get; set; } /// - /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// - /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - public string BatchId { get; set; } + [JsonPropertyName("label_id")] + public string? LabelId { get; set; } /// - /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// The label image resource that was used to create a custom label image. /// - /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// The label image resource that was used to create a custom label image. /// - /// se-28529731 + /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + [JsonPropertyName("label_image_id")] + public string? LabelImageId { get; set; } /// /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. @@ -200,25 +189,7 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// se-28529731 /// [JsonPropertyName("outbound_label_id")] - public string OutboundLabelId { get; set; } - - /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. - /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. - /// - /// usps_first_class_mail - /// - [JsonPropertyName("service_code")] - public string ServiceCode { 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")] - [Obsolete] - public bool TestLabel { get; set; } + public string? OutboundLabelId { get; set; } /// /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. @@ -228,92 +199,104 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// small_flat_rate_box /// [JsonPropertyName("package_code")] - public string PackageCode { get; set; } + public string? PackageCode { get; set; } /// - /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// - /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) - [JsonPropertyName("voided")] - public bool Voided { get; set; } + /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + [JsonPropertyName("packages")] + public List? Packages { get; set; } /// - /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// - /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("voided_at")] - public DateTimeOffset VoidedAt { get; set; } + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + [JsonPropertyName("paperless_download")] + public PaperlessDownload? PaperlessDownload { get; set; } /// - /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + /// The total shipping cost for the specified comparison_rate_type. /// - /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. - [JsonPropertyName("trackable")] - public bool Trackable { get; set; } + /// The total shipping cost for the specified comparison_rate_type. + [JsonPropertyName("requested_comparison_amount")] + public MonetaryValue? RequestedComparisonAmount { get; set; } /// - /// The label image resource that was used to create a custom label image. + /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. /// - /// The label image resource that was used to create a custom label image. + /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. + [JsonPropertyName("rma_number")] + public string? RmaNumber { get; set; } + + /// + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// - /// img_DtBXupDBxREpHnwEXhTfgK + /// usps_first_class_mail /// - [JsonPropertyName("label_image_id")] - public string LabelImageId { get; set; } + [JsonPropertyName("service_code")] + public string? ServiceCode { get; set; } /// - /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// dhl_express + /// 2018-09-23T00:00Z /// - [JsonPropertyName("carrier_code")] - public string CarrierCode { get; set; } + [JsonPropertyName("ship_date")] + public DateTimeOffset? ShipDate { get; set; } /// - /// Gets or Sets LabelDownload + /// The shipment information used to generate the label /// - [JsonPropertyName("label_download")] - public LabelDownload LabelDownload { get; set; } + /// The shipment information used to generate the label + [JsonPropertyName("shipment")] + public Shipment? Shipment { 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. + /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// - /// 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. - [JsonPropertyName("form_download")] - public Link FormDownload { get; set; } + /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + [JsonPropertyName("shipment_cost")] + public MonetaryValue? ShipmentCost { get; set; } /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - public PaperlessDownload PaperlessDownload { get; set; } + /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// + /// se-28529731 + /// + [JsonPropertyName("shipment_id")] + public string? ShipmentId { get; set; } /// - /// 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. + /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. /// - /// 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. - [JsonPropertyName("insurance_claim")] - public Link InsuranceClaim { get; set; } + /// 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")] + [Obsolete] + public bool? TestLabel { get; set; } /// - /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// - /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - public List Packages { get; set; } + /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + [JsonPropertyName("trackable")] + public bool? Trackable { get; set; } /// - /// Additional information some carriers may provide by which to identify a given label in their system. + /// The tracking number for the package. Tracking number formats vary across carriers. /// - /// Additional information some carriers may provide by which to identify a given label in their system. - [JsonPropertyName("alternative_identifiers")] - public List AlternativeIdentifiers { get; set; } + /// The tracking number for the package. Tracking number formats vary across carriers. + /// + /// 782758401696 + /// + [JsonPropertyName("tracking_number")] + public string? TrackingNumber { get; set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. @@ -323,7 +306,24 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url")] - public string TrackingUrl { get; set; } + public string? TrackingUrl { get; set; } + + /// + /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// + /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + [JsonPropertyName("voided")] + public bool? Voided { get; set; } + + /// + /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("voided_at")] + public DateTimeOffset? VoidedAt { get; set; } /// @@ -335,44 +335,44 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetLabelByExternalShipmentIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" LabelId: ").Append(LabelId).Append("\n"); - sb.Append(" Status: ").Append(Status).Append("\n"); - sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); - sb.Append(" Shipment: ").Append(Shipment).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); - sb.Append(" ShipmentCost: ").Append(ShipmentCost).Append("\n"); - sb.Append(" InsuranceCost: ").Append(InsuranceCost).Append("\n"); - sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); - sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); - sb.Append(" IsReturnLabel: ").Append(IsReturnLabel).Append("\n"); - sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); - sb.Append(" IsInternational: ").Append(IsInternational).Append("\n"); + sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" BatchId: ").Append(BatchId).Append("\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); - sb.Append(" OutboundLabelId: ").Append(OutboundLabelId).Append("\n"); - sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); - sb.Append(" TestLabel: ").Append(TestLabel).Append("\n"); - sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); - sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); - sb.Append(" Voided: ").Append(Voided).Append("\n"); - sb.Append(" VoidedAt: ").Append(VoidedAt).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); + sb.Append(" InsuranceClaim: ").Append(InsuranceClaim).Append("\n"); + sb.Append(" InsuranceCost: ").Append(InsuranceCost).Append("\n"); + sb.Append(" IsInternational: ").Append(IsInternational).Append("\n"); + sb.Append(" IsReturnLabel: ").Append(IsReturnLabel).Append("\n"); + sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); - sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" LabelId: ").Append(LabelId).Append("\n"); + sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); + sb.Append(" OutboundLabelId: ").Append(OutboundLabelId).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); + sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); + sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" Shipment: ").Append(Shipment).Append("\n"); + sb.Append(" ShipmentCost: ").Append(ShipmentCost).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" Status: ").Append(Status).Append("\n"); + sb.Append(" TestLabel: ").Append(TestLabel).Append("\n"); sb.Append(" Trackable: ").Append(Trackable).Append("\n"); - sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); - sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); sb.Append(" TrackingStatus: ").Append(TrackingStatus).Append("\n"); - sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); - sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); - sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); - sb.Append(" InsuranceClaim: ").Append(InsuranceClaim).Append("\n"); - sb.Append(" Packages: ").Append(Packages).Append("\n"); - sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); + sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); + sb.Append(" Voided: ").Append(Voided).Append("\n"); + sb.Append(" VoidedAt: ").Append(VoidedAt).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs index cd61a72f..b704b444 100644 --- a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs @@ -28,11 +28,6 @@ namespace ShipEngineSDK.Model; public partial class GetLabelByIdResponseBody { - /// - /// Gets or Sets Status CLOVUS - /// - [JsonPropertyName("status")] - public LabelStatus? Status { get; set; } /// /// The label charge event. CLOVUS /// @@ -40,10 +35,11 @@ public partial class GetLabelByIdResponseBody [JsonPropertyName("charge_event")] public LabelChargeEvent? ChargeEvent { get; set; } /// - /// Gets or Sets ValidateAddress CLOVUS + /// The display format that the label should be shown in. CLOVUS /// - [JsonPropertyName("validate_address")] - public ValidateAddress? ValidateAddress { get; set; } + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme")] + public DisplayScheme? DisplayScheme { get; set; } /// /// Gets or Sets LabelDownloadType CLOVUS /// @@ -56,59 +52,63 @@ public partial class GetLabelByIdResponseBody [JsonPropertyName("label_format")] public LabelFormat? LabelFormat { get; set; } /// - /// The display format that the label should be shown in. CLOVUS - /// - /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] - public DisplayScheme? DisplayScheme { 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. CLOVUS /// /// 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")] public LabelLayout? LabelLayout { get; set; } /// + /// Gets or Sets Status CLOVUS + /// + [JsonPropertyName("status")] + public LabelStatus? Status { get; set; } + /// /// The current status of the package, such as `in_transit` or `delivered` CLOVUS /// /// The current status of the package, such as `in_transit` or `delivered` [JsonPropertyName("tracking_status")] public TrackingStatus? TrackingStatus { get; set; } /// - /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. + /// Gets or Sets ValidateAddress CLOVUS /// - /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. - /// - /// se-28529731 - /// - [JsonPropertyName("label_id")] - public string LabelId { get; set; } + [JsonPropertyName("validate_address")] + public ValidateAddress? ValidateAddress { get; set; } + /// + /// Additional information some carriers may provide by which to identify a given label in their system. + /// + /// Additional information some carriers may provide by which to identify a given label in their system. + [JsonPropertyName("alternative_identifiers")] + public List? AlternativeIdentifiers { get; set; } /// - /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// - /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string ShipmentId { get; set; } + [JsonPropertyName("batch_id")] + public string? BatchId { get; set; } /// - /// The shipment information used to generate the label + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. /// - /// The shipment information used to generate the label - [JsonPropertyName("shipment")] - public Shipment Shipment { get; set; } + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// dhl_express + /// + [JsonPropertyName("carrier_code")] + public string? CarrierCode { get; set; } /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// - /// 2018-09-23T00:00Z + /// se-28529731 /// - [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + [JsonPropertyName("carrier_id")] + public string? CarrierId { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -118,79 +118,68 @@ public partial class GetLabelByIdResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + public DateTimeOffset? CreatedAt { get; set; } /// - /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + /// 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. /// - /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - [JsonPropertyName("shipment_cost")] - public MonetaryValue ShipmentCost { 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. + [JsonPropertyName("form_download")] + public Link? FormDownload { get; set; } /// - /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + /// 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. /// - /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. - [JsonPropertyName("insurance_cost")] - public MonetaryValue InsuranceCost { get; set; } + /// 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. + [JsonPropertyName("insurance_claim")] + public Link? InsuranceClaim { get; set; } /// - /// The total shipping cost for the specified comparison_rate_type. + /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// - /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue RequestedComparisonAmount { get; set; } + /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + [JsonPropertyName("insurance_cost")] + public MonetaryValue? InsuranceCost { get; set; } /// - /// The tracking number for the package. Tracking number formats vary across carriers. + /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// - /// The tracking number for the package. Tracking number formats vary across carriers. - /// - /// 782758401696 - /// - [JsonPropertyName("tracking_number")] - public string TrackingNumber { get; set; } + /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + [JsonPropertyName("is_international")] + public bool? IsInternational { get; set; } /// /// 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")] - public bool IsReturnLabel { get; set; } - - /// - /// 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")] - public string RmaNumber { get; set; } + public bool? IsReturnLabel { get; set; } /// - /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + /// Gets or Sets LabelDownload /// - /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. - [JsonPropertyName("is_international")] - public bool IsInternational { get; set; } + [JsonPropertyName("label_download")] + public LabelDownload? LabelDownload { get; set; } /// - /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// - /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - public string BatchId { get; set; } + [JsonPropertyName("label_id")] + public string? LabelId { get; set; } /// - /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// The label image resource that was used to create a custom label image. /// - /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// The label image resource that was used to create a custom label image. /// - /// se-28529731 + /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + [JsonPropertyName("label_image_id")] + public string? LabelImageId { get; set; } /// /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. @@ -200,25 +189,7 @@ public partial class GetLabelByIdResponseBody /// se-28529731 /// [JsonPropertyName("outbound_label_id")] - public string OutboundLabelId { get; set; } - - /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. - /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. - /// - /// usps_first_class_mail - /// - [JsonPropertyName("service_code")] - public string ServiceCode { 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")] - [Obsolete] - public bool TestLabel { get; set; } + public string? OutboundLabelId { get; set; } /// /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. @@ -228,92 +199,104 @@ public partial class GetLabelByIdResponseBody /// small_flat_rate_box /// [JsonPropertyName("package_code")] - public string PackageCode { get; set; } + public string? PackageCode { get; set; } /// - /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// - /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) - [JsonPropertyName("voided")] - public bool Voided { get; set; } + /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + [JsonPropertyName("packages")] + public List? Packages { get; set; } /// - /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// - /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("voided_at")] - public DateTimeOffset VoidedAt { get; set; } + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + [JsonPropertyName("paperless_download")] + public PaperlessDownload? PaperlessDownload { get; set; } /// - /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + /// The total shipping cost for the specified comparison_rate_type. /// - /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. - [JsonPropertyName("trackable")] - public bool Trackable { get; set; } + /// The total shipping cost for the specified comparison_rate_type. + [JsonPropertyName("requested_comparison_amount")] + public MonetaryValue? RequestedComparisonAmount { get; set; } /// - /// The label image resource that was used to create a custom label image. + /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. /// - /// The label image resource that was used to create a custom label image. + /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. + [JsonPropertyName("rma_number")] + public string? RmaNumber { get; set; } + + /// + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// - /// img_DtBXupDBxREpHnwEXhTfgK + /// usps_first_class_mail /// - [JsonPropertyName("label_image_id")] - public string LabelImageId { get; set; } + [JsonPropertyName("service_code")] + public string? ServiceCode { get; set; } /// - /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// dhl_express + /// 2018-09-23T00:00Z /// - [JsonPropertyName("carrier_code")] - public string CarrierCode { get; set; } + [JsonPropertyName("ship_date")] + public DateTimeOffset? ShipDate { get; set; } /// - /// Gets or Sets LabelDownload + /// The shipment information used to generate the label /// - [JsonPropertyName("label_download")] - public LabelDownload LabelDownload { get; set; } + /// The shipment information used to generate the label + [JsonPropertyName("shipment")] + public Shipment? Shipment { 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. + /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// - /// 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. - [JsonPropertyName("form_download")] - public Link FormDownload { get; set; } + /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + [JsonPropertyName("shipment_cost")] + public MonetaryValue? ShipmentCost { get; set; } /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - public PaperlessDownload PaperlessDownload { get; set; } + /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// + /// se-28529731 + /// + [JsonPropertyName("shipment_id")] + public string? ShipmentId { get; set; } /// - /// 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. + /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. /// - /// 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. - [JsonPropertyName("insurance_claim")] - public Link InsuranceClaim { get; set; } + /// 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")] + [Obsolete] + public bool? TestLabel { get; set; } /// - /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// - /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - public List Packages { get; set; } + /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + [JsonPropertyName("trackable")] + public bool? Trackable { get; set; } /// - /// Additional information some carriers may provide by which to identify a given label in their system. + /// The tracking number for the package. Tracking number formats vary across carriers. /// - /// Additional information some carriers may provide by which to identify a given label in their system. - [JsonPropertyName("alternative_identifiers")] - public List AlternativeIdentifiers { get; set; } + /// The tracking number for the package. Tracking number formats vary across carriers. + /// + /// 782758401696 + /// + [JsonPropertyName("tracking_number")] + public string? TrackingNumber { get; set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. @@ -323,7 +306,24 @@ public partial class GetLabelByIdResponseBody /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url")] - public string TrackingUrl { get; set; } + public string? TrackingUrl { get; set; } + + /// + /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// + /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + [JsonPropertyName("voided")] + public bool? Voided { get; set; } + + /// + /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("voided_at")] + public DateTimeOffset? VoidedAt { get; set; } /// @@ -335,44 +335,44 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetLabelByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" LabelId: ").Append(LabelId).Append("\n"); - sb.Append(" Status: ").Append(Status).Append("\n"); - sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); - sb.Append(" Shipment: ").Append(Shipment).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); - sb.Append(" ShipmentCost: ").Append(ShipmentCost).Append("\n"); - sb.Append(" InsuranceCost: ").Append(InsuranceCost).Append("\n"); - sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); - sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); - sb.Append(" IsReturnLabel: ").Append(IsReturnLabel).Append("\n"); - sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); - sb.Append(" IsInternational: ").Append(IsInternational).Append("\n"); + sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" BatchId: ").Append(BatchId).Append("\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); - sb.Append(" OutboundLabelId: ").Append(OutboundLabelId).Append("\n"); - sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); - sb.Append(" TestLabel: ").Append(TestLabel).Append("\n"); - sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); - sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); - sb.Append(" Voided: ").Append(Voided).Append("\n"); - sb.Append(" VoidedAt: ").Append(VoidedAt).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); + sb.Append(" InsuranceClaim: ").Append(InsuranceClaim).Append("\n"); + sb.Append(" InsuranceCost: ").Append(InsuranceCost).Append("\n"); + sb.Append(" IsInternational: ").Append(IsInternational).Append("\n"); + sb.Append(" IsReturnLabel: ").Append(IsReturnLabel).Append("\n"); + sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); - sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" LabelId: ").Append(LabelId).Append("\n"); + sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); + sb.Append(" OutboundLabelId: ").Append(OutboundLabelId).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); + sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); + sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" Shipment: ").Append(Shipment).Append("\n"); + sb.Append(" ShipmentCost: ").Append(ShipmentCost).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" Status: ").Append(Status).Append("\n"); + sb.Append(" TestLabel: ").Append(TestLabel).Append("\n"); sb.Append(" Trackable: ").Append(Trackable).Append("\n"); - sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); - sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); sb.Append(" TrackingStatus: ").Append(TrackingStatus).Append("\n"); - sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); - sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); - sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); - sb.Append(" InsuranceClaim: ").Append(InsuranceClaim).Append("\n"); - sb.Append(" Packages: ").Append(Packages).Append("\n"); - sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); + sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); + sb.Append(" Voided: ").Append(Voided).Append("\n"); + sb.Append(" VoidedAt: ").Append(VoidedAt).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs b/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs index c869ded8..bb7771d3 100644 --- a/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs @@ -29,15 +29,26 @@ public partial class GetManifestByIdResponseBody { /// - /// A string that uniquely identifies the manifest + /// A string that uniquely identifies the carrier /// - /// A string that uniquely identifies the manifest + /// A string that uniquely identifies the carrier /// /// se-28529731 /// - [JsonPropertyName("manifest_id")] + [JsonPropertyName("carrier_id")] [JsonRequired] - public string ManifestId { get; set; } + public string CarrierId { get; set; } + + /// + /// The date-time that the manifest was created + /// + /// The date-time that the manifest was created + /// + /// 2019-07-12T13:37:39.050Z + /// + [JsonPropertyName("created_at")] + [JsonRequired] + public DateTimeOffset CreatedAt { get; set; } /// /// A string that uniquely identifies the form @@ -51,15 +62,30 @@ public partial class GetManifestByIdResponseBody public string FormId { get; set; } /// - /// The date-time that the manifest was created + /// An array of the label ids used in this manifest. /// - /// The date-time that the manifest was created + /// An array of the label ids used in this manifest. + [JsonPropertyName("label_ids")] + [JsonRequired] + public List LabelIds { get; set; } + + /// + /// Gets or Sets ManifestDownload + /// + [JsonPropertyName("manifest_download")] + [JsonRequired] + public ManifestDownload ManifestDownload { get; set; } + + /// + /// A string that uniquely identifies the manifest + /// + /// A string that uniquely identifies the manifest /// - /// 2019-07-12T13:37:39.050Z + /// se-28529731 /// - [JsonPropertyName("created_at")] + [JsonPropertyName("manifest_id")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public string ManifestId { get; set; } /// /// The date-time that the manifests shipments will be picked up @@ -83,25 +109,6 @@ public partial class GetManifestByIdResponseBody [JsonRequired] public int Shipments { get; set; } - /// - /// An array of the label ids used in this manifest. - /// - /// An array of the label ids used in this manifest. - [JsonPropertyName("label_ids")] - [JsonRequired] - public List LabelIds { get; set; } - - /// - /// A string that uniquely identifies the warehouse - /// - /// A string that uniquely identifies the warehouse - /// - /// se-28529731 - /// - [JsonPropertyName("warehouse_id")] - [JsonRequired] - public string WarehouseId { get; set; } - /// /// A string that uniquely identifies the submission /// @@ -114,22 +121,15 @@ public partial class GetManifestByIdResponseBody public string SubmissionId { get; set; } /// - /// A string that uniquely identifies the carrier + /// A string that uniquely identifies the warehouse /// - /// A string that uniquely identifies the carrier + /// A string that uniquely identifies the warehouse /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [JsonRequired] - public string CarrierId { get; set; } - - /// - /// Gets or Sets ManifestDownload - /// - [JsonPropertyName("manifest_download")] + [JsonPropertyName("warehouse_id")] [JsonRequired] - public ManifestDownload ManifestDownload { get; set; } + public string WarehouseId { get; set; } /// @@ -141,16 +141,16 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetManifestByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ManifestId: ").Append(ManifestId).Append("\n"); - sb.Append(" FormId: ").Append(FormId).Append("\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" FormId: ").Append(FormId).Append("\n"); + sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); + sb.Append(" ManifestDownload: ").Append(ManifestDownload).Append("\n"); + sb.Append(" ManifestId: ").Append(ManifestId).Append("\n"); sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); sb.Append(" Shipments: ").Append(Shipments).Append("\n"); - sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); sb.Append(" SubmissionId: ").Append(SubmissionId).Append("\n"); - sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); - sb.Append(" ManifestDownload: ").Append(ManifestDownload).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs b/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs index cd911b63..035e311d 100644 --- a/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs @@ -29,14 +29,14 @@ public partial class GetPackageTypeByIdResponseBody { /// - /// A string that uniquely identifies the package. + /// Gets or Sets Name /// - /// A string that uniquely identifies the package. /// - /// se-28529731 + /// laptop_box /// - [JsonPropertyName("package_id")] - public string PackageId { get; set; } + [JsonPropertyName("name")] + [JsonRequired] + public string Name { get; set; } /// /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. @@ -50,31 +50,31 @@ public partial class GetPackageTypeByIdResponseBody public string PackageCode { get; set; } /// - /// Gets or Sets Name + /// Provides a helpful description for the custom package. /// + /// Provides a helpful description for the custom package. /// - /// laptop_box + /// Packaging for laptops /// - [JsonPropertyName("name")] - [JsonRequired] - public string Name { get; set; } + [JsonPropertyName("description")] + public string? Description { get; set; } /// /// The custom dimensions for the package. /// /// The custom dimensions for the package. [JsonPropertyName("dimensions")] - public Dimensions Dimensions { get; set; } + public Dimensions? Dimensions { get; set; } /// - /// Provides a helpful description for the custom package. + /// A string that uniquely identifies the package. /// - /// Provides a helpful description for the custom package. + /// A string that uniquely identifies the package. /// - /// Packaging for laptops + /// se-28529731 /// - [JsonPropertyName("description")] - public string Description { get; set; } + [JsonPropertyName("package_id")] + public string? PackageId { get; set; } /// @@ -86,11 +86,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetPackageTypeByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" PackageId: ").Append(PackageId).Append("\n"); - sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Description: ").Append(Description).Append("\n"); + sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); + sb.Append(" PackageId: ").Append(PackageId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs b/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs index 3ab41fc4..b2595e28 100644 --- a/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs @@ -29,23 +29,22 @@ public partial class GetPickupByIdResponseBody { /// - /// Pickup Resource ID + /// The carrier_id associated with the pickup /// - /// Pickup Resource ID + /// The carrier_id associated with the pickup /// - /// pik_3YcKU5zdtJuCqoeNwyqqbW + /// se-28529731 /// - [JsonPropertyName("pickup_id")] + [JsonPropertyName("carrier_id")] [JsonRequired] - public string PickupId { get; set; } + public string CarrierId { get; set; } /// - /// Label IDs that will be included in the pickup request + /// Gets or Sets ContactDetails /// - /// Label IDs that will be included in the pickup request - [JsonPropertyName("label_ids")] + [JsonPropertyName("contact_details")] [JsonRequired] - public List LabelIds { get; set; } + public ContactDetails ContactDetails { get; set; } /// /// The date and time that the pickup was created in ShipEngine. @@ -59,36 +58,56 @@ public partial class GetPickupByIdResponseBody public DateTimeOffset CreatedAt { get; set; } /// - /// The date and time that the pickup was cancelled in ShipEngine. + /// The errors associated with the failed API call /// - /// The date and time that the pickup was cancelled in ShipEngine. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("cancelled_at")] - public DateTimeOffset CancelledAt { get; set; } + /// The errors associated with the failed API call + [JsonPropertyName("errors")] + [JsonRequired] + public List Errors { get; set; } /// - /// The carrier_id associated with the pickup + /// Label IDs that will be included in the pickup request /// - /// The carrier_id associated with the pickup + /// Label IDs that will be included in the pickup request + [JsonPropertyName("label_ids")] + [JsonRequired] + public List LabelIds { get; set; } + + /// + /// Gets or Sets PickupAddress + /// + [JsonPropertyName("pickup_address")] + [JsonRequired] + public Address PickupAddress { get; set; } + + /// + /// Pickup Resource ID + /// + /// Pickup Resource ID /// - /// se-28529731 + /// pik_3YcKU5zdtJuCqoeNwyqqbW /// - [JsonPropertyName("carrier_id")] + [JsonPropertyName("pickup_id")] [JsonRequired] - public string CarrierId { get; set; } + public string PickupId { get; set; } /// - /// The carrier confirmation number for the scheduled pickup. + /// Gets or Sets PickupWindow /// - /// The carrier confirmation number for the scheduled pickup. + [JsonPropertyName("pickup_window")] + [JsonRequired] + public PickupWindow PickupWindow { get; set; } + + /// + /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur + /// + /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur /// - /// 292513CL4A3 + /// aa3d8e8e-462b-4476-9618-72db7f7b7009 /// - [JsonPropertyName("confirmation_number")] + [JsonPropertyName("request_id")] [JsonRequired] - public string ConfirmationNumber { get; set; } + public Guid RequestId { get; set; } /// /// The warehouse_id associated with the pickup @@ -102,58 +121,39 @@ public partial class GetPickupByIdResponseBody public string WarehouseId { get; set; } /// - /// Gets or Sets PickupAddress + /// The date and time that the pickup was cancelled in ShipEngine. /// - [JsonPropertyName("pickup_address")] - [JsonRequired] - public Address PickupAddress { get; set; } + /// The date and time that the pickup was cancelled in ShipEngine. + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("cancelled_at")] + public DateTimeOffset? CancelledAt { get; set; } /// - /// Gets or Sets ContactDetails + /// The carrier confirmation number for the scheduled pickup. /// - [JsonPropertyName("contact_details")] + /// The carrier confirmation number for the scheduled pickup. + /// + /// 292513CL4A3 + /// + [JsonPropertyName("confirmation_number")] [JsonRequired] - public ContactDetails ContactDetails { get; set; } + public string ConfirmationNumber { get; set; } /// /// Used by some carriers to give special instructions for a package pickup /// /// Used by some carriers to give special instructions for a package pickup [JsonPropertyName("pickup_notes")] - public string PickupNotes { get; set; } - - /// - /// Gets or Sets PickupWindow - /// - [JsonPropertyName("pickup_window")] - [JsonRequired] - public PickupWindow PickupWindow { get; set; } + public string? PickupNotes { get; set; } /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. [JsonPropertyName("pickup_windows")] - public List PickupWindows { get; set; } - - /// - /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur - /// - /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur - /// - /// aa3d8e8e-462b-4476-9618-72db7f7b7009 - /// - [JsonPropertyName("request_id")] - [JsonRequired] - public Guid RequestId { get; set; } - - /// - /// The errors associated with the failed API call - /// - /// The errors associated with the failed API call - [JsonPropertyName("errors")] - [JsonRequired] - public List Errors { get; set; } + public List? PickupWindows { get; set; } /// @@ -165,20 +165,20 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetPickupByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" PickupId: ").Append(PickupId).Append("\n"); - sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); + sb.Append(" ContactDetails: ").Append(ContactDetails).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); + sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); + sb.Append(" PickupAddress: ").Append(PickupAddress).Append("\n"); + sb.Append(" PickupId: ").Append(PickupId).Append("\n"); + sb.Append(" PickupWindow: ").Append(PickupWindow).Append("\n"); + sb.Append(" RequestId: ").Append(RequestId).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); sb.Append(" CancelledAt: ").Append(CancelledAt).Append("\n"); - sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ConfirmationNumber: ").Append(ConfirmationNumber).Append("\n"); - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); - sb.Append(" PickupAddress: ").Append(PickupAddress).Append("\n"); - sb.Append(" ContactDetails: ").Append(ContactDetails).Append("\n"); sb.Append(" PickupNotes: ").Append(PickupNotes).Append("\n"); - sb.Append(" PickupWindow: ").Append(PickupWindow).Append("\n"); sb.Append(" PickupWindows: ").Append(PickupWindows).Append("\n"); - sb.Append(" RequestId: ").Append(RequestId).Append("\n"); - sb.Append(" Errors: ").Append(Errors).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetPickupsResponseBody.cs b/ShipEngineSDK/Model/GetPickupsResponseBody.cs index 7ec6e605..5d79aa4a 100644 --- a/ShipEngineSDK/Model/GetPickupsResponseBody.cs +++ b/ShipEngineSDK/Model/GetPickupsResponseBody.cs @@ -29,23 +29,20 @@ public partial class GetPickupsResponseBody { /// - /// An array of pickups associated with the user's account. + /// The errors associated with the failed API call /// - /// An array of pickups associated with the user's account. - [JsonPropertyName("pickups")] + /// The errors associated with the failed API call + [JsonPropertyName("errors")] [JsonRequired] - public List Pickups { get; set; } + public List Errors { get; set; } /// - /// The total number of pickups returned + /// Helpful links to other pages of results /// - /// The total number of pickups returned - /// - /// 3 - /// - [JsonPropertyName("total")] + /// Helpful links to other pages of results + [JsonPropertyName("links")] [JsonRequired] - public long Total { get; set; } + public PaginationLink Links { get; set; } /// /// Current page of the list pickups results @@ -70,12 +67,12 @@ public partial class GetPickupsResponseBody public int Pages { get; set; } /// - /// Helpful links to other pages of results + /// An array of pickups associated with the user's account. /// - /// Helpful links to other pages of results - [JsonPropertyName("links")] + /// An array of pickups associated with the user's account. + [JsonPropertyName("pickups")] [JsonRequired] - public PaginationLink Links { get; set; } + public List Pickups { get; set; } /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur @@ -89,12 +86,15 @@ public partial class GetPickupsResponseBody public Guid RequestId { get; set; } /// - /// The errors associated with the failed API call + /// The total number of pickups returned /// - /// The errors associated with the failed API call - [JsonPropertyName("errors")] + /// The total number of pickups returned + /// + /// 3 + /// + [JsonPropertyName("total")] [JsonRequired] - public List Errors { get; set; } + public long Total { get; set; } /// @@ -106,13 +106,13 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetPickupsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Pickups: ").Append(Pickups).Append("\n"); - sb.Append(" Total: ").Append(Total).Append("\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); + sb.Append(" Links: ").Append(Links).Append("\n"); sb.Append(" Page: ").Append(Page).Append("\n"); sb.Append(" Pages: ").Append(Pages).Append("\n"); - sb.Append(" Links: ").Append(Links).Append("\n"); + sb.Append(" Pickups: ").Append(Pickups).Append("\n"); sb.Append(" RequestId: ").Append(RequestId).Append("\n"); - sb.Append(" Errors: ").Append(Errors).Append("\n"); + sb.Append(" Total: ").Append(Total).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetRateByIdResponseBody.cs b/ShipEngineSDK/Model/GetRateByIdResponseBody.cs index 4cb10944..64b756b5 100644 --- a/ShipEngineSDK/Model/GetRateByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetRateByIdResponseBody.cs @@ -45,15 +45,20 @@ public partial class GetRateByIdResponseBody /// - /// A string that uniquely identifies the rate + /// carrier code /// - /// A string that uniquely identifies the rate - /// - /// se-28529731 - /// - [JsonPropertyName("rate_id")] + /// carrier code + [JsonPropertyName("carrier_code")] [JsonRequired] - public string RateId { get; set; } + public string CarrierCode { get; set; } + + /// + /// carrier friendly name + /// + /// carrier friendly name + [JsonPropertyName("carrier_friendly_name")] + [JsonRequired] + public string CarrierFriendlyName { get; set; } /// /// A string that uniquely identifies the carrier @@ -67,20 +72,12 @@ public partial class GetRateByIdResponseBody public string CarrierId { get; set; } /// - /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. - /// - /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. - [JsonPropertyName("shipping_amount")] - [JsonRequired] - public MonetaryValue ShippingAmount { get; set; } - - /// - /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. + /// carrier nickname /// - /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. - [JsonPropertyName("insurance_amount")] + /// carrier nickname + [JsonPropertyName("carrier_nickname")] [JsonRequired] - public MonetaryValue InsuranceAmount { get; set; } + public string CarrierNickname { get; set; } /// /// The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price. @@ -91,98 +88,63 @@ public partial class GetRateByIdResponseBody public MonetaryValue ConfirmationAmount { get; set; } /// - /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. + /// The error messages /// - /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. - [JsonPropertyName("other_amount")] + /// The error messages + [JsonPropertyName("error_messages")] [JsonRequired] - public MonetaryValue OtherAmount { get; set; } - - /// - /// The total shipping cost for the specified comparison_rate_type. - /// - /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue RequestedComparisonAmount { get; set; } - - /// - /// Tariff and additional taxes associated with an international shipment. - /// - /// Tariff and additional taxes associated with an international shipment. - [JsonPropertyName("tax_amount")] - public MonetaryValue TaxAmount { get; set; } + public List ErrorMessages { get; set; } /// - /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location + /// Indicates if the rate is guaranteed. /// - /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location - /// - /// 6 - /// - [JsonPropertyName("zone")] + /// Indicates if the rate is guaranteed. + [JsonPropertyName("guaranteed_service")] [JsonRequired] - public int? Zone { get; set; } + public bool GuaranteedService { get; set; } /// - /// package type that this rate was estimated for + /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. /// - /// package type that this rate was estimated for - /// - /// package - /// - [JsonPropertyName("package_type")] + /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. + [JsonPropertyName("insurance_amount")] [JsonRequired] - public string PackageType { get; set; } + public MonetaryValue InsuranceAmount { get; set; } /// - /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday + /// Indicates if the rates been negotiated /// - /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday - /// - /// 5 - /// - [JsonPropertyName("delivery_days")] - public int DeliveryDays { get; set; } + /// Indicates if the rates been negotiated + [JsonPropertyName("negotiated_rate")] + [JsonRequired] + public bool NegotiatedRate { get; set; } /// - /// Indicates if the rate is guaranteed. + /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. /// - /// Indicates if the rate is guaranteed. - [JsonPropertyName("guaranteed_service")] + /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. + [JsonPropertyName("other_amount")] [JsonRequired] - public bool GuaranteedService { get; set; } + public MonetaryValue OtherAmount { get; set; } /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. + /// A string that uniquely identifies the rate /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. + /// A string that uniquely identifies the rate /// - /// 2018-09-23T00:00Z + /// se-28529731 /// - [JsonPropertyName("estimated_delivery_date")] - public DateTimeOffset EstimatedDeliveryDate { get; set; } - - /// - /// The carrier delivery days - /// - /// The carrier delivery days - [JsonPropertyName("carrier_delivery_days")] - public string CarrierDeliveryDays { get; set; } - - /// - /// ship date - /// - /// ship date - [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + [JsonPropertyName("rate_id")] + [JsonRequired] + public string RateId { get; set; } /// - /// Indicates if the rates been negotiated + /// service code for the rate /// - /// Indicates if the rates been negotiated - [JsonPropertyName("negotiated_rate")] + /// service code for the rate + [JsonPropertyName("service_code")] [JsonRequired] - public bool NegotiatedRate { get; set; } + public string ServiceCode { get; set; } /// /// service type @@ -193,12 +155,12 @@ public partial class GetRateByIdResponseBody public string ServiceType { get; set; } /// - /// service code for the rate + /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. /// - /// service code for the rate - [JsonPropertyName("service_code")] + /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. + [JsonPropertyName("shipping_amount")] [JsonRequired] - public string ServiceCode { get; set; } + public MonetaryValue ShippingAmount { get; set; } /// /// Indicates if rate is trackable @@ -209,44 +171,82 @@ public partial class GetRateByIdResponseBody public bool Trackable { get; set; } /// - /// carrier code + /// The warning messages /// - /// carrier code - [JsonPropertyName("carrier_code")] + /// The warning messages + [JsonPropertyName("warning_messages")] [JsonRequired] - public string CarrierCode { get; set; } + public List WarningMessages { get; set; } /// - /// carrier nickname + /// The carrier delivery days /// - /// carrier nickname - [JsonPropertyName("carrier_nickname")] - [JsonRequired] - public string CarrierNickname { get; set; } + /// The carrier delivery days + [JsonPropertyName("carrier_delivery_days")] + public string? CarrierDeliveryDays { get; set; } /// - /// carrier friendly name + /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday /// - /// carrier friendly name - [JsonPropertyName("carrier_friendly_name")] - [JsonRequired] - public string CarrierFriendlyName { get; set; } + /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday + /// + /// 5 + /// + [JsonPropertyName("delivery_days")] + public int? DeliveryDays { get; set; } /// - /// The warning messages + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. /// - /// The warning messages - [JsonPropertyName("warning_messages")] + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. + /// + /// 2018-09-23T00:00Z + /// + [JsonPropertyName("estimated_delivery_date")] + public DateTimeOffset? EstimatedDeliveryDate { get; set; } + + /// + /// package type that this rate was estimated for + /// + /// package type that this rate was estimated for + /// + /// package + /// + [JsonPropertyName("package_type")] [JsonRequired] - public List WarningMessages { get; set; } + public string PackageType { get; set; } /// - /// The error messages + /// The total shipping cost for the specified comparison_rate_type. /// - /// The error messages - [JsonPropertyName("error_messages")] + /// The total shipping cost for the specified comparison_rate_type. + [JsonPropertyName("requested_comparison_amount")] + public MonetaryValue? RequestedComparisonAmount { get; set; } + + /// + /// ship date + /// + /// ship date + [JsonPropertyName("ship_date")] + public DateTimeOffset? ShipDate { get; set; } + + /// + /// Tariff and additional taxes associated with an international shipment. + /// + /// Tariff and additional taxes associated with an international shipment. + [JsonPropertyName("tax_amount")] + public MonetaryValue? TaxAmount { get; set; } + + /// + /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location + /// + /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location + /// + /// 6 + /// + [JsonPropertyName("zone")] [JsonRequired] - public List ErrorMessages { get; set; } + public int Zone { get; set; } /// @@ -258,32 +258,32 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetRateByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" RateId: ").Append(RateId).Append("\n"); - sb.Append(" RateType: ").Append(RateType).Append("\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" CarrierFriendlyName: ").Append(CarrierFriendlyName).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); - sb.Append(" ShippingAmount: ").Append(ShippingAmount).Append("\n"); - sb.Append(" InsuranceAmount: ").Append(InsuranceAmount).Append("\n"); + sb.Append(" CarrierNickname: ").Append(CarrierNickname).Append("\n"); sb.Append(" ConfirmationAmount: ").Append(ConfirmationAmount).Append("\n"); - sb.Append(" OtherAmount: ").Append(OtherAmount).Append("\n"); - sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); - sb.Append(" TaxAmount: ").Append(TaxAmount).Append("\n"); - sb.Append(" Zone: ").Append(Zone).Append("\n"); - sb.Append(" PackageType: ").Append(PackageType).Append("\n"); - sb.Append(" DeliveryDays: ").Append(DeliveryDays).Append("\n"); + sb.Append(" ErrorMessages: ").Append(ErrorMessages).Append("\n"); sb.Append(" GuaranteedService: ").Append(GuaranteedService).Append("\n"); - sb.Append(" EstimatedDeliveryDate: ").Append(EstimatedDeliveryDate).Append("\n"); - sb.Append(" CarrierDeliveryDays: ").Append(CarrierDeliveryDays).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" InsuranceAmount: ").Append(InsuranceAmount).Append("\n"); sb.Append(" NegotiatedRate: ").Append(NegotiatedRate).Append("\n"); - sb.Append(" ServiceType: ").Append(ServiceType).Append("\n"); + sb.Append(" OtherAmount: ").Append(OtherAmount).Append("\n"); + sb.Append(" RateId: ").Append(RateId).Append("\n"); + sb.Append(" RateType: ").Append(RateType).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" ServiceType: ").Append(ServiceType).Append("\n"); + sb.Append(" ShippingAmount: ").Append(ShippingAmount).Append("\n"); sb.Append(" Trackable: ").Append(Trackable).Append("\n"); - sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); - sb.Append(" CarrierNickname: ").Append(CarrierNickname).Append("\n"); - sb.Append(" CarrierFriendlyName: ").Append(CarrierFriendlyName).Append("\n"); sb.Append(" ValidationStatus: ").Append(ValidationStatus).Append("\n"); sb.Append(" WarningMessages: ").Append(WarningMessages).Append("\n"); - sb.Append(" ErrorMessages: ").Append(ErrorMessages).Append("\n"); + sb.Append(" CarrierDeliveryDays: ").Append(CarrierDeliveryDays).Append("\n"); + sb.Append(" DeliveryDays: ").Append(DeliveryDays).Append("\n"); + sb.Append(" EstimatedDeliveryDate: ").Append(EstimatedDeliveryDate).Append("\n"); + sb.Append(" PackageType: ").Append(PackageType).Append("\n"); + sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" TaxAmount: ").Append(TaxAmount).Append("\n"); + sb.Append(" Zone: ").Append(Zone).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs b/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs index 21cf3ee2..75511c3a 100644 --- a/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs @@ -32,7 +32,7 @@ public partial class GetServicePointByIdResponseBody /// Gets or Sets ServicePoint /// [JsonPropertyName("service_point")] - public GetServicePointByIdResponseBodyServicePoint ServicePoint { get; set; } + public GetServicePointByIdResponseBodyServicePoint? ServicePoint { get; set; } /// diff --git a/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs b/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs index 24a692e3..e6f706a9 100644 --- a/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs +++ b/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs @@ -165,6 +165,16 @@ public override bool CanConvert(Type typeToConvert) => /// Service point type [JsonPropertyName("type")] public TypeEnum? Type { get; set; } + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// PLACE DU CANADA + /// + [JsonPropertyName("address_line1")] + public string? AddressLine1 { get; set; } + /// /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. /// @@ -173,23 +183,17 @@ public override bool CanConvert(Type typeToConvert) => /// dhl_express /// [JsonPropertyName("carrier_code")] - public string CarrierCode { get; set; } + public string? CarrierCode { get; set; } /// - /// Gets or Sets ServiceCodes - /// - [JsonPropertyName("service_codes")] - public List ServiceCodes { get; set; } - - /// - /// A unique identifier for a carrier drop off point. + /// The name of the city or locality /// - /// A unique identifier for a carrier drop off point. + /// The name of the city or locality /// - /// 614940 + /// TRUN /// - [JsonPropertyName("service_point_id")] - public string ServicePointId { get; set; } + [JsonPropertyName("city_locality")] + public string? CityLocality { get; set; } /// /// If this is a business address, then the company name should be specified here. @@ -199,57 +203,50 @@ public override bool CanConvert(Type typeToConvert) => /// My fancy company name /// [JsonPropertyName("company_name")] - public string CompanyName { get; set; } + public string? CompanyName { get; set; } /// - /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) /// - /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) /// - /// PLACE DU CANADA + /// CA /// - [JsonPropertyName("address_line1")] - public string AddressLine1 { get; set; } + [JsonPropertyName("country_code")] + public string? CountryCode { get; set; } /// - /// The name of the city or locality + /// Service features /// - /// The name of the city or locality - /// - /// TRUN - /// - [JsonPropertyName("city_locality")] - public string CityLocality { get; set; } + /// Service features + [JsonPropertyName("features")] + public List? Features { get; set; } /// - /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// Gets or Sets HoursOfOperation /// - /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. - /// - /// TRUN - /// - [JsonPropertyName("state_province")] - public string StateProvince { get; set; } + [JsonPropertyName("hours_of_operation")] + public ListServicePointsResponseBodyServicePointsInnerHoursOfOperation? HoursOfOperation { get; set; } /// - /// postal code + /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html /// - /// postal code + /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html /// - /// 78756-3717 + /// 48.842608 /// - [JsonPropertyName("postal_code")] - public string PostalCode { get; set; } + [JsonPropertyName("lat")] + public double? Lat { get; set; } /// - /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html /// - /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html /// - /// CA + /// 0.032875 /// - [JsonPropertyName("country_code")] - public string CountryCode { get; set; } + [JsonPropertyName("long")] + public double? Long { get; set; } /// /// Phone number associated @@ -259,40 +256,43 @@ public override bool CanConvert(Type typeToConvert) => /// 555-555-5555 /// [JsonPropertyName("phone_number")] - public string PhoneNumber { get; set; } + public string? PhoneNumber { get; set; } /// - /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html + /// postal code /// - /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html + /// postal code /// - /// 48.842608 + /// 78756-3717 /// - [JsonPropertyName("lat")] - public double Lat { get; set; } + [JsonPropertyName("postal_code")] + public string? PostalCode { get; set; } /// - /// The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html + /// Gets or Sets ServiceCodes /// - /// The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html - /// - /// 0.032875 - /// - [JsonPropertyName("long")] - public double Long { get; set; } + [JsonPropertyName("service_codes")] + public List? ServiceCodes { get; set; } /// - /// Gets or Sets HoursOfOperation + /// A unique identifier for a carrier drop off point. /// - [JsonPropertyName("hours_of_operation")] - public ListServicePointsResponseBodyServicePointsInnerHoursOfOperation HoursOfOperation { get; set; } + /// A unique identifier for a carrier drop off point. + /// + /// 614940 + /// + [JsonPropertyName("service_point_id")] + public string? ServicePointId { get; set; } /// - /// Service features + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. /// - /// Service features - [JsonPropertyName("features")] - public List Features { get; set; } + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// TRUN + /// + [JsonPropertyName("state_province")] + public string? StateProvince { get; set; } /// @@ -304,20 +304,20 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetServicePointByIdResponseBodyServicePoint {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); - sb.Append(" ServiceCodes: ").Append(ServiceCodes).Append("\n"); - sb.Append(" ServicePointId: ").Append(ServicePointId).Append("\n"); - sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); - sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); - sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); - sb.Append(" PhoneNumber: ").Append(PhoneNumber).Append("\n"); + sb.Append(" Features: ").Append(Features).Append("\n"); + sb.Append(" HoursOfOperation: ").Append(HoursOfOperation).Append("\n"); sb.Append(" Lat: ").Append(Lat).Append("\n"); sb.Append(" Long: ").Append(Long).Append("\n"); - sb.Append(" HoursOfOperation: ").Append(HoursOfOperation).Append("\n"); - sb.Append(" Features: ").Append(Features).Append("\n"); + sb.Append(" PhoneNumber: ").Append(PhoneNumber).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" ServiceCodes: ").Append(ServiceCodes).Append("\n"); + sb.Append(" ServicePointId: ").Append(ServicePointId).Append("\n"); + sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBody.cs b/ShipEngineSDK/Model/GetServicePointsRequestBody.cs index 8186de8b..3d041dd3 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBody.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBody.cs @@ -29,28 +29,28 @@ public partial class GetServicePointsRequestBody { /// - /// Unstructured text to search for service points by. + /// An array of shipping service providers and service codes /// - /// Unstructured text to search for service points by. - /// - /// 177A Bleecker Street New York - /// - [JsonPropertyName("address_query")] - public string AddressQuery { get; set; } + /// An array of shipping service providers and service codes + [JsonPropertyName("providers")] + [JsonRequired] + public List Providers { get; set; } /// /// Gets or Sets Address /// [JsonPropertyName("address")] - public GetServicePointsRequestBodyAddress Address { get; set; } + public GetServicePointsRequestBodyAddress? Address { get; set; } /// - /// An array of shipping service providers and service codes + /// Unstructured text to search for service points by. /// - /// An array of shipping service providers and service codes - [JsonPropertyName("providers")] - [JsonRequired] - public List Providers { get; set; } + /// Unstructured text to search for service points by. + /// + /// 177A Bleecker Street New York + /// + [JsonPropertyName("address_query")] + public string? AddressQuery { get; set; } /// /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html @@ -60,7 +60,7 @@ public partial class GetServicePointsRequestBody /// 48.874518928233094 /// [JsonPropertyName("lat")] - public double Lat { get; set; } + public double? Lat { get; set; } /// /// The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html @@ -70,33 +70,33 @@ public partial class GetServicePointsRequestBody /// 2.3591775711639404 /// [JsonPropertyName("long")] - public double Long { get; set; } + public double? Long { get; set; } /// - /// Search radius in kilometers + /// The maximum number of service points to return /// - /// Search radius in kilometers + /// The maximum number of service points to return /// - /// 500 + /// 25 /// - [JsonPropertyName("radius")] - public int Radius { get; set; } + [JsonPropertyName("max_results")] + public int? MaxResults { get; set; } /// - /// The maximum number of service points to return + /// Search radius in kilometers /// - /// The maximum number of service points to return + /// Search radius in kilometers /// - /// 25 + /// 500 /// - [JsonPropertyName("max_results")] - public int MaxResults { get; set; } + [JsonPropertyName("radius")] + public int? Radius { get; set; } /// /// Gets or Sets Shipment /// [JsonPropertyName("shipment")] - public GetServicePointsRequestBodyShipment Shipment { get; set; } + public GetServicePointsRequestBodyShipment? Shipment { get; set; } /// @@ -108,13 +108,13 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetServicePointsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" AddressQuery: ").Append(AddressQuery).Append("\n"); - sb.Append(" Address: ").Append(Address).Append("\n"); sb.Append(" Providers: ").Append(Providers).Append("\n"); + sb.Append(" Address: ").Append(Address).Append("\n"); + sb.Append(" AddressQuery: ").Append(AddressQuery).Append("\n"); sb.Append(" Lat: ").Append(Lat).Append("\n"); sb.Append(" Long: ").Append(Long).Append("\n"); - sb.Append(" Radius: ").Append(Radius).Append("\n"); sb.Append(" MaxResults: ").Append(MaxResults).Append("\n"); + sb.Append(" Radius: ").Append(Radius).Append("\n"); sb.Append(" Shipment: ").Append(Shipment).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs index 2233c6dd..2411831f 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs @@ -28,6 +28,17 @@ namespace ShipEngineSDK.Model; public partial class GetServicePointsRequestBodyAddress { + /// + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// CA + /// + [JsonPropertyName("country_code")] + [JsonRequired] + public string CountryCode { get; set; } + /// /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. /// @@ -36,33 +47,26 @@ public partial class GetServicePointsRequestBodyAddress /// 1999 Bishop Grandin Blvd. /// [JsonPropertyName("address_line1")] - public string AddressLine1 { get; set; } + public string? AddressLine1 { get; set; } /// /// Gets or Sets AddressLine2 /// [JsonPropertyName("address_line2")] - public string AddressLine2 { get; set; } + public string? AddressLine2 { get; set; } /// /// Gets or Sets AddressLine3 /// [JsonPropertyName("address_line3")] - public string AddressLine3 { get; set; } + public string? AddressLine3 { get; set; } /// /// The name of the city or locality /// /// The name of the city or locality [JsonPropertyName("city_locality")] - public string CityLocality { get; set; } - - /// - /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. - /// - /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. - [JsonPropertyName("state_province")] - public string StateProvince { get; set; } + public string? CityLocality { get; set; } /// /// postal code @@ -72,18 +76,14 @@ public partial class GetServicePointsRequestBodyAddress /// 78756-3717 /// [JsonPropertyName("postal_code")] - public string PostalCode { get; set; } + public string? PostalCode { get; set; } /// - /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. /// - /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) - /// - /// CA - /// - [JsonPropertyName("country_code")] - [JsonRequired] - public string CountryCode { get; set; } + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + [JsonPropertyName("state_province")] + public string? StateProvince { get; set; } /// @@ -95,13 +95,13 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetServicePointsRequestBodyAddress {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); - sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); - sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); + sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs index 2d6cbc8e..71e4f2c7 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs @@ -36,13 +36,13 @@ public partial class GetServicePointsRequestBodyProvidersInner /// se-123456 /// [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + public string? CarrierId { get; set; } /// /// Gets or Sets ServiceCode /// [JsonPropertyName("service_code")] - public List ServiceCode { get; set; } + public List? ServiceCode { get; set; } /// diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs index a515ffc5..e85bf1d1 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs @@ -33,7 +33,7 @@ public partial class GetServicePointsRequestBodyShipment /// /// Shipment total weight [JsonPropertyName("total_weight")] - public Weight TotalWeight { get; set; } + public Weight? TotalWeight { get; set; } /// diff --git a/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs b/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs index 6b7f5982..512379f8 100644 --- a/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs @@ -28,15 +28,6 @@ namespace ShipEngineSDK.Model; public partial class GetShipmentByExternalIdResponseBody { - /// - /// The current status of the shipment CLOVUS - /// - /// The current status of the shipment - [JsonPropertyName("shipment_status")] - [JsonRequired] - public ShipmentStatus ShipmentStatus { get; set; } = new(); - - /// /// The type of delivery confirmation that is required for this shipment. CLOVUS /// @@ -55,21 +46,27 @@ public partial class GetShipmentByExternalIdResponseBody public InsuranceProvider InsuranceProvider { get; set; } = new(); + /// + /// The current status of the shipment CLOVUS + /// + /// The current status of the shipment + [JsonPropertyName("shipment_status")] + [JsonRequired] + public ShipmentStatus ShipmentStatus { get; set; } = new(); + + /// /// Gets or Sets OrderSourceCode CLOVUS /// [JsonPropertyName("order_source_code")] public OrderSourceName? OrderSourceCode { get; set; } /// - /// A string that uniquely identifies the shipment + /// Advanced shipment options. These are entirely optional. /// - /// A string that uniquely identifies the shipment - /// - /// se-28529731 - /// - [JsonPropertyName("shipment_id")] + /// Advanced shipment options. These are entirely optional. + [JsonPropertyName("advanced_options")] [JsonRequired] - public string ShipmentId { get; set; } + public AdvancedShipmentOptions AdvancedOptions { get; set; } /// /// The carrier account that is billed for the shipping charges @@ -83,59 +80,53 @@ public partial class GetShipmentByExternalIdResponseBody public string CarrierId { get; set; } /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// The date and time that the shipment was created in ShipEngine. /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// The date and time that the shipment was created in ShipEngine. /// - /// usps_first_class_mail + /// 2018-09-23T15:00Z /// - [JsonPropertyName("service_code")] + [JsonPropertyName("created_at")] [JsonRequired] - public string ServiceCode { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// - /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// The date and time that the shipment was created or last modified. /// - /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// The date and time that the shipment was created or last modified. /// - /// se-28529731 + /// 2018-09-23T15:00Z /// - [JsonPropertyName("shipping_rule_id")] - public string ShippingRuleId { get; set; } - - /// - /// ID that the Order Source assigned - /// - /// ID that the Order Source assigned - [JsonPropertyName("external_order_id")] - public string ExternalOrderId { get; set; } - - /// - /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - /// - /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - [JsonPropertyName("items")] - public List Items { get; set; } + [JsonPropertyName("modified_at")] + [JsonRequired] + public DateTimeOffset ModifiedAt { get; set; } /// - /// Gets or Sets TaxIdentifiers + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// - [JsonPropertyName("tax_identifiers")] - public List TaxIdentifiers { get; set; } + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + [JsonPropertyName("packages")] + [JsonRequired] + public List Packages { get; set; } /// - /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. + /// The return address for this shipment. Defaults to the `ship_from` address. /// - /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("external_shipment_id")] - public string ExternalShipmentId { get; set; } + /// The return address for this shipment. Defaults to the `ship_from` address. + [JsonPropertyName("return_to")] + [JsonRequired] + public ShippingAddress ReturnTo { get; set; } /// - /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// - /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("shipment_number")] - public string ShipmentNumber { get; set; } + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// usps_first_class_mail + /// + [JsonPropertyName("service_code")] + [JsonRequired] + public string ServiceCode { get; set; } /// /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -149,26 +140,12 @@ public partial class GetShipmentByExternalIdResponseBody public DateTimeOffset ShipDate { get; set; } /// - /// The date and time that the shipment was created in ShipEngine. - /// - /// The date and time that the shipment was created in ShipEngine. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("created_at")] - [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } - - /// - /// The date and time that the shipment was created or last modified. + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// - /// The date and time that the shipment was created or last modified. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("modified_at")] + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. + [JsonPropertyName("ship_from")] [JsonRequired] - public DateTimeOffset ModifiedAt { get; set; } + public ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address @@ -179,38 +156,41 @@ public partial class GetShipmentByExternalIdResponseBody public ShippingAddressTo ShipTo { get; set; } /// - /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. + /// A string that uniquely identifies the shipment /// - /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from")] + /// A string that uniquely identifies the shipment + /// + /// se-28529731 + /// + [JsonPropertyName("shipment_id")] [JsonRequired] - public ShippingAddress ShipFrom { get; set; } + public string ShipmentId { get; set; } /// - /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// - /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. - /// - /// se-28529731 - /// - [JsonPropertyName("warehouse_id")] + /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. + [JsonPropertyName("tags")] [JsonRequired] - public string WarehouseId { get; set; } + public List Tags { get; set; } /// - /// The return address for this shipment. Defaults to the `ship_from` address. + /// The combined weight of all packages in the shipment /// - /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to")] + /// The combined weight of all packages in the shipment + [JsonPropertyName("total_weight")] [JsonRequired] - public ShippingAddress ReturnTo { get; set; } + public Weight TotalWeight { get; set; } /// - /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. /// - /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. - [JsonPropertyName("is_return")] - public bool? IsReturn { get; set; } + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// + /// retail + /// + [JsonPropertyName("comparison_rate_type")] + public string? ComparisonRateType { get; set; } /// /// Customs information. This is usually only needed for international shipments. @@ -221,46 +201,66 @@ public partial class GetShipmentByExternalIdResponseBody public InternationalShipmentOptions Customs { get; set; } /// - /// Advanced shipment options. These are entirely optional. + /// ID that the Order Source assigned /// - /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options")] - [JsonRequired] - public AdvancedShipmentOptions AdvancedOptions { get; set; } + /// ID that the Order Source assigned + [JsonPropertyName("external_order_id")] + public string? ExternalOrderId { get; set; } /// - /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. + /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. /// - /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. - [JsonPropertyName("tags")] - [JsonRequired] - public List Tags { get; set; } + /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. + [JsonPropertyName("external_shipment_id")] + public string? ExternalShipmentId { get; set; } /// - /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// - /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - [JsonRequired] - public List Packages { get; set; } + /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. + [JsonPropertyName("is_return")] + public bool? IsReturn { get; set; } /// - /// The combined weight of all packages in the shipment + /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources /// - /// The combined weight of all packages in the shipment - [JsonPropertyName("total_weight")] - [JsonRequired] - public Weight TotalWeight { get; set; } + /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources + [JsonPropertyName("items")] + public List? Items { get; set; } /// - /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// - /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. + [JsonPropertyName("shipment_number")] + public string? ShipmentNumber { get; set; } + + /// + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment /// - /// retail + /// se-28529731 /// - [JsonPropertyName("comparison_rate_type")] - public string ComparisonRateType { get; set; } + [JsonPropertyName("shipping_rule_id")] + public string? ShippingRuleId { get; set; } + + /// + /// Gets or Sets TaxIdentifiers + /// + [JsonPropertyName("tax_identifiers")] + public List? TaxIdentifiers { get; set; } + + /// + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// + /// se-28529731 + /// + [JsonPropertyName("warehouse_id")] + [JsonRequired] + public string WarehouseId { get; set; } /// @@ -272,33 +272,33 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetShipmentByExternalIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); - sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); - sb.Append(" ShippingRuleId: ").Append(ShippingRuleId).Append("\n"); - sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); - sb.Append(" Items: ").Append(Items).Append("\n"); - sb.Append(" TaxIdentifiers: ").Append(TaxIdentifiers).Append("\n"); - sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); - sb.Append(" ShipmentNumber: ").Append(ShipmentNumber).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" InsuranceProvider: ").Append(InsuranceProvider).Append("\n"); sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); - sb.Append(" ShipmentStatus: ").Append(ShipmentStatus).Append("\n"); - sb.Append(" ShipTo: ").Append(ShipTo).Append("\n"); - sb.Append(" ShipFrom: ").Append(ShipFrom).Append("\n"); - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" ReturnTo: ").Append(ReturnTo).Append("\n"); - sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); - sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); - sb.Append(" Customs: ").Append(Customs).Append("\n"); - sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); - sb.Append(" InsuranceProvider: ").Append(InsuranceProvider).Append("\n"); + sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" ShipFrom: ").Append(ShipFrom).Append("\n"); + sb.Append(" ShipTo: ").Append(ShipTo).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" ShipmentStatus: ").Append(ShipmentStatus).Append("\n"); sb.Append(" Tags: ").Append(Tags).Append("\n"); - sb.Append(" OrderSourceCode: ").Append(OrderSourceCode).Append("\n"); - sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); + sb.Append(" Customs: ").Append(Customs).Append("\n"); + sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); + sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); + sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); + sb.Append(" Items: ").Append(Items).Append("\n"); + sb.Append(" OrderSourceCode: ").Append(OrderSourceCode).Append("\n"); + sb.Append(" ShipmentNumber: ").Append(ShipmentNumber).Append("\n"); + sb.Append(" ShippingRuleId: ").Append(ShippingRuleId).Append("\n"); + sb.Append(" TaxIdentifiers: ").Append(TaxIdentifiers).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs b/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs index e9179ce2..61d89e50 100644 --- a/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs @@ -28,15 +28,6 @@ namespace ShipEngineSDK.Model; public partial class GetShipmentByIdResponseBody { - /// - /// The current status of the shipment CLOVUS - /// - /// The current status of the shipment - [JsonPropertyName("shipment_status")] - [JsonRequired] - public ShipmentStatus ShipmentStatus { get; set; } = new(); - - /// /// The type of delivery confirmation that is required for this shipment. CLOVUS /// @@ -55,21 +46,27 @@ public partial class GetShipmentByIdResponseBody public InsuranceProvider InsuranceProvider { get; set; } = new(); + /// + /// The current status of the shipment CLOVUS + /// + /// The current status of the shipment + [JsonPropertyName("shipment_status")] + [JsonRequired] + public ShipmentStatus ShipmentStatus { get; set; } = new(); + + /// /// Gets or Sets OrderSourceCode CLOVUS /// [JsonPropertyName("order_source_code")] public OrderSourceName? OrderSourceCode { get; set; } /// - /// A string that uniquely identifies the shipment + /// Advanced shipment options. These are entirely optional. /// - /// A string that uniquely identifies the shipment - /// - /// se-28529731 - /// - [JsonPropertyName("shipment_id")] + /// Advanced shipment options. These are entirely optional. + [JsonPropertyName("advanced_options")] [JsonRequired] - public string ShipmentId { get; set; } + public AdvancedShipmentOptions AdvancedOptions { get; set; } /// /// The carrier account that is billed for the shipping charges @@ -83,59 +80,53 @@ public partial class GetShipmentByIdResponseBody public string CarrierId { get; set; } /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// The date and time that the shipment was created in ShipEngine. /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// The date and time that the shipment was created in ShipEngine. /// - /// usps_first_class_mail + /// 2018-09-23T15:00Z /// - [JsonPropertyName("service_code")] + [JsonPropertyName("created_at")] [JsonRequired] - public string ServiceCode { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// - /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// The date and time that the shipment was created or last modified. /// - /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// The date and time that the shipment was created or last modified. /// - /// se-28529731 + /// 2018-09-23T15:00Z /// - [JsonPropertyName("shipping_rule_id")] - public string ShippingRuleId { get; set; } - - /// - /// ID that the Order Source assigned - /// - /// ID that the Order Source assigned - [JsonPropertyName("external_order_id")] - public string ExternalOrderId { get; set; } - - /// - /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - /// - /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - [JsonPropertyName("items")] - public List Items { get; set; } + [JsonPropertyName("modified_at")] + [JsonRequired] + public DateTimeOffset ModifiedAt { get; set; } /// - /// Gets or Sets TaxIdentifiers + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// - [JsonPropertyName("tax_identifiers")] - public List TaxIdentifiers { get; set; } + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + [JsonPropertyName("packages")] + [JsonRequired] + public List Packages { get; set; } /// - /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. + /// The return address for this shipment. Defaults to the `ship_from` address. /// - /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("external_shipment_id")] - public string ExternalShipmentId { get; set; } + /// The return address for this shipment. Defaults to the `ship_from` address. + [JsonPropertyName("return_to")] + [JsonRequired] + public ShippingAddress ReturnTo { get; set; } /// - /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// - /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("shipment_number")] - public string ShipmentNumber { get; set; } + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// usps_first_class_mail + /// + [JsonPropertyName("service_code")] + [JsonRequired] + public string ServiceCode { get; set; } /// /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -149,26 +140,12 @@ public partial class GetShipmentByIdResponseBody public DateTimeOffset ShipDate { get; set; } /// - /// The date and time that the shipment was created in ShipEngine. - /// - /// The date and time that the shipment was created in ShipEngine. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("created_at")] - [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } - - /// - /// The date and time that the shipment was created or last modified. + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// - /// The date and time that the shipment was created or last modified. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("modified_at")] + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. + [JsonPropertyName("ship_from")] [JsonRequired] - public DateTimeOffset ModifiedAt { get; set; } + public ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address @@ -179,38 +156,41 @@ public partial class GetShipmentByIdResponseBody public ShippingAddressTo ShipTo { get; set; } /// - /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. + /// A string that uniquely identifies the shipment /// - /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from")] + /// A string that uniquely identifies the shipment + /// + /// se-28529731 + /// + [JsonPropertyName("shipment_id")] [JsonRequired] - public ShippingAddress ShipFrom { get; set; } + public string ShipmentId { get; set; } /// - /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// - /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. - /// - /// se-28529731 - /// - [JsonPropertyName("warehouse_id")] + /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. + [JsonPropertyName("tags")] [JsonRequired] - public string WarehouseId { get; set; } + public List Tags { get; set; } /// - /// The return address for this shipment. Defaults to the `ship_from` address. + /// The combined weight of all packages in the shipment /// - /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to")] + /// The combined weight of all packages in the shipment + [JsonPropertyName("total_weight")] [JsonRequired] - public ShippingAddress ReturnTo { get; set; } + public Weight TotalWeight { get; set; } /// - /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. /// - /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. - [JsonPropertyName("is_return")] - public bool? IsReturn { get; set; } + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// + /// retail + /// + [JsonPropertyName("comparison_rate_type")] + public string? ComparisonRateType { get; set; } /// /// Customs information. This is usually only needed for international shipments. @@ -221,46 +201,66 @@ public partial class GetShipmentByIdResponseBody public InternationalShipmentOptions Customs { get; set; } /// - /// Advanced shipment options. These are entirely optional. + /// ID that the Order Source assigned /// - /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options")] - [JsonRequired] - public AdvancedShipmentOptions AdvancedOptions { get; set; } + /// ID that the Order Source assigned + [JsonPropertyName("external_order_id")] + public string? ExternalOrderId { get; set; } /// - /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. + /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. /// - /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. - [JsonPropertyName("tags")] - [JsonRequired] - public List Tags { get; set; } + /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. + [JsonPropertyName("external_shipment_id")] + public string? ExternalShipmentId { get; set; } /// - /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// - /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - [JsonRequired] - public List Packages { get; set; } + /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. + [JsonPropertyName("is_return")] + public bool? IsReturn { get; set; } /// - /// The combined weight of all packages in the shipment + /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources /// - /// The combined weight of all packages in the shipment - [JsonPropertyName("total_weight")] - [JsonRequired] - public Weight TotalWeight { get; set; } + /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources + [JsonPropertyName("items")] + public List? Items { get; set; } /// - /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// - /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. + [JsonPropertyName("shipment_number")] + public string? ShipmentNumber { get; set; } + + /// + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment /// - /// retail + /// se-28529731 /// - [JsonPropertyName("comparison_rate_type")] - public string ComparisonRateType { get; set; } + [JsonPropertyName("shipping_rule_id")] + public string? ShippingRuleId { get; set; } + + /// + /// Gets or Sets TaxIdentifiers + /// + [JsonPropertyName("tax_identifiers")] + public List? TaxIdentifiers { get; set; } + + /// + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// + /// se-28529731 + /// + [JsonPropertyName("warehouse_id")] + [JsonRequired] + public string WarehouseId { get; set; } /// @@ -272,33 +272,33 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetShipmentByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); - sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); - sb.Append(" ShippingRuleId: ").Append(ShippingRuleId).Append("\n"); - sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); - sb.Append(" Items: ").Append(Items).Append("\n"); - sb.Append(" TaxIdentifiers: ").Append(TaxIdentifiers).Append("\n"); - sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); - sb.Append(" ShipmentNumber: ").Append(ShipmentNumber).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" InsuranceProvider: ").Append(InsuranceProvider).Append("\n"); sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); - sb.Append(" ShipmentStatus: ").Append(ShipmentStatus).Append("\n"); - sb.Append(" ShipTo: ").Append(ShipTo).Append("\n"); - sb.Append(" ShipFrom: ").Append(ShipFrom).Append("\n"); - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" ReturnTo: ").Append(ReturnTo).Append("\n"); - sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); - sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); - sb.Append(" Customs: ").Append(Customs).Append("\n"); - sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); - sb.Append(" InsuranceProvider: ").Append(InsuranceProvider).Append("\n"); + sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" ShipFrom: ").Append(ShipFrom).Append("\n"); + sb.Append(" ShipTo: ").Append(ShipTo).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" ShipmentStatus: ").Append(ShipmentStatus).Append("\n"); sb.Append(" Tags: ").Append(Tags).Append("\n"); - sb.Append(" OrderSourceCode: ").Append(OrderSourceCode).Append("\n"); - sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); + sb.Append(" Customs: ").Append(Customs).Append("\n"); + sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); + sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); + sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); + sb.Append(" Items: ").Append(Items).Append("\n"); + sb.Append(" OrderSourceCode: ").Append(OrderSourceCode).Append("\n"); + sb.Append(" ShipmentNumber: ").Append(ShipmentNumber).Append("\n"); + sb.Append(" ShippingRuleId: ").Append(ShippingRuleId).Append("\n"); + sb.Append(" TaxIdentifiers: ").Append(TaxIdentifiers).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs index 2558c711..1fc8a425 100644 --- a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs @@ -37,66 +37,65 @@ public partial class GetTrackingLogFromLabelResponseBody /// - /// A tracking number for a package. The format depends on the carrier. + /// Carrier status code /// - /// A tracking number for a package. The format depends on the carrier. + /// Carrier status code /// - /// 1Z932R800392060079 + /// 1 /// - [JsonPropertyName("tracking_number")] + [JsonPropertyName("carrier_status_code")] [JsonRequired] - public string TrackingNumber { get; set; } + public string CarrierStatusCode { get; set; } /// - /// Carrier Tracking Url, if available + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. /// - /// Carrier Tracking Url, if available + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. /// - /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 + /// 2018-09-23T15:00Z /// - [JsonPropertyName("tracking_url")] - public string TrackingUrl { get; set; } + [JsonPropertyName("estimated_delivery_date")] + [JsonRequired] + public DateTimeOffset EstimatedDeliveryDate { get; set; } /// - /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// The events that have occured during the lifetime of this tracking number. /// - /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. - /// - /// dhl_express - /// - [JsonPropertyName("carrier_code")] - public string CarrierCode { get; set; } + /// The events that have occured during the lifetime of this tracking number. + [JsonPropertyName("events")] + [JsonRequired] + public List Events { get; set; } /// - /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. + /// A tracking number for a package. The format depends on the carrier. /// - /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. + /// A tracking number for a package. The format depends on the carrier. /// - /// se-28529731 + /// 1Z932R800392060079 /// - [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + [JsonPropertyName("tracking_number")] + [JsonRequired] + public string TrackingNumber { get; set; } /// - /// Status description + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. /// - /// Status description + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. /// - /// Delivered + /// 2018-09-23T15:00Z /// - [JsonPropertyName("status_description")] - public string StatusDescription { get; set; } + [JsonPropertyName("actual_delivery_date")] + public DateTimeOffset? ActualDeliveryDate { get; set; } /// - /// Carrier status code + /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. /// - /// Carrier status code + /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. /// - /// 1 + /// dhl_express /// - [JsonPropertyName("carrier_status_code")] - [JsonRequired] - public string CarrierStatusCode { get; set; } + [JsonPropertyName("carrier_code")] + public string? CarrierCode { get; set; } /// /// Carrier detail code @@ -106,7 +105,17 @@ public partial class GetTrackingLogFromLabelResponseBody /// OT /// [JsonPropertyName("carrier_detail_code")] - public string CarrierDetailCode { get; set; } + public string? CarrierDetailCode { get; set; } + + /// + /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. + /// + /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. + /// + /// se-28529731 + /// + [JsonPropertyName("carrier_id")] + public string? CarrierId { get; set; } /// /// carrier status description @@ -116,17 +125,14 @@ public partial class GetTrackingLogFromLabelResponseBody /// Your item was delivered in or at the mailbox at 9:10 am on March /// [JsonPropertyName("carrier_status_description")] - public string CarrierStatusDescription { get; set; } + public string? CarrierStatusDescription { get; set; } /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. + /// Exception description /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + /// Exception description + [JsonPropertyName("exception_description")] + public string? ExceptionDescription { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -135,34 +141,28 @@ public partial class GetTrackingLogFromLabelResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("estimated_delivery_date")] - [JsonRequired] - public DateTimeOffset EstimatedDeliveryDate { get; set; } + [JsonPropertyName("ship_date")] + public DateTimeOffset? ShipDate { get; set; } /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. + /// Status description /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. + /// Status description /// - /// 2018-09-23T15:00Z + /// Delivered /// - [JsonPropertyName("actual_delivery_date")] - public DateTimeOffset ActualDeliveryDate { get; set; } - - /// - /// Exception description - /// - /// Exception description - [JsonPropertyName("exception_description")] - public string ExceptionDescription { get; set; } + [JsonPropertyName("status_description")] + public string? StatusDescription { get; set; } /// - /// The events that have occured during the lifetime of this tracking number. + /// Carrier Tracking Url, if available /// - /// The events that have occured during the lifetime of this tracking number. - [JsonPropertyName("events")] - [JsonRequired] - public List Events { get; set; } + /// Carrier Tracking Url, if available + /// + /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 + /// + [JsonPropertyName("tracking_url")] + public string? TrackingUrl { get; set; } /// @@ -174,20 +174,20 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetTrackingLogFromLabelResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); - sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); + sb.Append(" CarrierStatusCode: ").Append(CarrierStatusCode).Append("\n"); + sb.Append(" EstimatedDeliveryDate: ").Append(EstimatedDeliveryDate).Append("\n"); + sb.Append(" Events: ").Append(Events).Append("\n"); sb.Append(" StatusCode: ").Append(StatusCode).Append("\n"); + sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); + sb.Append(" ActualDeliveryDate: ").Append(ActualDeliveryDate).Append("\n"); sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); - sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); - sb.Append(" StatusDescription: ").Append(StatusDescription).Append("\n"); - sb.Append(" CarrierStatusCode: ").Append(CarrierStatusCode).Append("\n"); sb.Append(" CarrierDetailCode: ").Append(CarrierDetailCode).Append("\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" CarrierStatusDescription: ").Append(CarrierStatusDescription).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); - sb.Append(" EstimatedDeliveryDate: ").Append(EstimatedDeliveryDate).Append("\n"); - sb.Append(" ActualDeliveryDate: ").Append(ActualDeliveryDate).Append("\n"); sb.Append(" ExceptionDescription: ").Append(ExceptionDescription).Append("\n"); - sb.Append(" Events: ").Append(Events).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" StatusDescription: ").Append(StatusDescription).Append("\n"); + sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs index 8d8900ba..795d4c53 100644 --- a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs @@ -37,37 +37,26 @@ public partial class GetTrackingLogResponseBody /// - /// A tracking number for a package. The format depends on the carrier. - /// - /// A tracking number for a package. The format depends on the carrier. - /// - /// 1Z932R800392060079 - /// - [JsonPropertyName("tracking_number")] - [JsonRequired] - public string TrackingNumber { get; set; } - - /// - /// Carrier Tracking Url, if available + /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. /// - /// Carrier Tracking Url, if available + /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. /// - /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 + /// dhl_express /// - [JsonPropertyName("tracking_url")] + [JsonPropertyName("carrier_code")] [JsonRequired] - public string TrackingUrl { get; set; } + public string CarrierCode { get; set; } /// - /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// Carrier detail code /// - /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// Carrier detail code /// - /// dhl_express + /// OT /// - [JsonPropertyName("carrier_code")] + [JsonPropertyName("carrier_detail_code")] [JsonRequired] - public string CarrierCode { get; set; } + public string CarrierDetailCode { get; set; } /// /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. @@ -80,16 +69,6 @@ public partial class GetTrackingLogResponseBody [JsonRequired] public string CarrierId { get; set; } - /// - /// Status description - /// - /// Status description - /// - /// Delivered - /// - [JsonPropertyName("status_description")] - public string StatusDescription { get; set; } - /// /// Carrier status code /// @@ -102,46 +81,45 @@ public partial class GetTrackingLogResponseBody public string CarrierStatusCode { get; set; } /// - /// Carrier detail code + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. /// - /// Carrier detail code + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. /// - /// OT + /// 2018-09-23T15:00Z /// - [JsonPropertyName("carrier_detail_code")] + [JsonPropertyName("estimated_delivery_date")] [JsonRequired] - public string CarrierDetailCode { get; set; } + public DateTimeOffset EstimatedDeliveryDate { get; set; } /// - /// carrier status description + /// The events that have occured during the lifetime of this tracking number. /// - /// carrier status description - /// - /// Your item was delivered in or at the mailbox at 9:10 am on March - /// - [JsonPropertyName("carrier_status_description")] - public string CarrierStatusDescription { get; set; } + /// The events that have occured during the lifetime of this tracking number. + [JsonPropertyName("events")] + [JsonRequired] + public List Events { get; set; } /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. + /// A tracking number for a package. The format depends on the carrier. /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. + /// A tracking number for a package. The format depends on the carrier. /// - /// 2018-09-23T15:00Z + /// 1Z932R800392060079 /// - [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + [JsonPropertyName("tracking_number")] + [JsonRequired] + public string TrackingNumber { get; set; } /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. + /// Carrier Tracking Url, if available /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. + /// Carrier Tracking Url, if available /// - /// 2018-09-23T15:00Z + /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// - [JsonPropertyName("estimated_delivery_date")] + [JsonPropertyName("tracking_url")] [JsonRequired] - public DateTimeOffset EstimatedDeliveryDate { get; set; } + public string TrackingUrl { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -151,22 +129,44 @@ public partial class GetTrackingLogResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("actual_delivery_date")] - public DateTimeOffset ActualDeliveryDate { get; set; } + public DateTimeOffset? ActualDeliveryDate { get; set; } + + /// + /// carrier status description + /// + /// carrier status description + /// + /// Your item was delivered in or at the mailbox at 9:10 am on March + /// + [JsonPropertyName("carrier_status_description")] + public string? CarrierStatusDescription { get; set; } /// /// Exception description /// /// Exception description [JsonPropertyName("exception_description")] - public string ExceptionDescription { get; set; } + public string? ExceptionDescription { get; set; } /// - /// The events that have occured during the lifetime of this tracking number. + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. /// - /// The events that have occured during the lifetime of this tracking number. - [JsonPropertyName("events")] - [JsonRequired] - public List Events { get; set; } + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("ship_date")] + public DateTimeOffset? ShipDate { get; set; } + + /// + /// Status description + /// + /// Status description + /// + /// Delivered + /// + [JsonPropertyName("status_description")] + public string? StatusDescription { get; set; } /// @@ -178,20 +178,20 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetTrackingLogResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); - sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); - sb.Append(" StatusCode: ").Append(StatusCode).Append("\n"); sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" CarrierDetailCode: ").Append(CarrierDetailCode).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); - sb.Append(" StatusDescription: ").Append(StatusDescription).Append("\n"); sb.Append(" CarrierStatusCode: ").Append(CarrierStatusCode).Append("\n"); - sb.Append(" CarrierDetailCode: ").Append(CarrierDetailCode).Append("\n"); - sb.Append(" CarrierStatusDescription: ").Append(CarrierStatusDescription).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); sb.Append(" EstimatedDeliveryDate: ").Append(EstimatedDeliveryDate).Append("\n"); + sb.Append(" Events: ").Append(Events).Append("\n"); + sb.Append(" StatusCode: ").Append(StatusCode).Append("\n"); + sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); + sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); sb.Append(" ActualDeliveryDate: ").Append(ActualDeliveryDate).Append("\n"); + sb.Append(" CarrierStatusDescription: ").Append(CarrierStatusDescription).Append("\n"); sb.Append(" ExceptionDescription: ").Append(ExceptionDescription).Append("\n"); - sb.Append(" Events: ").Append(Events).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" StatusDescription: ").Append(StatusDescription).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs b/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs index 9396a6e2..88d9461b 100644 --- a/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs @@ -29,22 +29,15 @@ public partial class GetWarehouseByIdResponseBody { /// - /// A string that uniquely identifies the warehouse + /// Timestamp that indicates when the warehouse was created /// - /// A string that uniquely identifies the warehouse + /// Timestamp that indicates when the warehouse was created /// - /// se-28529731 + /// 2019-06-25T18:12:35.583Z /// - [JsonPropertyName("warehouse_id")] + [JsonPropertyName("created_at")] [JsonRequired] - public string WarehouseId { get; set; } - - /// - /// Designates which single warehouse is the default on the account - /// - /// Designates which single warehouse is the default on the account - [JsonPropertyName("is_default")] - public bool? IsDefault { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// /// Name of the warehouse @@ -57,17 +50,6 @@ public partial class GetWarehouseByIdResponseBody [JsonRequired] public string Name { get; set; } - /// - /// Timestamp that indicates when the warehouse was created - /// - /// Timestamp that indicates when the warehouse was created - /// - /// 2019-06-25T18:12:35.583Z - /// - [JsonPropertyName("created_at")] - [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } - /// /// The origin address of the warehouse /// @@ -84,6 +66,24 @@ public partial class GetWarehouseByIdResponseBody [JsonRequired] public Address ReturnAddress { get; set; } + /// + /// A string that uniquely identifies the warehouse + /// + /// A string that uniquely identifies the warehouse + /// + /// se-28529731 + /// + [JsonPropertyName("warehouse_id")] + [JsonRequired] + public string WarehouseId { get; set; } + + /// + /// Designates which single warehouse is the default on the account + /// + /// Designates which single warehouse is the default on the account + [JsonPropertyName("is_default")] + public bool? IsDefault { get; set; } + /// /// Returns the string presentation of the object @@ -94,12 +94,12 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetWarehouseByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); - sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); - sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" OriginAddress: ").Append(OriginAddress).Append("\n"); sb.Append(" ReturnAddress: ").Append(ReturnAddress).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); + sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs b/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs index 924ae7a4..5e6d22a6 100644 --- a/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs @@ -37,33 +37,33 @@ public partial class GetWebhookByIdResponseBody /// - /// A string that uniquely identifies the webhook + /// The url that the webhook sends the request to /// - /// A string that uniquely identifies the webhook + /// The url that the webhook sends the request to /// - /// se-28529731 + /// http://api.shipengine.com/v1/labels/se-28529731 /// - [JsonPropertyName("webhook_id")] + [JsonPropertyName("url")] [JsonRequired] - public string WebhookId { get; set; } + public string Url { get; set; } /// - /// The url that the webhook sends the request to + /// A string that uniquely identifies the webhook /// - /// The url that the webhook sends the request to + /// A string that uniquely identifies the webhook /// - /// http://api.shipengine.com/v1/labels/se-28529731 + /// se-28529731 /// - [JsonPropertyName("url")] + [JsonPropertyName("webhook_id")] [JsonRequired] - public string Url { get; set; } + public string WebhookId { get; set; } /// /// Array of custom webhook headers /// /// Array of custom webhook headers [JsonPropertyName("headers")] - public List Headers { get; set; } + public List? Headers { get; set; } /// @@ -75,9 +75,9 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class GetWebhookByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" WebhookId: ").Append(WebhookId).Append("\n"); - sb.Append(" Url: ").Append(Url).Append("\n"); sb.Append(" Event: ").Append(Event).Append("\n"); + sb.Append(" Url: ").Append(Url).Append("\n"); + sb.Append(" WebhookId: ").Append(WebhookId).Append("\n"); sb.Append(" Headers: ").Append(Headers).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/ImporterOfRecords.cs b/ShipEngineSDK/Model/ImporterOfRecords.cs index 6b6ff91b..a53694e6 100644 --- a/ShipEngineSDK/Model/ImporterOfRecords.cs +++ b/ShipEngineSDK/Model/ImporterOfRecords.cs @@ -29,56 +29,59 @@ public partial class ImporterOfRecords { /// - /// The name of a contact person at this address. Either `name` or the `company_name` field should always be set. + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. /// - /// The name of a contact person at this address. Either `name` or the `company_name` field should always be set. + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. /// - /// John Doe + /// 1999 Bishop Grandin Blvd. /// - [JsonPropertyName("name")] + [JsonPropertyName("address_line1")] [JsonRequired] - public string Name { get; set; } + public string AddressLine1 { get; set; } /// - /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// The name of the city or locality /// - /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// The name of the city or locality /// - /// +1 204-253-9411 ext. 123 + /// Winnipeg /// - [JsonPropertyName("phone")] - public string Phone { get; set; } + [JsonPropertyName("city_locality")] + [JsonRequired] + public string CityLocality { get; set; } /// - /// Email for the address owner. + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) /// - /// Email for the address owner. + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) /// - /// example@example.com + /// CA /// - [JsonPropertyName("email")] - public string Email { get; set; } + [JsonPropertyName("country_code")] + [JsonRequired] + public string CountryCode { get; set; } /// - /// If this is a business address, then the company name should be specified here. Either `name` or the `company_name` field should always be set. + /// The name of a contact person at this address. Either `name` or the `company_name` field should always be set. /// - /// If this is a business address, then the company name should be specified here. Either `name` or the `company_name` field should always be set. + /// The name of a contact person at this address. Either `name` or the `company_name` field should always be set. /// - /// The Home Depot + /// John Doe /// - [JsonPropertyName("company_name")] - public string CompanyName { get; set; } + [JsonPropertyName("name")] + [JsonRequired] + public string Name { get; set; } /// - /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// postal code /// - /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// postal code /// - /// 1999 Bishop Grandin Blvd. + /// 78756-3717 /// - [JsonPropertyName("address_line1")] + [JsonPropertyName("postal_code")] [JsonRequired] - public string AddressLine1 { get; set; } + public string PostalCode { get; set; } /// /// The second line of the street address. For some addresses, this line may not be needed. @@ -88,7 +91,7 @@ public partial class ImporterOfRecords /// Unit 408 /// [JsonPropertyName("address_line2")] - public string AddressLine2 { get; set; } + public string? AddressLine2 { get; set; } /// /// The third line of the street address. For some addresses, this line may not be needed. @@ -98,50 +101,47 @@ public partial class ImporterOfRecords /// Building #7 /// [JsonPropertyName("address_line3")] - public string AddressLine3 { get; set; } + public string? AddressLine3 { get; set; } /// - /// The name of the city or locality + /// If this is a business address, then the company name should be specified here. Either `name` or the `company_name` field should always be set. /// - /// The name of the city or locality + /// If this is a business address, then the company name should be specified here. Either `name` or the `company_name` field should always be set. /// - /// Winnipeg + /// The Home Depot /// - [JsonPropertyName("city_locality")] - [JsonRequired] - public string CityLocality { get; set; } + [JsonPropertyName("company_name")] + public string? CompanyName { get; set; } /// - /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// Email for the address owner. /// - /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// Email for the address owner. /// - /// Manitoba + /// example@example.com /// - [JsonPropertyName("state_province")] - public string StateProvince { get; set; } + [JsonPropertyName("email")] + public string? Email { get; set; } /// - /// postal code + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. /// - /// postal code + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. /// - /// 78756-3717 + /// +1 204-253-9411 ext. 123 /// - [JsonPropertyName("postal_code")] - [JsonRequired] - public string PostalCode { get; set; } + [JsonPropertyName("phone")] + public string? Phone { get; set; } /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. /// - /// CA + /// Manitoba /// - [JsonPropertyName("country_code")] - [JsonRequired] - public string CountryCode { get; set; } + [JsonPropertyName("state_province")] + public string? StateProvince { get; set; } /// @@ -153,17 +153,17 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ImporterOfRecords {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Phone: ").Append(Phone).Append("\n"); - sb.Append(" Email: ").Append(Email).Append("\n"); - sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); + sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); - sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); + sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); - sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); - sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/InternationalShipmentOptions.cs b/ShipEngineSDK/Model/InternationalShipmentOptions.cs index a737b721..71be2755 100644 --- a/ShipEngineSDK/Model/InternationalShipmentOptions.cs +++ b/ShipEngineSDK/Model/InternationalShipmentOptions.cs @@ -57,34 +57,34 @@ public partial class InternationalShipmentOptions /// /// Explanation for contents (required if the `contents` is provided as `other`) [JsonPropertyName("contents_explanation")] - public string ContentsExplanation { get; set; } + public string? ContentsExplanation { get; set; } /// - /// Declaration statement to be placed on the commercial invoice + /// Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`) /// - /// Declaration statement to be placed on the commercial invoice - [JsonPropertyName("declaration")] - public string Declaration { get; set; } + /// Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`) + [JsonPropertyName("customs_items")] + [Obsolete] + public List? CustomsItems { get; set; } /// - /// Gets or Sets InvoiceAdditionalDetails + /// Declaration statement to be placed on the commercial invoice /// - [JsonPropertyName("invoice_additional_details")] - public InvoiceAdditionalDetails InvoiceAdditionalDetails { get; set; } + /// Declaration statement to be placed on the commercial invoice + [JsonPropertyName("declaration")] + public string? Declaration { get; set; } /// /// Gets or Sets ImporterOfRecord /// [JsonPropertyName("importer_of_record")] - public ImporterOfRecords ImporterOfRecord { get; set; } + public ImporterOfRecords? ImporterOfRecord { get; set; } /// - /// Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`) + /// Gets or Sets InvoiceAdditionalDetails /// - /// Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`) - [JsonPropertyName("customs_items")] - [Obsolete] - public List CustomsItems { get; set; } + [JsonPropertyName("invoice_additional_details")] + public InvoiceAdditionalDetails? InvoiceAdditionalDetails { get; set; } /// @@ -97,13 +97,13 @@ public override string ToString() sb.Append("class InternationalShipmentOptions {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Contents: ").Append(Contents).Append("\n"); - sb.Append(" ContentsExplanation: ").Append(ContentsExplanation).Append("\n"); sb.Append(" NonDelivery: ").Append(NonDelivery).Append("\n"); - sb.Append(" TermsOfTradeCode: ").Append(TermsOfTradeCode).Append("\n"); + sb.Append(" ContentsExplanation: ").Append(ContentsExplanation).Append("\n"); + sb.Append(" CustomsItems: ").Append(CustomsItems).Append("\n"); sb.Append(" Declaration: ").Append(Declaration).Append("\n"); - sb.Append(" InvoiceAdditionalDetails: ").Append(InvoiceAdditionalDetails).Append("\n"); sb.Append(" ImporterOfRecord: ").Append(ImporterOfRecord).Append("\n"); - sb.Append(" CustomsItems: ").Append(CustomsItems).Append("\n"); + sb.Append(" InvoiceAdditionalDetails: ").Append(InvoiceAdditionalDetails).Append("\n"); + sb.Append(" TermsOfTradeCode: ").Append(TermsOfTradeCode).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs b/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs index fca0610c..20aeba95 100644 --- a/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs +++ b/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs @@ -28,40 +28,40 @@ namespace ShipEngineSDK.Model; public partial class InvoiceAdditionalDetails { + /// + /// Discount for shipment. + /// + /// Discount for shipment. + [JsonPropertyName("discount")] + public MonetaryValue? Discount { get; set; } + /// /// Freight Charge for shipment. /// /// Freight Charge for shipment. [JsonPropertyName("freight_charge")] - public MonetaryValue FreightCharge { get; set; } + public MonetaryValue? FreightCharge { get; set; } /// /// Insurance Charge for shipment. /// /// Insurance Charge for shipment. [JsonPropertyName("insurance_charge")] - public MonetaryValue InsuranceCharge { get; set; } - - /// - /// Discount for shipment. - /// - /// Discount for shipment. - [JsonPropertyName("discount")] - public MonetaryValue Discount { get; set; } + public MonetaryValue? InsuranceCharge { get; set; } /// /// Other charge for shipment. /// /// Other charge for shipment. [JsonPropertyName("other_charge")] - public MonetaryValue OtherCharge { get; set; } + public MonetaryValue? OtherCharge { get; set; } /// /// Description for the other charge (if provided). /// /// Description for the other charge (if provided). [JsonPropertyName("other_charge_description")] - public string OtherChargeDescription { get; set; } + public string? OtherChargeDescription { get; set; } /// @@ -73,9 +73,9 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class InvoiceAdditionalDetails {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" Discount: ").Append(Discount).Append("\n"); sb.Append(" FreightCharge: ").Append(FreightCharge).Append("\n"); sb.Append(" InsuranceCharge: ").Append(InsuranceCharge).Append("\n"); - sb.Append(" Discount: ").Append(Discount).Append("\n"); sb.Append(" OtherCharge: ").Append(OtherCharge).Append("\n"); sb.Append(" OtherChargeDescription: ").Append(OtherChargeDescription).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete diff --git a/ShipEngineSDK/Model/Label.cs b/ShipEngineSDK/Model/Label.cs index b2b58e32..ca5b4c38 100644 --- a/ShipEngineSDK/Model/Label.cs +++ b/ShipEngineSDK/Model/Label.cs @@ -28,11 +28,6 @@ namespace ShipEngineSDK.Model; public partial class Label { - /// - /// Gets or Sets Status CLOVUS - /// - [JsonPropertyName("status")] - public LabelStatus? Status { get; set; } /// /// The label charge event. CLOVUS /// @@ -40,10 +35,11 @@ public partial class Label [JsonPropertyName("charge_event")] public LabelChargeEvent? ChargeEvent { get; set; } /// - /// Gets or Sets ValidateAddress CLOVUS + /// The display format that the label should be shown in. CLOVUS /// - [JsonPropertyName("validate_address")] - public ValidateAddress? ValidateAddress { get; set; } + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme")] + public DisplayScheme? DisplayScheme { get; set; } /// /// Gets or Sets LabelDownloadType CLOVUS /// @@ -56,59 +52,63 @@ public partial class Label [JsonPropertyName("label_format")] public LabelFormat? LabelFormat { get; set; } /// - /// The display format that the label should be shown in. CLOVUS - /// - /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] - public DisplayScheme? DisplayScheme { 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. CLOVUS /// /// 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")] public LabelLayout? LabelLayout { get; set; } /// + /// Gets or Sets Status CLOVUS + /// + [JsonPropertyName("status")] + public LabelStatus? Status { get; set; } + /// /// The current status of the package, such as `in_transit` or `delivered` CLOVUS /// /// The current status of the package, such as `in_transit` or `delivered` [JsonPropertyName("tracking_status")] public TrackingStatus? TrackingStatus { get; set; } /// - /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. + /// Gets or Sets ValidateAddress CLOVUS /// - /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. - /// - /// se-28529731 - /// - [JsonPropertyName("label_id")] - public string LabelId { get; set; } + [JsonPropertyName("validate_address")] + public ValidateAddress? ValidateAddress { get; set; } + /// + /// Additional information some carriers may provide by which to identify a given label in their system. + /// + /// Additional information some carriers may provide by which to identify a given label in their system. + [JsonPropertyName("alternative_identifiers")] + public List? AlternativeIdentifiers { get; set; } /// - /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// - /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string ShipmentId { get; set; } + [JsonPropertyName("batch_id")] + public string? BatchId { get; set; } /// - /// The shipment information used to generate the label + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. /// - /// The shipment information used to generate the label - [JsonPropertyName("shipment")] - public Shipment Shipment { get; set; } + /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// dhl_express + /// + [JsonPropertyName("carrier_code")] + public string? CarrierCode { get; set; } /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// - /// 2018-09-23T00:00Z + /// se-28529731 /// - [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + [JsonPropertyName("carrier_id")] + public string? CarrierId { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -118,79 +118,68 @@ public partial class Label /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + public DateTimeOffset? CreatedAt { get; set; } /// - /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + /// 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. /// - /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - [JsonPropertyName("shipment_cost")] - public MonetaryValue ShipmentCost { 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. + [JsonPropertyName("form_download")] + public Link? FormDownload { get; set; } /// - /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + /// 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. /// - /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. - [JsonPropertyName("insurance_cost")] - public MonetaryValue InsuranceCost { get; set; } + /// 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. + [JsonPropertyName("insurance_claim")] + public Link? InsuranceClaim { get; set; } /// - /// The total shipping cost for the specified comparison_rate_type. + /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// - /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue RequestedComparisonAmount { get; set; } + /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + [JsonPropertyName("insurance_cost")] + public MonetaryValue? InsuranceCost { get; set; } /// - /// The tracking number for the package. Tracking number formats vary across carriers. + /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// - /// The tracking number for the package. Tracking number formats vary across carriers. - /// - /// 782758401696 - /// - [JsonPropertyName("tracking_number")] - public string TrackingNumber { get; set; } + /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + [JsonPropertyName("is_international")] + public bool? IsInternational { get; set; } /// /// 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")] - public bool IsReturnLabel { get; set; } - - /// - /// 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")] - public string RmaNumber { get; set; } + public bool? IsReturnLabel { get; set; } /// - /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + /// Gets or Sets LabelDownload /// - /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. - [JsonPropertyName("is_international")] - public bool IsInternational { get; set; } + [JsonPropertyName("label_download")] + public LabelDownload? LabelDownload { get; set; } /// - /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// - /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - public string BatchId { get; set; } + [JsonPropertyName("label_id")] + public string? LabelId { get; set; } /// - /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// The label image resource that was used to create a custom label image. /// - /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// The label image resource that was used to create a custom label image. /// - /// se-28529731 + /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + [JsonPropertyName("label_image_id")] + public string? LabelImageId { get; set; } /// /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. @@ -200,25 +189,7 @@ public partial class Label /// se-28529731 /// [JsonPropertyName("outbound_label_id")] - public string OutboundLabelId { get; set; } - - /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. - /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. - /// - /// usps_first_class_mail - /// - [JsonPropertyName("service_code")] - public string ServiceCode { 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")] - [Obsolete] - public bool TestLabel { get; set; } + public string? OutboundLabelId { get; set; } /// /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. @@ -228,92 +199,104 @@ public partial class Label /// small_flat_rate_box /// [JsonPropertyName("package_code")] - public string PackageCode { get; set; } + public string? PackageCode { get; set; } /// - /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// - /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) - [JsonPropertyName("voided")] - public bool Voided { get; set; } + /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + [JsonPropertyName("packages")] + public List? Packages { get; set; } /// - /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// - /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("voided_at")] - public DateTimeOffset VoidedAt { get; set; } + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + [JsonPropertyName("paperless_download")] + public PaperlessDownload? PaperlessDownload { get; set; } /// - /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + /// The total shipping cost for the specified comparison_rate_type. /// - /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. - [JsonPropertyName("trackable")] - public bool Trackable { get; set; } + /// The total shipping cost for the specified comparison_rate_type. + [JsonPropertyName("requested_comparison_amount")] + public MonetaryValue? RequestedComparisonAmount { get; set; } /// - /// The label image resource that was used to create a custom label image. + /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. /// - /// The label image resource that was used to create a custom label image. + /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. + [JsonPropertyName("rma_number")] + public string? RmaNumber { get; set; } + + /// + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// - /// img_DtBXupDBxREpHnwEXhTfgK + /// usps_first_class_mail /// - [JsonPropertyName("label_image_id")] - public string LabelImageId { get; set; } + [JsonPropertyName("service_code")] + public string? ServiceCode { get; set; } /// - /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// dhl_express + /// 2018-09-23T00:00Z /// - [JsonPropertyName("carrier_code")] - public string CarrierCode { get; set; } + [JsonPropertyName("ship_date")] + public DateTimeOffset? ShipDate { get; set; } /// - /// Gets or Sets LabelDownload + /// The shipment information used to generate the label /// - [JsonPropertyName("label_download")] - public LabelDownload LabelDownload { get; set; } + /// The shipment information used to generate the label + [JsonPropertyName("shipment")] + public Shipment? Shipment { 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. + /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// - /// 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. - [JsonPropertyName("form_download")] - public Link FormDownload { get; set; } + /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + [JsonPropertyName("shipment_cost")] + public MonetaryValue? ShipmentCost { get; set; } /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - public PaperlessDownload PaperlessDownload { get; set; } + /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// + /// se-28529731 + /// + [JsonPropertyName("shipment_id")] + public string? ShipmentId { get; set; } /// - /// 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. + /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. /// - /// 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. - [JsonPropertyName("insurance_claim")] - public Link InsuranceClaim { get; set; } + /// 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")] + [Obsolete] + public bool? TestLabel { get; set; } /// - /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// - /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - public List Packages { get; set; } + /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + [JsonPropertyName("trackable")] + public bool? Trackable { get; set; } /// - /// Additional information some carriers may provide by which to identify a given label in their system. + /// The tracking number for the package. Tracking number formats vary across carriers. /// - /// Additional information some carriers may provide by which to identify a given label in their system. - [JsonPropertyName("alternative_identifiers")] - public List AlternativeIdentifiers { get; set; } + /// The tracking number for the package. Tracking number formats vary across carriers. + /// + /// 782758401696 + /// + [JsonPropertyName("tracking_number")] + public string? TrackingNumber { get; set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. @@ -323,7 +306,24 @@ public partial class Label /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url")] - public string TrackingUrl { get; set; } + public string? TrackingUrl { get; set; } + + /// + /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// + /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + [JsonPropertyName("voided")] + public bool? Voided { get; set; } + + /// + /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("voided_at")] + public DateTimeOffset? VoidedAt { get; set; } /// @@ -335,44 +335,44 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class Label {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" LabelId: ").Append(LabelId).Append("\n"); - sb.Append(" Status: ").Append(Status).Append("\n"); - sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); - sb.Append(" Shipment: ").Append(Shipment).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); - sb.Append(" ShipmentCost: ").Append(ShipmentCost).Append("\n"); - sb.Append(" InsuranceCost: ").Append(InsuranceCost).Append("\n"); - sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); - sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); - sb.Append(" IsReturnLabel: ").Append(IsReturnLabel).Append("\n"); - sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); - sb.Append(" IsInternational: ").Append(IsInternational).Append("\n"); + sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" BatchId: ").Append(BatchId).Append("\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); - sb.Append(" OutboundLabelId: ").Append(OutboundLabelId).Append("\n"); - sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); - sb.Append(" TestLabel: ").Append(TestLabel).Append("\n"); - sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); - sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); - sb.Append(" Voided: ").Append(Voided).Append("\n"); - sb.Append(" VoidedAt: ").Append(VoidedAt).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); + sb.Append(" InsuranceClaim: ").Append(InsuranceClaim).Append("\n"); + sb.Append(" InsuranceCost: ").Append(InsuranceCost).Append("\n"); + sb.Append(" IsInternational: ").Append(IsInternational).Append("\n"); + sb.Append(" IsReturnLabel: ").Append(IsReturnLabel).Append("\n"); + sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); - sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" LabelId: ").Append(LabelId).Append("\n"); + sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); + sb.Append(" OutboundLabelId: ").Append(OutboundLabelId).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); + sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); + sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" Shipment: ").Append(Shipment).Append("\n"); + sb.Append(" ShipmentCost: ").Append(ShipmentCost).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" Status: ").Append(Status).Append("\n"); + sb.Append(" TestLabel: ").Append(TestLabel).Append("\n"); sb.Append(" Trackable: ").Append(Trackable).Append("\n"); - sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); - sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); sb.Append(" TrackingStatus: ").Append(TrackingStatus).Append("\n"); - sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); - sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); - sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); - sb.Append(" InsuranceClaim: ").Append(InsuranceClaim).Append("\n"); - sb.Append(" Packages: ").Append(Packages).Append("\n"); - sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); + sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); + sb.Append(" Voided: ").Append(Voided).Append("\n"); + sb.Append(" VoidedAt: ").Append(VoidedAt).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/LabelDownload.cs b/ShipEngineSDK/Model/LabelDownload.cs index 1a2cfc0e..f4aae4c6 100644 --- a/ShipEngineSDK/Model/LabelDownload.cs +++ b/ShipEngineSDK/Model/LabelDownload.cs @@ -36,7 +36,7 @@ public partial class LabelDownload /// http://api.shipengine.com/v1/labels/se-28529731 /// [JsonPropertyName("href")] - public string Href { get; set; } + public string? Href { get; set; } /// /// The URL for the pdf generated label @@ -46,7 +46,7 @@ public partial class LabelDownload /// http://api.shipengine.com/v1/labels/se-28529731 /// [JsonPropertyName("pdf")] - public string Pdf { get; set; } + public string? Pdf { get; set; } /// /// The URL for the png generated label @@ -56,7 +56,7 @@ public partial class LabelDownload /// http://api.shipengine.com/v1/labels/se-28529731 /// [JsonPropertyName("png")] - public string Png { get; set; } + public string? Png { get; set; } /// /// The URL for the zpl generated label @@ -66,7 +66,7 @@ public partial class LabelDownload /// http://api.shipengine.com/v1/labels/se-28529731 /// [JsonPropertyName("zpl")] - public string Zpl { get; set; } + public string? Zpl { get; set; } /// diff --git a/ShipEngineSDK/Model/LabelPackagesInner.cs b/ShipEngineSDK/Model/LabelPackagesInner.cs index 5b06ba3d..f671009f 100644 --- a/ShipEngineSDK/Model/LabelPackagesInner.cs +++ b/ShipEngineSDK/Model/LabelPackagesInner.cs @@ -29,24 +29,19 @@ public partial class LabelPackagesInner { /// - /// A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/) + /// The package weight /// - /// A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/) - /// - /// se-28529731 - /// - [JsonPropertyName("package_id")] - public string PackageId { get; set; } + /// The package weight + [JsonPropertyName("weight")] + [JsonRequired] + public Weight Weight { get; set; } /// - /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// Alternative identifiers associated with this package. /// - /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. - /// - /// small_flat_rate_box - /// - [JsonPropertyName("package_code")] - public string PackageCode { get; set; } + /// Alternative identifiers associated with this package. + [JsonPropertyName("alternative_identifiers")] + public List? AlternativeIdentifiers { get; set; } /// /// A short description of the package content. Required for shipments moving to, from, and through Mexico. @@ -56,94 +51,99 @@ public partial class LabelPackagesInner /// Hand knitted wool socks /// [JsonPropertyName("content_description")] - public string ContentDescription { get; set; } - - /// - /// The package weight - /// - /// The package weight - [JsonPropertyName("weight")] - [JsonRequired] - public Weight Weight { get; set; } + public string? ContentDescription { get; set; } /// /// The package dimensions /// /// The package dimensions [JsonPropertyName("dimensions")] - public Dimensions Dimensions { get; set; } + public Dimensions? Dimensions { get; set; } + + /// + /// An external package id. + /// + /// An external package id. + [JsonPropertyName("external_package_id")] + public string? ExternalPackageId { get; set; } + + /// + /// The form download for any customs that are needed + /// + /// The form download for any customs that are needed + [JsonPropertyName("form_download")] + public OptionalLink? FormDownload { get; set; } /// /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. /// /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. [JsonPropertyName("insured_value")] - public MonetaryValue InsuredValue { get; set; } + public MonetaryValue? InsuredValue { get; set; } /// - /// The tracking number for the package. The format depends on the carrier. + /// The label download for the package /// - /// The tracking number for the package. The format depends on the carrier. - /// - /// 1Z932R800392060079 - /// - [JsonPropertyName("tracking_number")] - public string TrackingNumber { get; set; } + /// The label download for the package + [JsonPropertyName("label_download")] + public LabelDownload? LabelDownload { get; set; } /// /// Gets or Sets LabelMessages /// [JsonPropertyName("label_messages")] - public LabelMessages LabelMessages { get; set; } + public LabelMessages? LabelMessages { get; set; } /// - /// An external package id. - /// - /// An external package id. - [JsonPropertyName("external_package_id")] - public string ExternalPackageId { get; set; } - - /// - /// The label download for the package + /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. /// - /// The label download for the package - [JsonPropertyName("label_download")] - public LabelDownload LabelDownload { get; set; } + /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// + /// small_flat_rate_box + /// + [JsonPropertyName("package_code")] + public string? PackageCode { get; set; } /// - /// The form download for any customs that are needed + /// A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/) /// - /// The form download for any customs that are needed - [JsonPropertyName("form_download")] - public OptionalLink FormDownload { get; set; } + /// A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/) + /// + /// se-28529731 + /// + [JsonPropertyName("package_id")] + public string? PackageId { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. [JsonPropertyName("paperless_download")] - public PaperlessDownload PaperlessDownload { get; set; } - - /// - /// Package sequence - /// - /// Package sequence - [JsonPropertyName("sequence")] - public int Sequence { get; set; } + public PaperlessDownload? PaperlessDownload { get; set; } /// /// Details about products inside packages (Information provided would be used on custom documentation) /// /// Details about products inside packages (Information provided would be used on custom documentation) [JsonPropertyName("products")] - public List Products { get; set; } + public List? Products { get; set; } /// - /// Alternative identifiers associated with this package. + /// Package sequence /// - /// Alternative identifiers associated with this package. - [JsonPropertyName("alternative_identifiers")] - public List AlternativeIdentifiers { get; set; } + /// Package sequence + [JsonPropertyName("sequence")] + public int? Sequence { get; set; } + + /// + /// The tracking number for the package. The format depends on the carrier. + /// + /// The tracking number for the package. The format depends on the carrier. + /// + /// 1Z932R800392060079 + /// + [JsonPropertyName("tracking_number")] + public string? TrackingNumber { get; set; } /// @@ -155,21 +155,21 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class LabelPackagesInner {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" PackageId: ").Append(PackageId).Append("\n"); - sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); - sb.Append(" ContentDescription: ").Append(ContentDescription).Append("\n"); sb.Append(" Weight: ").Append(Weight).Append("\n"); + sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); + sb.Append(" ContentDescription: ").Append(ContentDescription).Append("\n"); sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); - sb.Append(" InsuredValue: ").Append(InsuredValue).Append("\n"); - sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); - sb.Append(" LabelMessages: ").Append(LabelMessages).Append("\n"); sb.Append(" ExternalPackageId: ").Append(ExternalPackageId).Append("\n"); - sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); + sb.Append(" InsuredValue: ").Append(InsuredValue).Append("\n"); + sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); + sb.Append(" LabelMessages: ").Append(LabelMessages).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); + sb.Append(" PackageId: ").Append(PackageId).Append("\n"); sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); - sb.Append(" Sequence: ").Append(Sequence).Append("\n"); sb.Append(" Products: ").Append(Products).Append("\n"); - sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); + sb.Append(" Sequence: ").Append(Sequence).Append("\n"); + sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/Link.cs b/ShipEngineSDK/Model/Link.cs index 8a5abd10..4e4fcb2a 100644 --- a/ShipEngineSDK/Model/Link.cs +++ b/ShipEngineSDK/Model/Link.cs @@ -44,7 +44,7 @@ public partial class Link /// /// The type of resource, or the type of relationship to the parent resource [JsonPropertyName("type")] - public string Type { get; set; } + public string? Type { get; set; } /// diff --git a/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs b/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs index 1e56ca7c..f00b438c 100644 --- a/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs +++ b/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs @@ -107,15 +107,11 @@ public class ListAccountImagesResponseBodyItem public List Images { get; set; } /// - /// The total number of items across all pages of results + /// Gets or Sets Links /// - /// The total number of items across all pages of results - /// - /// 2750 - /// - [JsonPropertyName("total")] + [JsonPropertyName("links")] [JsonRequired] - public int Total { get; set; } + public PaginationLink Links { get; set; } /// /// The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. @@ -140,11 +136,15 @@ public class ListAccountImagesResponseBodyItem public int Pages { get; set; } /// - /// Gets or Sets Links + /// The total number of items across all pages of results /// - [JsonPropertyName("links")] + /// The total number of items across all pages of results + /// + /// 2750 + /// + [JsonPropertyName("total")] [JsonRequired] - public PaginationLink Links { get; set; } + public int Total { get; set; } /// @@ -157,10 +157,10 @@ public override string ToString() sb.Append("class ListAccountImagesResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Images: ").Append(Images).Append("\n"); - sb.Append(" Total: ").Append(Total).Append("\n"); + sb.Append(" Links: ").Append(Links).Append("\n"); sb.Append(" Page: ").Append(Page).Append("\n"); sb.Append(" Pages: ").Append(Pages).Append("\n"); - sb.Append(" Links: ").Append(Links).Append("\n"); + sb.Append(" Total: ").Append(Total).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs b/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs index 584e7d4e..fe0a5f35 100644 --- a/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs +++ b/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs @@ -107,15 +107,11 @@ public class ListAccountSettingsImagesResponseBodyItem public List Images { get; set; } /// - /// The total number of items across all pages of results + /// Gets or Sets Links /// - /// The total number of items across all pages of results - /// - /// 2750 - /// - [JsonPropertyName("total")] + [JsonPropertyName("links")] [JsonRequired] - public int Total { get; set; } + public PaginationLink Links { get; set; } /// /// The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. @@ -140,11 +136,15 @@ public class ListAccountSettingsImagesResponseBodyItem public int Pages { get; set; } /// - /// Gets or Sets Links + /// The total number of items across all pages of results /// - [JsonPropertyName("links")] + /// The total number of items across all pages of results + /// + /// 2750 + /// + [JsonPropertyName("total")] [JsonRequired] - public PaginationLink Links { get; set; } + public int Total { get; set; } /// @@ -157,10 +157,10 @@ public override string ToString() sb.Append("class ListAccountSettingsImagesResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Images: ").Append(Images).Append("\n"); - sb.Append(" Total: ").Append(Total).Append("\n"); + sb.Append(" Links: ").Append(Links).Append("\n"); sb.Append(" Page: ").Append(Page).Append("\n"); sb.Append(" Pages: ").Append(Pages).Append("\n"); - sb.Append(" Links: ").Append(Links).Append("\n"); + sb.Append(" Total: ").Append(Total).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ListBatchesResponseBody.cs b/ShipEngineSDK/Model/ListBatchesResponseBody.cs index 53ae7b14..6bfa3655 100644 --- a/ShipEngineSDK/Model/ListBatchesResponseBody.cs +++ b/ShipEngineSDK/Model/ListBatchesResponseBody.cs @@ -37,15 +37,11 @@ public partial class ListBatchesResponseBody public List Batches { get; set; } /// - /// The total number of batches the API call returned + /// Gets or Sets Links /// - /// The total number of batches the API call returned - /// - /// 10 - /// - [JsonPropertyName("total")] + [JsonPropertyName("links")] [JsonRequired] - public long Total { get; set; } + public PaginationLink Links { get; set; } /// /// The page that is currently being read @@ -70,11 +66,15 @@ public partial class ListBatchesResponseBody public int Pages { get; set; } /// - /// Gets or Sets Links + /// The total number of batches the API call returned /// - [JsonPropertyName("links")] + /// The total number of batches the API call returned + /// + /// 10 + /// + [JsonPropertyName("total")] [JsonRequired] - public PaginationLink Links { get; set; } + public long Total { get; set; } /// @@ -87,10 +87,10 @@ public override string ToString() sb.Append("class ListBatchesResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Batches: ").Append(Batches).Append("\n"); - sb.Append(" Total: ").Append(Total).Append("\n"); + sb.Append(" Links: ").Append(Links).Append("\n"); sb.Append(" Page: ").Append(Page).Append("\n"); sb.Append(" Pages: ").Append(Pages).Append("\n"); - sb.Append(" Links: ").Append(Links).Append("\n"); + sb.Append(" Total: ").Append(Total).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs b/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs index de5f8e4a..89237479 100644 --- a/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs +++ b/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs @@ -33,7 +33,7 @@ public partial class ListCarrierPackageTypesResponseBody /// /// An array of custom package types [JsonPropertyName("packages")] - public List Packages { get; set; } + public List? Packages { get; set; } /// diff --git a/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs b/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs index 321ee33f..49be1c8b 100644 --- a/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs +++ b/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs @@ -33,7 +33,7 @@ public partial class ListCarrierServicesResponseBody /// /// An array of services associated with the carrier [JsonPropertyName("services")] - public List Services { get; set; } + public List? Services { get; set; } /// diff --git a/ShipEngineSDK/Model/ListLabelsResponseBody.cs b/ShipEngineSDK/Model/ListLabelsResponseBody.cs index 2adaa123..6e8260d2 100644 --- a/ShipEngineSDK/Model/ListLabelsResponseBody.cs +++ b/ShipEngineSDK/Model/ListLabelsResponseBody.cs @@ -345,15 +345,11 @@ public class ListLabelsResponseBodyItem public List Labels { get; set; } /// - /// The total number of items across all pages of results + /// Gets or Sets Links /// - /// The total number of items across all pages of results - /// - /// 2750 - /// - [JsonPropertyName("total")] + [JsonPropertyName("links")] [JsonRequired] - public int Total { get; set; } + public PaginationLink Links { get; set; } /// /// The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. @@ -378,11 +374,15 @@ public class ListLabelsResponseBodyItem public int Pages { get; set; } /// - /// Gets or Sets Links + /// The total number of items across all pages of results /// - [JsonPropertyName("links")] + /// The total number of items across all pages of results + /// + /// 2750 + /// + [JsonPropertyName("total")] [JsonRequired] - public PaginationLink Links { get; set; } + public int Total { get; set; } /// @@ -395,10 +395,10 @@ public override string ToString() sb.Append("class ListLabelsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Labels: ").Append(Labels).Append("\n"); - sb.Append(" Total: ").Append(Total).Append("\n"); + sb.Append(" Links: ").Append(Links).Append("\n"); sb.Append(" Page: ").Append(Page).Append("\n"); sb.Append(" Pages: ").Append(Pages).Append("\n"); - sb.Append(" Links: ").Append(Links).Append("\n"); + sb.Append(" Total: ").Append(Total).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ListManifestsResponseBody.cs b/ShipEngineSDK/Model/ListManifestsResponseBody.cs index 6c6f0863..251585e5 100644 --- a/ShipEngineSDK/Model/ListManifestsResponseBody.cs +++ b/ShipEngineSDK/Model/ListManifestsResponseBody.cs @@ -29,23 +29,20 @@ public partial class ListManifestsResponseBody { /// - /// The list of available manifests + /// Helpful links to other pages of results /// - /// The list of available manifests - [JsonPropertyName("manifests")] + /// Helpful links to other pages of results + [JsonPropertyName("links")] [JsonRequired] - public List Manifests { get; set; } + public PaginationLink Links { get; set; } /// - /// The total number of manifests returned + /// The list of available manifests /// - /// The total number of manifests returned - /// - /// 3 - /// - [JsonPropertyName("total")] + /// The list of available manifests + [JsonPropertyName("manifests")] [JsonRequired] - public long Total { get; set; } + public List Manifests { get; set; } /// /// Current page of the list manifests results @@ -70,12 +67,15 @@ public partial class ListManifestsResponseBody public int Pages { get; set; } /// - /// Helpful links to other pages of results + /// The total number of manifests returned /// - /// Helpful links to other pages of results - [JsonPropertyName("links")] + /// The total number of manifests returned + /// + /// 3 + /// + [JsonPropertyName("total")] [JsonRequired] - public PaginationLink Links { get; set; } + public long Total { get; set; } /// @@ -87,11 +87,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ListManifestsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" Links: ").Append(Links).Append("\n"); sb.Append(" Manifests: ").Append(Manifests).Append("\n"); - sb.Append(" Total: ").Append(Total).Append("\n"); sb.Append(" Page: ").Append(Page).Append("\n"); sb.Append(" Pages: ").Append(Pages).Append("\n"); - sb.Append(" Links: ").Append(Links).Append("\n"); + sb.Append(" Total: ").Append(Total).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs b/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs index 9bb1e96e..500f2d46 100644 --- a/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs +++ b/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs @@ -33,7 +33,7 @@ public partial class ListPackageTypesResponseBody /// /// An array of custom package types [JsonPropertyName("packages")] - public List Packages { get; set; } + public List? Packages { get; set; } /// diff --git a/ShipEngineSDK/Model/ListPickupResponseBody.cs b/ShipEngineSDK/Model/ListPickupResponseBody.cs index 66f3e9ca..cf08ad3f 100644 --- a/ShipEngineSDK/Model/ListPickupResponseBody.cs +++ b/ShipEngineSDK/Model/ListPickupResponseBody.cs @@ -29,23 +29,12 @@ public partial class ListPickupResponseBody { /// - /// An array of pickups associated with the user's account. - /// - /// An array of pickups associated with the user's account. - [JsonPropertyName("pickups")] - [JsonRequired] - public List Pickups { get; set; } - - /// - /// The total number of pickups returned + /// Helpful links to other pages of results /// - /// The total number of pickups returned - /// - /// 3 - /// - [JsonPropertyName("total")] + /// Helpful links to other pages of results + [JsonPropertyName("links")] [JsonRequired] - public long Total { get; set; } + public PaginationLink Links { get; set; } /// /// Current page of the list pickups results @@ -70,12 +59,23 @@ public partial class ListPickupResponseBody public int Pages { get; set; } /// - /// Helpful links to other pages of results + /// An array of pickups associated with the user's account. /// - /// Helpful links to other pages of results - [JsonPropertyName("links")] + /// An array of pickups associated with the user's account. + [JsonPropertyName("pickups")] [JsonRequired] - public PaginationLink Links { get; set; } + public List Pickups { get; set; } + + /// + /// The total number of pickups returned + /// + /// The total number of pickups returned + /// + /// 3 + /// + [JsonPropertyName("total")] + [JsonRequired] + public long Total { get; set; } /// @@ -87,11 +87,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ListPickupResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Pickups: ").Append(Pickups).Append("\n"); - sb.Append(" Total: ").Append(Total).Append("\n"); + sb.Append(" Links: ").Append(Links).Append("\n"); sb.Append(" Page: ").Append(Page).Append("\n"); sb.Append(" Pages: ").Append(Pages).Append("\n"); - sb.Append(" Links: ").Append(Links).Append("\n"); + sb.Append(" Pickups: ").Append(Pickups).Append("\n"); + sb.Append(" Total: ").Append(Total).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBody.cs b/ShipEngineSDK/Model/ListServicePointsResponseBody.cs index e4343ca3..5436d416 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBody.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBody.cs @@ -28,6 +28,13 @@ namespace ShipEngineSDK.Model; public partial class ListServicePointsResponseBody { + /// + /// The errors associated with the failed API call + /// + /// The errors associated with the failed API call + [JsonPropertyName("errors")] + public List? Errors { get; set; } + /// /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html /// @@ -36,7 +43,7 @@ public partial class ListServicePointsResponseBody /// 48.842608 /// [JsonPropertyName("lat")] - public double Lat { get; set; } + public double? Lat { get; set; } /// /// The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html @@ -46,20 +53,13 @@ public partial class ListServicePointsResponseBody /// 0.032875 /// [JsonPropertyName("long")] - public double Long { get; set; } + public double? Long { get; set; } /// /// Gets or Sets ServicePoints /// [JsonPropertyName("service_points")] - public List ServicePoints { get; set; } - - /// - /// The errors associated with the failed API call - /// - /// The errors associated with the failed API call - [JsonPropertyName("errors")] - public List Errors { get; set; } + public List? ServicePoints { get; set; } /// @@ -71,10 +71,10 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ListServicePointsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" Errors: ").Append(Errors).Append("\n"); sb.Append(" Lat: ").Append(Lat).Append("\n"); sb.Append(" Long: ").Append(Long).Append("\n"); sb.Append(" ServicePoints: ").Append(ServicePoints).Append("\n"); - sb.Append(" Errors: ").Append(Errors).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs index 383c2097..8e17b6cb 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs @@ -165,6 +165,16 @@ public override bool CanConvert(Type typeToConvert) => /// Service point type [JsonPropertyName("type")] public TypeEnum? Type { get; set; } + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// PLACE DU CANADA + /// + [JsonPropertyName("address_line1")] + public string? AddressLine1 { get; set; } + /// /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. /// @@ -173,23 +183,17 @@ public override bool CanConvert(Type typeToConvert) => /// dhl_express /// [JsonPropertyName("carrier_code")] - public string CarrierCode { get; set; } - - /// - /// Gets or Sets ServiceCodes - /// - [JsonPropertyName("service_codes")] - public List ServiceCodes { get; set; } + public string? CarrierCode { get; set; } /// - /// A unique identifier for a carrier drop off point. + /// The name of the city or locality /// - /// A unique identifier for a carrier drop off point. + /// The name of the city or locality /// - /// 614940 + /// TRUN /// - [JsonPropertyName("service_point_id")] - public string ServicePointId { get; set; } + [JsonPropertyName("city_locality")] + public string? CityLocality { get; set; } /// /// If this is a business address, then the company name should be specified here. @@ -199,57 +203,60 @@ public override bool CanConvert(Type typeToConvert) => /// My fancy company name /// [JsonPropertyName("company_name")] - public string CompanyName { get; set; } + public string? CompanyName { get; set; } /// - /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) /// - /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) /// - /// PLACE DU CANADA + /// CA /// - [JsonPropertyName("address_line1")] - public string AddressLine1 { get; set; } + [JsonPropertyName("country_code")] + public string? CountryCode { get; set; } /// - /// The name of the city or locality + /// Distance in meters /// - /// The name of the city or locality + /// Distance in meters /// - /// TRUN + /// 728.9959308847579 /// - [JsonPropertyName("city_locality")] - public string CityLocality { get; set; } + [JsonPropertyName("distance_in_meters")] + public double? DistanceInMeters { get; set; } /// - /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// Service features /// - /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. - /// - /// TRUN - /// - [JsonPropertyName("state_province")] - public string StateProvince { get; set; } + /// Service features + [JsonPropertyName("features")] + public List? Features { get; set; } /// - /// postal code + /// Gets or Sets HoursOfOperation /// - /// postal code + [JsonPropertyName("hours_of_operation")] + public ListServicePointsResponseBodyServicePointsInnerHoursOfOperation? HoursOfOperation { get; set; } + + /// + /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html + /// + /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html /// - /// 78756-3717 + /// 48.842608 /// - [JsonPropertyName("postal_code")] - public string PostalCode { get; set; } + [JsonPropertyName("lat")] + public double? Lat { get; set; } /// - /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html /// - /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html /// - /// CA + /// 0.032875 /// - [JsonPropertyName("country_code")] - public string CountryCode { get; set; } + [JsonPropertyName("long")] + public double? Long { get; set; } /// /// Phone number associated @@ -259,50 +266,43 @@ public override bool CanConvert(Type typeToConvert) => /// 555-555-5555 /// [JsonPropertyName("phone_number")] - public string PhoneNumber { get; set; } + public string? PhoneNumber { get; set; } /// - /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html + /// postal code /// - /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html + /// postal code /// - /// 48.842608 + /// 78756-3717 /// - [JsonPropertyName("lat")] - public double Lat { get; set; } + [JsonPropertyName("postal_code")] + public string? PostalCode { get; set; } /// - /// The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html + /// Gets or Sets ServiceCodes /// - /// The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html - /// - /// 0.032875 - /// - [JsonPropertyName("long")] - public double Long { get; set; } + [JsonPropertyName("service_codes")] + public List? ServiceCodes { get; set; } /// - /// Distance in meters + /// A unique identifier for a carrier drop off point. /// - /// Distance in meters + /// A unique identifier for a carrier drop off point. /// - /// 728.9959308847579 + /// 614940 /// - [JsonPropertyName("distance_in_meters")] - public double DistanceInMeters { get; set; } - - /// - /// Gets or Sets HoursOfOperation - /// - [JsonPropertyName("hours_of_operation")] - public ListServicePointsResponseBodyServicePointsInnerHoursOfOperation HoursOfOperation { get; set; } + [JsonPropertyName("service_point_id")] + public string? ServicePointId { get; set; } /// - /// Service features + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. /// - /// Service features - [JsonPropertyName("features")] - public List Features { get; set; } + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// TRUN + /// + [JsonPropertyName("state_province")] + public string? StateProvince { get; set; } /// @@ -314,21 +314,21 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ListServicePointsResponseBodyServicePointsInner {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); - sb.Append(" ServiceCodes: ").Append(ServiceCodes).Append("\n"); - sb.Append(" ServicePointId: ").Append(ServicePointId).Append("\n"); - sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); - sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); - sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); - sb.Append(" PhoneNumber: ").Append(PhoneNumber).Append("\n"); - sb.Append(" Lat: ").Append(Lat).Append("\n"); - sb.Append(" Long: ").Append(Long).Append("\n"); sb.Append(" DistanceInMeters: ").Append(DistanceInMeters).Append("\n"); - sb.Append(" HoursOfOperation: ").Append(HoursOfOperation).Append("\n"); sb.Append(" Features: ").Append(Features).Append("\n"); + sb.Append(" HoursOfOperation: ").Append(HoursOfOperation).Append("\n"); + sb.Append(" Lat: ").Append(Lat).Append("\n"); + sb.Append(" Long: ").Append(Long).Append("\n"); + sb.Append(" PhoneNumber: ").Append(PhoneNumber).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" ServiceCodes: ").Append(ServiceCodes).Append("\n"); + sb.Append(" ServicePointId: ").Append(ServicePointId).Append("\n"); + sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs index 8a26562a..35b9e37b 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs @@ -28,47 +28,47 @@ namespace ShipEngineSDK.Model; public partial class ListServicePointsResponseBodyServicePointsInnerHoursOfOperation { + /// + /// Gets or Sets Friday + /// + [JsonPropertyName("friday")] + public List? Friday { get; set; } + /// /// Gets or Sets Monday /// [JsonPropertyName("monday")] - public List Monday { get; set; } + public List? Monday { get; set; } /// - /// Gets or Sets Tuesday + /// Gets or Sets Saturday /// - [JsonPropertyName("tuesday")] - public List Tuesday { get; set; } + [JsonPropertyName("saturday")] + public List? Saturday { get; set; } /// - /// Gets or Sets Wednesday + /// Gets or Sets Sunday /// - [JsonPropertyName("wednesday")] - public List Wednesday { get; set; } + [JsonPropertyName("sunday")] + public List? Sunday { get; set; } /// /// Gets or Sets Thursday /// [JsonPropertyName("thursday")] - public List Thursday { get; set; } - - /// - /// Gets or Sets Friday - /// - [JsonPropertyName("friday")] - public List Friday { get; set; } + public List? Thursday { get; set; } /// - /// Gets or Sets Saturday + /// Gets or Sets Tuesday /// - [JsonPropertyName("saturday")] - public List Saturday { get; set; } + [JsonPropertyName("tuesday")] + public List? Tuesday { get; set; } /// - /// Gets or Sets Sunday + /// Gets or Sets Wednesday /// - [JsonPropertyName("sunday")] - public List Sunday { get; set; } + [JsonPropertyName("wednesday")] + public List? Wednesday { get; set; } /// @@ -80,13 +80,13 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ListServicePointsResponseBodyServicePointsInnerHoursOfOperation {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Monday: ").Append(Monday).Append("\n"); - sb.Append(" Tuesday: ").Append(Tuesday).Append("\n"); - sb.Append(" Wednesday: ").Append(Wednesday).Append("\n"); - sb.Append(" Thursday: ").Append(Thursday).Append("\n"); sb.Append(" Friday: ").Append(Friday).Append("\n"); + sb.Append(" Monday: ").Append(Monday).Append("\n"); sb.Append(" Saturday: ").Append(Saturday).Append("\n"); sb.Append(" Sunday: ").Append(Sunday).Append("\n"); + sb.Append(" Thursday: ").Append(Thursday).Append("\n"); + sb.Append(" Tuesday: ").Append(Tuesday).Append("\n"); + sb.Append(" Wednesday: ").Append(Wednesday).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs index c74750b3..d010d589 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs @@ -29,24 +29,24 @@ public partial class ListServicePointsResponseBodyServicePointsInnerHoursOfOpera { /// - /// Opening time + /// Closing time /// - /// Opening time + /// Closing time /// - /// 09:15 + /// 12:00 /// - [JsonPropertyName("open")] - public string Open { get; set; } + [JsonPropertyName("close")] + public string? Close { get; set; } /// - /// Closing time + /// Opening time /// - /// Closing time + /// Opening time /// - /// 12:00 + /// 09:15 /// - [JsonPropertyName("close")] - public string Close { get; set; } + [JsonPropertyName("open")] + public string? Open { get; set; } /// @@ -58,8 +58,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Open: ").Append(Open).Append("\n"); sb.Append(" Close: ").Append(Close).Append("\n"); + sb.Append(" Open: ").Append(Open).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs b/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs index 8037b765..bfd00878 100644 --- a/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs +++ b/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs @@ -37,12 +37,22 @@ public partial class ListShipmentRatesResponseBody /// - /// An array of shipment rates + /// When the rate was created /// - /// An array of shipment rates - [JsonPropertyName("rates")] + /// When the rate was created + /// + /// se-28529731 + /// + [JsonPropertyName("created_at")] [JsonRequired] - public List Rates { get; set; } + public string CreatedAt { get; set; } + + /// + /// Gets or Sets Errors + /// + [JsonPropertyName("errors")] + [JsonRequired] + public List Errors { get; set; } /// /// An array of invalid shipment rates @@ -64,33 +74,23 @@ public partial class ListShipmentRatesResponseBody public string RateRequestId { get; set; } /// - /// A string that uniquely identifies the shipment + /// An array of shipment rates /// - /// A string that uniquely identifies the shipment - /// - /// se-28529731 - /// - [JsonPropertyName("shipment_id")] + /// An array of shipment rates + [JsonPropertyName("rates")] [JsonRequired] - public string ShipmentId { get; set; } + public List Rates { get; set; } /// - /// When the rate was created + /// A string that uniquely identifies the shipment /// - /// When the rate was created + /// A string that uniquely identifies the shipment /// /// se-28529731 /// - [JsonPropertyName("created_at")] - [JsonRequired] - public string CreatedAt { get; set; } - - /// - /// Gets or Sets Errors - /// - [JsonPropertyName("errors")] + [JsonPropertyName("shipment_id")] [JsonRequired] - public List Errors { get; set; } + public string ShipmentId { get; set; } /// @@ -102,13 +102,13 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ListShipmentRatesResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Rates: ").Append(Rates).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); sb.Append(" InvalidRates: ").Append(InvalidRates).Append("\n"); sb.Append(" RateRequestId: ").Append(RateRequestId).Append("\n"); + sb.Append(" Rates: ").Append(Rates).Append("\n"); sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); - sb.Append(" Errors: ").Append(Errors).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ListShipmentsResponseBody.cs b/ShipEngineSDK/Model/ListShipmentsResponseBody.cs index 2a4412f5..3559f773 100644 --- a/ShipEngineSDK/Model/ListShipmentsResponseBody.cs +++ b/ShipEngineSDK/Model/ListShipmentsResponseBody.cs @@ -29,23 +29,11 @@ public partial class ListShipmentsResponseBody { /// - /// The list of shipments returned by the api call - /// - /// The list of shipments returned by the api call - [JsonPropertyName("shipments")] - [JsonRequired] - public List Shipments { get; set; } - - /// - /// Total number of shipments returned by the api call + /// Gets or Sets Links /// - /// Total number of shipments returned by the api call - /// - /// 1990 - /// - [JsonPropertyName("total")] + [JsonPropertyName("links")] [JsonRequired] - public long Total { get; set; } + public PaginationLink Links { get; set; } /// /// Gets or Sets Page @@ -62,11 +50,23 @@ public partial class ListShipmentsResponseBody public int Pages { get; set; } /// - /// Gets or Sets Links + /// The list of shipments returned by the api call /// - [JsonPropertyName("links")] + /// The list of shipments returned by the api call + [JsonPropertyName("shipments")] [JsonRequired] - public PaginationLink Links { get; set; } + public List Shipments { get; set; } + + /// + /// Total number of shipments returned by the api call + /// + /// Total number of shipments returned by the api call + /// + /// 1990 + /// + [JsonPropertyName("total")] + [JsonRequired] + public long Total { get; set; } /// @@ -78,11 +78,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ListShipmentsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Shipments: ").Append(Shipments).Append("\n"); - sb.Append(" Total: ").Append(Total).Append("\n"); + sb.Append(" Links: ").Append(Links).Append("\n"); sb.Append(" Page: ").Append(Page).Append("\n"); sb.Append(" Pages: ").Append(Pages).Append("\n"); - sb.Append(" Links: ").Append(Links).Append("\n"); + sb.Append(" Shipments: ").Append(Shipments).Append("\n"); + sb.Append(" Total: ").Append(Total).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ListTagsResponseBody.cs b/ShipEngineSDK/Model/ListTagsResponseBody.cs index 98c01e5d..0057d51e 100644 --- a/ShipEngineSDK/Model/ListTagsResponseBody.cs +++ b/ShipEngineSDK/Model/ListTagsResponseBody.cs @@ -33,7 +33,7 @@ public partial class ListTagsResponseBody /// /// The array of tags returned by the API call [JsonPropertyName("tags")] - public List Tags { get; set; } + public List? Tags { get; set; } /// diff --git a/ShipEngineSDK/Model/Manifest.cs b/ShipEngineSDK/Model/Manifest.cs index abce686e..de145fd1 100644 --- a/ShipEngineSDK/Model/Manifest.cs +++ b/ShipEngineSDK/Model/Manifest.cs @@ -29,14 +29,24 @@ public partial class Manifest { /// - /// A string that uniquely identifies the manifest + /// A string that uniquely identifies the carrier /// - /// A string that uniquely identifies the manifest + /// A string that uniquely identifies the carrier /// /// se-28529731 /// - [JsonPropertyName("manifest_id")] - public string ManifestId { get; set; } + [JsonPropertyName("carrier_id")] + public string? CarrierId { get; set; } + + /// + /// The date-time that the manifest was created + /// + /// The date-time that the manifest was created + /// + /// 2019-07-12T13:37:39.050Z + /// + [JsonPropertyName("created_at")] + public DateTimeOffset? CreatedAt { get; set; } /// /// A string that uniquely identifies the form @@ -46,17 +56,30 @@ public partial class Manifest /// se-28529731 /// [JsonPropertyName("form_id")] - public string FormId { get; set; } + public string? FormId { get; set; } /// - /// The date-time that the manifest was created + /// An array of the label ids used in this manifest. /// - /// The date-time that the manifest was created + /// An array of the label ids used in this manifest. + [JsonPropertyName("label_ids")] + public List? LabelIds { get; set; } + + /// + /// Gets or Sets ManifestDownload + /// + [JsonPropertyName("manifest_download")] + public ManifestDownload? ManifestDownload { get; set; } + + /// + /// A string that uniquely identifies the manifest + /// + /// A string that uniquely identifies the manifest /// - /// 2019-07-12T13:37:39.050Z + /// se-28529731 /// - [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("manifest_id")] + public string? ManifestId { get; set; } /// /// The date-time that the manifests shipments will be picked up @@ -66,7 +89,7 @@ public partial class Manifest /// 2019-07-12T13:37:39.050Z /// [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + public DateTimeOffset? ShipDate { get; set; } /// /// The number of shipments that are included in this manifest @@ -76,24 +99,7 @@ public partial class Manifest /// 100 /// [JsonPropertyName("shipments")] - public int Shipments { get; set; } - - /// - /// An array of the label ids used in this manifest. - /// - /// An array of the label ids used in this manifest. - [JsonPropertyName("label_ids")] - public List LabelIds { get; set; } - - /// - /// A string that uniquely identifies the warehouse - /// - /// A string that uniquely identifies the warehouse - /// - /// se-28529731 - /// - [JsonPropertyName("warehouse_id")] - public string WarehouseId { get; set; } + public int? Shipments { get; set; } /// /// A string that uniquely identifies the submission @@ -103,23 +109,17 @@ public partial class Manifest /// 9475711899564878915476 /// [JsonPropertyName("submission_id")] - public string SubmissionId { get; set; } + public string? SubmissionId { get; set; } /// - /// A string that uniquely identifies the carrier + /// A string that uniquely identifies the warehouse /// - /// A string that uniquely identifies the carrier + /// A string that uniquely identifies the warehouse /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } - - /// - /// Gets or Sets ManifestDownload - /// - [JsonPropertyName("manifest_download")] - public ManifestDownload ManifestDownload { get; set; } + [JsonPropertyName("warehouse_id")] + public string? WarehouseId { get; set; } /// @@ -131,16 +131,16 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class Manifest {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ManifestId: ").Append(ManifestId).Append("\n"); - sb.Append(" FormId: ").Append(FormId).Append("\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" FormId: ").Append(FormId).Append("\n"); + sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); + sb.Append(" ManifestDownload: ").Append(ManifestDownload).Append("\n"); + sb.Append(" ManifestId: ").Append(ManifestId).Append("\n"); sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); sb.Append(" Shipments: ").Append(Shipments).Append("\n"); - sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); sb.Append(" SubmissionId: ").Append(SubmissionId).Append("\n"); - sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); - sb.Append(" ManifestDownload: ").Append(ManifestDownload).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ManifestDownload.cs b/ShipEngineSDK/Model/ManifestDownload.cs index fe32db8e..a816af8e 100644 --- a/ShipEngineSDK/Model/ManifestDownload.cs +++ b/ShipEngineSDK/Model/ManifestDownload.cs @@ -36,7 +36,7 @@ public partial class ManifestDownload /// http://api.shipengine.com/v1/labels/se-28529731 /// [JsonPropertyName("href")] - public string Href { get; set; } + public string? Href { get; set; } /// diff --git a/ShipEngineSDK/Model/ManifestRequest.cs b/ShipEngineSDK/Model/ManifestRequest.cs index 9294c7a2..7739a3c5 100644 --- a/ShipEngineSDK/Model/ManifestRequest.cs +++ b/ShipEngineSDK/Model/ManifestRequest.cs @@ -41,7 +41,7 @@ public partial class ManifestRequest /// se-28529731 /// [JsonPropertyName("manifest_request_id")] - public string ManifestRequestId { get; set; } + public string? ManifestRequestId { get; set; } /// diff --git a/ShipEngineSDK/Model/Manifests.cs b/ShipEngineSDK/Model/Manifests.cs index 29b943d0..b284052e 100644 --- a/ShipEngineSDK/Model/Manifests.cs +++ b/ShipEngineSDK/Model/Manifests.cs @@ -33,7 +33,7 @@ public partial class Manifests /// /// Resulting Manifests [JsonPropertyName("manifests")] - public List VarManifests { get; set; } + public List? VarManifests { get; set; } /// diff --git a/ShipEngineSDK/Model/ManifestsRequests.cs b/ShipEngineSDK/Model/ManifestsRequests.cs index 0a15ad35..33551ae7 100644 --- a/ShipEngineSDK/Model/ManifestsRequests.cs +++ b/ShipEngineSDK/Model/ManifestsRequests.cs @@ -33,7 +33,7 @@ public partial class ManifestsRequests /// /// Resulting manifest requests with statuses [JsonPropertyName("manifest_requests")] - public List ManifestRequests { get; set; } + public List? ManifestRequests { get; set; } /// diff --git a/ShipEngineSDK/Model/ModifyBatch.cs b/ShipEngineSDK/Model/ModifyBatch.cs index d2403304..aeffeddb 100644 --- a/ShipEngineSDK/Model/ModifyBatch.cs +++ b/ShipEngineSDK/Model/ModifyBatch.cs @@ -28,19 +28,19 @@ namespace ShipEngineSDK.Model; public partial class ModifyBatch { - /// - /// The Shipment Ids to be modified on the batch - /// - /// The Shipment Ids to be modified on the batch - [JsonPropertyName("shipment_ids")] - public List ShipmentIds { get; set; } - /// /// Array of Rate IDs to be modifed on the batch /// /// Array of Rate IDs to be modifed on the batch [JsonPropertyName("rate_ids")] - public List RateIds { get; set; } + public List? RateIds { get; set; } + + /// + /// The Shipment Ids to be modified on the batch + /// + /// The Shipment Ids to be modified on the batch + [JsonPropertyName("shipment_ids")] + public List? ShipmentIds { get; set; } /// @@ -52,8 +52,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ModifyBatch {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); sb.Append(" RateIds: ").Append(RateIds).Append("\n"); + sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/MonetaryValue.cs b/ShipEngineSDK/Model/MonetaryValue.cs index 24ad59d6..53da3a46 100644 --- a/ShipEngineSDK/Model/MonetaryValue.cs +++ b/ShipEngineSDK/Model/MonetaryValue.cs @@ -28,14 +28,6 @@ namespace ShipEngineSDK.Model; public partial class MonetaryValue { - /// - /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - /// - /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("currency")] - [JsonRequired] - public string Currency { get; set; } - /// /// The monetary amount, in the specified currency. /// @@ -44,6 +36,14 @@ public partial class MonetaryValue [JsonRequired] public double Amount { get; set; } + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + /// + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + [JsonPropertyName("currency")] + [JsonRequired] + public string Currency { get; set; } + /// /// Returns the string presentation of the object @@ -54,8 +54,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class MonetaryValue {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Currency: ").Append(Currency).Append("\n"); sb.Append(" Amount: ").Append(Amount).Append("\n"); + sb.Append(" Currency: ").Append(Currency).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/OptionalLink.cs b/ShipEngineSDK/Model/OptionalLink.cs index 8818d005..f67ae5ba 100644 --- a/ShipEngineSDK/Model/OptionalLink.cs +++ b/ShipEngineSDK/Model/OptionalLink.cs @@ -36,14 +36,14 @@ public partial class OptionalLink /// http://api.shipengine.com/v1/labels/se-28529731 /// [JsonPropertyName("href")] - public string Href { get; set; } + public string? Href { get; set; } /// /// The type of resource, or the type of relationship to the parent resource /// /// The type of resource, or the type of relationship to the parent resource [JsonPropertyName("type")] - public string Type { get; set; } + public string? Type { get; set; } /// diff --git a/ShipEngineSDK/Model/Package.cs b/ShipEngineSDK/Model/Package.cs index 0998c920..080084fa 100644 --- a/ShipEngineSDK/Model/Package.cs +++ b/ShipEngineSDK/Model/Package.cs @@ -29,24 +29,12 @@ public partial class Package { /// - /// A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/) - /// - /// A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/) - /// - /// se-28529731 - /// - [JsonPropertyName("package_id")] - public string PackageId { get; set; } - - /// - /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// The package weight /// - /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. - /// - /// small_flat_rate_box - /// - [JsonPropertyName("package_code")] - public string PackageCode { get; set; } + /// The package weight + [JsonPropertyName("weight")] + [JsonRequired] + public Weight Weight { get; set; } /// /// A short description of the package content. Required for shipments moving to, from, and through Mexico. @@ -56,87 +44,99 @@ public partial class Package /// Hand knitted wool socks /// [JsonPropertyName("content_description")] - public string ContentDescription { get; set; } - - /// - /// The package weight - /// - /// The package weight - [JsonPropertyName("weight")] - [JsonRequired] - public Weight Weight { get; set; } + public string? ContentDescription { get; set; } /// /// The package dimensions /// /// The package dimensions [JsonPropertyName("dimensions")] - public Dimensions Dimensions { get; set; } + public Dimensions? Dimensions { get; set; } + + /// + /// An external package id. + /// + /// An external package id. + [JsonPropertyName("external_package_id")] + public string? ExternalPackageId { get; set; } + + /// + /// The form download for any customs that are needed + /// + /// The form download for any customs that are needed + [JsonPropertyName("form_download")] + public OptionalLink? FormDownload { get; set; } /// /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. /// /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. [JsonPropertyName("insured_value")] - public MonetaryValue InsuredValue { get; set; } + public MonetaryValue? InsuredValue { get; set; } /// - /// The tracking number for the package. The format depends on the carrier. + /// The label download for the package /// - /// The tracking number for the package. The format depends on the carrier. - /// - /// 1Z932R800392060079 - /// - [JsonPropertyName("tracking_number")] - public string TrackingNumber { get; set; } + /// The label download for the package + [JsonPropertyName("label_download")] + public LabelDownload? LabelDownload { get; set; } /// /// Gets or Sets LabelMessages /// [JsonPropertyName("label_messages")] - public LabelMessages LabelMessages { get; set; } - - /// - /// An external package id. - /// - /// An external package id. - [JsonPropertyName("external_package_id")] - public string ExternalPackageId { get; set; } + public LabelMessages? LabelMessages { get; set; } /// - /// The label download for the package + /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. /// - /// The label download for the package - [JsonPropertyName("label_download")] - public LabelDownload LabelDownload { get; set; } + /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// + /// small_flat_rate_box + /// + [JsonPropertyName("package_code")] + public string? PackageCode { get; set; } /// - /// The form download for any customs that are needed + /// A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/) /// - /// The form download for any customs that are needed - [JsonPropertyName("form_download")] - public OptionalLink FormDownload { get; set; } + /// A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/) + /// + /// se-28529731 + /// + [JsonPropertyName("package_id")] + public string? PackageId { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. [JsonPropertyName("paperless_download")] - public PaperlessDownload PaperlessDownload { get; set; } + public PaperlessDownload? PaperlessDownload { get; set; } + + /// + /// Details about products inside packages (Information provided would be used on custom documentation) + /// + /// Details about products inside packages (Information provided would be used on custom documentation) + [JsonPropertyName("products")] + public List? Products { get; set; } /// /// Package sequence /// /// Package sequence [JsonPropertyName("sequence")] - public int Sequence { get; set; } + public int? Sequence { get; set; } /// - /// Details about products inside packages (Information provided would be used on custom documentation) + /// The tracking number for the package. The format depends on the carrier. /// - /// Details about products inside packages (Information provided would be used on custom documentation) - [JsonPropertyName("products")] - public List Products { get; set; } + /// The tracking number for the package. The format depends on the carrier. + /// + /// 1Z932R800392060079 + /// + [JsonPropertyName("tracking_number")] + public string? TrackingNumber { get; set; } /// @@ -148,20 +148,20 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class Package {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" PackageId: ").Append(PackageId).Append("\n"); - sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); - sb.Append(" ContentDescription: ").Append(ContentDescription).Append("\n"); sb.Append(" Weight: ").Append(Weight).Append("\n"); + sb.Append(" ContentDescription: ").Append(ContentDescription).Append("\n"); sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); - sb.Append(" InsuredValue: ").Append(InsuredValue).Append("\n"); - sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); - sb.Append(" LabelMessages: ").Append(LabelMessages).Append("\n"); sb.Append(" ExternalPackageId: ").Append(ExternalPackageId).Append("\n"); - sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); + sb.Append(" InsuredValue: ").Append(InsuredValue).Append("\n"); + sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); + sb.Append(" LabelMessages: ").Append(LabelMessages).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); + sb.Append(" PackageId: ").Append(PackageId).Append("\n"); sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); - sb.Append(" Sequence: ").Append(Sequence).Append("\n"); sb.Append(" Products: ").Append(Products).Append("\n"); + sb.Append(" Sequence: ").Append(Sequence).Append("\n"); + sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/PackageType.cs b/ShipEngineSDK/Model/PackageType.cs index e94428b3..ad7158fd 100644 --- a/ShipEngineSDK/Model/PackageType.cs +++ b/ShipEngineSDK/Model/PackageType.cs @@ -29,14 +29,14 @@ public partial class PackageType { /// - /// A string that uniquely identifies the package. + /// Gets or Sets Name /// - /// A string that uniquely identifies the package. /// - /// se-28529731 + /// laptop_box /// - [JsonPropertyName("package_id")] - public string PackageId { get; set; } + [JsonPropertyName("name")] + [JsonRequired] + public string Name { get; set; } /// /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. @@ -50,31 +50,31 @@ public partial class PackageType public string PackageCode { get; set; } /// - /// Gets or Sets Name + /// Provides a helpful description for the custom package. /// + /// Provides a helpful description for the custom package. /// - /// laptop_box + /// Packaging for laptops /// - [JsonPropertyName("name")] - [JsonRequired] - public string Name { get; set; } + [JsonPropertyName("description")] + public string? Description { get; set; } /// /// The custom dimensions for the package. /// /// The custom dimensions for the package. [JsonPropertyName("dimensions")] - public Dimensions Dimensions { get; set; } + public Dimensions? Dimensions { get; set; } /// - /// Provides a helpful description for the custom package. + /// A string that uniquely identifies the package. /// - /// Provides a helpful description for the custom package. + /// A string that uniquely identifies the package. /// - /// Packaging for laptops + /// se-28529731 /// - [JsonPropertyName("description")] - public string Description { get; set; } + [JsonPropertyName("package_id")] + public string? PackageId { get; set; } /// @@ -86,11 +86,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class PackageType {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" PackageId: ").Append(PackageId).Append("\n"); - sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Description: ").Append(Description).Append("\n"); + sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); + sb.Append(" PackageId: ").Append(PackageId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/PagedListResponseBody.cs b/ShipEngineSDK/Model/PagedListResponseBody.cs index 591e0b11..f0629ebc 100644 --- a/ShipEngineSDK/Model/PagedListResponseBody.cs +++ b/ShipEngineSDK/Model/PagedListResponseBody.cs @@ -29,15 +29,11 @@ public partial class PagedListResponseBody { /// - /// The total number of items across all pages of results + /// Gets or Sets Links /// - /// The total number of items across all pages of results - /// - /// 2750 - /// - [JsonPropertyName("total")] + [JsonPropertyName("links")] [JsonRequired] - public int Total { get; set; } + public PaginationLink Links { get; set; } /// /// The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. @@ -62,11 +58,15 @@ public partial class PagedListResponseBody public int Pages { get; set; } /// - /// Gets or Sets Links + /// The total number of items across all pages of results /// - [JsonPropertyName("links")] + /// The total number of items across all pages of results + /// + /// 2750 + /// + [JsonPropertyName("total")] [JsonRequired] - public PaginationLink Links { get; set; } + public int Total { get; set; } /// /// Gets or Sets additional properties @@ -84,10 +84,10 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class PagedListResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Total: ").Append(Total).Append("\n"); + sb.Append(" Links: ").Append(Links).Append("\n"); sb.Append(" Page: ").Append(Page).Append("\n"); sb.Append(" Pages: ").Append(Pages).Append("\n"); - sb.Append(" Links: ").Append(Links).Append("\n"); + sb.Append(" Total: ").Append(Total).Append("\n"); sb.Append(" AdditionalProperties: ").Append(AdditionalProperties).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/PaginationLink.cs b/ShipEngineSDK/Model/PaginationLink.cs index 9a8fb501..c9ed9b21 100644 --- a/ShipEngineSDK/Model/PaginationLink.cs +++ b/ShipEngineSDK/Model/PaginationLink.cs @@ -44,14 +44,6 @@ public partial class PaginationLink [JsonRequired] public Link Last { get; set; } - /// - /// The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater. - /// - /// The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater. - [JsonPropertyName("prev")] - [JsonRequired] - public OptionalLink Prev { get; set; } - /// /// The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`. /// @@ -60,6 +52,14 @@ public partial class PaginationLink [JsonRequired] public OptionalLink Next { get; set; } + /// + /// The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater. + /// + /// The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater. + [JsonPropertyName("prev")] + [JsonRequired] + public OptionalLink Prev { get; set; } + /// /// Returns the string presentation of the object @@ -72,8 +72,8 @@ public override string ToString() #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" First: ").Append(First).Append("\n"); sb.Append(" Last: ").Append(Last).Append("\n"); - sb.Append(" Prev: ").Append(Prev).Append("\n"); sb.Append(" Next: ").Append(Next).Append("\n"); + sb.Append(" Prev: ").Append(Prev).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/PaperlessDownload.cs b/ShipEngineSDK/Model/PaperlessDownload.cs index a8e06cce..680e3dae 100644 --- a/ShipEngineSDK/Model/PaperlessDownload.cs +++ b/ShipEngineSDK/Model/PaperlessDownload.cs @@ -28,6 +28,13 @@ namespace ShipEngineSDK.Model; public partial class PaperlessDownload { + /// + /// The handoff code for the paperless download. + /// + /// The handoff code for the paperless download. + [JsonPropertyName("handoff_code")] + public string? HandoffCode { get; set; } + /// /// The URL of the linked resource, if any /// @@ -36,21 +43,14 @@ public partial class PaperlessDownload /// http://api.shipengine.com/v1/labels/se-28529731 /// [JsonPropertyName("href")] - public string Href { get; set; } + public string? Href { get; set; } /// /// The instructions for the paperless download. /// /// The instructions for the paperless download. [JsonPropertyName("instructions")] - public string Instructions { get; set; } - - /// - /// The handoff code for the paperless download. - /// - /// The handoff code for the paperless download. - [JsonPropertyName("handoff_code")] - public string HandoffCode { get; set; } + public string? Instructions { get; set; } /// @@ -62,9 +62,9 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class PaperlessDownload {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" HandoffCode: ").Append(HandoffCode).Append("\n"); sb.Append(" Href: ").Append(Href).Append("\n"); sb.Append(" Instructions: ").Append(Instructions).Append("\n"); - sb.Append(" HandoffCode: ").Append(HandoffCode).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ParseAddressRequestBody.cs b/ShipEngineSDK/Model/ParseAddressRequestBody.cs index 03c04530..9f72d7d4 100644 --- a/ShipEngineSDK/Model/ParseAddressRequestBody.cs +++ b/ShipEngineSDK/Model/ParseAddressRequestBody.cs @@ -44,7 +44,7 @@ public partial class ParseAddressRequestBody /// /// You can optionally provide any already-known address 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. [JsonPropertyName("address")] - public PartialAddress Address { get; set; } + public PartialAddress? Address { get; set; } /// diff --git a/ShipEngineSDK/Model/ParseAddressResponseBody.cs b/ShipEngineSDK/Model/ParseAddressResponseBody.cs index 59ee23b8..811cd317 100644 --- a/ShipEngineSDK/Model/ParseAddressResponseBody.cs +++ b/ShipEngineSDK/Model/ParseAddressResponseBody.cs @@ -28,14 +28,6 @@ namespace ShipEngineSDK.Model; public partial class ParseAddressResponseBody { - /// - /// A confidence score between zero and one that indicates how certain the API is that it understood the text. - /// - /// A confidence score between zero and one that indicates how certain the API is that it understood the text. - [JsonPropertyName("score")] - [JsonRequired] - public double Score { get; set; } - /// /// The parsed address. This address may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The address-recognition API does not currently perform any validation of the parsed address, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the address is correct. /// @@ -52,6 +44,14 @@ public partial class ParseAddressResponseBody [JsonRequired] public List Entities { get; set; } + /// + /// A confidence score between zero and one that indicates how certain the API is that it understood the text. + /// + /// A confidence score between zero and one that indicates how certain the API is that it understood the text. + [JsonPropertyName("score")] + [JsonRequired] + public double Score { get; set; } + /// /// Returns the string presentation of the object @@ -62,9 +62,9 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ParseAddressResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Score: ").Append(Score).Append("\n"); sb.Append(" Address: ").Append(Address).Append("\n"); sb.Append(" Entities: ").Append(Entities).Append("\n"); + sb.Append(" Score: ").Append(Score).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ParseShipmentRequestBody.cs b/ShipEngineSDK/Model/ParseShipmentRequestBody.cs index 57481407..d3f84e3c 100644 --- a/ShipEngineSDK/Model/ParseShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/ParseShipmentRequestBody.cs @@ -45,7 +45,7 @@ public partial class ParseShipmentRequestBody /// /// You can optionally provide a `shipment` object 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. [JsonPropertyName("shipment")] - public PartialShipment Shipment { get; set; } + public PartialShipment? Shipment { get; set; } /// diff --git a/ShipEngineSDK/Model/ParseShipmentResponseBody.cs b/ShipEngineSDK/Model/ParseShipmentResponseBody.cs index 04a34988..7c7a4173 100644 --- a/ShipEngineSDK/Model/ParseShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/ParseShipmentResponseBody.cs @@ -28,6 +28,14 @@ namespace ShipEngineSDK.Model; public partial class ParseShipmentResponseBody { + /// + /// All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, a carrier name, or a package weight. Each entity includes the original text and the parsed value. + /// + /// All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, a carrier name, or a package weight. Each entity includes the original text and the parsed value. + [JsonPropertyName("entities")] + [JsonRequired] + public List Entities { get; set; } + /// /// A confidence score between zero and one that indicates how certain the API is that it understood the text. /// @@ -44,14 +52,6 @@ public partial class ParseShipmentResponseBody [JsonRequired] public PartialShipment Shipment { get; set; } - /// - /// All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, a carrier name, or a package weight. Each entity includes the original text and the parsed value. - /// - /// All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, a carrier name, or a package weight. Each entity includes the original text and the parsed value. - [JsonPropertyName("entities")] - [JsonRequired] - public List Entities { get; set; } - /// /// Returns the string presentation of the object @@ -62,9 +62,9 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ParseShipmentResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" Entities: ").Append(Entities).Append("\n"); sb.Append(" Score: ").Append(Score).Append("\n"); sb.Append(" Shipment: ").Append(Shipment).Append("\n"); - sb.Append(" Entities: ").Append(Entities).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/PartialAddress.cs b/ShipEngineSDK/Model/PartialAddress.cs index 9ab7393c..f63a1953 100644 --- a/ShipEngineSDK/Model/PartialAddress.cs +++ b/ShipEngineSDK/Model/PartialAddress.cs @@ -35,94 +35,94 @@ public partial class PartialAddress [JsonPropertyName("address_residential_indicator")] public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } /// - /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. /// - /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. /// - /// John Doe + /// 1999 Bishop Grandin Blvd. /// - [JsonPropertyName("name")] - public string Name { get; set; } + [JsonPropertyName("address_line1")] + public string? AddressLine1 { get; set; } /// - /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// The second line of the street address. For some addresses, this line may not be needed. /// - /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// The second line of the street address. For some addresses, this line may not be needed. /// - /// +1 204-253-9411 ext. 123 + /// Unit 408 /// - [JsonPropertyName("phone")] - public string Phone { get; set; } + [JsonPropertyName("address_line2")] + public string? AddressLine2 { get; set; } /// - /// Email for the address owner. + /// The third line of the street address. For some addresses, this line may not be needed. /// - /// Email for the address owner. + /// The third line of the street address. For some addresses, this line may not be needed. /// - /// example@example.com + /// Building #7 /// - [JsonPropertyName("email")] - public string Email { get; set; } + [JsonPropertyName("address_line3")] + public string? AddressLine3 { get; set; } /// - /// If this is a business address, then the company name should be specified here. + /// The name of the city or locality /// - /// If this is a business address, then the company name should be specified here. + /// The name of the city or locality /// - /// The Home Depot + /// Winnipeg /// - [JsonPropertyName("company_name")] - public string CompanyName { get; set; } + [JsonPropertyName("city_locality")] + public string? CityLocality { get; set; } /// - /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// If this is a business address, then the company name should be specified here. /// - /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// If this is a business address, then the company name should be specified here. /// - /// 1999 Bishop Grandin Blvd. + /// The Home Depot /// - [JsonPropertyName("address_line1")] - public string AddressLine1 { get; set; } + [JsonPropertyName("company_name")] + public string? CompanyName { get; set; } /// - /// The second line of the street address. For some addresses, this line may not be needed. + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) /// - /// The second line of the street address. For some addresses, this line may not be needed. + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) /// - /// Unit 408 + /// CA /// - [JsonPropertyName("address_line2")] - public string AddressLine2 { get; set; } + [JsonPropertyName("country_code")] + public string? CountryCode { get; set; } /// - /// The third line of the street address. For some addresses, this line may not be needed. + /// Email for the address owner. /// - /// The third line of the street address. For some addresses, this line may not be needed. + /// Email for the address owner. /// - /// Building #7 + /// example@example.com /// - [JsonPropertyName("address_line3")] - public string AddressLine3 { get; set; } + [JsonPropertyName("email")] + public string? Email { get; set; } /// - /// The name of the city or locality + /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. /// - /// The name of the city or locality + /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. /// - /// Winnipeg + /// John Doe /// - [JsonPropertyName("city_locality")] - public string CityLocality { get; set; } + [JsonPropertyName("name")] + public string? Name { get; set; } /// - /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. /// - /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. /// - /// Manitoba + /// +1 204-253-9411 ext. 123 /// - [JsonPropertyName("state_province")] - public string StateProvince { get; set; } + [JsonPropertyName("phone")] + public string? Phone { get; set; } /// /// postal code @@ -132,17 +132,17 @@ public partial class PartialAddress /// 78756-3717 /// [JsonPropertyName("postal_code")] - public string PostalCode { get; set; } + public string? PostalCode { get; set; } /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. /// - /// CA + /// Manitoba /// - [JsonPropertyName("country_code")] - public string CountryCode { get; set; } + [JsonPropertyName("state_province")] + public string? StateProvince { get; set; } /// @@ -154,18 +154,18 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class PartialAddress {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Phone: ").Append(Phone).Append("\n"); - sb.Append(" Email: ").Append(Email).Append("\n"); - sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); + sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); - sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); - sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); - sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/PartialShipment.cs b/ShipEngineSDK/Model/PartialShipment.cs index 64594367..5ff03ffd 100644 --- a/ShipEngineSDK/Model/PartialShipment.cs +++ b/ShipEngineSDK/Model/PartialShipment.cs @@ -28,12 +28,6 @@ namespace ShipEngineSDK.Model; public partial class PartialShipment { - /// - /// The current status of the shipment CLOVUS - /// - /// The current status of the shipment - [JsonPropertyName("shipment_status")] - public ShipmentStatus? ShipmentStatus { get; set; } /// /// The type of delivery confirmation that is required for this shipment. CLOVUS /// @@ -52,14 +46,17 @@ public partial class PartialShipment [JsonPropertyName("order_source_code")] public OrderSourceName? OrderSourceCode { get; set; } /// - /// A string that uniquely identifies the shipment + /// The current status of the shipment CLOVUS /// - /// A string that uniquely identifies the shipment - /// - /// se-28529731 - /// - [JsonPropertyName("shipment_id")] - public string ShipmentId { get; set; } + /// The current status of the shipment + [JsonPropertyName("shipment_status")] + public ShipmentStatus? ShipmentStatus { get; set; } + /// + /// Advanced shipment options. These are entirely optional. + /// + /// Advanced shipment options. These are entirely optional. + [JsonPropertyName("advanced_options")] + public AdvancedShipmentOptions? AdvancedOptions { get; set; } /// /// The carrier account that is billed for the shipping charges @@ -69,174 +66,177 @@ public partial class PartialShipment /// se-28529731 /// [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + public string? CarrierId { get; set; } /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. /// - /// usps_first_class_mail + /// retail /// - [JsonPropertyName("service_code")] - public string ServiceCode { get; set; } + [JsonPropertyName("comparison_rate_type")] + public string? ComparisonRateType { get; set; } /// - /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// The date and time that the shipment was created in ShipEngine. /// - /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// The date and time that the shipment was created in ShipEngine. /// - /// se-28529731 + /// 2018-09-23T15:00Z /// - [JsonPropertyName("shipping_rule_id")] - public string ShippingRuleId { get; set; } + [JsonPropertyName("created_at")] + public DateTimeOffset? CreatedAt { get; set; } + + /// + /// Customs information. This is usually only needed for international shipments. + /// + /// Customs information. This is usually only needed for international shipments. + [JsonPropertyName("customs")] + public InternationalShipmentOptions? Customs { get; set; } /// /// ID that the Order Source assigned /// /// ID that the Order Source assigned [JsonPropertyName("external_order_id")] - public string ExternalOrderId { get; set; } + public string? ExternalOrderId { get; set; } + + /// + /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. + /// + /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. + [JsonPropertyName("external_shipment_id")] + public string? ExternalShipmentId { get; set; } + + /// + /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. + /// + /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. + [JsonPropertyName("is_return")] + public bool? IsReturn { get; set; } /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources [JsonPropertyName("items")] - public List Items { get; set; } + public List? Items { get; set; } /// - /// Gets or Sets TaxIdentifiers + /// The date and time that the shipment was created or last modified. /// - [JsonPropertyName("tax_identifiers")] - public List TaxIdentifiers { get; set; } + /// The date and time that the shipment was created or last modified. + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("modified_at")] + public DateTimeOffset? ModifiedAt { get; set; } /// - /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// - /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("external_shipment_id")] - public string ExternalShipmentId { get; set; } + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + [JsonPropertyName("packages")] + public List? Packages { get; set; } /// - /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. + /// The return address for this shipment. Defaults to the `ship_from` address. /// - /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("shipment_number")] - public string ShipmentNumber { get; set; } + /// The return address for this shipment. Defaults to the `ship_from` address. + [JsonPropertyName("return_to")] + public ShippingAddress? ReturnTo { get; set; } /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// - /// 2018-09-23T00:00Z + /// usps_first_class_mail /// - [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + [JsonPropertyName("service_code")] + public string? ServiceCode { get; set; } /// - /// The date and time that the shipment was created in ShipEngine. + /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The date and time that the shipment was created in ShipEngine. + /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// 2018-09-23T15:00Z + /// 2018-09-23T00:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("ship_date")] + public DateTimeOffset? ShipDate { get; set; } /// - /// The date and time that the shipment was created or last modified. + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// - /// The date and time that the shipment was created or last modified. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("modified_at")] - public DateTimeOffset ModifiedAt { get; set; } + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. + [JsonPropertyName("ship_from")] + public ShippingAddress? ShipFrom { get; set; } /// /// The recipient's mailing address /// /// The recipient's mailing address [JsonPropertyName("ship_to")] - public ShippingAddressTo ShipTo { get; set; } + public ShippingAddressTo? ShipTo { get; set; } /// - /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - /// - /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from")] - public ShippingAddress ShipFrom { get; set; } - - /// - /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// A string that uniquely identifies the shipment /// - /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// A string that uniquely identifies the shipment /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] - public string WarehouseId { get; set; } - - /// - /// The return address for this shipment. Defaults to the `ship_from` address. - /// - /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to")] - public ShippingAddress ReturnTo { get; set; } - - /// - /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. - /// - /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. - [JsonPropertyName("is_return")] - public bool? IsReturn { get; set; } + [JsonPropertyName("shipment_id")] + public string? ShipmentId { get; set; } /// - /// Customs information. This is usually only needed for international shipments. + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// - /// Customs information. This is usually only needed for international shipments. - [JsonPropertyName("customs")] - public InternationalShipmentOptions Customs { get; set; } + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. + [JsonPropertyName("shipment_number")] + public string? ShipmentNumber { get; set; } /// - /// Advanced shipment options. These are entirely optional. + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment /// - /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options")] - public AdvancedShipmentOptions AdvancedOptions { get; set; } + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// + /// se-28529731 + /// + [JsonPropertyName("shipping_rule_id")] + public string? ShippingRuleId { get; set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. [JsonPropertyName("tags")] - public List Tags { get; set; } + public List? Tags { get; set; } /// - /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + /// Gets or Sets TaxIdentifiers /// - /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - public List Packages { get; set; } + [JsonPropertyName("tax_identifiers")] + public List? TaxIdentifiers { get; set; } /// /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment [JsonPropertyName("total_weight")] - public Weight TotalWeight { get; set; } + public Weight? TotalWeight { get; set; } /// - /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. /// - /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. /// - /// retail + /// se-28529731 /// - [JsonPropertyName("comparison_rate_type")] - public string ComparisonRateType { get; set; } + [JsonPropertyName("warehouse_id")] + public string? WarehouseId { get; set; } /// @@ -248,33 +248,33 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class PartialShipment {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); - sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); - sb.Append(" ShippingRuleId: ").Append(ShippingRuleId).Append("\n"); - sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); - sb.Append(" Items: ").Append(Items).Append("\n"); - sb.Append(" TaxIdentifiers: ").Append(TaxIdentifiers).Append("\n"); - sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); - sb.Append(" ShipmentNumber: ").Append(ShipmentNumber).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); - sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); - sb.Append(" ShipmentStatus: ").Append(ShipmentStatus).Append("\n"); - sb.Append(" ShipTo: ").Append(ShipTo).Append("\n"); - sb.Append(" ShipFrom: ").Append(ShipFrom).Append("\n"); - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); - sb.Append(" ReturnTo: ").Append(ReturnTo).Append("\n"); - sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); + sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" Customs: ").Append(Customs).Append("\n"); - sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); + sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); + sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); sb.Append(" InsuranceProvider: ").Append(InsuranceProvider).Append("\n"); - sb.Append(" Tags: ").Append(Tags).Append("\n"); + sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); + sb.Append(" Items: ").Append(Items).Append("\n"); + sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); sb.Append(" OrderSourceCode: ").Append(OrderSourceCode).Append("\n"); sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" ReturnTo: ").Append(ReturnTo).Append("\n"); + sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" ShipFrom: ").Append(ShipFrom).Append("\n"); + sb.Append(" ShipTo: ").Append(ShipTo).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" ShipmentNumber: ").Append(ShipmentNumber).Append("\n"); + sb.Append(" ShipmentStatus: ").Append(ShipmentStatus).Append("\n"); + sb.Append(" ShippingRuleId: ").Append(ShippingRuleId).Append("\n"); + sb.Append(" Tags: ").Append(Tags).Append("\n"); + sb.Append(" TaxIdentifiers: ").Append(TaxIdentifiers).Append("\n"); sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); - sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/PartialShippingAddress.cs b/ShipEngineSDK/Model/PartialShippingAddress.cs index b1d8f1ac..1dd0fe45 100644 --- a/ShipEngineSDK/Model/PartialShippingAddress.cs +++ b/ShipEngineSDK/Model/PartialShippingAddress.cs @@ -33,7 +33,7 @@ public partial class PartialShippingAddress /// /// Additional text about how to handle the shipment at this address. [JsonPropertyName("instructions")] - public string Instructions { get; set; } + public string? Instructions { get; set; } /// diff --git a/ShipEngineSDK/Model/PartialShippingAddressTo.cs b/ShipEngineSDK/Model/PartialShippingAddressTo.cs index edeedb19..e1930c82 100644 --- a/ShipEngineSDK/Model/PartialShippingAddressTo.cs +++ b/ShipEngineSDK/Model/PartialShippingAddressTo.cs @@ -29,17 +29,17 @@ public partial class PartialShippingAddressTo { /// - /// Additional text about how to handle the shipment at this address. + /// Gets or Sets Geolocation /// - /// Additional text about how to handle the shipment at this address. - [JsonPropertyName("instructions")] - public string Instructions { get; set; } + [JsonPropertyName("geolocation")] + public List? Geolocation { get; set; } /// - /// Gets or Sets Geolocation + /// Additional text about how to handle the shipment at this address. /// - [JsonPropertyName("geolocation")] - public List Geolocation { get; set; } + /// Additional text about how to handle the shipment at this address. + [JsonPropertyName("instructions")] + public string? Instructions { get; set; } /// @@ -51,8 +51,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class PartialShippingAddressTo {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Instructions: ").Append(Instructions).Append("\n"); sb.Append(" Geolocation: ").Append(Geolocation).Append("\n"); + sb.Append(" Instructions: ").Append(Instructions).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs b/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs index 5189e246..cfa6f194 100644 --- a/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs +++ b/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs @@ -96,7 +96,7 @@ public override bool CanConvert(Type typeToConvert) => /// cats.with.thumbs /// [JsonPropertyName("value")] - public string Value { get; set; } + public string? Value { get; set; } /// diff --git a/ShipEngineSDK/Model/PaymentAmount.cs b/ShipEngineSDK/Model/PaymentAmount.cs index 9beb8623..4f804ad7 100644 --- a/ShipEngineSDK/Model/PaymentAmount.cs +++ b/ShipEngineSDK/Model/PaymentAmount.cs @@ -29,17 +29,17 @@ public partial class PaymentAmount { /// - /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + /// Gets or Sets Amount /// - /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("currency")] - public string Currency { get; set; } + [JsonPropertyName("amount")] + public double? Amount { get; set; } /// - /// Gets or Sets Amount + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html /// - [JsonPropertyName("amount")] - public double Amount { get; set; } + /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html + [JsonPropertyName("currency")] + public string? Currency { get; set; } /// @@ -51,8 +51,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class PaymentAmount {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Currency: ").Append(Currency).Append("\n"); sb.Append(" Amount: ").Append(Amount).Append("\n"); + sb.Append(" Currency: ").Append(Currency).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/Pickup.cs b/ShipEngineSDK/Model/Pickup.cs index 962f837d..395f650a 100644 --- a/ShipEngineSDK/Model/Pickup.cs +++ b/ShipEngineSDK/Model/Pickup.cs @@ -28,33 +28,6 @@ namespace ShipEngineSDK.Model; public partial class Pickup { - /// - /// Pickup Resource ID - /// - /// Pickup Resource ID - /// - /// pik_3YcKU5zdtJuCqoeNwyqqbW - /// - [JsonPropertyName("pickup_id")] - public string PickupId { get; set; } - - /// - /// Label IDs that will be included in the pickup request - /// - /// Label IDs that will be included in the pickup request - [JsonPropertyName("label_ids")] - public List LabelIds { get; set; } - - /// - /// The date and time that the pickup was created in ShipEngine. - /// - /// The date and time that the pickup was created in ShipEngine. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } - /// /// The date and time that the pickup was cancelled in ShipEngine. /// @@ -63,7 +36,7 @@ public partial class Pickup /// 2018-09-23T15:00Z /// [JsonPropertyName("cancelled_at")] - public DateTimeOffset CancelledAt { get; set; } + public DateTimeOffset? CancelledAt { get; set; } /// /// The carrier_id associated with the pickup @@ -73,7 +46,7 @@ public partial class Pickup /// se-28529731 /// [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + public string? CarrierId { get; set; } /// /// The carrier confirmation number for the scheduled pickup. @@ -83,49 +56,76 @@ public partial class Pickup /// 292513CL4A3 /// [JsonPropertyName("confirmation_number")] - public string ConfirmationNumber { get; set; } + public string? ConfirmationNumber { get; set; } /// - /// The warehouse_id associated with the pickup + /// Gets or Sets ContactDetails /// - /// The warehouse_id associated with the pickup + [JsonPropertyName("contact_details")] + public ContactDetails? ContactDetails { get; set; } + + /// + /// The date and time that the pickup was created in ShipEngine. + /// + /// The date and time that the pickup was created in ShipEngine. /// - /// se-28529731 + /// 2018-09-23T15:00Z /// - [JsonPropertyName("warehouse_id")] - public string WarehouseId { get; set; } + [JsonPropertyName("created_at")] + public DateTimeOffset? CreatedAt { get; set; } + + /// + /// Label IDs that will be included in the pickup request + /// + /// Label IDs that will be included in the pickup request + [JsonPropertyName("label_ids")] + public List? LabelIds { get; set; } /// /// Gets or Sets PickupAddress /// [JsonPropertyName("pickup_address")] - public Address PickupAddress { get; set; } + public Address? PickupAddress { get; set; } /// - /// Gets or Sets ContactDetails + /// Pickup Resource ID /// - [JsonPropertyName("contact_details")] - public ContactDetails ContactDetails { get; set; } + /// Pickup Resource ID + /// + /// pik_3YcKU5zdtJuCqoeNwyqqbW + /// + [JsonPropertyName("pickup_id")] + public string? PickupId { get; set; } /// /// Used by some carriers to give special instructions for a package pickup /// /// Used by some carriers to give special instructions for a package pickup [JsonPropertyName("pickup_notes")] - public string PickupNotes { get; set; } + public string? PickupNotes { get; set; } /// /// Gets or Sets PickupWindow /// [JsonPropertyName("pickup_window")] - public PickupWindow PickupWindow { get; set; } + public PickupWindow? PickupWindow { get; set; } /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. [JsonPropertyName("pickup_windows")] - public List PickupWindows { get; set; } + public List? PickupWindows { get; set; } + + /// + /// The warehouse_id associated with the pickup + /// + /// The warehouse_id associated with the pickup + /// + /// se-28529731 + /// + [JsonPropertyName("warehouse_id")] + public string? WarehouseId { get; set; } /// @@ -137,18 +137,18 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class Pickup {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" PickupId: ").Append(PickupId).Append("\n"); - sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" CancelledAt: ").Append(CancelledAt).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ConfirmationNumber: ").Append(ConfirmationNumber).Append("\n"); - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); - sb.Append(" PickupAddress: ").Append(PickupAddress).Append("\n"); sb.Append(" ContactDetails: ").Append(ContactDetails).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); + sb.Append(" PickupAddress: ").Append(PickupAddress).Append("\n"); + sb.Append(" PickupId: ").Append(PickupId).Append("\n"); sb.Append(" PickupNotes: ").Append(PickupNotes).Append("\n"); sb.Append(" PickupWindow: ").Append(PickupWindow).Append("\n"); sb.Append(" PickupWindows: ").Append(PickupWindows).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/PickupResponseBody.cs b/ShipEngineSDK/Model/PickupResponseBody.cs index 7a177275..2d745aac 100644 --- a/ShipEngineSDK/Model/PickupResponseBody.cs +++ b/ShipEngineSDK/Model/PickupResponseBody.cs @@ -29,23 +29,22 @@ public partial class PickupResponseBody { /// - /// Pickup Resource ID + /// The carrier_id associated with the pickup /// - /// Pickup Resource ID + /// The carrier_id associated with the pickup /// - /// pik_3YcKU5zdtJuCqoeNwyqqbW + /// se-28529731 /// - [JsonPropertyName("pickup_id")] + [JsonPropertyName("carrier_id")] [JsonRequired] - public string PickupId { get; set; } + public string CarrierId { get; set; } /// - /// Label IDs that will be included in the pickup request + /// Gets or Sets ContactDetails /// - /// Label IDs that will be included in the pickup request - [JsonPropertyName("label_ids")] + [JsonPropertyName("contact_details")] [JsonRequired] - public List LabelIds { get; set; } + public ContactDetails ContactDetails { get; set; } /// /// The date and time that the pickup was created in ShipEngine. @@ -59,36 +58,37 @@ public partial class PickupResponseBody public DateTimeOffset CreatedAt { get; set; } /// - /// The date and time that the pickup was cancelled in ShipEngine. + /// Label IDs that will be included in the pickup request /// - /// The date and time that the pickup was cancelled in ShipEngine. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("cancelled_at")] - public DateTimeOffset CancelledAt { get; set; } + /// Label IDs that will be included in the pickup request + [JsonPropertyName("label_ids")] + [JsonRequired] + public List LabelIds { get; set; } /// - /// The carrier_id associated with the pickup + /// Gets or Sets PickupAddress /// - /// The carrier_id associated with the pickup - /// - /// se-28529731 - /// - [JsonPropertyName("carrier_id")] + [JsonPropertyName("pickup_address")] [JsonRequired] - public string CarrierId { get; set; } + public Address PickupAddress { get; set; } /// - /// The carrier confirmation number for the scheduled pickup. + /// Pickup Resource ID /// - /// The carrier confirmation number for the scheduled pickup. + /// Pickup Resource ID /// - /// 292513CL4A3 + /// pik_3YcKU5zdtJuCqoeNwyqqbW /// - [JsonPropertyName("confirmation_number")] + [JsonPropertyName("pickup_id")] [JsonRequired] - public string ConfirmationNumber { get; set; } + public string PickupId { get; set; } + + /// + /// Gets or Sets PickupWindow + /// + [JsonPropertyName("pickup_window")] + [JsonRequired] + public PickupWindow PickupWindow { get; set; } /// /// The warehouse_id associated with the pickup @@ -102,39 +102,39 @@ public partial class PickupResponseBody public string WarehouseId { get; set; } /// - /// Gets or Sets PickupAddress + /// The date and time that the pickup was cancelled in ShipEngine. /// - [JsonPropertyName("pickup_address")] - [JsonRequired] - public Address PickupAddress { get; set; } + /// The date and time that the pickup was cancelled in ShipEngine. + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("cancelled_at")] + public DateTimeOffset? CancelledAt { get; set; } /// - /// Gets or Sets ContactDetails + /// The carrier confirmation number for the scheduled pickup. /// - [JsonPropertyName("contact_details")] + /// The carrier confirmation number for the scheduled pickup. + /// + /// 292513CL4A3 + /// + [JsonPropertyName("confirmation_number")] [JsonRequired] - public ContactDetails ContactDetails { get; set; } + public string ConfirmationNumber { get; set; } /// /// Used by some carriers to give special instructions for a package pickup /// /// Used by some carriers to give special instructions for a package pickup [JsonPropertyName("pickup_notes")] - public string PickupNotes { get; set; } - - /// - /// Gets or Sets PickupWindow - /// - [JsonPropertyName("pickup_window")] - [JsonRequired] - public PickupWindow PickupWindow { get; set; } + public string? PickupNotes { get; set; } /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. [JsonPropertyName("pickup_windows")] - public List PickupWindows { get; set; } + public List? PickupWindows { get; set; } /// @@ -146,17 +146,17 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class PickupResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" PickupId: ").Append(PickupId).Append("\n"); - sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); + sb.Append(" ContactDetails: ").Append(ContactDetails).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); + sb.Append(" PickupAddress: ").Append(PickupAddress).Append("\n"); + sb.Append(" PickupId: ").Append(PickupId).Append("\n"); + sb.Append(" PickupWindow: ").Append(PickupWindow).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); sb.Append(" CancelledAt: ").Append(CancelledAt).Append("\n"); - sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ConfirmationNumber: ").Append(ConfirmationNumber).Append("\n"); - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); - sb.Append(" PickupAddress: ").Append(PickupAddress).Append("\n"); - sb.Append(" ContactDetails: ").Append(ContactDetails).Append("\n"); sb.Append(" PickupNotes: ").Append(PickupNotes).Append("\n"); - sb.Append(" PickupWindow: ").Append(PickupWindow).Append("\n"); sb.Append(" PickupWindows: ").Append(PickupWindows).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/PickupWindow.cs b/ShipEngineSDK/Model/PickupWindow.cs index ffc64b82..e6b460ab 100644 --- a/ShipEngineSDK/Model/PickupWindow.cs +++ b/ShipEngineSDK/Model/PickupWindow.cs @@ -35,9 +35,9 @@ public partial class PickupWindow /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("start_at")] + [JsonPropertyName("end_at")] [JsonRequired] - public DateTimeOffset StartAt { get; set; } + public DateTimeOffset EndAt { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -46,9 +46,9 @@ public partial class PickupWindow /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("end_at")] + [JsonPropertyName("start_at")] [JsonRequired] - public DateTimeOffset EndAt { get; set; } + public DateTimeOffset StartAt { get; set; } /// @@ -60,8 +60,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class PickupWindow {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" StartAt: ").Append(StartAt).Append("\n"); sb.Append(" EndAt: ").Append(EndAt).Append("\n"); + sb.Append(" StartAt: ").Append(StartAt).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/PickupWindows.cs b/ShipEngineSDK/Model/PickupWindows.cs index 1452ada2..d96e62e1 100644 --- a/ShipEngineSDK/Model/PickupWindows.cs +++ b/ShipEngineSDK/Model/PickupWindows.cs @@ -35,8 +35,8 @@ public partial class PickupWindows /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("start_at")] - public DateTimeOffset StartAt { get; set; } + [JsonPropertyName("end_at")] + public DateTimeOffset? EndAt { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -45,8 +45,8 @@ public partial class PickupWindows /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("end_at")] - public DateTimeOffset EndAt { get; set; } + [JsonPropertyName("start_at")] + public DateTimeOffset? StartAt { get; set; } /// @@ -58,8 +58,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class PickupWindows {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" StartAt: ").Append(StartAt).Append("\n"); sb.Append(" EndAt: ").Append(EndAt).Append("\n"); + sb.Append(" StartAt: ").Append(StartAt).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ProcessBatchRequestBody.cs b/ShipEngineSDK/Model/ProcessBatchRequestBody.cs index 279e4df5..046198ed 100644 --- a/ShipEngineSDK/Model/ProcessBatchRequestBody.cs +++ b/ShipEngineSDK/Model/ProcessBatchRequestBody.cs @@ -29,21 +29,21 @@ public partial class ProcessBatchRequestBody { /// - /// Gets or Sets LabelLayout CLOVUS + /// The display format that the label should be shown in. CLOVUS /// - [JsonPropertyName("label_layout")] - public LabelLayout? LabelLayout { get; set; } + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme")] + public DisplayScheme? DisplayScheme { get; set; } /// /// Gets or Sets LabelFormat CLOVUS /// [JsonPropertyName("label_format")] public LabelFormat? LabelFormat { get; set; } /// - /// The display format that the label should be shown in. CLOVUS + /// Gets or Sets LabelLayout CLOVUS /// - /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] - public DisplayScheme? DisplayScheme { get; set; } + [JsonPropertyName("label_layout")] + public LabelLayout? LabelLayout { get; set; } /// /// The Ship date the batch is being processed for /// @@ -52,7 +52,7 @@ public partial class ProcessBatchRequestBody /// 2018-09-23T15:00Z /// [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + public DateTimeOffset? ShipDate { get; set; } /// @@ -64,10 +64,10 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ProcessBatchRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); - sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); - sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/Products.cs b/ShipEngineSDK/Model/Products.cs index 6a26a930..c62fed79 100644 --- a/ShipEngineSDK/Model/Products.cs +++ b/ShipEngineSDK/Model/Products.cs @@ -29,32 +29,28 @@ public partial class Products { /// - /// A description of the item - /// - /// A description of the item - [JsonPropertyName("description")] - public string Description { get; set; } - - /// - /// The quantity of this item in the shipment. + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated /// - /// The quantity of this item in the shipment. - [JsonPropertyName("quantity")] - public int Quantity { get; set; } + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated + /// + /// CA + /// + [JsonPropertyName("country_of_origin")] + public string? CountryOfOrigin { get; set; } /// - /// The declared value of each item + /// Details about dangerous goods inside products /// - /// The declared value of each item - [JsonPropertyName("value")] - public MonetaryValue Value { get; set; } + /// Details about dangerous goods inside products + [JsonPropertyName("dangerous_goods")] + public List? DangerousGoods { get; set; } /// - /// The item weight + /// A description of the item /// - /// The item weight - [JsonPropertyName("weight")] - public Weight Weight { get; set; } + /// A description of the item + [JsonPropertyName("description")] + public string? Description { get; set; } /// /// The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item. @@ -64,51 +60,55 @@ public partial class Products /// 3926.1 /// [JsonPropertyName("harmonized_tariff_code")] - public string HarmonizedTariffCode { get; set; } + public string? HarmonizedTariffCode { get; set; } /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated + /// Manufacturers Identification code /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated - /// - /// CA - /// - [JsonPropertyName("country_of_origin")] - public string CountryOfOrigin { get; set; } + /// Manufacturers Identification code + [JsonPropertyName("mid_code")] + public string? MidCode { get; set; } /// - /// Gets or Sets UnitOfMeasure + /// link to the item on the seller website /// - [JsonPropertyName("unit_of_measure")] - public string UnitOfMeasure { get; set; } + /// link to the item on the seller website + [JsonPropertyName("product_url")] + public string? ProductUrl { get; set; } + + /// + /// The quantity of this item in the shipment. + /// + /// The quantity of this item in the shipment. + [JsonPropertyName("quantity")] + public int? Quantity { get; set; } /// /// The SKU (Stock Keeping Unit) of the item /// /// The SKU (Stock Keeping Unit) of the item [JsonPropertyName("sku")] - public string Sku { get; set; } + public string? Sku { get; set; } /// /// Description of the Custom Item's SKU /// /// Description of the Custom Item's SKU [JsonPropertyName("sku_description")] - public string SkuDescription { get; set; } + public string? SkuDescription { get; set; } /// - /// Manufacturers Identification code + /// Gets or Sets UnitOfMeasure /// - /// Manufacturers Identification code - [JsonPropertyName("mid_code")] - public string MidCode { get; set; } + [JsonPropertyName("unit_of_measure")] + public string? UnitOfMeasure { get; set; } /// - /// link to the item on the seller website + /// The declared value of each item /// - /// link to the item on the seller website - [JsonPropertyName("product_url")] - public string ProductUrl { get; set; } + /// The declared value of each item + [JsonPropertyName("value")] + public MonetaryValue? Value { get; set; } /// /// VAT rate applicable to the item @@ -121,11 +121,11 @@ public partial class Products public double? VatRate { get; set; } /// - /// Details about dangerous goods inside products + /// The item weight /// - /// Details about dangerous goods inside products - [JsonPropertyName("dangerous_goods")] - public List DangerousGoods { get; set; } + /// The item weight + [JsonPropertyName("weight")] + public Weight? Weight { get; set; } /// @@ -137,19 +137,19 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class Products {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" CountryOfOrigin: ").Append(CountryOfOrigin).Append("\n"); + sb.Append(" DangerousGoods: ").Append(DangerousGoods).Append("\n"); sb.Append(" Description: ").Append(Description).Append("\n"); - sb.Append(" Quantity: ").Append(Quantity).Append("\n"); - sb.Append(" Value: ").Append(Value).Append("\n"); - sb.Append(" Weight: ").Append(Weight).Append("\n"); sb.Append(" HarmonizedTariffCode: ").Append(HarmonizedTariffCode).Append("\n"); - sb.Append(" CountryOfOrigin: ").Append(CountryOfOrigin).Append("\n"); - sb.Append(" UnitOfMeasure: ").Append(UnitOfMeasure).Append("\n"); - sb.Append(" Sku: ").Append(Sku).Append("\n"); - sb.Append(" SkuDescription: ").Append(SkuDescription).Append("\n"); sb.Append(" MidCode: ").Append(MidCode).Append("\n"); sb.Append(" ProductUrl: ").Append(ProductUrl).Append("\n"); + sb.Append(" Quantity: ").Append(Quantity).Append("\n"); + sb.Append(" Sku: ").Append(Sku).Append("\n"); + sb.Append(" SkuDescription: ").Append(SkuDescription).Append("\n"); + sb.Append(" UnitOfMeasure: ").Append(UnitOfMeasure).Append("\n"); + sb.Append(" Value: ").Append(Value).Append("\n"); sb.Append(" VatRate: ").Append(VatRate).Append("\n"); - sb.Append(" DangerousGoods: ").Append(DangerousGoods).Append("\n"); + sb.Append(" Weight: ").Append(Weight).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs b/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs index 61a77085..c3db19d0 100644 --- a/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs +++ b/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs @@ -29,31 +29,31 @@ public partial class PurchaseLabelWithoutShipment { /// - /// Gets or Sets ValidateAddress CLOVUS + /// The display format that the label should be shown in. CLOVUS /// - [JsonPropertyName("validate_address")] - public ValidateAddress? ValidateAddress { get; set; } + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme")] + public DisplayScheme? DisplayScheme { get; set; } /// - /// Gets or Sets LabelLayout CLOVUS + /// Gets or Sets LabelDownloadType CLOVUS /// - [JsonPropertyName("label_layout")] - public LabelLayout? LabelLayout { get; set; } + [JsonPropertyName("label_download_type")] + public LabelDownloadType? LabelDownloadType { get; set; } /// /// Gets or Sets LabelFormat CLOVUS /// [JsonPropertyName("label_format")] public LabelFormat? LabelFormat { get; set; } /// - /// Gets or Sets LabelDownloadType CLOVUS + /// Gets or Sets LabelLayout CLOVUS /// - [JsonPropertyName("label_download_type")] - public LabelDownloadType? LabelDownloadType { get; set; } + [JsonPropertyName("label_layout")] + public LabelLayout? LabelLayout { get; set; } /// - /// The display format that the label should be shown in. CLOVUS + /// Gets or Sets ValidateAddress CLOVUS /// - /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] - public DisplayScheme? DisplayScheme { get; set; } + [JsonPropertyName("validate_address")] + public ValidateAddress? ValidateAddress { get; set; } /// /// Returns the string presentation of the object @@ -64,11 +64,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class PurchaseLabelWithoutShipment {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); - sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); - sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); - sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); + sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); + sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/Rate.cs b/ShipEngineSDK/Model/Rate.cs index ea2c0735..c37f2ab7 100644 --- a/ShipEngineSDK/Model/Rate.cs +++ b/ShipEngineSDK/Model/Rate.cs @@ -45,15 +45,20 @@ public partial class Rate /// - /// A string that uniquely identifies the rate + /// carrier code /// - /// A string that uniquely identifies the rate - /// - /// se-28529731 - /// - [JsonPropertyName("rate_id")] + /// carrier code + [JsonPropertyName("carrier_code")] [JsonRequired] - public string RateId { get; set; } + public string CarrierCode { get; set; } + + /// + /// carrier friendly name + /// + /// carrier friendly name + [JsonPropertyName("carrier_friendly_name")] + [JsonRequired] + public string CarrierFriendlyName { get; set; } /// /// A string that uniquely identifies the carrier @@ -67,20 +72,12 @@ public partial class Rate public string CarrierId { get; set; } /// - /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. - /// - /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. - [JsonPropertyName("shipping_amount")] - [JsonRequired] - public MonetaryValue ShippingAmount { get; set; } - - /// - /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. + /// carrier nickname /// - /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. - [JsonPropertyName("insurance_amount")] + /// carrier nickname + [JsonPropertyName("carrier_nickname")] [JsonRequired] - public MonetaryValue InsuranceAmount { get; set; } + public string CarrierNickname { get; set; } /// /// The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price. @@ -91,98 +88,63 @@ public partial class Rate public MonetaryValue ConfirmationAmount { get; set; } /// - /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. + /// The error messages /// - /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. - [JsonPropertyName("other_amount")] + /// The error messages + [JsonPropertyName("error_messages")] [JsonRequired] - public MonetaryValue OtherAmount { get; set; } - - /// - /// The total shipping cost for the specified comparison_rate_type. - /// - /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue RequestedComparisonAmount { get; set; } - - /// - /// Tariff and additional taxes associated with an international shipment. - /// - /// Tariff and additional taxes associated with an international shipment. - [JsonPropertyName("tax_amount")] - public MonetaryValue TaxAmount { get; set; } + public List ErrorMessages { get; set; } /// - /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location + /// Indicates if the rate is guaranteed. /// - /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location - /// - /// 6 - /// - [JsonPropertyName("zone")] + /// Indicates if the rate is guaranteed. + [JsonPropertyName("guaranteed_service")] [JsonRequired] - public int? Zone { get; set; } + public bool GuaranteedService { get; set; } /// - /// package type that this rate was estimated for + /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. /// - /// package type that this rate was estimated for - /// - /// package - /// - [JsonPropertyName("package_type")] + /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. + [JsonPropertyName("insurance_amount")] [JsonRequired] - public string PackageType { get; set; } + public MonetaryValue InsuranceAmount { get; set; } /// - /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday + /// Indicates if the rates been negotiated /// - /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday - /// - /// 5 - /// - [JsonPropertyName("delivery_days")] - public int DeliveryDays { get; set; } + /// Indicates if the rates been negotiated + [JsonPropertyName("negotiated_rate")] + [JsonRequired] + public bool NegotiatedRate { get; set; } /// - /// Indicates if the rate is guaranteed. + /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. /// - /// Indicates if the rate is guaranteed. - [JsonPropertyName("guaranteed_service")] + /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. + [JsonPropertyName("other_amount")] [JsonRequired] - public bool GuaranteedService { get; set; } + public MonetaryValue OtherAmount { get; set; } /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. + /// A string that uniquely identifies the rate /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. + /// A string that uniquely identifies the rate /// - /// 2018-09-23T00:00Z + /// se-28529731 /// - [JsonPropertyName("estimated_delivery_date")] - public DateTimeOffset EstimatedDeliveryDate { get; set; } - - /// - /// The carrier delivery days - /// - /// The carrier delivery days - [JsonPropertyName("carrier_delivery_days")] - public string CarrierDeliveryDays { get; set; } - - /// - /// ship date - /// - /// ship date - [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + [JsonPropertyName("rate_id")] + [JsonRequired] + public string RateId { get; set; } /// - /// Indicates if the rates been negotiated + /// service code for the rate /// - /// Indicates if the rates been negotiated - [JsonPropertyName("negotiated_rate")] + /// service code for the rate + [JsonPropertyName("service_code")] [JsonRequired] - public bool NegotiatedRate { get; set; } + public string ServiceCode { get; set; } /// /// service type @@ -193,12 +155,12 @@ public partial class Rate public string ServiceType { get; set; } /// - /// service code for the rate + /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. /// - /// service code for the rate - [JsonPropertyName("service_code")] + /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. + [JsonPropertyName("shipping_amount")] [JsonRequired] - public string ServiceCode { get; set; } + public MonetaryValue ShippingAmount { get; set; } /// /// Indicates if rate is trackable @@ -209,44 +171,82 @@ public partial class Rate public bool Trackable { get; set; } /// - /// carrier code + /// The warning messages /// - /// carrier code - [JsonPropertyName("carrier_code")] + /// The warning messages + [JsonPropertyName("warning_messages")] [JsonRequired] - public string CarrierCode { get; set; } + public List WarningMessages { get; set; } /// - /// carrier nickname + /// The carrier delivery days /// - /// carrier nickname - [JsonPropertyName("carrier_nickname")] - [JsonRequired] - public string CarrierNickname { get; set; } + /// The carrier delivery days + [JsonPropertyName("carrier_delivery_days")] + public string? CarrierDeliveryDays { get; set; } /// - /// carrier friendly name + /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday /// - /// carrier friendly name - [JsonPropertyName("carrier_friendly_name")] - [JsonRequired] - public string CarrierFriendlyName { get; set; } + /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday + /// + /// 5 + /// + [JsonPropertyName("delivery_days")] + public int? DeliveryDays { get; set; } /// - /// The warning messages + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. /// - /// The warning messages - [JsonPropertyName("warning_messages")] + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. + /// + /// 2018-09-23T00:00Z + /// + [JsonPropertyName("estimated_delivery_date")] + public DateTimeOffset? EstimatedDeliveryDate { get; set; } + + /// + /// package type that this rate was estimated for + /// + /// package type that this rate was estimated for + /// + /// package + /// + [JsonPropertyName("package_type")] [JsonRequired] - public List WarningMessages { get; set; } + public string PackageType { get; set; } /// - /// The error messages + /// The total shipping cost for the specified comparison_rate_type. /// - /// The error messages - [JsonPropertyName("error_messages")] + /// The total shipping cost for the specified comparison_rate_type. + [JsonPropertyName("requested_comparison_amount")] + public MonetaryValue? RequestedComparisonAmount { get; set; } + + /// + /// ship date + /// + /// ship date + [JsonPropertyName("ship_date")] + public DateTimeOffset? ShipDate { get; set; } + + /// + /// Tariff and additional taxes associated with an international shipment. + /// + /// Tariff and additional taxes associated with an international shipment. + [JsonPropertyName("tax_amount")] + public MonetaryValue? TaxAmount { get; set; } + + /// + /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location + /// + /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location + /// + /// 6 + /// + [JsonPropertyName("zone")] [JsonRequired] - public List ErrorMessages { get; set; } + public int Zone { get; set; } /// @@ -258,32 +258,32 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class Rate {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" RateId: ").Append(RateId).Append("\n"); - sb.Append(" RateType: ").Append(RateType).Append("\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" CarrierFriendlyName: ").Append(CarrierFriendlyName).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); - sb.Append(" ShippingAmount: ").Append(ShippingAmount).Append("\n"); - sb.Append(" InsuranceAmount: ").Append(InsuranceAmount).Append("\n"); + sb.Append(" CarrierNickname: ").Append(CarrierNickname).Append("\n"); sb.Append(" ConfirmationAmount: ").Append(ConfirmationAmount).Append("\n"); - sb.Append(" OtherAmount: ").Append(OtherAmount).Append("\n"); - sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); - sb.Append(" TaxAmount: ").Append(TaxAmount).Append("\n"); - sb.Append(" Zone: ").Append(Zone).Append("\n"); - sb.Append(" PackageType: ").Append(PackageType).Append("\n"); - sb.Append(" DeliveryDays: ").Append(DeliveryDays).Append("\n"); + sb.Append(" ErrorMessages: ").Append(ErrorMessages).Append("\n"); sb.Append(" GuaranteedService: ").Append(GuaranteedService).Append("\n"); - sb.Append(" EstimatedDeliveryDate: ").Append(EstimatedDeliveryDate).Append("\n"); - sb.Append(" CarrierDeliveryDays: ").Append(CarrierDeliveryDays).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" InsuranceAmount: ").Append(InsuranceAmount).Append("\n"); sb.Append(" NegotiatedRate: ").Append(NegotiatedRate).Append("\n"); - sb.Append(" ServiceType: ").Append(ServiceType).Append("\n"); + sb.Append(" OtherAmount: ").Append(OtherAmount).Append("\n"); + sb.Append(" RateId: ").Append(RateId).Append("\n"); + sb.Append(" RateType: ").Append(RateType).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" ServiceType: ").Append(ServiceType).Append("\n"); + sb.Append(" ShippingAmount: ").Append(ShippingAmount).Append("\n"); sb.Append(" Trackable: ").Append(Trackable).Append("\n"); - sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); - sb.Append(" CarrierNickname: ").Append(CarrierNickname).Append("\n"); - sb.Append(" CarrierFriendlyName: ").Append(CarrierFriendlyName).Append("\n"); sb.Append(" ValidationStatus: ").Append(ValidationStatus).Append("\n"); sb.Append(" WarningMessages: ").Append(WarningMessages).Append("\n"); - sb.Append(" ErrorMessages: ").Append(ErrorMessages).Append("\n"); + sb.Append(" CarrierDeliveryDays: ").Append(CarrierDeliveryDays).Append("\n"); + sb.Append(" DeliveryDays: ").Append(DeliveryDays).Append("\n"); + sb.Append(" EstimatedDeliveryDate: ").Append(EstimatedDeliveryDate).Append("\n"); + sb.Append(" PackageType: ").Append(PackageType).Append("\n"); + sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" TaxAmount: ").Append(TaxAmount).Append("\n"); + sb.Append(" Zone: ").Append(Zone).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/RateEstimate.cs b/ShipEngineSDK/Model/RateEstimate.cs index 0f5ceebf..5a13ba36 100644 --- a/ShipEngineSDK/Model/RateEstimate.cs +++ b/ShipEngineSDK/Model/RateEstimate.cs @@ -44,6 +44,22 @@ public partial class RateEstimate public ValidationStatus ValidationStatus { get; set; } = new(); + /// + /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. + [JsonPropertyName("carrier_code")] + [JsonRequired] + public string CarrierCode { get; set; } + + /// + /// carrier friendly name + /// + /// carrier friendly name + [JsonPropertyName("carrier_friendly_name")] + [JsonRequired] + public string CarrierFriendlyName { get; set; } + /// /// A string that uniquely identifies the carrier /// @@ -56,20 +72,12 @@ public partial class RateEstimate public string CarrierId { get; set; } /// - /// The shipping amount - /// - /// The shipping amount - [JsonPropertyName("shipping_amount")] - [JsonRequired] - public MonetaryValue ShippingAmount { get; set; } - - /// - /// The insurance amount + /// carrier nickname /// - /// The insurance amount - [JsonPropertyName("insurance_amount")] + /// carrier nickname + [JsonPropertyName("carrier_nickname")] [JsonRequired] - public MonetaryValue InsuranceAmount { get; set; } + public string CarrierNickname { get; set; } /// /// The confirmation amount @@ -80,51 +88,12 @@ public partial class RateEstimate public MonetaryValue ConfirmationAmount { get; set; } /// - /// Any other charges associated with this rate - /// - /// Any other charges associated with this rate - [JsonPropertyName("other_amount")] - [JsonRequired] - public MonetaryValue OtherAmount { get; set; } - - /// - /// Tariff and additional taxes associated with an international shipment. - /// - /// Tariff and additional taxes associated with an international shipment. - [JsonPropertyName("tax_amount")] - public MonetaryValue TaxAmount { get; set; } - - /// - /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location - /// - /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location - /// - /// 6 - /// - [JsonPropertyName("zone")] - [JsonRequired] - public int? Zone { get; set; } - - /// - /// package type that this rate was estimated for + /// The error messages /// - /// package type that this rate was estimated for - /// - /// package - /// - [JsonPropertyName("package_type")] + /// The error messages + [JsonPropertyName("error_messages")] [JsonRequired] - public string PackageType { get; set; } - - /// - /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday - /// - /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday - /// - /// 5 - /// - [JsonPropertyName("delivery_days")] - public int DeliveryDays { get; set; } + public List ErrorMessages { get; set; } /// /// Indicates if the rate is guaranteed. @@ -135,36 +104,36 @@ public partial class RateEstimate public bool GuaranteedService { get; set; } /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. + /// The insurance amount /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. - /// - /// 2018-09-23T00:00Z - /// - [JsonPropertyName("estimated_delivery_date")] - public DateTimeOffset EstimatedDeliveryDate { get; set; } + /// The insurance amount + [JsonPropertyName("insurance_amount")] + [JsonRequired] + public MonetaryValue InsuranceAmount { get; set; } /// - /// The carrier delivery days + /// Indicates if the rates been negotiated /// - /// The carrier delivery days - [JsonPropertyName("carrier_delivery_days")] - public string CarrierDeliveryDays { get; set; } + /// Indicates if the rates been negotiated + [JsonPropertyName("negotiated_rate")] + [JsonRequired] + public bool NegotiatedRate { get; set; } /// - /// ship date + /// Any other charges associated with this rate /// - /// ship date - [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + /// Any other charges associated with this rate + [JsonPropertyName("other_amount")] + [JsonRequired] + public MonetaryValue OtherAmount { get; set; } /// - /// Indicates if the rates been negotiated + /// service code for the rate /// - /// Indicates if the rates been negotiated - [JsonPropertyName("negotiated_rate")] + /// service code for the rate + [JsonPropertyName("service_code")] [JsonRequired] - public bool NegotiatedRate { get; set; } + public string ServiceCode { get; set; } /// /// service type @@ -175,12 +144,12 @@ public partial class RateEstimate public string ServiceType { get; set; } /// - /// service code for the rate + /// The shipping amount /// - /// service code for the rate - [JsonPropertyName("service_code")] + /// The shipping amount + [JsonPropertyName("shipping_amount")] [JsonRequired] - public string ServiceCode { get; set; } + public MonetaryValue ShippingAmount { get; set; } /// /// Indicates if rate is trackable @@ -191,44 +160,75 @@ public partial class RateEstimate public bool Trackable { get; set; } /// - /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// The warning messages /// - /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. - [JsonPropertyName("carrier_code")] + /// The warning messages + [JsonPropertyName("warning_messages")] [JsonRequired] - public string CarrierCode { get; set; } + public List WarningMessages { get; set; } /// - /// carrier nickname + /// The carrier delivery days /// - /// carrier nickname - [JsonPropertyName("carrier_nickname")] - [JsonRequired] - public string CarrierNickname { get; set; } + /// The carrier delivery days + [JsonPropertyName("carrier_delivery_days")] + public string? CarrierDeliveryDays { get; set; } /// - /// carrier friendly name + /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday /// - /// carrier friendly name - [JsonPropertyName("carrier_friendly_name")] - [JsonRequired] - public string CarrierFriendlyName { get; set; } + /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday + /// + /// 5 + /// + [JsonPropertyName("delivery_days")] + public int? DeliveryDays { get; set; } /// - /// The warning messages + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. /// - /// The warning messages - [JsonPropertyName("warning_messages")] + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. + /// + /// 2018-09-23T00:00Z + /// + [JsonPropertyName("estimated_delivery_date")] + public DateTimeOffset? EstimatedDeliveryDate { get; set; } + + /// + /// package type that this rate was estimated for + /// + /// package type that this rate was estimated for + /// + /// package + /// + [JsonPropertyName("package_type")] [JsonRequired] - public List WarningMessages { get; set; } + public string PackageType { get; set; } /// - /// The error messages + /// ship date /// - /// The error messages - [JsonPropertyName("error_messages")] + /// ship date + [JsonPropertyName("ship_date")] + public DateTimeOffset? ShipDate { get; set; } + + /// + /// Tariff and additional taxes associated with an international shipment. + /// + /// Tariff and additional taxes associated with an international shipment. + [JsonPropertyName("tax_amount")] + public MonetaryValue? TaxAmount { get; set; } + + /// + /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location + /// + /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location + /// + /// 6 + /// + [JsonPropertyName("zone")] [JsonRequired] - public List ErrorMessages { get; set; } + public int Zone { get; set; } /// @@ -240,30 +240,30 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class RateEstimate {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" RateType: ").Append(RateType).Append("\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" CarrierFriendlyName: ").Append(CarrierFriendlyName).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); - sb.Append(" ShippingAmount: ").Append(ShippingAmount).Append("\n"); - sb.Append(" InsuranceAmount: ").Append(InsuranceAmount).Append("\n"); + sb.Append(" CarrierNickname: ").Append(CarrierNickname).Append("\n"); sb.Append(" ConfirmationAmount: ").Append(ConfirmationAmount).Append("\n"); - sb.Append(" OtherAmount: ").Append(OtherAmount).Append("\n"); - sb.Append(" TaxAmount: ").Append(TaxAmount).Append("\n"); - sb.Append(" Zone: ").Append(Zone).Append("\n"); - sb.Append(" PackageType: ").Append(PackageType).Append("\n"); - sb.Append(" DeliveryDays: ").Append(DeliveryDays).Append("\n"); + sb.Append(" ErrorMessages: ").Append(ErrorMessages).Append("\n"); sb.Append(" GuaranteedService: ").Append(GuaranteedService).Append("\n"); - sb.Append(" EstimatedDeliveryDate: ").Append(EstimatedDeliveryDate).Append("\n"); - sb.Append(" CarrierDeliveryDays: ").Append(CarrierDeliveryDays).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" InsuranceAmount: ").Append(InsuranceAmount).Append("\n"); sb.Append(" NegotiatedRate: ").Append(NegotiatedRate).Append("\n"); - sb.Append(" ServiceType: ").Append(ServiceType).Append("\n"); + sb.Append(" OtherAmount: ").Append(OtherAmount).Append("\n"); + sb.Append(" RateType: ").Append(RateType).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" ServiceType: ").Append(ServiceType).Append("\n"); + sb.Append(" ShippingAmount: ").Append(ShippingAmount).Append("\n"); sb.Append(" Trackable: ").Append(Trackable).Append("\n"); - sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); - sb.Append(" CarrierNickname: ").Append(CarrierNickname).Append("\n"); - sb.Append(" CarrierFriendlyName: ").Append(CarrierFriendlyName).Append("\n"); sb.Append(" ValidationStatus: ").Append(ValidationStatus).Append("\n"); sb.Append(" WarningMessages: ").Append(WarningMessages).Append("\n"); - sb.Append(" ErrorMessages: ").Append(ErrorMessages).Append("\n"); + sb.Append(" CarrierDeliveryDays: ").Append(CarrierDeliveryDays).Append("\n"); + sb.Append(" DeliveryDays: ").Append(DeliveryDays).Append("\n"); + sb.Append(" EstimatedDeliveryDate: ").Append(EstimatedDeliveryDate).Append("\n"); + sb.Append(" PackageType: ").Append(PackageType).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" TaxAmount: ").Append(TaxAmount).Append("\n"); + sb.Append(" Zone: ").Append(Zone).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/RateEstimateByCarrierId.cs b/ShipEngineSDK/Model/RateEstimateByCarrierId.cs index cb820e88..6977b538 100644 --- a/ShipEngineSDK/Model/RateEstimateByCarrierId.cs +++ b/ShipEngineSDK/Model/RateEstimateByCarrierId.cs @@ -37,7 +37,7 @@ public partial class RateEstimateByCarrierId /// [JsonPropertyName("carrier_id")] [Obsolete] - public string CarrierId { get; set; } + public string? CarrierId { get; set; } /// diff --git a/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs b/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs index f73d46d3..44fe6725 100644 --- a/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs +++ b/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs @@ -33,7 +33,7 @@ public partial class RateEstimateByCarrierIds /// /// Array of Carrier Ids [JsonPropertyName("carrier_ids")] - public List CarrierIds { get; set; } + public List? CarrierIds { get; set; } /// diff --git a/ShipEngineSDK/Model/RateEstimateOptions.cs b/ShipEngineSDK/Model/RateEstimateOptions.cs index 0749d17d..23bc056d 100644 --- a/ShipEngineSDK/Model/RateEstimateOptions.cs +++ b/ShipEngineSDK/Model/RateEstimateOptions.cs @@ -28,16 +28,33 @@ namespace ShipEngineSDK.Model; public partial class RateEstimateOptions { + /// + /// Gets or Sets AddressResidentialIndicator CLOVUS + /// + [JsonPropertyName("address_residential_indicator")] + public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } /// /// Gets or Sets Confirmation CLOVUS /// [JsonPropertyName("confirmation")] public DeliveryConfirmation? Confirmation { get; set; } /// - /// Gets or Sets AddressResidentialIndicator CLOVUS + /// The dimensions of the package /// - [JsonPropertyName("address_residential_indicator")] - public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } + /// The dimensions of the package + [JsonPropertyName("dimensions")] + public Dimensions? Dimensions { get; set; } + + /// + /// from postal code + /// + /// from postal code + /// + /// Austin + /// + [JsonPropertyName("from_city_locality")] + public string? FromCityLocality { get; set; } + /// /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) /// @@ -46,7 +63,7 @@ public partial class RateEstimateOptions /// CA /// [JsonPropertyName("from_country_code")] - public string FromCountryCode { get; set; } + public string? FromCountryCode { get; set; } /// /// postal code @@ -56,27 +73,37 @@ public partial class RateEstimateOptions /// 78756-3717 /// [JsonPropertyName("from_postal_code")] - public string FromPostalCode { get; set; } + public string? FromPostalCode { get; set; } /// - /// from postal code + /// From state province /// - /// from postal code + /// From state province /// /// Austin /// - [JsonPropertyName("from_city_locality")] - public string FromCityLocality { get; set; } + [JsonPropertyName("from_state_province")] + public string? FromStateProvince { get; set; } /// - /// From state province + /// ship date /// - /// From state province + /// ship date + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("ship_date")] + public DateTimeOffset? ShipDate { get; set; } + + /// + /// The city locality the package is being shipped to + /// + /// The city locality the package is being shipped to /// /// Austin /// - [JsonPropertyName("from_state_province")] - public string FromStateProvince { get; set; } + [JsonPropertyName("to_city_locality")] + public string? ToCityLocality { get; set; } /// /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) @@ -86,7 +113,7 @@ public partial class RateEstimateOptions /// CA /// [JsonPropertyName("to_country_code")] - public string ToCountryCode { get; set; } + public string? ToCountryCode { get; set; } /// /// postal code @@ -96,17 +123,7 @@ public partial class RateEstimateOptions /// 78756-3717 /// [JsonPropertyName("to_postal_code")] - public string ToPostalCode { get; set; } - - /// - /// The city locality the package is being shipped to - /// - /// The city locality the package is being shipped to - /// - /// Austin - /// - [JsonPropertyName("to_city_locality")] - public string ToCityLocality { get; set; } + public string? ToPostalCode { get; set; } /// /// To state province @@ -116,31 +133,14 @@ public partial class RateEstimateOptions /// Houston /// [JsonPropertyName("to_state_province")] - public string ToStateProvince { get; set; } + public string? ToStateProvince { get; set; } /// /// The weight of the package /// /// The weight of the package [JsonPropertyName("weight")] - public Weight Weight { get; set; } - - /// - /// The dimensions of the package - /// - /// The dimensions of the package - [JsonPropertyName("dimensions")] - public Dimensions Dimensions { get; set; } - - /// - /// ship date - /// - /// ship date - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + public Weight? Weight { get; set; } /// @@ -152,19 +152,19 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class RateEstimateOptions {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); + sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); + sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); + sb.Append(" FromCityLocality: ").Append(FromCityLocality).Append("\n"); sb.Append(" FromCountryCode: ").Append(FromCountryCode).Append("\n"); sb.Append(" FromPostalCode: ").Append(FromPostalCode).Append("\n"); - sb.Append(" FromCityLocality: ").Append(FromCityLocality).Append("\n"); sb.Append(" FromStateProvince: ").Append(FromStateProvince).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" ToCityLocality: ").Append(ToCityLocality).Append("\n"); sb.Append(" ToCountryCode: ").Append(ToCountryCode).Append("\n"); sb.Append(" ToPostalCode: ").Append(ToPostalCode).Append("\n"); - sb.Append(" ToCityLocality: ").Append(ToCityLocality).Append("\n"); sb.Append(" ToStateProvince: ").Append(ToStateProvince).Append("\n"); sb.Append(" Weight: ").Append(Weight).Append("\n"); - sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); - sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); - sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/RateRequestBody.cs b/ShipEngineSDK/Model/RateRequestBody.cs index 5cbd9e7a..81b9b7eb 100644 --- a/ShipEngineSDK/Model/RateRequestBody.cs +++ b/ShipEngineSDK/Model/RateRequestBody.cs @@ -37,37 +37,37 @@ public partial class RateRequestBody public List CarrierIds { get; set; } /// - /// Gets or Sets PackageTypes + /// Calculate the duties and tariffs for cross border shipments. /// - [JsonPropertyName("package_types")] - public List PackageTypes { get; set; } + /// Calculate the duties and tariffs for cross border shipments. + [JsonPropertyName("calculate_tax_amount")] + public bool? CalculateTaxAmount { get; set; } /// - /// Gets or Sets ServiceCodes + /// Indicate if it's a return shipment /// - [JsonPropertyName("service_codes")] - public List ServiceCodes { get; set; } + /// Indicate if it's a return shipment + [JsonPropertyName("is_return")] + public bool? IsReturn { get; set; } /// - /// Calculate the duties and tariffs for cross border shipments. + /// Gets or Sets PackageTypes /// - /// Calculate the duties and tariffs for cross border shipments. - [JsonPropertyName("calculate_tax_amount")] - public bool CalculateTaxAmount { get; set; } + [JsonPropertyName("package_types")] + public List? PackageTypes { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html [JsonPropertyName("preferred_currency")] - public string PreferredCurrency { get; set; } + public string? PreferredCurrency { get; set; } /// - /// Indicate if it's a return shipment + /// Gets or Sets ServiceCodes /// - /// Indicate if it's a return shipment - [JsonPropertyName("is_return")] - public bool IsReturn { get; set; } + [JsonPropertyName("service_codes")] + public List? ServiceCodes { get; set; } /// @@ -80,11 +80,11 @@ public override string ToString() sb.Append("class RateRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierIds: ").Append(CarrierIds).Append("\n"); - sb.Append(" PackageTypes: ").Append(PackageTypes).Append("\n"); - sb.Append(" ServiceCodes: ").Append(ServiceCodes).Append("\n"); sb.Append(" CalculateTaxAmount: ").Append(CalculateTaxAmount).Append("\n"); - sb.Append(" PreferredCurrency: ").Append(PreferredCurrency).Append("\n"); sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); + sb.Append(" PackageTypes: ").Append(PackageTypes).Append("\n"); + sb.Append(" PreferredCurrency: ").Append(PreferredCurrency).Append("\n"); + sb.Append(" ServiceCodes: ").Append(ServiceCodes).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/RateRequestOptions.cs b/ShipEngineSDK/Model/RateRequestOptions.cs index 4582220b..f1854580 100644 --- a/ShipEngineSDK/Model/RateRequestOptions.cs +++ b/ShipEngineSDK/Model/RateRequestOptions.cs @@ -33,7 +33,7 @@ public partial class RateRequestOptions /// /// The rate options [JsonPropertyName("rate_options")] - public RateRequestBody RateOptions { get; set; } + public RateRequestBody? RateOptions { get; set; } /// diff --git a/ShipEngineSDK/Model/RateRequestRateOptions.cs b/ShipEngineSDK/Model/RateRequestRateOptions.cs index cba828e0..e08b7ada 100644 --- a/ShipEngineSDK/Model/RateRequestRateOptions.cs +++ b/ShipEngineSDK/Model/RateRequestRateOptions.cs @@ -33,7 +33,7 @@ public partial class RateRequestRateOptions /// /// The rate options [JsonPropertyName("rate_options")] - public RateRequestBody RateOptions { get; set; } + public RateRequestBody? RateOptions { get; set; } /// diff --git a/ShipEngineSDK/Model/RateResponse.cs b/ShipEngineSDK/Model/RateResponse.cs index 103913a0..d2924353 100644 --- a/ShipEngineSDK/Model/RateResponse.cs +++ b/ShipEngineSDK/Model/RateResponse.cs @@ -33,7 +33,7 @@ public partial class RateResponse /// /// The rates response [JsonPropertyName("rate_response")] - public RatesInformation VarRateResponse { get; set; } + public RatesInformation? VarRateResponse { get; set; } /// diff --git a/ShipEngineSDK/Model/RatesInformation.cs b/ShipEngineSDK/Model/RatesInformation.cs index 821345f2..e7542ba7 100644 --- a/ShipEngineSDK/Model/RatesInformation.cs +++ b/ShipEngineSDK/Model/RatesInformation.cs @@ -34,18 +34,27 @@ public partial class RatesInformation [JsonPropertyName("status")] public RateResponseStatus? Status { get; set; } /// - /// An array of shipment rates + /// When the rate was created /// - /// An array of shipment rates - [JsonPropertyName("rates")] - public List Rates { get; set; } + /// When the rate was created + /// + /// se-28529731 + /// + [JsonPropertyName("created_at")] + public string? CreatedAt { get; set; } + + /// + /// Gets or Sets Errors + /// + [JsonPropertyName("errors")] + public List? Errors { get; set; } /// /// An array of invalid shipment rates /// /// An array of invalid shipment rates [JsonPropertyName("invalid_rates")] - public List InvalidRates { get; set; } + public List? InvalidRates { get; set; } /// /// A string that uniquely identifies the rate request @@ -55,33 +64,24 @@ public partial class RatesInformation /// se-28529731 /// [JsonPropertyName("rate_request_id")] - public string RateRequestId { get; set; } + public string? RateRequestId { get; set; } /// - /// A string that uniquely identifies the shipment + /// An array of shipment rates /// - /// A string that uniquely identifies the shipment - /// - /// se-28529731 - /// - [JsonPropertyName("shipment_id")] - public string ShipmentId { get; set; } + /// An array of shipment rates + [JsonPropertyName("rates")] + public List? Rates { get; set; } /// - /// When the rate was created + /// A string that uniquely identifies the shipment /// - /// When the rate was created + /// A string that uniquely identifies the shipment /// /// se-28529731 /// - [JsonPropertyName("created_at")] - public string CreatedAt { get; set; } - - /// - /// Gets or Sets Errors - /// - [JsonPropertyName("errors")] - public List Errors { get; set; } + [JsonPropertyName("shipment_id")] + public string? ShipmentId { get; set; } /// @@ -93,13 +93,13 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class RatesInformation {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Rates: ").Append(Rates).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); sb.Append(" InvalidRates: ").Append(InvalidRates).Append("\n"); sb.Append(" RateRequestId: ").Append(RateRequestId).Append("\n"); + sb.Append(" Rates: ").Append(Rates).Append("\n"); sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" Status: ").Append(Status).Append("\n"); - sb.Append(" Errors: ").Append(Errors).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/RecognizedEntity.cs b/ShipEngineSDK/Model/RecognizedEntity.cs index 7f218ac1..ed8e61a2 100644 --- a/ShipEngineSDK/Model/RecognizedEntity.cs +++ b/ShipEngineSDK/Model/RecognizedEntity.cs @@ -29,12 +29,12 @@ public partial class RecognizedEntity { /// - /// The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.) + /// The index of the last character of this entity within the original text /// - /// The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.) - [JsonPropertyName("type")] + /// The index of the last character of this entity within the original text + [JsonPropertyName("end_index")] [JsonRequired] - public string Type { get; set; } + public int EndIndex { get; set; } /// /// A confidence score between zero and one that indicates how certain the API is that it correctly recognized this entity @@ -44,14 +44,6 @@ public partial class RecognizedEntity [JsonRequired] public double Score { get; set; } - /// - /// The substring from the original text that was recognized as this entity - /// - /// The substring from the original text that was recognized as this entity - [JsonPropertyName("text")] - [JsonRequired] - public string Text { get; set; } - /// /// The index of the first character of this entity within the original text /// @@ -61,19 +53,27 @@ public partial class RecognizedEntity public int StartIndex { get; set; } /// - /// The index of the last character of this entity within the original text + /// The substring from the original text that was recognized as this entity /// - /// The index of the last character of this entity within the original text - [JsonPropertyName("end_index")] + /// The substring from the original text that was recognized as this entity + [JsonPropertyName("text")] [JsonRequired] - public int EndIndex { get; set; } + public string Text { get; set; } + + /// + /// The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.) + /// + /// The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.) + [JsonPropertyName("type")] + [JsonRequired] + public string Type { get; set; } /// /// The normalized value of the entity. Most entity results have a `value` field, which is the normalized value of the entity. For example, if the substring \"john doe\" was recognized as a \"person\" entity, then the value might be normalized to have proper capitalization (e.g. \"John Doe\"). Or if the substring \"ft worth\" was recognized as a \"city\" entity, then the value might be normalized to \"Fort Worth\". Some entities have other information in addition to, or instead of a `value`. For example, a \"dimensions\" entity will have separate fields for `length`, `width`, `height`, and `unit`. /// /// The normalized value of the entity. Most entity results have a `value` field, which is the normalized value of the entity. For example, if the substring \"john doe\" was recognized as a \"person\" entity, then the value might be normalized to have proper capitalization (e.g. \"John Doe\"). Or if the substring \"ft worth\" was recognized as a \"city\" entity, then the value might be normalized to \"Fort Worth\". Some entities have other information in addition to, or instead of a `value`. For example, a \"dimensions\" entity will have separate fields for `length`, `width`, `height`, and `unit`. [JsonPropertyName("result")] - public Dictionary Result { get; set; } + public Dictionary? Result { get; set; } /// @@ -85,11 +85,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class RecognizedEntity {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Type: ").Append(Type).Append("\n"); + sb.Append(" EndIndex: ").Append(EndIndex).Append("\n"); sb.Append(" Score: ").Append(Score).Append("\n"); - sb.Append(" Text: ").Append(Text).Append("\n"); sb.Append(" StartIndex: ").Append(StartIndex).Append("\n"); - sb.Append(" EndIndex: ").Append(EndIndex).Append("\n"); + sb.Append(" Text: ").Append(Text).Append("\n"); + sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" Result: ").Append(Result).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs b/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs index 2eed5458..ca39a749 100644 --- a/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs +++ b/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs @@ -28,19 +28,19 @@ namespace ShipEngineSDK.Model; public partial class RemoveFromBatchRequestBody { - /// - /// The Shipment Ids to be modified on the batch - /// - /// The Shipment Ids to be modified on the batch - [JsonPropertyName("shipment_ids")] - public List ShipmentIds { get; set; } - /// /// Array of Rate IDs to be modifed on the batch /// /// Array of Rate IDs to be modifed on the batch [JsonPropertyName("rate_ids")] - public List RateIds { get; set; } + public List? RateIds { get; set; } + + /// + /// The Shipment Ids to be modified on the batch + /// + /// The Shipment Ids to be modified on the batch + [JsonPropertyName("shipment_ids")] + public List? ShipmentIds { get; set; } /// @@ -52,8 +52,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class RemoveFromBatchRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); sb.Append(" RateIds: ").Append(RateIds).Append("\n"); + sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/SchedulePickupRequestBody.cs b/ShipEngineSDK/Model/SchedulePickupRequestBody.cs index 236ddd0b..08464269 100644 --- a/ShipEngineSDK/Model/SchedulePickupRequestBody.cs +++ b/ShipEngineSDK/Model/SchedulePickupRequestBody.cs @@ -29,14 +29,11 @@ public partial class SchedulePickupRequestBody { /// - /// Pickup Resource ID + /// Gets or Sets ContactDetails /// - /// Pickup Resource ID - /// - /// pik_3YcKU5zdtJuCqoeNwyqqbW - /// - [JsonPropertyName("pickup_id")] - public string PickupId { get; set; } + [JsonPropertyName("contact_details")] + [JsonRequired] + public ContactDetails ContactDetails { get; set; } /// /// Label IDs that will be included in the pickup request @@ -47,14 +44,11 @@ public partial class SchedulePickupRequestBody public List LabelIds { get; set; } /// - /// The date and time that the pickup was created in ShipEngine. + /// Gets or Sets PickupWindow /// - /// The date and time that the pickup was created in ShipEngine. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("pickup_window")] + [JsonRequired] + public PickupWindow PickupWindow { get; set; } /// /// The date and time that the pickup was cancelled in ShipEngine. @@ -64,7 +58,7 @@ public partial class SchedulePickupRequestBody /// 2018-09-23T15:00Z /// [JsonPropertyName("cancelled_at")] - public DateTimeOffset CancelledAt { get; set; } + public DateTimeOffset? CancelledAt { get; set; } /// /// The carrier_id associated with the pickup @@ -74,7 +68,7 @@ public partial class SchedulePickupRequestBody /// se-28529731 /// [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + public string? CarrierId { get; set; } /// /// The carrier confirmation number for the scheduled pickup. @@ -84,51 +78,57 @@ public partial class SchedulePickupRequestBody /// 292513CL4A3 /// [JsonPropertyName("confirmation_number")] - public string ConfirmationNumber { get; set; } + public string? ConfirmationNumber { get; set; } /// - /// The warehouse_id associated with the pickup + /// The date and time that the pickup was created in ShipEngine. /// - /// The warehouse_id associated with the pickup + /// The date and time that the pickup was created in ShipEngine. /// - /// se-28529731 + /// 2018-09-23T15:00Z /// - [JsonPropertyName("warehouse_id")] - public string WarehouseId { get; set; } + [JsonPropertyName("created_at")] + public DateTimeOffset? CreatedAt { get; set; } /// /// Gets or Sets PickupAddress /// [JsonPropertyName("pickup_address")] - public Address PickupAddress { get; set; } + public Address? PickupAddress { get; set; } /// - /// Gets or Sets ContactDetails + /// Pickup Resource ID /// - [JsonPropertyName("contact_details")] - [JsonRequired] - public ContactDetails ContactDetails { get; set; } + /// Pickup Resource ID + /// + /// pik_3YcKU5zdtJuCqoeNwyqqbW + /// + [JsonPropertyName("pickup_id")] + public string? PickupId { get; set; } /// /// Used by some carriers to give special instructions for a package pickup /// /// Used by some carriers to give special instructions for a package pickup [JsonPropertyName("pickup_notes")] - public string PickupNotes { get; set; } - - /// - /// Gets or Sets PickupWindow - /// - [JsonPropertyName("pickup_window")] - [JsonRequired] - public PickupWindow PickupWindow { get; set; } + public string? PickupNotes { get; set; } /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. [JsonPropertyName("pickup_windows")] - public List PickupWindows { get; set; } + public List? PickupWindows { get; set; } + + /// + /// The warehouse_id associated with the pickup + /// + /// The warehouse_id associated with the pickup + /// + /// se-28529731 + /// + [JsonPropertyName("warehouse_id")] + public string? WarehouseId { get; set; } /// @@ -140,18 +140,18 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class SchedulePickupRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" PickupId: ").Append(PickupId).Append("\n"); + sb.Append(" ContactDetails: ").Append(ContactDetails).Append("\n"); sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" PickupWindow: ").Append(PickupWindow).Append("\n"); sb.Append(" CancelledAt: ").Append(CancelledAt).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ConfirmationNumber: ").Append(ConfirmationNumber).Append("\n"); - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" PickupAddress: ").Append(PickupAddress).Append("\n"); - sb.Append(" ContactDetails: ").Append(ContactDetails).Append("\n"); + sb.Append(" PickupId: ").Append(PickupId).Append("\n"); sb.Append(" PickupNotes: ").Append(PickupNotes).Append("\n"); - sb.Append(" PickupWindow: ").Append(PickupWindow).Append("\n"); sb.Append(" PickupWindows: ").Append(PickupWindows).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/SchedulePickupResponseBody.cs b/ShipEngineSDK/Model/SchedulePickupResponseBody.cs index 37943f52..943b5336 100644 --- a/ShipEngineSDK/Model/SchedulePickupResponseBody.cs +++ b/ShipEngineSDK/Model/SchedulePickupResponseBody.cs @@ -29,31 +29,23 @@ public partial class SchedulePickupResponseBody { /// - /// Pickup Resource ID - /// - /// Pickup Resource ID - /// - /// pik_3YcKU5zdtJuCqoeNwyqqbW - /// - [JsonPropertyName("pickup_id")] - public string PickupId { get; set; } - - /// - /// Label IDs that will be included in the pickup request + /// The errors associated with the failed API call /// - /// Label IDs that will be included in the pickup request - [JsonPropertyName("label_ids")] - public List LabelIds { get; set; } + /// The errors associated with the failed API call + [JsonPropertyName("errors")] + [JsonRequired] + public List Errors { get; set; } /// - /// The date and time that the pickup was created in ShipEngine. + /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur /// - /// The date and time that the pickup was created in ShipEngine. + /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur /// - /// 2018-09-23T15:00Z + /// aa3d8e8e-462b-4476-9618-72db7f7b7009 /// - [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("request_id")] + [JsonRequired] + public Guid RequestId { get; set; } /// /// The date and time that the pickup was cancelled in ShipEngine. @@ -63,7 +55,7 @@ public partial class SchedulePickupResponseBody /// 2018-09-23T15:00Z /// [JsonPropertyName("cancelled_at")] - public DateTimeOffset CancelledAt { get; set; } + public DateTimeOffset? CancelledAt { get; set; } /// /// The carrier_id associated with the pickup @@ -73,7 +65,7 @@ public partial class SchedulePickupResponseBody /// se-28529731 /// [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + public string? CarrierId { get; set; } /// /// The carrier confirmation number for the scheduled pickup. @@ -83,68 +75,76 @@ public partial class SchedulePickupResponseBody /// 292513CL4A3 /// [JsonPropertyName("confirmation_number")] - public string ConfirmationNumber { get; set; } + public string? ConfirmationNumber { get; set; } /// - /// The warehouse_id associated with the pickup + /// Gets or Sets ContactDetails /// - /// The warehouse_id associated with the pickup + [JsonPropertyName("contact_details")] + public ContactDetails? ContactDetails { get; set; } + + /// + /// The date and time that the pickup was created in ShipEngine. + /// + /// The date and time that the pickup was created in ShipEngine. /// - /// se-28529731 + /// 2018-09-23T15:00Z /// - [JsonPropertyName("warehouse_id")] - public string WarehouseId { get; set; } + [JsonPropertyName("created_at")] + public DateTimeOffset? CreatedAt { get; set; } + + /// + /// Label IDs that will be included in the pickup request + /// + /// Label IDs that will be included in the pickup request + [JsonPropertyName("label_ids")] + public List? LabelIds { get; set; } /// /// Gets or Sets PickupAddress /// [JsonPropertyName("pickup_address")] - public Address PickupAddress { get; set; } + public Address? PickupAddress { get; set; } /// - /// Gets or Sets ContactDetails + /// Pickup Resource ID /// - [JsonPropertyName("contact_details")] - public ContactDetails ContactDetails { get; set; } + /// Pickup Resource ID + /// + /// pik_3YcKU5zdtJuCqoeNwyqqbW + /// + [JsonPropertyName("pickup_id")] + public string? PickupId { get; set; } /// /// Used by some carriers to give special instructions for a package pickup /// /// Used by some carriers to give special instructions for a package pickup [JsonPropertyName("pickup_notes")] - public string PickupNotes { get; set; } + public string? PickupNotes { get; set; } /// /// Gets or Sets PickupWindow /// [JsonPropertyName("pickup_window")] - public PickupWindow PickupWindow { get; set; } + public PickupWindow? PickupWindow { get; set; } /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. [JsonPropertyName("pickup_windows")] - public List PickupWindows { get; set; } + public List? PickupWindows { get; set; } /// - /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur + /// The warehouse_id associated with the pickup /// - /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur + /// The warehouse_id associated with the pickup /// - /// aa3d8e8e-462b-4476-9618-72db7f7b7009 + /// se-28529731 /// - [JsonPropertyName("request_id")] - [JsonRequired] - public Guid RequestId { get; set; } - - /// - /// The errors associated with the failed API call - /// - /// The errors associated with the failed API call - [JsonPropertyName("errors")] - [JsonRequired] - public List Errors { get; set; } + [JsonPropertyName("warehouse_id")] + public string? WarehouseId { get; set; } /// @@ -156,20 +156,20 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class SchedulePickupResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" PickupId: ").Append(PickupId).Append("\n"); - sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); + sb.Append(" RequestId: ").Append(RequestId).Append("\n"); sb.Append(" CancelledAt: ").Append(CancelledAt).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ConfirmationNumber: ").Append(ConfirmationNumber).Append("\n"); - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); - sb.Append(" PickupAddress: ").Append(PickupAddress).Append("\n"); sb.Append(" ContactDetails: ").Append(ContactDetails).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); + sb.Append(" PickupAddress: ").Append(PickupAddress).Append("\n"); + sb.Append(" PickupId: ").Append(PickupId).Append("\n"); sb.Append(" PickupNotes: ").Append(PickupNotes).Append("\n"); sb.Append(" PickupWindow: ").Append(PickupWindow).Append("\n"); sb.Append(" PickupWindows: ").Append(PickupWindows).Append("\n"); - sb.Append(" RequestId: ").Append(RequestId).Append("\n"); - sb.Append(" Errors: ").Append(Errors).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/Service.cs b/ShipEngineSDK/Model/Service.cs index 533995e7..c42b3afc 100644 --- a/ShipEngineSDK/Model/Service.cs +++ b/ShipEngineSDK/Model/Service.cs @@ -28,16 +28,6 @@ namespace ShipEngineSDK.Model; public partial class Service { - /// - /// A string that uniquely identifies the carrier - /// - /// A string that uniquely identifies the carrier - /// - /// se-28529731 - /// - [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } - /// /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. /// @@ -46,48 +36,58 @@ public partial class Service /// se-28529731 /// [JsonPropertyName("carrier_code")] - public string CarrierCode { get; set; } + public string? CarrierCode { get; set; } /// - /// service code - /// - /// service code - /// - /// usps_media_mail - /// - [JsonPropertyName("service_code")] - public string ServiceCode { get; set; } - - /// - /// User friendly service name + /// A string that uniquely identifies the carrier /// - /// User friendly service name + /// A string that uniquely identifies the carrier /// - /// USPS First Class Mail + /// se-28529731 /// - [JsonPropertyName("name")] - public string Name { get; set; } + [JsonPropertyName("carrier_id")] + public string? CarrierId { get; set; } /// /// Supports domestic shipping /// /// Supports domestic shipping [JsonPropertyName("domestic")] - public bool Domestic { get; set; } + public bool? Domestic { get; set; } /// /// Supports international shipping. /// /// Supports international shipping. [JsonPropertyName("international")] - public bool International { get; set; } + public bool? International { get; set; } /// /// Carrier supports multiple packages per shipment /// /// Carrier supports multiple packages per shipment [JsonPropertyName("is_multi_package_supported")] - public bool IsMultiPackageSupported { get; set; } + public bool? IsMultiPackageSupported { get; set; } + + /// + /// User friendly service name + /// + /// User friendly service name + /// + /// USPS First Class Mail + /// + [JsonPropertyName("name")] + public string? Name { get; set; } + + /// + /// service code + /// + /// service code + /// + /// usps_media_mail + /// + [JsonPropertyName("service_code")] + public string? ServiceCode { get; set; } /// @@ -99,13 +99,13 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class Service {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); - sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); - sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" Domestic: ").Append(Domestic).Append("\n"); sb.Append(" International: ").Append(International).Append("\n"); sb.Append(" IsMultiPackageSupported: ").Append(IsMultiPackageSupported).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/Shipment.cs b/ShipEngineSDK/Model/Shipment.cs index a2fe7e0f..b528fb95 100644 --- a/ShipEngineSDK/Model/Shipment.cs +++ b/ShipEngineSDK/Model/Shipment.cs @@ -28,15 +28,6 @@ namespace ShipEngineSDK.Model; public partial class Shipment { - /// - /// The current status of the shipment CLOVUS - /// - /// The current status of the shipment - [JsonPropertyName("shipment_status")] - [JsonRequired] - public ShipmentStatus ShipmentStatus { get; set; } = new(); - - /// /// The type of delivery confirmation that is required for this shipment. CLOVUS /// @@ -55,21 +46,27 @@ public partial class Shipment public InsuranceProvider InsuranceProvider { get; set; } = new(); + /// + /// The current status of the shipment CLOVUS + /// + /// The current status of the shipment + [JsonPropertyName("shipment_status")] + [JsonRequired] + public ShipmentStatus ShipmentStatus { get; set; } = new(); + + /// /// Gets or Sets OrderSourceCode CLOVUS /// [JsonPropertyName("order_source_code")] public OrderSourceName? OrderSourceCode { get; set; } /// - /// A string that uniquely identifies the shipment + /// Advanced shipment options. These are entirely optional. /// - /// A string that uniquely identifies the shipment - /// - /// se-28529731 - /// - [JsonPropertyName("shipment_id")] + /// Advanced shipment options. These are entirely optional. + [JsonPropertyName("advanced_options")] [JsonRequired] - public string ShipmentId { get; set; } + public AdvancedShipmentOptions AdvancedOptions { get; set; } /// /// The carrier account that is billed for the shipping charges @@ -83,59 +80,53 @@ public partial class Shipment public string CarrierId { get; set; } /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// The date and time that the shipment was created in ShipEngine. /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// The date and time that the shipment was created in ShipEngine. /// - /// usps_first_class_mail + /// 2018-09-23T15:00Z /// - [JsonPropertyName("service_code")] + [JsonPropertyName("created_at")] [JsonRequired] - public string ServiceCode { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// - /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// The date and time that the shipment was created or last modified. /// - /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// The date and time that the shipment was created or last modified. /// - /// se-28529731 + /// 2018-09-23T15:00Z /// - [JsonPropertyName("shipping_rule_id")] - public string ShippingRuleId { get; set; } - - /// - /// ID that the Order Source assigned - /// - /// ID that the Order Source assigned - [JsonPropertyName("external_order_id")] - public string ExternalOrderId { get; set; } - - /// - /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - /// - /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - [JsonPropertyName("items")] - public List Items { get; set; } + [JsonPropertyName("modified_at")] + [JsonRequired] + public DateTimeOffset ModifiedAt { get; set; } /// - /// Gets or Sets TaxIdentifiers + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// - [JsonPropertyName("tax_identifiers")] - public List TaxIdentifiers { get; set; } + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + [JsonPropertyName("packages")] + [JsonRequired] + public List Packages { get; set; } /// - /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. + /// The return address for this shipment. Defaults to the `ship_from` address. /// - /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("external_shipment_id")] - public string ExternalShipmentId { get; set; } + /// The return address for this shipment. Defaults to the `ship_from` address. + [JsonPropertyName("return_to")] + [JsonRequired] + public ShippingAddress ReturnTo { get; set; } /// - /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// - /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("shipment_number")] - public string ShipmentNumber { get; set; } + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// usps_first_class_mail + /// + [JsonPropertyName("service_code")] + [JsonRequired] + public string ServiceCode { get; set; } /// /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -149,26 +140,12 @@ public partial class Shipment public DateTimeOffset ShipDate { get; set; } /// - /// The date and time that the shipment was created in ShipEngine. - /// - /// The date and time that the shipment was created in ShipEngine. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("created_at")] - [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } - - /// - /// The date and time that the shipment was created or last modified. + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// - /// The date and time that the shipment was created or last modified. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("modified_at")] + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. + [JsonPropertyName("ship_from")] [JsonRequired] - public DateTimeOffset ModifiedAt { get; set; } + public ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address @@ -179,38 +156,41 @@ public partial class Shipment public ShippingAddressTo ShipTo { get; set; } /// - /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. + /// A string that uniquely identifies the shipment /// - /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from")] + /// A string that uniquely identifies the shipment + /// + /// se-28529731 + /// + [JsonPropertyName("shipment_id")] [JsonRequired] - public ShippingAddress ShipFrom { get; set; } + public string ShipmentId { get; set; } /// - /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// - /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. - /// - /// se-28529731 - /// - [JsonPropertyName("warehouse_id")] + /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. + [JsonPropertyName("tags")] [JsonRequired] - public string WarehouseId { get; set; } + public List Tags { get; set; } /// - /// The return address for this shipment. Defaults to the `ship_from` address. + /// The combined weight of all packages in the shipment /// - /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to")] + /// The combined weight of all packages in the shipment + [JsonPropertyName("total_weight")] [JsonRequired] - public ShippingAddress ReturnTo { get; set; } + public Weight TotalWeight { get; set; } /// - /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. /// - /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. - [JsonPropertyName("is_return")] - public bool? IsReturn { get; set; } + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// + /// retail + /// + [JsonPropertyName("comparison_rate_type")] + public string? ComparisonRateType { get; set; } /// /// Customs information. This is usually only needed for international shipments. @@ -221,46 +201,66 @@ public partial class Shipment public InternationalShipmentOptions Customs { get; set; } /// - /// Advanced shipment options. These are entirely optional. + /// ID that the Order Source assigned /// - /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options")] - [JsonRequired] - public AdvancedShipmentOptions AdvancedOptions { get; set; } + /// ID that the Order Source assigned + [JsonPropertyName("external_order_id")] + public string? ExternalOrderId { get; set; } /// - /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. + /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. /// - /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. - [JsonPropertyName("tags")] - [JsonRequired] - public List Tags { get; set; } + /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. + [JsonPropertyName("external_shipment_id")] + public string? ExternalShipmentId { get; set; } /// - /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// - /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - [JsonRequired] - public List Packages { get; set; } + /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. + [JsonPropertyName("is_return")] + public bool? IsReturn { get; set; } /// - /// The combined weight of all packages in the shipment + /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources /// - /// The combined weight of all packages in the shipment - [JsonPropertyName("total_weight")] - [JsonRequired] - public Weight TotalWeight { get; set; } + /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources + [JsonPropertyName("items")] + public List? Items { get; set; } /// - /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// - /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. + [JsonPropertyName("shipment_number")] + public string? ShipmentNumber { get; set; } + + /// + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment /// - /// retail + /// se-28529731 /// - [JsonPropertyName("comparison_rate_type")] - public string ComparisonRateType { get; set; } + [JsonPropertyName("shipping_rule_id")] + public string? ShippingRuleId { get; set; } + + /// + /// Gets or Sets TaxIdentifiers + /// + [JsonPropertyName("tax_identifiers")] + public List? TaxIdentifiers { get; set; } + + /// + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// + /// se-28529731 + /// + [JsonPropertyName("warehouse_id")] + [JsonRequired] + public string WarehouseId { get; set; } /// @@ -272,33 +272,33 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class Shipment {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); - sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); - sb.Append(" ShippingRuleId: ").Append(ShippingRuleId).Append("\n"); - sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); - sb.Append(" Items: ").Append(Items).Append("\n"); - sb.Append(" TaxIdentifiers: ").Append(TaxIdentifiers).Append("\n"); - sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); - sb.Append(" ShipmentNumber: ").Append(ShipmentNumber).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" InsuranceProvider: ").Append(InsuranceProvider).Append("\n"); sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); - sb.Append(" ShipmentStatus: ").Append(ShipmentStatus).Append("\n"); - sb.Append(" ShipTo: ").Append(ShipTo).Append("\n"); - sb.Append(" ShipFrom: ").Append(ShipFrom).Append("\n"); - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" ReturnTo: ").Append(ReturnTo).Append("\n"); - sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); - sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); - sb.Append(" Customs: ").Append(Customs).Append("\n"); - sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); - sb.Append(" InsuranceProvider: ").Append(InsuranceProvider).Append("\n"); + sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" ShipFrom: ").Append(ShipFrom).Append("\n"); + sb.Append(" ShipTo: ").Append(ShipTo).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" ShipmentStatus: ").Append(ShipmentStatus).Append("\n"); sb.Append(" Tags: ").Append(Tags).Append("\n"); - sb.Append(" OrderSourceCode: ").Append(OrderSourceCode).Append("\n"); - sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); + sb.Append(" Customs: ").Append(Customs).Append("\n"); + sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); + sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); + sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); + sb.Append(" Items: ").Append(Items).Append("\n"); + sb.Append(" OrderSourceCode: ").Append(OrderSourceCode).Append("\n"); + sb.Append(" ShipmentNumber: ").Append(ShipmentNumber).Append("\n"); + sb.Append(" ShippingRuleId: ").Append(ShippingRuleId).Append("\n"); + sb.Append(" TaxIdentifiers: ").Append(TaxIdentifiers).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ShipmentIdRequest.cs b/ShipEngineSDK/Model/ShipmentIdRequest.cs index d34c01b0..4da6ce01 100644 --- a/ShipEngineSDK/Model/ShipmentIdRequest.cs +++ b/ShipEngineSDK/Model/ShipmentIdRequest.cs @@ -36,7 +36,7 @@ public partial class ShipmentIdRequest /// se-28529731 /// [JsonPropertyName("shipment_id")] - public string ShipmentId { get; set; } + public string? ShipmentId { get; set; } /// diff --git a/ShipEngineSDK/Model/ShipmentItem.cs b/ShipEngineSDK/Model/ShipmentItem.cs index c7688820..720b8cfb 100644 --- a/ShipEngineSDK/Model/ShipmentItem.cs +++ b/ShipEngineSDK/Model/ShipmentItem.cs @@ -34,63 +34,63 @@ public partial class ShipmentItem [JsonPropertyName("order_source_code")] public OrderSourceName? OrderSourceCode { get; set; } /// - /// item name + /// Amazon Standard Identification Number /// - /// item name - [JsonPropertyName("name")] - public string Name { get; set; } + /// Amazon Standard Identification Number + /// + /// B00005N5PF + /// + [JsonPropertyName("asin")] + public string? Asin { get; set; } /// - /// sales order id + /// external order id /// - /// sales order id - [JsonPropertyName("sales_order_id")] - public string SalesOrderId { get; set; } + /// external order id + [JsonPropertyName("external_order_id")] + public string? ExternalOrderId { get; set; } /// - /// sales order item id + /// external order item id /// - /// sales order item id - [JsonPropertyName("sales_order_item_id")] - public string SalesOrderItemId { get; set; } + /// external order item id + [JsonPropertyName("external_order_item_id")] + public string? ExternalOrderItemId { get; set; } /// - /// The quantity of this item included in the shipment + /// item name /// - /// The quantity of this item included in the shipment - [JsonPropertyName("quantity")] - public int Quantity { get; set; } + /// item name + [JsonPropertyName("name")] + public string? Name { get; set; } /// - /// Item Stock Keeping Unit + /// The quantity of this item included in the shipment /// - /// Item Stock Keeping Unit - [JsonPropertyName("sku")] - public string Sku { get; set; } + /// The quantity of this item included in the shipment + [JsonPropertyName("quantity")] + public int? Quantity { get; set; } /// - /// external order id + /// sales order id /// - /// external order id - [JsonPropertyName("external_order_id")] - public string ExternalOrderId { get; set; } + /// sales order id + [JsonPropertyName("sales_order_id")] + public string? SalesOrderId { get; set; } /// - /// external order item id + /// sales order item id /// - /// external order item id - [JsonPropertyName("external_order_item_id")] - public string ExternalOrderItemId { get; set; } + /// sales order item id + [JsonPropertyName("sales_order_item_id")] + public string? SalesOrderItemId { get; set; } /// - /// Amazon Standard Identification Number + /// Item Stock Keeping Unit /// - /// Amazon Standard Identification Number - /// - /// B00005N5PF - /// - [JsonPropertyName("asin")] - public string Asin { get; set; } + /// Item Stock Keeping Unit + [JsonPropertyName("sku")] + public string? Sku { get; set; } /// @@ -102,15 +102,15 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ShipmentItem {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" Asin: ").Append(Asin).Append("\n"); + sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); + sb.Append(" ExternalOrderItemId: ").Append(ExternalOrderItemId).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" OrderSourceCode: ").Append(OrderSourceCode).Append("\n"); + sb.Append(" Quantity: ").Append(Quantity).Append("\n"); sb.Append(" SalesOrderId: ").Append(SalesOrderId).Append("\n"); sb.Append(" SalesOrderItemId: ").Append(SalesOrderItemId).Append("\n"); - sb.Append(" Quantity: ").Append(Quantity).Append("\n"); sb.Append(" Sku: ").Append(Sku).Append("\n"); - sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); - sb.Append(" ExternalOrderItemId: ").Append(ExternalOrderItemId).Append("\n"); - sb.Append(" Asin: ").Append(Asin).Append("\n"); - sb.Append(" OrderSourceCode: ").Append(OrderSourceCode).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ShipmentRequest.cs b/ShipEngineSDK/Model/ShipmentRequest.cs index dbae09c3..186d282c 100644 --- a/ShipEngineSDK/Model/ShipmentRequest.cs +++ b/ShipEngineSDK/Model/ShipmentRequest.cs @@ -33,7 +33,7 @@ public partial class ShipmentRequest /// /// The shipment object [JsonPropertyName("shipment")] - public AddressValidatingShipment Shipment { get; set; } + public AddressValidatingShipment? Shipment { get; set; } /// diff --git a/ShipEngineSDK/Model/ShippingAddress.cs b/ShipEngineSDK/Model/ShippingAddress.cs index 737c0473..353a7684 100644 --- a/ShipEngineSDK/Model/ShippingAddress.cs +++ b/ShipEngineSDK/Model/ShippingAddress.cs @@ -37,6 +37,39 @@ public partial class ShippingAddress public AddressResidentialIndicator AddressResidentialIndicator { get; set; } = new(); + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// 1999 Bishop Grandin Blvd. + /// + [JsonPropertyName("address_line1")] + [JsonRequired] + public string AddressLine1 { get; set; } + + /// + /// The name of the city or locality + /// + /// The name of the city or locality + /// + /// Winnipeg + /// + [JsonPropertyName("city_locality")] + [JsonRequired] + public string CityLocality { get; set; } + + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// CA + /// + [JsonPropertyName("country_code")] + [JsonRequired] + public string CountryCode { get; set; } + /// /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. /// @@ -60,35 +93,26 @@ public partial class ShippingAddress public string Phone { get; set; } /// - /// Email for the address owner. - /// - /// Email for the address owner. - /// - /// example@example.com - /// - [JsonPropertyName("email")] - public string Email { get; set; } - - /// - /// If this is a business address, then the company name should be specified here. + /// postal code /// - /// If this is a business address, then the company name should be specified here. + /// postal code /// - /// The Home Depot + /// 78756-3717 /// - [JsonPropertyName("company_name")] - public string CompanyName { get; set; } + [JsonPropertyName("postal_code")] + [JsonRequired] + public string PostalCode { get; set; } /// - /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. /// - /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. /// - /// 1999 Bishop Grandin Blvd. + /// Manitoba /// - [JsonPropertyName("address_line1")] + [JsonPropertyName("state_province")] [JsonRequired] - public string AddressLine1 { get; set; } + public string StateProvince { get; set; } /// /// The second line of the street address. For some addresses, this line may not be needed. @@ -98,7 +122,7 @@ public partial class ShippingAddress /// Unit 408 /// [JsonPropertyName("address_line2")] - public string AddressLine2 { get; set; } + public string? AddressLine2 { get; set; } /// /// The third line of the street address. For some addresses, this line may not be needed. @@ -108,58 +132,34 @@ public partial class ShippingAddress /// Building #7 /// [JsonPropertyName("address_line3")] - public string AddressLine3 { get; set; } - - /// - /// The name of the city or locality - /// - /// The name of the city or locality - /// - /// Winnipeg - /// - [JsonPropertyName("city_locality")] - [JsonRequired] - public string CityLocality { get; set; } - - /// - /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. - /// - /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. - /// - /// Manitoba - /// - [JsonPropertyName("state_province")] - [JsonRequired] - public string StateProvince { get; set; } + public string? AddressLine3 { get; set; } /// - /// postal code + /// If this is a business address, then the company name should be specified here. /// - /// postal code + /// If this is a business address, then the company name should be specified here. /// - /// 78756-3717 + /// The Home Depot /// - [JsonPropertyName("postal_code")] - [JsonRequired] - public string PostalCode { get; set; } + [JsonPropertyName("company_name")] + public string? CompanyName { get; set; } /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// Email for the address owner. /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// Email for the address owner. /// - /// CA + /// example@example.com /// - [JsonPropertyName("country_code")] - [JsonRequired] - public string CountryCode { get; set; } + [JsonPropertyName("email")] + public string? Email { get; set; } /// /// Additional text about how to handle the shipment at this address. /// /// Additional text about how to handle the shipment at this address. [JsonPropertyName("instructions")] - public string Instructions { get; set; } + public string? Instructions { get; set; } /// @@ -171,18 +171,18 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ShippingAddress {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); + sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); + sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" Phone: ").Append(Phone).Append("\n"); - sb.Append(" Email: ").Append(Email).Append("\n"); - sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); - sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); - sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); - sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); - sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); - sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); - sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); + sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); sb.Append(" Instructions: ").Append(Instructions).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/ShippingAddressTo.cs b/ShipEngineSDK/Model/ShippingAddressTo.cs index d490b9b1..0d312b49 100644 --- a/ShipEngineSDK/Model/ShippingAddressTo.cs +++ b/ShipEngineSDK/Model/ShippingAddressTo.cs @@ -37,6 +37,39 @@ public partial class ShippingAddressTo public AddressResidentialIndicator AddressResidentialIndicator { get; set; } = new(); + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// 1999 Bishop Grandin Blvd. + /// + [JsonPropertyName("address_line1")] + [JsonRequired] + public string AddressLine1 { get; set; } + + /// + /// The name of the city or locality + /// + /// The name of the city or locality + /// + /// Winnipeg + /// + [JsonPropertyName("city_locality")] + [JsonRequired] + public string CityLocality { get; set; } + + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// CA + /// + [JsonPropertyName("country_code")] + [JsonRequired] + public string CountryCode { get; set; } + /// /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. /// @@ -60,35 +93,26 @@ public partial class ShippingAddressTo public string Phone { get; set; } /// - /// Email for the address owner. - /// - /// Email for the address owner. - /// - /// example@example.com - /// - [JsonPropertyName("email")] - public string Email { get; set; } - - /// - /// If this is a business address, then the company name should be specified here. + /// postal code /// - /// If this is a business address, then the company name should be specified here. + /// postal code /// - /// The Home Depot + /// 78756-3717 /// - [JsonPropertyName("company_name")] - public string CompanyName { get; set; } + [JsonPropertyName("postal_code")] + [JsonRequired] + public string PostalCode { get; set; } /// - /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. /// - /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. /// - /// 1999 Bishop Grandin Blvd. + /// Manitoba /// - [JsonPropertyName("address_line1")] + [JsonPropertyName("state_province")] [JsonRequired] - public string AddressLine1 { get; set; } + public string StateProvince { get; set; } /// /// The second line of the street address. For some addresses, this line may not be needed. @@ -98,7 +122,7 @@ public partial class ShippingAddressTo /// Unit 408 /// [JsonPropertyName("address_line2")] - public string AddressLine2 { get; set; } + public string? AddressLine2 { get; set; } /// /// The third line of the street address. For some addresses, this line may not be needed. @@ -108,64 +132,40 @@ public partial class ShippingAddressTo /// Building #7 /// [JsonPropertyName("address_line3")] - public string AddressLine3 { get; set; } - - /// - /// The name of the city or locality - /// - /// The name of the city or locality - /// - /// Winnipeg - /// - [JsonPropertyName("city_locality")] - [JsonRequired] - public string CityLocality { get; set; } + public string? AddressLine3 { get; set; } /// - /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// If this is a business address, then the company name should be specified here. /// - /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// If this is a business address, then the company name should be specified here. /// - /// Manitoba + /// The Home Depot /// - [JsonPropertyName("state_province")] - [JsonRequired] - public string StateProvince { get; set; } + [JsonPropertyName("company_name")] + public string? CompanyName { get; set; } /// - /// postal code + /// Email for the address owner. /// - /// postal code + /// Email for the address owner. /// - /// 78756-3717 + /// example@example.com /// - [JsonPropertyName("postal_code")] - [JsonRequired] - public string PostalCode { get; set; } + [JsonPropertyName("email")] + public string? Email { get; set; } /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// Gets or Sets Geolocation /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) - /// - /// CA - /// - [JsonPropertyName("country_code")] - [JsonRequired] - public string CountryCode { get; set; } + [JsonPropertyName("geolocation")] + public List? Geolocation { get; set; } /// /// Additional text about how to handle the shipment at this address. /// /// Additional text about how to handle the shipment at this address. [JsonPropertyName("instructions")] - public string Instructions { get; set; } - - /// - /// Gets or Sets Geolocation - /// - [JsonPropertyName("geolocation")] - public List Geolocation { get; set; } + public string? Instructions { get; set; } /// @@ -177,20 +177,20 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ShippingAddressTo {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); + sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); + sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" Phone: ").Append(Phone).Append("\n"); - sb.Append(" Email: ").Append(Email).Append("\n"); - sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); - sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); - sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); - sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); - sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); - sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); - sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); - sb.Append(" Instructions: ").Append(Instructions).Append("\n"); + sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); sb.Append(" Geolocation: ").Append(Geolocation).Append("\n"); + sb.Append(" Instructions: ").Append(Instructions).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/TaxIdentifier.cs b/ShipEngineSDK/Model/TaxIdentifier.cs index 4938a5b8..91795e81 100644 --- a/ShipEngineSDK/Model/TaxIdentifier.cs +++ b/ShipEngineSDK/Model/TaxIdentifier.cs @@ -29,19 +29,19 @@ public partial class TaxIdentifier { /// - /// Gets or Sets TaxableEntityType CLOVUS + /// Gets or Sets IdentifierType CLOVUS /// - [JsonPropertyName("taxable_entity_type")] + [JsonPropertyName("identifier_type")] [JsonRequired] - public TaxableEntityType TaxableEntityType { get; set; } = new(); + public IdentifierType IdentifierType { get; set; } = new(); /// - /// Gets or Sets IdentifierType CLOVUS + /// Gets or Sets TaxableEntityType CLOVUS /// - [JsonPropertyName("identifier_type")] + [JsonPropertyName("taxable_entity_type")] [JsonRequired] - public IdentifierType IdentifierType { get; set; } = new(); + public TaxableEntityType TaxableEntityType { get; set; } = new(); /// @@ -70,9 +70,9 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class TaxIdentifier {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" TaxableEntityType: ").Append(TaxableEntityType).Append("\n"); sb.Append(" IdentifierType: ").Append(IdentifierType).Append("\n"); sb.Append(" IssuingAuthority: ").Append(IssuingAuthority).Append("\n"); + sb.Append(" TaxableEntityType: ").Append(TaxableEntityType).Append("\n"); sb.Append(" Value: ").Append(Value).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs b/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs index d1779535..6da37e3f 100644 --- a/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs +++ b/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs @@ -28,19 +28,19 @@ namespace ShipEngineSDK.Model; public partial class TokensGetEphemeralTokenResponseBodyYaml { - /// - /// The requested token that expires in 10 seconds. - /// - /// The requested token that expires in 10 seconds. - [JsonPropertyName("token")] - public string Token { get; set; } - /// /// The redirect url formatted with the requested token. /// /// The redirect url formatted with the requested token. [JsonPropertyName("redirect_url")] - public string RedirectUrl { get; set; } + public string? RedirectUrl { get; set; } + + /// + /// The requested token that expires in 10 seconds. + /// + /// The requested token that expires in 10 seconds. + [JsonPropertyName("token")] + public string? Token { get; set; } /// @@ -52,8 +52,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class TokensGetEphemeralTokenResponseBodyYaml {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Token: ").Append(Token).Append("\n"); sb.Append(" RedirectUrl: ").Append(RedirectUrl).Append("\n"); + sb.Append(" Token: ").Append(Token).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/TrackEvent.cs b/ShipEngineSDK/Model/TrackEvent.cs index 8a82c4a1..3bfb4f5d 100644 --- a/ShipEngineSDK/Model/TrackEvent.cs +++ b/ShipEngineSDK/Model/TrackEvent.cs @@ -37,35 +37,37 @@ public partial class TrackEvent /// - /// Timestamp for carrier event + /// Carrier detail code /// - /// Timestamp for carrier event + /// Carrier detail code /// - /// 2018-09-23T15:00Z + /// OT /// - [JsonPropertyName("occurred_at")] + [JsonPropertyName("carrier_detail_code")] [JsonRequired] - public DateTimeOffset OccurredAt { get; set; } + public string CarrierDetailCode { get; set; } /// - /// Carrier timestamp for the event, it is assumed to be the local time of where the event occurred. + /// Carrier status code /// - /// Carrier timestamp for the event, it is assumed to be the local time of where the event occurred. + /// Carrier status code /// - /// 2018-09-23T15:00Z + /// 1 /// - [JsonPropertyName("carrier_occurred_at")] - public DateTimeOffset CarrierOccurredAt { get; set; } + [JsonPropertyName("carrier_status_code")] + [JsonRequired] + public string CarrierStatusCode { get; set; } /// - /// Event description + /// carrier status description /// - /// Event description + /// carrier status description /// - /// Delivered, In/At Mailbox + /// Your item was delivered in or at the mailbox at 9:10 am on March /// - [JsonPropertyName("description")] - public string Description { get; set; } + [JsonPropertyName("carrier_status_description")] + [JsonRequired] + public string CarrierStatusDescription { get; set; } /// /// City locality @@ -79,15 +81,15 @@ public partial class TrackEvent public string CityLocality { get; set; } /// - /// State province + /// Timestamp for carrier event /// - /// State province + /// Timestamp for carrier event /// - /// TX + /// 2018-09-23T15:00Z /// - [JsonPropertyName("state_province")] + [JsonPropertyName("occurred_at")] [JsonRequired] - public string StateProvince { get; set; } + public DateTimeOffset OccurredAt { get; set; } /// /// Postal code @@ -101,96 +103,94 @@ public partial class TrackEvent public string PostalCode { get; set; } /// - /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// State province /// - /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// State province /// - /// CA + /// TX /// - [JsonPropertyName("country_code")] - public string CountryCode { get; set; } + [JsonPropertyName("state_province")] + [JsonRequired] + public string StateProvince { get; set; } /// - /// Company Name + /// Event Status Description /// - /// Company Name + /// Event Status Description /// - /// Stamps.com + /// In Transit /// - [JsonPropertyName("company_name")] - public string CompanyName { get; set; } - - /// - /// Signer information - /// - /// Signer information - [JsonPropertyName("signer")] - public string Signer { get; set; } + [JsonPropertyName("status_description")] + [JsonRequired] + public string StatusDescription { get; set; } /// - /// Event Code + /// Carrier timestamp for the event, it is assumed to be the local time of where the event occurred. /// - /// Event Code - [JsonPropertyName("event_code")] - public string EventCode { get; set; } + /// Carrier timestamp for the event, it is assumed to be the local time of where the event occurred. + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("carrier_occurred_at")] + public DateTimeOffset? CarrierOccurredAt { get; set; } /// - /// Carrier detail code + /// Company Name /// - /// Carrier detail code + /// Company Name /// - /// OT + /// Stamps.com /// - [JsonPropertyName("carrier_detail_code")] - [JsonRequired] - public string CarrierDetailCode { get; set; } + [JsonPropertyName("company_name")] + public string? CompanyName { get; set; } /// - /// Event Status Description + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) /// - /// Event Status Description + /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) /// - /// In Transit + /// CA /// - [JsonPropertyName("status_description")] - [JsonRequired] - public string StatusDescription { get; set; } + [JsonPropertyName("country_code")] + public string? CountryCode { get; set; } /// - /// Carrier status code + /// Event description /// - /// Carrier status code + /// Event description /// - /// 1 + /// Delivered, In/At Mailbox /// - [JsonPropertyName("carrier_status_code")] - [JsonRequired] - public string CarrierStatusCode { get; set; } + [JsonPropertyName("description")] + public string? Description { get; set; } /// - /// carrier status description + /// Event Code /// - /// carrier status description - /// - /// Your item was delivered in or at the mailbox at 9:10 am on March - /// - [JsonPropertyName("carrier_status_description")] - [JsonRequired] - public string CarrierStatusDescription { get; set; } + /// Event Code + [JsonPropertyName("event_code")] + public string? EventCode { get; set; } /// /// Latitude coordinate of tracking event. /// /// Latitude coordinate of tracking event. [JsonPropertyName("latitude")] - public double Latitude { get; set; } + public double? Latitude { get; set; } /// /// Longitude coordinate of tracking event. /// /// Longitude coordinate of tracking event. [JsonPropertyName("longitude")] - public double Longitude { get; set; } + public double? Longitude { get; set; } + + /// + /// Signer information + /// + /// Signer information + [JsonPropertyName("signer")] + public string? Signer { get; set; } /// @@ -202,23 +202,23 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class TrackEvent {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" OccurredAt: ").Append(OccurredAt).Append("\n"); - sb.Append(" CarrierOccurredAt: ").Append(CarrierOccurredAt).Append("\n"); - sb.Append(" Description: ").Append(Description).Append("\n"); + sb.Append(" CarrierDetailCode: ").Append(CarrierDetailCode).Append("\n"); + sb.Append(" CarrierStatusCode: ").Append(CarrierStatusCode).Append("\n"); + sb.Append(" CarrierStatusDescription: ").Append(CarrierStatusDescription).Append("\n"); sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); - sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); + sb.Append(" OccurredAt: ").Append(OccurredAt).Append("\n"); sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); - sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); - sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); - sb.Append(" Signer: ").Append(Signer).Append("\n"); - sb.Append(" EventCode: ").Append(EventCode).Append("\n"); - sb.Append(" CarrierDetailCode: ").Append(CarrierDetailCode).Append("\n"); + sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); sb.Append(" StatusCode: ").Append(StatusCode).Append("\n"); sb.Append(" StatusDescription: ").Append(StatusDescription).Append("\n"); - sb.Append(" CarrierStatusCode: ").Append(CarrierStatusCode).Append("\n"); - sb.Append(" CarrierStatusDescription: ").Append(CarrierStatusDescription).Append("\n"); + sb.Append(" CarrierOccurredAt: ").Append(CarrierOccurredAt).Append("\n"); + sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); + sb.Append(" Description: ").Append(Description).Append("\n"); + sb.Append(" EventCode: ").Append(EventCode).Append("\n"); sb.Append(" Latitude: ").Append(Latitude).Append("\n"); sb.Append(" Longitude: ").Append(Longitude).Append("\n"); + sb.Append(" Signer: ").Append(Signer).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/TrackingInformation.cs b/ShipEngineSDK/Model/TrackingInformation.cs index 1d7509fe..92619896 100644 --- a/ShipEngineSDK/Model/TrackingInformation.cs +++ b/ShipEngineSDK/Model/TrackingInformation.cs @@ -34,24 +34,14 @@ public partial class TrackingInformation [JsonPropertyName("status_code")] public StatusCode? StatusCode { get; set; } /// - /// A tracking number for a package. The format depends on the carrier. - /// - /// A tracking number for a package. The format depends on the carrier. - /// - /// 1Z932R800392060079 - /// - [JsonPropertyName("tracking_number")] - public string TrackingNumber { get; set; } - - /// - /// Carrier Tracking Url, if available + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. /// - /// Carrier Tracking Url, if available + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. /// - /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 + /// 2018-09-23T15:00Z /// - [JsonPropertyName("tracking_url")] - public string TrackingUrl { get; set; } + [JsonPropertyName("actual_delivery_date")] + public DateTimeOffset? ActualDeliveryDate { get; set; } /// /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. @@ -61,27 +51,27 @@ public partial class TrackingInformation /// dhl_express /// [JsonPropertyName("carrier_code")] - public string CarrierCode { get; set; } + public string? CarrierCode { get; set; } /// - /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. + /// Carrier detail code /// - /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. + /// Carrier detail code /// - /// se-28529731 + /// OT /// - [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + [JsonPropertyName("carrier_detail_code")] + public string? CarrierDetailCode { get; set; } /// - /// Status description + /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. /// - /// Status description + /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. /// - /// Delivered + /// se-28529731 /// - [JsonPropertyName("status_description")] - public string StatusDescription { get; set; } + [JsonPropertyName("carrier_id")] + public string? CarrierId { get; set; } /// /// Carrier status code @@ -91,17 +81,7 @@ public partial class TrackingInformation /// 1 /// [JsonPropertyName("carrier_status_code")] - public string CarrierStatusCode { get; set; } - - /// - /// Carrier detail code - /// - /// Carrier detail code - /// - /// OT - /// - [JsonPropertyName("carrier_detail_code")] - public string CarrierDetailCode { get; set; } + public string? CarrierStatusCode { get; set; } /// /// carrier status description @@ -111,7 +91,7 @@ public partial class TrackingInformation /// Your item was delivered in or at the mailbox at 9:10 am on March /// [JsonPropertyName("carrier_status_description")] - public string CarrierStatusDescription { get; set; } + public string? CarrierStatusDescription { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -120,8 +100,22 @@ public partial class TrackingInformation /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + [JsonPropertyName("estimated_delivery_date")] + public DateTimeOffset? EstimatedDeliveryDate { get; set; } + + /// + /// The events that have occured during the lifetime of this tracking number. + /// + /// The events that have occured during the lifetime of this tracking number. + [JsonPropertyName("events")] + public List? Events { get; set; } + + /// + /// Exception description + /// + /// Exception description + [JsonPropertyName("exception_description")] + public string? ExceptionDescription { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -130,32 +124,38 @@ public partial class TrackingInformation /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("estimated_delivery_date")] - public DateTimeOffset EstimatedDeliveryDate { get; set; } + [JsonPropertyName("ship_date")] + public DateTimeOffset? ShipDate { get; set; } /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. + /// Status description /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. + /// Status description /// - /// 2018-09-23T15:00Z + /// Delivered /// - [JsonPropertyName("actual_delivery_date")] - public DateTimeOffset ActualDeliveryDate { get; set; } + [JsonPropertyName("status_description")] + public string? StatusDescription { get; set; } /// - /// Exception description + /// A tracking number for a package. The format depends on the carrier. /// - /// Exception description - [JsonPropertyName("exception_description")] - public string ExceptionDescription { get; set; } + /// A tracking number for a package. The format depends on the carrier. + /// + /// 1Z932R800392060079 + /// + [JsonPropertyName("tracking_number")] + public string? TrackingNumber { get; set; } /// - /// The events that have occured during the lifetime of this tracking number. + /// Carrier Tracking Url, if available /// - /// The events that have occured during the lifetime of this tracking number. - [JsonPropertyName("events")] - public List Events { get; set; } + /// Carrier Tracking Url, if available + /// + /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 + /// + [JsonPropertyName("tracking_url")] + public string? TrackingUrl { get; set; } /// @@ -167,20 +167,20 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class TrackingInformation {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); - sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); - sb.Append(" StatusCode: ").Append(StatusCode).Append("\n"); + sb.Append(" ActualDeliveryDate: ").Append(ActualDeliveryDate).Append("\n"); sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" CarrierDetailCode: ").Append(CarrierDetailCode).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); - sb.Append(" StatusDescription: ").Append(StatusDescription).Append("\n"); sb.Append(" CarrierStatusCode: ").Append(CarrierStatusCode).Append("\n"); - sb.Append(" CarrierDetailCode: ").Append(CarrierDetailCode).Append("\n"); sb.Append(" CarrierStatusDescription: ").Append(CarrierStatusDescription).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); sb.Append(" EstimatedDeliveryDate: ").Append(EstimatedDeliveryDate).Append("\n"); - sb.Append(" ActualDeliveryDate: ").Append(ActualDeliveryDate).Append("\n"); - sb.Append(" ExceptionDescription: ").Append(ExceptionDescription).Append("\n"); sb.Append(" Events: ").Append(Events).Append("\n"); + sb.Append(" ExceptionDescription: ").Append(ExceptionDescription).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" StatusCode: ").Append(StatusCode).Append("\n"); + sb.Append(" StatusDescription: ").Append(StatusDescription).Append("\n"); + sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); + sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs index fbd6053e..891fe3ad 100644 --- a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs @@ -91,26 +91,6 @@ public override bool CanConvert(Type typeToConvert) => /// The image type [JsonPropertyName("image_content_type")] public ImageContentTypeEnum? ImageContentType { get; set; } - /// - /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. - /// - /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. - /// - /// img_DtBXupDBxREpHnwEXhTfgK - /// - [JsonPropertyName("label_image_id")] - public string LabelImageId { get; set; } - - /// - /// A human readable name for the image. - /// - /// A human readable name for the image. - /// - /// My logo - /// - [JsonPropertyName("name")] - public string Name { get; set; } - /// /// Indicates whether this image is set as default. /// @@ -122,6 +102,16 @@ public override bool CanConvert(Type typeToConvert) => [JsonRequired] public bool IsDefault { get; set; } + /// + /// The date and time that the image was created in ShipEngine. + /// + /// The date and time that the image was created in ShipEngine. + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("created_at")] + public DateTimeOffset? CreatedAt { get; set; } + /// /// A base64 encoded string representation of the image. /// @@ -130,17 +120,17 @@ public override bool CanConvert(Type typeToConvert) => /// iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg== /// [JsonPropertyName("image_data")] - public string ImageData { get; set; } + public string? ImageData { get; set; } /// - /// The date and time that the image was created in ShipEngine. + /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. /// - /// The date and time that the image was created in ShipEngine. + /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. /// - /// 2018-09-23T15:00Z + /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("label_image_id")] + public string? LabelImageId { get; set; } /// /// The date and time that the image was modified in ShipEngine. @@ -150,7 +140,17 @@ public override bool CanConvert(Type typeToConvert) => /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at")] - public DateTimeOffset ModifiedAt { get; set; } + public DateTimeOffset? ModifiedAt { get; set; } + + /// + /// A human readable name for the image. + /// + /// A human readable name for the image. + /// + /// My logo + /// + [JsonPropertyName("name")] + public string? Name { get; set; } /// @@ -162,13 +162,13 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class UpdateAccountSettingsImageRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); - sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" ImageContentType: ").Append(ImageContentType).Append("\n"); sb.Append(" ImageData: ").Append(ImageData).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs b/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs index 33b6f648..a673d1a9 100644 --- a/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs @@ -33,7 +33,7 @@ public partial class UpdateAmazonBuyShippingRequestBody /// /// Email [JsonPropertyName("email")] - public string Email { get; set; } + public string? Email { get; set; } /// diff --git a/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs index 76f92e98..f9106d9b 100644 --- a/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs @@ -28,26 +28,26 @@ namespace ShipEngineSDK.Model; public partial class UpdateDhlExpressSettingsRequestBody { + /// + /// Indicates if this is primary account + /// + /// Indicates if this is primary account + [JsonPropertyName("is_primary_account")] + public bool? IsPrimaryAccount { get; set; } + /// /// Account nickname /// /// Account nickname [JsonPropertyName("nickname")] - public string Nickname { get; set; } + public string? Nickname { get; set; } /// /// Indicates if the account number should be hidden on the archive documentation /// /// Indicates if the account number should be hidden on the archive documentation [JsonPropertyName("should_hide_account_number_on_archive_doc")] - public bool ShouldHideAccountNumberOnArchiveDoc { get; set; } - - /// - /// Indicates if this is primary account - /// - /// Indicates if this is primary account - [JsonPropertyName("is_primary_account")] - public bool IsPrimaryAccount { get; set; } + public bool? ShouldHideAccountNumberOnArchiveDoc { get; set; } /// @@ -59,9 +59,9 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class UpdateDhlExpressSettingsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" ShouldHideAccountNumberOnArchiveDoc: ").Append(ShouldHideAccountNumberOnArchiveDoc).Append("\n"); - sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs index f6594704..4a3b1a2d 100644 --- a/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs @@ -34,39 +34,39 @@ public partial class UpdateFedexSettingsRequestBody [JsonPropertyName("pickup_type")] public FedexPickupType? PickupType { get; set; } /// - /// Gets or Sets SmartPostHub CLOVUS - /// - [JsonPropertyName("smart_post_hub")] - public SmartPostHub? SmartPostHub { get; set; } - /// /// Gets or Sets SmartPostEndorsement CLOVUS /// [JsonPropertyName("smart_post_endorsement")] public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } /// - /// Account nickname + /// Gets or Sets SmartPostHub CLOVUS /// - /// Account nickname - [JsonPropertyName("nickname")] - public string Nickname { get; set; } - + [JsonPropertyName("smart_post_hub")] + public SmartPostHub? SmartPostHub { get; set; } /// /// Gets or Sets IsPrimaryAccount /// [JsonPropertyName("is_primary_account")] - public bool IsPrimaryAccount { get; set; } + public bool? IsPrimaryAccount { get; set; } /// - /// Gets or Sets SignatureImage + /// Gets or Sets LetterheadImage /// - [JsonPropertyName("signature_image")] - public string SignatureImage { get; set; } + [JsonPropertyName("letterhead_image")] + public string? LetterheadImage { get; set; } /// - /// Gets or Sets LetterheadImage + /// Account nickname /// - [JsonPropertyName("letterhead_image")] - public string LetterheadImage { get; set; } + /// Account nickname + [JsonPropertyName("nickname")] + public string? Nickname { get; set; } + + /// + /// Gets or Sets SignatureImage + /// + [JsonPropertyName("signature_image")] + public string? SignatureImage { get; set; } /// @@ -78,13 +78,13 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class UpdateFedexSettingsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); + sb.Append(" LetterheadImage: ").Append(LetterheadImage).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" PickupType: ").Append(PickupType).Append("\n"); - sb.Append(" SmartPostHub: ").Append(SmartPostHub).Append("\n"); - sb.Append(" SmartPostEndorsement: ").Append(SmartPostEndorsement).Append("\n"); - sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); sb.Append(" SignatureImage: ").Append(SignatureImage).Append("\n"); - sb.Append(" LetterheadImage: ").Append(LetterheadImage).Append("\n"); + sb.Append(" SmartPostEndorsement: ").Append(SmartPostEndorsement).Append("\n"); + sb.Append(" SmartPostHub: ").Append(SmartPostHub).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs index 71555a9d..e6cdbc1c 100644 --- a/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs @@ -32,13 +32,13 @@ public partial class UpdateNewgisticsSettingsRequestBody /// Gets or Sets IncludeBarcodeWithOrderNumber /// [JsonPropertyName("include_barcode_with_order_number")] - public bool IncludeBarcodeWithOrderNumber { get; set; } + public bool? IncludeBarcodeWithOrderNumber { get; set; } /// /// Gets or Sets ReceiveEmailOnManifestProcessing /// [JsonPropertyName("receive_email_on_manifest_processing")] - public bool ReceiveEmailOnManifestProcessing { get; set; } + public bool? ReceiveEmailOnManifestProcessing { get; set; } /// diff --git a/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs b/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs index 2a5e6db9..b76ed883 100644 --- a/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs +++ b/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs @@ -29,14 +29,14 @@ public partial class UpdatePackageTypeRequestBody { /// - /// A string that uniquely identifies the package. + /// Gets or Sets Name /// - /// A string that uniquely identifies the package. /// - /// se-28529731 + /// laptop_box /// - [JsonPropertyName("package_id")] - public string PackageId { get; set; } + [JsonPropertyName("name")] + [JsonRequired] + public string Name { get; set; } /// /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. @@ -50,31 +50,31 @@ public partial class UpdatePackageTypeRequestBody public string PackageCode { get; set; } /// - /// Gets or Sets Name + /// Provides a helpful description for the custom package. /// + /// Provides a helpful description for the custom package. /// - /// laptop_box + /// Packaging for laptops /// - [JsonPropertyName("name")] - [JsonRequired] - public string Name { get; set; } + [JsonPropertyName("description")] + public string? Description { get; set; } /// /// The custom dimensions for the package. /// /// The custom dimensions for the package. [JsonPropertyName("dimensions")] - public Dimensions Dimensions { get; set; } + public Dimensions? Dimensions { get; set; } /// - /// Provides a helpful description for the custom package. + /// A string that uniquely identifies the package. /// - /// Provides a helpful description for the custom package. + /// A string that uniquely identifies the package. /// - /// Packaging for laptops + /// se-28529731 /// - [JsonPropertyName("description")] - public string Description { get; set; } + [JsonPropertyName("package_id")] + public string? PackageId { get; set; } /// @@ -86,11 +86,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class UpdatePackageTypeRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" PackageId: ").Append(PackageId).Append("\n"); - sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Description: ").Append(Description).Append("\n"); + sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); + sb.Append(" PackageId: ").Append(PackageId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs b/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs index 85187327..47ba137e 100644 --- a/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs @@ -28,12 +28,6 @@ namespace ShipEngineSDK.Model; public partial class UpdateShipmentRequestBody { - /// - /// The current status of the shipment CLOVUS - /// - /// The current status of the shipment - [JsonPropertyName("shipment_status")] - public ShipmentStatus? ShipmentStatus { get; set; } /// /// The type of delivery confirmation that is required for this shipment. CLOVUS /// @@ -52,19 +46,38 @@ public partial class UpdateShipmentRequestBody [JsonPropertyName("order_source_code")] public OrderSourceName? OrderSourceCode { get; set; } /// + /// The current status of the shipment CLOVUS + /// + /// The current status of the shipment + [JsonPropertyName("shipment_status")] + public ShipmentStatus? ShipmentStatus { get; set; } + /// /// Gets or Sets ValidateAddress CLOVUS /// [JsonPropertyName("validate_address")] public ValidateAddress? ValidateAddress { get; set; } /// - /// A string that uniquely identifies the shipment + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// - /// A string that uniquely identifies the shipment - /// - /// se-28529731 - /// - [JsonPropertyName("shipment_id")] - public string ShipmentId { get; set; } + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. + [JsonPropertyName("ship_from")] + [JsonRequired] + public ShippingAddress ShipFrom { get; set; } + + /// + /// The recipient's mailing address + /// + /// The recipient's mailing address + [JsonPropertyName("ship_to")] + [JsonRequired] + public ShippingAddressTo ShipTo { get; set; } + + /// + /// Advanced shipment options. These are entirely optional. + /// + /// Advanced shipment options. These are entirely optional. + [JsonPropertyName("advanced_options")] + public AdvancedShipmentOptions? AdvancedOptions { get; set; } /// /// The carrier account that is billed for the shipping charges @@ -74,81 +87,62 @@ public partial class UpdateShipmentRequestBody /// se-28529731 /// [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + public string? CarrierId { get; set; } /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. /// - /// usps_first_class_mail + /// retail /// - [JsonPropertyName("service_code")] - public string ServiceCode { get; set; } + [JsonPropertyName("comparison_rate_type")] + public string? ComparisonRateType { get; set; } /// - /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// The date and time that the shipment was created in ShipEngine. /// - /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// The date and time that the shipment was created in ShipEngine. /// - /// se-28529731 + /// 2018-09-23T15:00Z /// - [JsonPropertyName("shipping_rule_id")] - public string ShippingRuleId { get; set; } - - /// - /// ID that the Order Source assigned - /// - /// ID that the Order Source assigned - [JsonPropertyName("external_order_id")] - public string ExternalOrderId { get; set; } + [JsonPropertyName("created_at")] + public DateTimeOffset? CreatedAt { get; set; } /// - /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources + /// Customs information. This is usually only needed for international shipments. /// - /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - [JsonPropertyName("items")] - public List Items { get; set; } + /// Customs information. This is usually only needed for international shipments. + [JsonPropertyName("customs")] + public InternationalShipmentOptions? Customs { get; set; } /// - /// Gets or Sets TaxIdentifiers + /// ID that the Order Source assigned /// - [JsonPropertyName("tax_identifiers")] - public List TaxIdentifiers { get; set; } + /// ID that the Order Source assigned + [JsonPropertyName("external_order_id")] + public string? ExternalOrderId { get; set; } /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. [JsonPropertyName("external_shipment_id")] - public string ExternalShipmentId { get; set; } + public string? ExternalShipmentId { get; set; } /// - /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - /// - /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("shipment_number")] - public string ShipmentNumber { get; set; } - - /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. - /// - /// 2018-09-23T00:00Z - /// - [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. + [JsonPropertyName("is_return")] + public bool? IsReturn { get; set; } /// - /// The date and time that the shipment was created in ShipEngine. + /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources /// - /// The date and time that the shipment was created in ShipEngine. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources + [JsonPropertyName("items")] + public List? Items { get; set; } /// /// The date and time that the shipment was created or last modified. @@ -158,92 +152,98 @@ public partial class UpdateShipmentRequestBody /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at")] - public DateTimeOffset ModifiedAt { get; set; } + public DateTimeOffset? ModifiedAt { get; set; } /// - /// The recipient's mailing address + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// - /// The recipient's mailing address - [JsonPropertyName("ship_to")] - [JsonRequired] - public ShippingAddressTo ShipTo { get; set; } + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + [JsonPropertyName("packages")] + public List? Packages { get; set; } /// - /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. + /// The return address for this shipment. Defaults to the `ship_from` address. /// - /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from")] - [JsonRequired] - public ShippingAddress ShipFrom { get; set; } + /// The return address for this shipment. Defaults to the `ship_from` address. + [JsonPropertyName("return_to")] + public ShippingAddress? ReturnTo { get; set; } /// - /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// - /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// - /// se-28529731 + /// usps_first_class_mail /// - [JsonPropertyName("warehouse_id")] - public string WarehouseId { get; set; } + [JsonPropertyName("service_code")] + public string? ServiceCode { get; set; } /// - /// The return address for this shipment. Defaults to the `ship_from` address. + /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to")] - public ShippingAddress ReturnTo { get; set; } + /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// + /// 2018-09-23T00:00Z + /// + [JsonPropertyName("ship_date")] + public DateTimeOffset? ShipDate { get; set; } /// - /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. + /// A string that uniquely identifies the shipment /// - /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. - [JsonPropertyName("is_return")] - public bool? IsReturn { get; set; } + /// A string that uniquely identifies the shipment + /// + /// se-28529731 + /// + [JsonPropertyName("shipment_id")] + public string? ShipmentId { get; set; } /// - /// Customs information. This is usually only needed for international shipments. + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// - /// Customs information. This is usually only needed for international shipments. - [JsonPropertyName("customs")] - public InternationalShipmentOptions Customs { get; set; } + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. + [JsonPropertyName("shipment_number")] + public string? ShipmentNumber { get; set; } /// - /// Advanced shipment options. These are entirely optional. + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment /// - /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options")] - public AdvancedShipmentOptions AdvancedOptions { get; set; } + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// + /// se-28529731 + /// + [JsonPropertyName("shipping_rule_id")] + public string? ShippingRuleId { get; set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. [JsonPropertyName("tags")] - public List Tags { get; set; } + public List? Tags { get; set; } /// - /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + /// Gets or Sets TaxIdentifiers /// - /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - public List Packages { get; set; } + [JsonPropertyName("tax_identifiers")] + public List? TaxIdentifiers { get; set; } /// /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment [JsonPropertyName("total_weight")] - public Weight TotalWeight { get; set; } + public Weight? TotalWeight { get; set; } /// - /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. /// - /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. /// - /// retail + /// se-28529731 /// - [JsonPropertyName("comparison_rate_type")] - public string ComparisonRateType { get; set; } + [JsonPropertyName("warehouse_id")] + public string? WarehouseId { get; set; } /// @@ -255,34 +255,34 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class UpdateShipmentRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); - sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); - sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); - sb.Append(" ShippingRuleId: ").Append(ShippingRuleId).Append("\n"); - sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); - sb.Append(" Items: ").Append(Items).Append("\n"); - sb.Append(" TaxIdentifiers: ").Append(TaxIdentifiers).Append("\n"); - sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); - sb.Append(" ShipmentNumber: ").Append(ShipmentNumber).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); - sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); - sb.Append(" ShipmentStatus: ").Append(ShipmentStatus).Append("\n"); - sb.Append(" ShipTo: ").Append(ShipTo).Append("\n"); sb.Append(" ShipFrom: ").Append(ShipFrom).Append("\n"); - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); - sb.Append(" ReturnTo: ").Append(ReturnTo).Append("\n"); - sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); + sb.Append(" ShipTo: ").Append(ShipTo).Append("\n"); + sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); + sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" Customs: ").Append(Customs).Append("\n"); - sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); + sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); + sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); sb.Append(" InsuranceProvider: ").Append(InsuranceProvider).Append("\n"); - sb.Append(" Tags: ").Append(Tags).Append("\n"); + sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); + sb.Append(" Items: ").Append(Items).Append("\n"); + sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); sb.Append(" OrderSourceCode: ").Append(OrderSourceCode).Append("\n"); sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" ReturnTo: ").Append(ReturnTo).Append("\n"); + sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" ShipmentNumber: ").Append(ShipmentNumber).Append("\n"); + sb.Append(" ShipmentStatus: ").Append(ShipmentStatus).Append("\n"); + sb.Append(" ShippingRuleId: ").Append(ShippingRuleId).Append("\n"); + sb.Append(" Tags: ").Append(Tags).Append("\n"); + sb.Append(" TaxIdentifiers: ").Append(TaxIdentifiers).Append("\n"); sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); - sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs b/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs index f103d3bb..6a662a95 100644 --- a/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs @@ -28,15 +28,6 @@ namespace ShipEngineSDK.Model; public partial class UpdateShipmentResponseBody { - /// - /// The current status of the shipment CLOVUS - /// - /// The current status of the shipment - [JsonPropertyName("shipment_status")] - [JsonRequired] - public ShipmentStatus ShipmentStatus { get; set; } = new(); - - /// /// The type of delivery confirmation that is required for this shipment. CLOVUS /// @@ -55,21 +46,35 @@ public partial class UpdateShipmentResponseBody public InsuranceProvider InsuranceProvider { get; set; } = new(); + /// + /// The current status of the shipment CLOVUS + /// + /// The current status of the shipment + [JsonPropertyName("shipment_status")] + [JsonRequired] + public ShipmentStatus ShipmentStatus { get; set; } = new(); + + /// /// Gets or Sets OrderSourceCode CLOVUS /// [JsonPropertyName("order_source_code")] public OrderSourceName? OrderSourceCode { get; set; } /// - /// A string that uniquely identifies the shipment + /// The address validation /// - /// A string that uniquely identifies the shipment - /// - /// se-28529731 - /// - [JsonPropertyName("shipment_id")] + /// The address validation + [JsonPropertyName("address_validation")] [JsonRequired] - public string ShipmentId { get; set; } + public AddressValidationResult AddressValidation { get; set; } + + /// + /// Advanced shipment options. These are entirely optional. + /// + /// Advanced shipment options. These are entirely optional. + [JsonPropertyName("advanced_options")] + [JsonRequired] + public AdvancedShipmentOptions AdvancedOptions { get; set; } /// /// The carrier account that is billed for the shipping charges @@ -83,59 +88,51 @@ public partial class UpdateShipmentResponseBody public string CarrierId { get; set; } /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// The date and time that the shipment was created in ShipEngine. /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// The date and time that the shipment was created in ShipEngine. /// - /// usps_first_class_mail + /// 2018-09-23T15:00Z /// - [JsonPropertyName("service_code")] + [JsonPropertyName("created_at")] [JsonRequired] - public string ServiceCode { get; set; } - - /// - /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment - /// - /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment - /// - /// se-28529731 - /// - [JsonPropertyName("shipping_rule_id")] - public string ShippingRuleId { get; set; } - - /// - /// ID that the Order Source assigned - /// - /// ID that the Order Source assigned - [JsonPropertyName("external_order_id")] - public string ExternalOrderId { get; set; } + public DateTimeOffset CreatedAt { get; set; } /// - /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources + /// An array of errors that occurred while creating shipment. /// - /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - [JsonPropertyName("items")] - public List Items { get; set; } + /// An array of errors that occurred while creating shipment. + [JsonPropertyName("errors")] + [JsonRequired] + [Obsolete] + public List Errors { get; set; } /// - /// Gets or Sets TaxIdentifiers + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// - [JsonPropertyName("tax_identifiers")] - public List TaxIdentifiers { get; set; } + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + [JsonPropertyName("packages")] + [JsonRequired] + public List Packages { get; set; } /// - /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. + /// The return address for this shipment. Defaults to the `ship_from` address. /// - /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("external_shipment_id")] - public string ExternalShipmentId { get; set; } + /// The return address for this shipment. Defaults to the `ship_from` address. + [JsonPropertyName("return_to")] + [JsonRequired] + public ShippingAddress ReturnTo { get; set; } /// - /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// - /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("shipment_number")] - public string ShipmentNumber { get; set; } + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// usps_first_class_mail + /// + [JsonPropertyName("service_code")] + [JsonRequired] + public string ServiceCode { get; set; } /// /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -149,25 +146,12 @@ public partial class UpdateShipmentResponseBody public DateTimeOffset ShipDate { get; set; } /// - /// The date and time that the shipment was created in ShipEngine. + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// - /// The date and time that the shipment was created in ShipEngine. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("created_at")] + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. + [JsonPropertyName("ship_from")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } - - /// - /// The date and time that the shipment was created or last modified. - /// - /// The date and time that the shipment was created or last modified. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("modified_at")] - public DateTimeOffset ModifiedAt { get; set; } + public ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address @@ -178,37 +162,41 @@ public partial class UpdateShipmentResponseBody public ShippingAddressTo ShipTo { get; set; } /// - /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. + /// A string that uniquely identifies the shipment /// - /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from")] + /// A string that uniquely identifies the shipment + /// + /// se-28529731 + /// + [JsonPropertyName("shipment_id")] [JsonRequired] - public ShippingAddress ShipFrom { get; set; } + public string ShipmentId { get; set; } /// - /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// - /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. - /// - /// se-28529731 - /// - [JsonPropertyName("warehouse_id")] - public string WarehouseId { get; set; } + /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. + [JsonPropertyName("tags")] + [JsonRequired] + public List Tags { get; set; } /// - /// The return address for this shipment. Defaults to the `ship_from` address. + /// The combined weight of all packages in the shipment /// - /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to")] + /// The combined weight of all packages in the shipment + [JsonPropertyName("total_weight")] [JsonRequired] - public ShippingAddress ReturnTo { get; set; } + public Weight TotalWeight { get; set; } /// - /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. /// - /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. - [JsonPropertyName("is_return")] - public bool? IsReturn { get; set; } + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// + /// retail + /// + [JsonPropertyName("comparison_rate_type")] + public string? ComparisonRateType { get; set; } /// /// Customs information. This is usually only needed for international shipments. @@ -219,63 +207,75 @@ public partial class UpdateShipmentResponseBody public InternationalShipmentOptions Customs { get; set; } /// - /// Advanced shipment options. These are entirely optional. + /// ID that the Order Source assigned /// - /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options")] - [JsonRequired] - public AdvancedShipmentOptions AdvancedOptions { get; set; } + /// ID that the Order Source assigned + [JsonPropertyName("external_order_id")] + public string? ExternalOrderId { get; set; } /// - /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. + /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. /// - /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. - [JsonPropertyName("tags")] - [JsonRequired] - public List Tags { get; set; } + /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. + [JsonPropertyName("external_shipment_id")] + public string? ExternalShipmentId { get; set; } /// - /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// - /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - [JsonRequired] - public List Packages { get; set; } + /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. + [JsonPropertyName("is_return")] + public bool? IsReturn { get; set; } /// - /// The combined weight of all packages in the shipment + /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources /// - /// The combined weight of all packages in the shipment - [JsonPropertyName("total_weight")] - [JsonRequired] - public Weight TotalWeight { get; set; } + /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources + [JsonPropertyName("items")] + public List? Items { get; set; } /// - /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// The date and time that the shipment was created or last modified. /// - /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// The date and time that the shipment was created or last modified. /// - /// retail + /// 2018-09-23T15:00Z /// - [JsonPropertyName("comparison_rate_type")] - public string ComparisonRateType { get; set; } + [JsonPropertyName("modified_at")] + public DateTimeOffset? ModifiedAt { get; set; } /// - /// An array of errors that occurred while creating shipment. + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// - /// An array of errors that occurred while creating shipment. - [JsonPropertyName("errors")] - [JsonRequired] - [Obsolete] - public List Errors { get; set; } + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. + [JsonPropertyName("shipment_number")] + public string? ShipmentNumber { get; set; } /// - /// The address validation + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment /// - /// The address validation - [JsonPropertyName("address_validation")] - [JsonRequired] - public AddressValidationResult AddressValidation { get; set; } + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// + /// se-28529731 + /// + [JsonPropertyName("shipping_rule_id")] + public string? ShippingRuleId { get; set; } + + /// + /// Gets or Sets TaxIdentifiers + /// + [JsonPropertyName("tax_identifiers")] + public List? TaxIdentifiers { get; set; } + + /// + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// + /// se-28529731 + /// + [JsonPropertyName("warehouse_id")] + public string? WarehouseId { get; set; } /// @@ -287,35 +287,35 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class UpdateShipmentResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" AddressValidation: ").Append(AddressValidation).Append("\n"); + sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); + sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" Errors: ").Append(Errors).Append("\n"); + sb.Append(" InsuranceProvider: ").Append(InsuranceProvider).Append("\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" ReturnTo: ").Append(ReturnTo).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); - sb.Append(" ShippingRuleId: ").Append(ShippingRuleId).Append("\n"); - sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); - sb.Append(" Items: ").Append(Items).Append("\n"); - sb.Append(" TaxIdentifiers: ").Append(TaxIdentifiers).Append("\n"); - sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); - sb.Append(" ShipmentNumber: ").Append(ShipmentNumber).Append("\n"); sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); - sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); - sb.Append(" ShipmentStatus: ").Append(ShipmentStatus).Append("\n"); - sb.Append(" ShipTo: ").Append(ShipTo).Append("\n"); sb.Append(" ShipFrom: ").Append(ShipFrom).Append("\n"); - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); - sb.Append(" ReturnTo: ").Append(ReturnTo).Append("\n"); - sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); - sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); - sb.Append(" Customs: ").Append(Customs).Append("\n"); - sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); - sb.Append(" InsuranceProvider: ").Append(InsuranceProvider).Append("\n"); + sb.Append(" ShipTo: ").Append(ShipTo).Append("\n"); + sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); + sb.Append(" ShipmentStatus: ").Append(ShipmentStatus).Append("\n"); sb.Append(" Tags: ").Append(Tags).Append("\n"); - sb.Append(" OrderSourceCode: ").Append(OrderSourceCode).Append("\n"); - sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); - sb.Append(" Errors: ").Append(Errors).Append("\n"); - sb.Append(" AddressValidation: ").Append(AddressValidation).Append("\n"); + sb.Append(" Customs: ").Append(Customs).Append("\n"); + sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); + sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); + sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); + sb.Append(" Items: ").Append(Items).Append("\n"); + sb.Append(" ModifiedAt: ").Append(ModifiedAt).Append("\n"); + sb.Append(" OrderSourceCode: ").Append(OrderSourceCode).Append("\n"); + sb.Append(" ShipmentNumber: ").Append(ShipmentNumber).Append("\n"); + sb.Append(" ShippingRuleId: ").Append(ShippingRuleId).Append("\n"); + sb.Append(" TaxIdentifiers: ").Append(TaxIdentifiers).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/UpdateShipmentsTags.cs b/ShipEngineSDK/Model/UpdateShipmentsTags.cs index 92f96d2c..dce0361f 100644 --- a/ShipEngineSDK/Model/UpdateShipmentsTags.cs +++ b/ShipEngineSDK/Model/UpdateShipmentsTags.cs @@ -32,7 +32,7 @@ public partial class UpdateShipmentsTags /// Gets or Sets ShipmentsTags /// [JsonPropertyName("shipments_tags")] - public List ShipmentsTags { get; set; } + public List? ShipmentsTags { get; set; } /// diff --git a/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs b/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs index 6b90c526..614b96ff 100644 --- a/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs @@ -32,7 +32,7 @@ public partial class UpdateShipmentsTagsRequestBody /// Gets or Sets ShipmentsTags /// [JsonPropertyName("shipments_tags")] - public List ShipmentsTags { get; set; } + public List? ShipmentsTags { get; set; } /// diff --git a/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs b/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs index 57a04740..94c1f72c 100644 --- a/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs +++ b/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs @@ -32,13 +32,13 @@ public partial class UpdateShipmentsTagsShipmentsTagsInner /// Gets or Sets ShipmentId /// [JsonPropertyName("shipment_id")] - public string ShipmentId { get; set; } + public string? ShipmentId { get; set; } /// /// Gets or Sets Tags /// [JsonPropertyName("tags")] - public List Tags { get; set; } + public List? Tags { get; set; } /// diff --git a/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs index 96e93d6d..18ac008f 100644 --- a/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs @@ -28,85 +28,85 @@ namespace ShipEngineSDK.Model; public partial class UpdateUpsSettingsRequestBody { + /// + /// Gets or Sets MailInnovationsEndorsement CLOVUS + /// + [JsonPropertyName("mail_innovations_endorsement")] + public AncillaryServiceEndorsement? MailInnovationsEndorsement { get; set; } /// /// Gets or Sets PickupType CLOVUS /// [JsonPropertyName("pickup_type")] public UpsPickupType? PickupType { get; set; } /// - /// Gets or Sets MailInnovationsEndorsement CLOVUS + /// account postal code /// - [JsonPropertyName("mail_innovations_endorsement")] - public AncillaryServiceEndorsement? MailInnovationsEndorsement { get; set; } + /// account postal code + [JsonPropertyName("account_postal_code")] + public string? AccountPostalCode { get; set; } + /// - /// nickname + /// The invoice /// - /// nickname - [JsonPropertyName("nickname")] - public string Nickname { get; set; } + /// The invoice + [JsonPropertyName("invoice")] + public UpsInvoice? Invoice { get; set; } /// /// Indicates if this is the primary UPS account /// /// Indicates if this is the primary UPS account [JsonPropertyName("is_primary_account")] - public bool IsPrimaryAccount { get; set; } + public bool? IsPrimaryAccount { get; set; } /// - /// The use carbon neutral shipping program + /// mail innovations cost center /// - /// The use carbon neutral shipping program - [JsonPropertyName("use_carbon_neutral_shipping_program")] - public bool UseCarbonNeutralShippingProgram { get; set; } + /// mail innovations cost center + [JsonPropertyName("mail_innovations_cost_center")] + public string? MailInnovationsCostCenter { get; set; } /// - /// The use ground freight pricing + /// nickname /// - /// The use ground freight pricing - [JsonPropertyName("use_ground_freight_pricing")] - public bool UseGroundFreightPricing { get; set; } + /// nickname + [JsonPropertyName("nickname")] + public string? Nickname { get; set; } /// - /// The use consolidation services + /// The use carbon neutral shipping program /// - /// The use consolidation services - [JsonPropertyName("use_consolidation_services")] - public bool UseConsolidationServices { get; set; } + /// The use carbon neutral shipping program + [JsonPropertyName("use_carbon_neutral_shipping_program")] + public bool? UseCarbonNeutralShippingProgram { get; set; } /// - /// The use order number on mail innovations labels + /// The use consolidation services /// - /// The use order number on mail innovations labels - [JsonPropertyName("use_order_number_on_mail_innovations_labels")] - public bool UseOrderNumberOnMailInnovationsLabels { get; set; } + /// The use consolidation services + [JsonPropertyName("use_consolidation_services")] + public bool? UseConsolidationServices { get; set; } /// - /// mail innovations cost center + /// The use ground freight pricing /// - /// mail innovations cost center - [JsonPropertyName("mail_innovations_cost_center")] - public string MailInnovationsCostCenter { get; set; } + /// The use ground freight pricing + [JsonPropertyName("use_ground_freight_pricing")] + public bool? UseGroundFreightPricing { get; set; } /// /// The use negotiated rates /// /// The use negotiated rates [JsonPropertyName("use_negotiated_rates")] - public bool UseNegotiatedRates { get; set; } + public bool? UseNegotiatedRates { get; set; } /// - /// account postal code - /// - /// account postal code - [JsonPropertyName("account_postal_code")] - public string AccountPostalCode { get; set; } - - /// - /// The invoice + /// The use order number on mail innovations labels /// - /// The invoice - [JsonPropertyName("invoice")] - public UpsInvoice Invoice { get; set; } + /// The use order number on mail innovations labels + [JsonPropertyName("use_order_number_on_mail_innovations_labels")] + public bool? UseOrderNumberOnMailInnovationsLabels { get; set; } /// @@ -118,18 +118,18 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class UpdateUpsSettingsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" AccountPostalCode: ").Append(AccountPostalCode).Append("\n"); + sb.Append(" Invoice: ").Append(Invoice).Append("\n"); sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); + sb.Append(" MailInnovationsCostCenter: ").Append(MailInnovationsCostCenter).Append("\n"); + sb.Append(" MailInnovationsEndorsement: ").Append(MailInnovationsEndorsement).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" PickupType: ").Append(PickupType).Append("\n"); sb.Append(" UseCarbonNeutralShippingProgram: ").Append(UseCarbonNeutralShippingProgram).Append("\n"); - sb.Append(" UseGroundFreightPricing: ").Append(UseGroundFreightPricing).Append("\n"); sb.Append(" UseConsolidationServices: ").Append(UseConsolidationServices).Append("\n"); - sb.Append(" UseOrderNumberOnMailInnovationsLabels: ").Append(UseOrderNumberOnMailInnovationsLabels).Append("\n"); - sb.Append(" MailInnovationsEndorsement: ").Append(MailInnovationsEndorsement).Append("\n"); - sb.Append(" MailInnovationsCostCenter: ").Append(MailInnovationsCostCenter).Append("\n"); + sb.Append(" UseGroundFreightPricing: ").Append(UseGroundFreightPricing).Append("\n"); sb.Append(" UseNegotiatedRates: ").Append(UseNegotiatedRates).Append("\n"); - sb.Append(" AccountPostalCode: ").Append(AccountPostalCode).Append("\n"); - sb.Append(" Invoice: ").Append(Invoice).Append("\n"); + sb.Append(" UseOrderNumberOnMailInnovationsLabels: ").Append(UseOrderNumberOnMailInnovationsLabels).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs b/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs index 91e53b12..006448b3 100644 --- a/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs @@ -28,23 +28,6 @@ namespace ShipEngineSDK.Model; public partial class UpdateWarehouseRequestBody { - /// - /// A string that uniquely identifies the warehouse - /// - /// A string that uniquely identifies the warehouse - /// - /// se-28529731 - /// - [JsonPropertyName("warehouse_id")] - public string WarehouseId { get; set; } - - /// - /// Designates which single warehouse is the default on the account - /// - /// Designates which single warehouse is the default on the account - [JsonPropertyName("is_default")] - public bool? IsDefault { get; set; } - /// /// Name of the warehouse /// @@ -56,6 +39,14 @@ public partial class UpdateWarehouseRequestBody [JsonRequired] public string Name { get; set; } + /// + /// The origin address of the warehouse + /// + /// The origin address of the warehouse + [JsonPropertyName("origin_address")] + [JsonRequired] + public Address OriginAddress { get; set; } + /// /// Timestamp that indicates when the warehouse was created /// @@ -64,22 +55,31 @@ public partial class UpdateWarehouseRequestBody /// 2019-06-25T18:12:35.583Z /// [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + public DateTimeOffset? CreatedAt { get; set; } /// - /// The origin address of the warehouse + /// Designates which single warehouse is the default on the account /// - /// The origin address of the warehouse - [JsonPropertyName("origin_address")] - [JsonRequired] - public Address OriginAddress { get; set; } + /// Designates which single warehouse is the default on the account + [JsonPropertyName("is_default")] + public bool? IsDefault { get; set; } /// /// The return address associated with the warehouse /// /// The return address associated with the warehouse [JsonPropertyName("return_address")] - public Address ReturnAddress { get; set; } + public Address? ReturnAddress { get; set; } + + /// + /// A string that uniquely identifies the warehouse + /// + /// A string that uniquely identifies the warehouse + /// + /// se-28529731 + /// + [JsonPropertyName("warehouse_id")] + public string? WarehouseId { get; set; } /// @@ -91,12 +91,12 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class UpdateWarehouseRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); - sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" OriginAddress: ").Append(OriginAddress).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); sb.Append(" ReturnAddress: ").Append(ReturnAddress).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs b/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs index 1451803d..19ea895e 100644 --- a/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs @@ -28,6 +28,13 @@ namespace ShipEngineSDK.Model; public partial class UpdateWebhookRequestBody { + /// + /// Array of custom webhook headers + /// + /// Array of custom webhook headers + [JsonPropertyName("headers")] + public List? Headers { get; set; } + /// /// The url that the wehbook sends the request /// @@ -36,14 +43,7 @@ public partial class UpdateWebhookRequestBody /// http://api.shipengine.com/v1/labels/se-28529731 /// [JsonPropertyName("url")] - public string Url { get; set; } - - /// - /// Array of custom webhook headers - /// - /// Array of custom webhook headers - [JsonPropertyName("headers")] - public List Headers { get; set; } + public string? Url { get; set; } /// @@ -55,8 +55,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class UpdateWebhookRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Url: ").Append(Url).Append("\n"); sb.Append(" Headers: ").Append(Headers).Append("\n"); + sb.Append(" Url: ").Append(Url).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/UpsAccountSettings.cs b/ShipEngineSDK/Model/UpsAccountSettings.cs index 050afe89..99a88a1f 100644 --- a/ShipEngineSDK/Model/UpsAccountSettings.cs +++ b/ShipEngineSDK/Model/UpsAccountSettings.cs @@ -28,85 +28,85 @@ namespace ShipEngineSDK.Model; public partial class UpsAccountSettings { + /// + /// Gets or Sets MailInnovationsEndorsement CLOVUS + /// + [JsonPropertyName("mail_innovations_endorsement")] + public AncillaryServiceEndorsement? MailInnovationsEndorsement { get; set; } /// /// Gets or Sets PickupType CLOVUS /// [JsonPropertyName("pickup_type")] public UpsPickupType? PickupType { get; set; } /// - /// Gets or Sets MailInnovationsEndorsement CLOVUS + /// account postal code /// - [JsonPropertyName("mail_innovations_endorsement")] - public AncillaryServiceEndorsement? MailInnovationsEndorsement { get; set; } + /// account postal code + [JsonPropertyName("account_postal_code")] + public string? AccountPostalCode { get; set; } + /// - /// nickname + /// The invoice /// - /// nickname - [JsonPropertyName("nickname")] - public string Nickname { get; set; } + /// The invoice + [JsonPropertyName("invoice")] + public UpsInvoice? Invoice { get; set; } /// /// Indicates if this is the primary UPS account /// /// Indicates if this is the primary UPS account [JsonPropertyName("is_primary_account")] - public bool IsPrimaryAccount { get; set; } + public bool? IsPrimaryAccount { get; set; } /// - /// The use carbon neutral shipping program + /// mail innovations cost center /// - /// The use carbon neutral shipping program - [JsonPropertyName("use_carbon_neutral_shipping_program")] - public bool UseCarbonNeutralShippingProgram { get; set; } + /// mail innovations cost center + [JsonPropertyName("mail_innovations_cost_center")] + public string? MailInnovationsCostCenter { get; set; } /// - /// The use ground freight pricing + /// nickname /// - /// The use ground freight pricing - [JsonPropertyName("use_ground_freight_pricing")] - public bool UseGroundFreightPricing { get; set; } + /// nickname + [JsonPropertyName("nickname")] + public string? Nickname { get; set; } /// - /// The use consolidation services + /// The use carbon neutral shipping program /// - /// The use consolidation services - [JsonPropertyName("use_consolidation_services")] - public bool UseConsolidationServices { get; set; } + /// The use carbon neutral shipping program + [JsonPropertyName("use_carbon_neutral_shipping_program")] + public bool? UseCarbonNeutralShippingProgram { get; set; } /// - /// The use order number on mail innovations labels + /// The use consolidation services /// - /// The use order number on mail innovations labels - [JsonPropertyName("use_order_number_on_mail_innovations_labels")] - public bool UseOrderNumberOnMailInnovationsLabels { get; set; } + /// The use consolidation services + [JsonPropertyName("use_consolidation_services")] + public bool? UseConsolidationServices { get; set; } /// - /// mail innovations cost center + /// The use ground freight pricing /// - /// mail innovations cost center - [JsonPropertyName("mail_innovations_cost_center")] - public string MailInnovationsCostCenter { get; set; } + /// The use ground freight pricing + [JsonPropertyName("use_ground_freight_pricing")] + public bool? UseGroundFreightPricing { get; set; } /// /// The use negotiated rates /// /// The use negotiated rates [JsonPropertyName("use_negotiated_rates")] - public bool UseNegotiatedRates { get; set; } + public bool? UseNegotiatedRates { get; set; } /// - /// account postal code - /// - /// account postal code - [JsonPropertyName("account_postal_code")] - public string AccountPostalCode { get; set; } - - /// - /// The invoice + /// The use order number on mail innovations labels /// - /// The invoice - [JsonPropertyName("invoice")] - public UpsInvoice Invoice { get; set; } + /// The use order number on mail innovations labels + [JsonPropertyName("use_order_number_on_mail_innovations_labels")] + public bool? UseOrderNumberOnMailInnovationsLabels { get; set; } /// @@ -118,18 +118,18 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class UpsAccountSettings {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" AccountPostalCode: ").Append(AccountPostalCode).Append("\n"); + sb.Append(" Invoice: ").Append(Invoice).Append("\n"); sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); + sb.Append(" MailInnovationsCostCenter: ").Append(MailInnovationsCostCenter).Append("\n"); + sb.Append(" MailInnovationsEndorsement: ").Append(MailInnovationsEndorsement).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" PickupType: ").Append(PickupType).Append("\n"); sb.Append(" UseCarbonNeutralShippingProgram: ").Append(UseCarbonNeutralShippingProgram).Append("\n"); - sb.Append(" UseGroundFreightPricing: ").Append(UseGroundFreightPricing).Append("\n"); sb.Append(" UseConsolidationServices: ").Append(UseConsolidationServices).Append("\n"); - sb.Append(" UseOrderNumberOnMailInnovationsLabels: ").Append(UseOrderNumberOnMailInnovationsLabels).Append("\n"); - sb.Append(" MailInnovationsEndorsement: ").Append(MailInnovationsEndorsement).Append("\n"); - sb.Append(" MailInnovationsCostCenter: ").Append(MailInnovationsCostCenter).Append("\n"); + sb.Append(" UseGroundFreightPricing: ").Append(UseGroundFreightPricing).Append("\n"); sb.Append(" UseNegotiatedRates: ").Append(UseNegotiatedRates).Append("\n"); - sb.Append(" AccountPostalCode: ").Append(AccountPostalCode).Append("\n"); - sb.Append(" Invoice: ").Append(Invoice).Append("\n"); + sb.Append(" UseOrderNumberOnMailInnovationsLabels: ").Append(UseOrderNumberOnMailInnovationsLabels).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/UpsInvoice.cs b/ShipEngineSDK/Model/UpsInvoice.cs index 18b96736..19661a12 100644 --- a/ShipEngineSDK/Model/UpsInvoice.cs +++ b/ShipEngineSDK/Model/UpsInvoice.cs @@ -28,20 +28,6 @@ namespace ShipEngineSDK.Model; public partial class UpsInvoice { - /// - /// invoice date - /// - /// invoice date - [JsonPropertyName("invoice_date")] - public DateTimeOffset InvoiceDate { get; set; } - - /// - /// invoice number - /// - /// invoice number - [JsonPropertyName("invoice_number")] - public string InvoiceNumber { get; set; } - /// /// A string that uniquely identifies the control /// @@ -50,19 +36,33 @@ public partial class UpsInvoice /// se-28529731 /// [JsonPropertyName("control_id")] - public string ControlId { get; set; } + public string? ControlId { get; set; } /// /// Gets or Sets InvoiceAmount /// [JsonPropertyName("invoice_amount")] - public double InvoiceAmount { get; set; } + public double? InvoiceAmount { get; set; } /// /// Gets or Sets InvoiceCurrencyCode /// [JsonPropertyName("invoice_currency_code")] - public string InvoiceCurrencyCode { get; set; } + public string? InvoiceCurrencyCode { get; set; } + + /// + /// invoice date + /// + /// invoice date + [JsonPropertyName("invoice_date")] + public DateTimeOffset? InvoiceDate { get; set; } + + /// + /// invoice number + /// + /// invoice number + [JsonPropertyName("invoice_number")] + public string? InvoiceNumber { get; set; } /// @@ -74,11 +74,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class UpsInvoice {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" InvoiceDate: ").Append(InvoiceDate).Append("\n"); - sb.Append(" InvoiceNumber: ").Append(InvoiceNumber).Append("\n"); sb.Append(" ControlId: ").Append(ControlId).Append("\n"); sb.Append(" InvoiceAmount: ").Append(InvoiceAmount).Append("\n"); sb.Append(" InvoiceCurrencyCode: ").Append(InvoiceCurrencyCode).Append("\n"); + sb.Append(" InvoiceDate: ").Append(InvoiceDate).Append("\n"); + sb.Append(" InvoiceNumber: ").Append(InvoiceNumber).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/UpsSettingsResponseBody.cs b/ShipEngineSDK/Model/UpsSettingsResponseBody.cs index e0747409..fc8611eb 100644 --- a/ShipEngineSDK/Model/UpsSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/UpsSettingsResponseBody.cs @@ -28,85 +28,85 @@ namespace ShipEngineSDK.Model; public partial class UpsSettingsResponseBody { + /// + /// Gets or Sets MailInnovationsEndorsement CLOVUS + /// + [JsonPropertyName("mail_innovations_endorsement")] + public AncillaryServiceEndorsement? MailInnovationsEndorsement { get; set; } /// /// Gets or Sets PickupType CLOVUS /// [JsonPropertyName("pickup_type")] public UpsPickupType? PickupType { get; set; } /// - /// Gets or Sets MailInnovationsEndorsement CLOVUS + /// account postal code /// - [JsonPropertyName("mail_innovations_endorsement")] - public AncillaryServiceEndorsement? MailInnovationsEndorsement { get; set; } + /// account postal code + [JsonPropertyName("account_postal_code")] + public string? AccountPostalCode { get; set; } + /// - /// nickname + /// The invoice /// - /// nickname - [JsonPropertyName("nickname")] - public string Nickname { get; set; } + /// The invoice + [JsonPropertyName("invoice")] + public UpsInvoice? Invoice { get; set; } /// /// Indicates if this is the primary UPS account /// /// Indicates if this is the primary UPS account [JsonPropertyName("is_primary_account")] - public bool IsPrimaryAccount { get; set; } + public bool? IsPrimaryAccount { get; set; } /// - /// The use carbon neutral shipping program + /// mail innovations cost center /// - /// The use carbon neutral shipping program - [JsonPropertyName("use_carbon_neutral_shipping_program")] - public bool UseCarbonNeutralShippingProgram { get; set; } + /// mail innovations cost center + [JsonPropertyName("mail_innovations_cost_center")] + public string? MailInnovationsCostCenter { get; set; } /// - /// The use ground freight pricing + /// nickname /// - /// The use ground freight pricing - [JsonPropertyName("use_ground_freight_pricing")] - public bool UseGroundFreightPricing { get; set; } + /// nickname + [JsonPropertyName("nickname")] + public string? Nickname { get; set; } /// - /// The use consolidation services + /// The use carbon neutral shipping program /// - /// The use consolidation services - [JsonPropertyName("use_consolidation_services")] - public bool UseConsolidationServices { get; set; } + /// The use carbon neutral shipping program + [JsonPropertyName("use_carbon_neutral_shipping_program")] + public bool? UseCarbonNeutralShippingProgram { get; set; } /// - /// The use order number on mail innovations labels + /// The use consolidation services /// - /// The use order number on mail innovations labels - [JsonPropertyName("use_order_number_on_mail_innovations_labels")] - public bool UseOrderNumberOnMailInnovationsLabels { get; set; } + /// The use consolidation services + [JsonPropertyName("use_consolidation_services")] + public bool? UseConsolidationServices { get; set; } /// - /// mail innovations cost center + /// The use ground freight pricing /// - /// mail innovations cost center - [JsonPropertyName("mail_innovations_cost_center")] - public string MailInnovationsCostCenter { get; set; } + /// The use ground freight pricing + [JsonPropertyName("use_ground_freight_pricing")] + public bool? UseGroundFreightPricing { get; set; } /// /// The use negotiated rates /// /// The use negotiated rates [JsonPropertyName("use_negotiated_rates")] - public bool UseNegotiatedRates { get; set; } + public bool? UseNegotiatedRates { get; set; } /// - /// account postal code - /// - /// account postal code - [JsonPropertyName("account_postal_code")] - public string AccountPostalCode { get; set; } - - /// - /// The invoice + /// The use order number on mail innovations labels /// - /// The invoice - [JsonPropertyName("invoice")] - public UpsInvoice Invoice { get; set; } + /// The use order number on mail innovations labels + [JsonPropertyName("use_order_number_on_mail_innovations_labels")] + public bool? UseOrderNumberOnMailInnovationsLabels { get; set; } /// @@ -118,18 +118,18 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class UpsSettingsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" AccountPostalCode: ").Append(AccountPostalCode).Append("\n"); + sb.Append(" Invoice: ").Append(Invoice).Append("\n"); sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); + sb.Append(" MailInnovationsCostCenter: ").Append(MailInnovationsCostCenter).Append("\n"); + sb.Append(" MailInnovationsEndorsement: ").Append(MailInnovationsEndorsement).Append("\n"); + sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" PickupType: ").Append(PickupType).Append("\n"); sb.Append(" UseCarbonNeutralShippingProgram: ").Append(UseCarbonNeutralShippingProgram).Append("\n"); - sb.Append(" UseGroundFreightPricing: ").Append(UseGroundFreightPricing).Append("\n"); sb.Append(" UseConsolidationServices: ").Append(UseConsolidationServices).Append("\n"); - sb.Append(" UseOrderNumberOnMailInnovationsLabels: ").Append(UseOrderNumberOnMailInnovationsLabels).Append("\n"); - sb.Append(" MailInnovationsEndorsement: ").Append(MailInnovationsEndorsement).Append("\n"); - sb.Append(" MailInnovationsCostCenter: ").Append(MailInnovationsCostCenter).Append("\n"); + sb.Append(" UseGroundFreightPricing: ").Append(UseGroundFreightPricing).Append("\n"); sb.Append(" UseNegotiatedRates: ").Append(UseNegotiatedRates).Append("\n"); - sb.Append(" AccountPostalCode: ").Append(AccountPostalCode).Append("\n"); - sb.Append(" Invoice: ").Append(Invoice).Append("\n"); + sb.Append(" UseOrderNumberOnMailInnovationsLabels: ").Append(UseOrderNumberOnMailInnovationsLabels).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/Warehouse.cs b/ShipEngineSDK/Model/Warehouse.cs index 49882090..13c1bdb2 100644 --- a/ShipEngineSDK/Model/Warehouse.cs +++ b/ShipEngineSDK/Model/Warehouse.cs @@ -29,14 +29,14 @@ public partial class Warehouse { /// - /// A string that uniquely identifies the warehouse + /// Timestamp that indicates when the warehouse was created /// - /// A string that uniquely identifies the warehouse + /// Timestamp that indicates when the warehouse was created /// - /// se-28529731 + /// 2019-06-25T18:12:35.583Z /// - [JsonPropertyName("warehouse_id")] - public string WarehouseId { get; set; } + [JsonPropertyName("created_at")] + public DateTimeOffset? CreatedAt { get; set; } /// /// Designates which single warehouse is the default on the account @@ -53,31 +53,31 @@ public partial class Warehouse /// Zero Cool HQ /// [JsonPropertyName("name")] - public string Name { get; set; } - - /// - /// Timestamp that indicates when the warehouse was created - /// - /// Timestamp that indicates when the warehouse was created - /// - /// 2019-06-25T18:12:35.583Z - /// - [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + public string? Name { get; set; } /// /// The origin address of the warehouse /// /// The origin address of the warehouse [JsonPropertyName("origin_address")] - public Address OriginAddress { get; set; } + public Address? OriginAddress { get; set; } /// /// The return address associated with the warehouse /// /// The return address associated with the warehouse [JsonPropertyName("return_address")] - public Address ReturnAddress { get; set; } + public Address? ReturnAddress { get; set; } + + /// + /// A string that uniquely identifies the warehouse + /// + /// A string that uniquely identifies the warehouse + /// + /// se-28529731 + /// + [JsonPropertyName("warehouse_id")] + public string? WarehouseId { get; set; } /// @@ -89,12 +89,12 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class Warehouse {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" OriginAddress: ").Append(OriginAddress).Append("\n"); sb.Append(" ReturnAddress: ").Append(ReturnAddress).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/Webhook.cs b/ShipEngineSDK/Model/Webhook.cs index 1b59b2a2..293c0442 100644 --- a/ShipEngineSDK/Model/Webhook.cs +++ b/ShipEngineSDK/Model/Webhook.cs @@ -34,14 +34,11 @@ public partial class Webhook [JsonPropertyName("event")] public WebhookEvent? Event { get; set; } /// - /// A string that uniquely identifies the webhook + /// Array of custom webhook headers /// - /// A string that uniquely identifies the webhook - /// - /// se-28529731 - /// - [JsonPropertyName("webhook_id")] - public string WebhookId { get; set; } + /// Array of custom webhook headers + [JsonPropertyName("headers")] + public List? Headers { get; set; } /// /// The url that the webhook sends the request to @@ -51,14 +48,17 @@ public partial class Webhook /// http://api.shipengine.com/v1/labels/se-28529731 /// [JsonPropertyName("url")] - public string Url { get; set; } + public string? Url { get; set; } /// - /// Array of custom webhook headers + /// A string that uniquely identifies the webhook /// - /// Array of custom webhook headers - [JsonPropertyName("headers")] - public List Headers { get; set; } + /// A string that uniquely identifies the webhook + /// + /// se-28529731 + /// + [JsonPropertyName("webhook_id")] + public string? WebhookId { get; set; } /// @@ -70,10 +70,10 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class Webhook {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" WebhookId: ").Append(WebhookId).Append("\n"); - sb.Append(" Url: ").Append(Url).Append("\n"); sb.Append(" Event: ").Append(Event).Append("\n"); sb.Append(" Headers: ").Append(Headers).Append("\n"); + sb.Append(" Url: ").Append(Url).Append("\n"); + sb.Append(" WebhookId: ").Append(WebhookId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/Weight.cs b/ShipEngineSDK/Model/Weight.cs index b0cf4a8a..ce6a0300 100644 --- a/ShipEngineSDK/Model/Weight.cs +++ b/ShipEngineSDK/Model/Weight.cs @@ -54,8 +54,8 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class Weight {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Value: ").Append(Value).Append("\n"); sb.Append(" Unit: ").Append(Unit).Append("\n"); + sb.Append(" Value: ").Append(Value).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/generation/swagger.json b/generation/swagger.json index ca870b7f..3cf16587 100644 --- a/generation/swagger.json +++ b/generation/swagger.json @@ -8720,92 +8720,92 @@ "description": "Customer Branch" }, "Address": { - "type": "string,", + "type": "string", "description": "Address" }, "Address2": { - "type": "string,", + "type": "string", "description": "Address2" }, "PostalCode": { - "type": "string,", + "type": "string", "description": "PostalCode" }, "City": { - "type": "string,", + "type": "string", "description": "City" }, "State": { - "type": "string,", + "type": "string", "description": "State" }, "country": { - "type": "string,", + "type": "string", "description": "Country" }, "Phone": { - "type": "string,", + "type": "string", "description": "Phone" }, "Email": { - "type": "string,", + "type": "string", "description": "Email" }, "instructions": { - "type": "string,", + "type": "string", "description": "Instructions" }, "facility_code": { - "type": "string,", + "type": "string", "description": "Facility Code" }, "lasership_critical_pull_time": { - "type": "string,", + "type": "string", "description": "Critical Pull Time (local time)" }, "lasership_critical_entry_time": { - "type": "string,", + "type": "string", "description": "Critical Entry Time (local time)" }, "declare_piece_attributes_separately_for_every_shipment": { - "type": "boolean,", + "type": "boolean", "description": "Declare piece attributes separately for every shipment, overrides individual attribute below.", "default": false }, "AttrAlcohol": { - "type": "boolean,", + "type": "boolean", "description": "Set this to true if your shipments will always contain Alcohol" }, "AttrDryIce": { - "type": "boolean,", + "type": "boolean", "description": "Set this to true if your shipments will always contain DryIce" }, "AttrHazmat": { - "type": "boolean,", + "type": "boolean", "description": "Set this to true if your shipments will always contain Hazmat" }, "AttrTwoPersons": { - "type": "boolean,", + "type": "boolean", "description": "Set this to true if your shipments will always require Two Persons" }, "AttrExplosive": { - "type": "boolean,", + "type": "boolean", "description": "Set this to true if your shipments will always contain Explosives" }, "AttrControlledSubstance": { - "type": "boolean,", + "type": "boolean", "description": "Set this to true if your shipments will always contain Controlled Substances" }, "AttrRefrigerated": { - "type": "boolean,", + "type": "boolean", "description": "Set this to true if your shipments will always require Refrigeration" }, "AttrPerishable": { - "type": "boolean,", + "type": "boolean", "description": "Set this to true if your shipments will always be Perishable" }, "AttrNoRTS": { - "type": "boolean,", + "type": "boolean", "description": "Set this to true if your shipments will always use \"No Return To Sender\"" } } diff --git a/generation/templates/modelGeneric.mustache b/generation/templates/modelGeneric.mustache index bd7bed15..b99d061f 100644 --- a/generation/templates/modelGeneric.mustache +++ b/generation/templates/modelGeneric.mustache @@ -102,7 +102,7 @@ {{#deprecated}} [Obsolete] {{/deprecated}} - public {{#items.vars}}{{#-first}}List<{{classname}}Item>{{/-first}}{{/items.vars}}{{^items.vars}}{{{dataType}}}{{/items.vars}} {{name}} { get; set; } + public {{#items.vars}}{{#-first}}List<{{classname}}Item>{{/-first}}{{/items.vars}}{{^items.vars}}{{{dataType}}}{{/items.vars}}{{^required}}?{{/required}} {{name}} { get; set; } {{/isEnum}} {{/isInherited}} diff --git a/generation/templates/modelOneOf.mustache b/generation/templates/modelOneOf.mustache index f0fb399c..94ca1121 100644 --- a/generation/templates/modelOneOf.mustache +++ b/generation/templates/modelOneOf.mustache @@ -70,7 +70,7 @@ {{#deprecated}} [Obsolete] {{/deprecated}} - public {{{dataType}}} {{name}} { get; set; } + public {{{dataType}}}{{^required}}?{{/required}} {{name}} { get; set; } {{/isEnum}} {{/isInherited}} diff --git a/openapitools.json b/openapitools.json index 854678cc..a6381e6c 100644 --- a/openapitools.json +++ b/openapitools.json @@ -12,6 +12,7 @@ "skipValidateSpec": true, "packageName": "ShipEngineSDK", "ignoreFileOverride": "./.openapi-generator-ignore", + "library": "generichost", "additionalProperties": { "packageVersion": "3.0.0-beta.2", "targetFramework": "netstandard2.0", @@ -19,7 +20,8 @@ "sourceFolder": "", "optionalProjectFile": false, "nullableReferenceTypes": true, - "useDateTimeOffset": true + "useDateTimeOffset": true, + "modelPropertySorting": "alphabetical" } } } From 7b3cb74c13fa6bed59ecbb30500ceff5fd27f8a9 Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Tue, 16 Jul 2024 16:48:31 -0500 Subject: [PATCH 07/42] Add required keyword to required properties --- .../CompilerFeatureRequiredAttribute.cs | 33 ++++++++ .../CompilerSupport/IsExternalInit.cs | 10 +++ .../NotNullIfNotNullAttribute.cs | 0 .../RequiredMemberAttribute.cs | 13 +++ .../SetsRequiredMembersAttribute.cs | 16 ++++ .../Model/AddFundsToCarrierRequestBody.cs | 4 +- .../Model/AddFundsToCarrierResponseBody.cs | 2 +- .../Model/AddFundsToInsuranceRequestBody.cs | 4 +- .../Model/AddFundsToInsuranceResponseBody.cs | 4 +- ShipEngineSDK/Model/Address.cs | 16 ++-- ShipEngineSDK/Model/AddressToValidate.cs | 8 +- .../Model/AddressValidatingShipment.cs | 10 +-- .../Model/AddressValidationResult.cs | 8 +- ShipEngineSDK/Model/Batch.cs | 42 +++++----- ShipEngineSDK/Model/BulkRate.cs | 10 +-- .../Model/CalculateRatesRequestBody.cs | 15 +++- .../Model/CalculateRatesResponseBody.cs | 28 +++---- .../Model/CompareBulkRatesRequestBody.cs | 18 ++-- .../ConnectAccessWorldwideRequestBody.cs | 6 +- .../ConnectAmazonBuyShippingRequestBody.cs | 8 +- .../Model/ConnectAmazonShippingUk.cs | 4 +- ShipEngineSDK/Model/ConnectApcRequestBody.cs | 6 +- .../Model/ConnectAsendiaRequestBody.cs | 8 +- .../Model/ConnectAustraliaPostRequestBody.cs | 8 +- .../Model/ConnectCanadaPostRequestBody.cs | 10 +-- .../Model/ConnectCarrierRequestBody.cs | 2 +- .../Model/ConnectCarrierResponseBody.cs | 2 +- .../Model/ConnectDhlEcommerceRequestBody.cs | 12 +-- .../Model/ConnectDhlExpressAuRequestBody.cs | 4 +- .../Model/ConnectDhlExpressCaRequestBody.cs | 4 +- .../Model/ConnectDhlExpressRequestBody.cs | 4 +- .../Model/ConnectDhlExpressUkRequestBody.cs | 8 +- ShipEngineSDK/Model/ConnectDpdRequestBody.cs | 6 +- .../Model/ConnectEndiciaRequestBody.cs | 6 +- .../Model/ConnectFedexRequestBody.cs | 24 +++--- .../Model/ConnectFedexUkRequestBody.cs | 24 +++--- .../Model/ConnectFirstmileRequestBody.cs | 6 +- ShipEngineSDK/Model/ConnectImexRequestBody.cs | 6 +- .../Model/ConnectInsurerRequestBody.cs | 4 +- .../Model/ConnectLasershipRequestBody.cs | 20 ++--- .../Model/ConnectNewgisticsRequestBody.cs | 4 +- .../Model/ConnectOntracRequestBody.cs | 6 +- .../Model/ConnectPurolatorRequestBody.cs | 6 +- .../Model/ConnectRoyalMailRequestBody.cs | 10 +-- .../Model/ConnectRrDonnelleyRequestBody.cs | 6 +- ShipEngineSDK/Model/ConnectSekoRequestBody.cs | 4 +- .../Model/ConnectSendleRequestBody.cs | 6 +- .../Model/ConnectStampsRequestBody.cs | 6 +- ShipEngineSDK/Model/ConnectUpsRequestBody.cs | 4 +- ShipEngineSDK/Model/ContactDetails.cs | 6 +- .../CreateAccountSettingsImageRequestBody.cs | 6 +- ShipEngineSDK/Model/CreateBatchRequest.cs | 2 +- .../Model/CreateBatchResponseBody.cs | 42 +++++----- ShipEngineSDK/Model/CreateLabelRequestBody.cs | 2 +- .../Model/CreateLabelResponseBody.cs | 60 +++++++------- .../CreateManifestByObjectRequestBody.cs | 6 +- .../CreateManifestLabelIdsRequestBody.cs | 2 +- .../Model/CreateManifestRequestBody.cs | 2 +- .../Model/CreateManifestResponseBody.cs | 22 ++--- .../Model/CreatePackageTypeRequestBody.cs | 4 +- .../Model/CreatePackageTypeResponseBody.cs | 4 +- .../Model/CreateShipmentsRequestBody.cs | 2 +- .../Model/CreateShipmentsResponseBody.cs | 4 +- ShipEngineSDK/Model/CreateTagResponseBody.cs | 2 +- .../Model/CreateWarehouseRequestBody.cs | 4 +- .../Model/CreateWarehouseResponseBody.cs | 10 +-- .../Model/CreateWebhookRequestBody.cs | 4 +- .../Model/CreateWebhookResponseBody.cs | 6 +- ShipEngineSDK/Model/CustomsItem.cs | 2 +- .../Model/DeletePickupByIdResponseBody.cs | 6 +- .../DeleteScheduledPickupResponseBody.cs | 2 +- ShipEngineSDK/Model/Dimensions.cs | 8 +- ShipEngineSDK/Model/Error.cs | 8 +- ShipEngineSDK/Model/ErrorResponseBody.cs | 4 +- .../Model/ErrorWithLabelIdResponseBody.cs | 4 +- .../Model/EstimateRatesRequestBody.cs | 83 +++++++++++++------ .../Model/GetBatchByExternalIdResponseBody.cs | 42 +++++----- .../Model/GetBatchByIdResponseBody.cs | 42 +++++----- .../Model/GetCarrierSettingsResponseBody.cs | 2 +- .../Model/GetCarriersResponseBody.cs | 6 +- .../Model/GetInsuranceBalanceResponseBody.cs | 4 +- .../Model/GetManifestByIdResponseBody.cs | 20 ++--- .../Model/GetPackageTypeByIdResponseBody.cs | 4 +- .../Model/GetPickupByIdResponseBody.cs | 22 ++--- ShipEngineSDK/Model/GetPickupsResponseBody.cs | 14 ++-- .../Model/GetRateByIdResponseBody.cs | 40 ++++----- .../Model/GetServicePointsRequest.cs | 2 +- .../Model/GetServicePointsRequestBody.cs | 2 +- .../GetServicePointsRequestBodyAddress.cs | 2 +- .../GetShipmentByExternalIdResponseBody.cs | 36 ++++---- .../Model/GetShipmentByIdResponseBody.cs | 36 ++++---- .../GetTrackingLogFromLabelResponseBody.cs | 10 +-- .../Model/GetTrackingLogResponseBody.cs | 18 ++-- .../Model/GetWarehouseByIdResponseBody.cs | 10 +-- .../Model/GetWebhookByIdResponseBody.cs | 6 +- ShipEngineSDK/Model/ImporterOfRecords.cs | 10 +-- .../Model/InternationalShipmentOptions.cs | 4 +- ShipEngineSDK/Model/LabelMessages.cs | 6 +- ShipEngineSDK/Model/LabelPackagesInner.cs | 2 +- ShipEngineSDK/Model/Link.cs | 2 +- .../Model/ListAccountImagesResponseBody.cs | 10 +-- .../ListAccountSettingsImagesResponseBody.cs | 10 +-- .../Model/ListBatchErrorsResponseBody.cs | 4 +- .../Model/ListBatchesResponseBody.cs | 10 +-- .../Model/ListCarriersResponseBody.cs | 2 +- ShipEngineSDK/Model/ListLabelsResponseBody.cs | 10 +-- .../Model/ListManifestsResponseBody.cs | 10 +-- ShipEngineSDK/Model/ListPickupResponseBody.cs | 10 +-- .../Model/ListShipmentRatesResponseBody.cs | 14 ++-- .../Model/ListShipmentsResponseBody.cs | 10 +-- .../Model/ListWarehousesResponseBody.cs | 2 +- ShipEngineSDK/Model/MonetaryValue.cs | 4 +- ShipEngineSDK/Model/Package.cs | 2 +- ShipEngineSDK/Model/PackageType.cs | 4 +- ShipEngineSDK/Model/PagedListResponseBody.cs | 8 +- ShipEngineSDK/Model/PaginationLink.cs | 8 +- .../Model/ParseAddressRequestBody.cs | 2 +- .../Model/ParseAddressResponseBody.cs | 6 +- .../Model/ParseShipmentRequestBody.cs | 2 +- .../Model/ParseShipmentResponseBody.cs | 6 +- ShipEngineSDK/Model/PickupResponseBody.cs | 18 ++-- ShipEngineSDK/Model/PickupWindow.cs | 4 +- ShipEngineSDK/Model/Rate.cs | 40 ++++----- ShipEngineSDK/Model/RateEstimate.cs | 38 ++++----- ShipEngineSDK/Model/RateRequestBody.cs | 2 +- .../Model/RateRequestByShipmentIds.cs | 2 +- ShipEngineSDK/Model/RateRequestByShipments.cs | 2 +- ShipEngineSDK/Model/RecognizedEntity.cs | 10 +-- ShipEngineSDK/Model/ResponseMessage.cs | 8 +- .../Model/SchedulePickupRequestBody.cs | 6 +- .../Model/SchedulePickupResponseBody.cs | 4 +- ShipEngineSDK/Model/Shipment.cs | 36 ++++---- ShipEngineSDK/Model/ShippingAddress.cs | 16 ++-- ShipEngineSDK/Model/ShippingAddressTo.cs | 16 ++-- ShipEngineSDK/Model/Tag.cs | 2 +- .../Model/TagShipmentResponseBody.cs | 2 +- ShipEngineSDK/Model/TaxIdentifier.cs | 8 +- ShipEngineSDK/Model/TrackEvent.cs | 18 ++-- .../UpdateAccountSettingsImageRequestBody.cs | 2 +- .../Model/UpdateCarrierSettingsRequestBody.cs | 2 +- .../Model/UpdatePackageTypeRequestBody.cs | 4 +- .../Model/UpdateShipmentRequestBody.cs | 4 +- .../Model/UpdateShipmentResponseBody.cs | 36 ++++---- .../Model/UpdateWarehouseRequestBody.cs | 4 +- ShipEngineSDK/Model/VoidLabelResponseBody.cs | 4 +- ShipEngineSDK/Model/WebhookHeader.cs | 4 +- ShipEngineSDK/Model/Weight.cs | 4 +- generation/templates/modelGeneric.mustache | 6 +- generation/templates/modelOneOf.mustache | 24 ++++-- 149 files changed, 854 insertions(+), 730 deletions(-) create mode 100644 ShipEngineSDK/CompilerSupport/CompilerFeatureRequiredAttribute.cs create mode 100644 ShipEngineSDK/CompilerSupport/IsExternalInit.cs rename ShipEngineSDK/{ => CompilerSupport}/NotNullIfNotNullAttribute.cs (100%) create mode 100644 ShipEngineSDK/CompilerSupport/RequiredMemberAttribute.cs create mode 100644 ShipEngineSDK/CompilerSupport/SetsRequiredMembersAttribute.cs diff --git a/ShipEngineSDK/CompilerSupport/CompilerFeatureRequiredAttribute.cs b/ShipEngineSDK/CompilerSupport/CompilerFeatureRequiredAttribute.cs new file mode 100644 index 00000000..5a6e87af --- /dev/null +++ b/ShipEngineSDK/CompilerSupport/CompilerFeatureRequiredAttribute.cs @@ -0,0 +1,33 @@ +namespace System.Runtime.CompilerServices; + +/// +/// Indicates that compiler support for a particular feature is required for the location where this attribute is applied. +/// +[AttributeUsage(AttributeTargets.All, AllowMultiple = true, Inherited = false)] +public sealed class CompilerFeatureRequiredAttribute : Attribute +{ + public CompilerFeatureRequiredAttribute(string featureName) + { + FeatureName = featureName; + } + + /// + /// The name of the compiler feature. + /// + public string FeatureName { get; } + + /// + /// If true, the compiler can choose to allow access to the location where this attribute is applied if it does not understand . + /// + public bool IsOptional { get; init; } + + /// + /// The used for the ref structs C# feature. + /// + public const string RefStructs = nameof(RefStructs); + + /// + /// The used for the required members C# feature. + /// + public const string RequiredMembers = nameof(RequiredMembers); +} \ No newline at end of file diff --git a/ShipEngineSDK/CompilerSupport/IsExternalInit.cs b/ShipEngineSDK/CompilerSupport/IsExternalInit.cs new file mode 100644 index 00000000..e1ef35e8 --- /dev/null +++ b/ShipEngineSDK/CompilerSupport/IsExternalInit.cs @@ -0,0 +1,10 @@ +using System.ComponentModel; + +namespace System.Runtime.CompilerServices +{ + [EditorBrowsable(EditorBrowsableState.Never)] + internal class IsExternalInit + { + + } +} \ No newline at end of file diff --git a/ShipEngineSDK/NotNullIfNotNullAttribute.cs b/ShipEngineSDK/CompilerSupport/NotNullIfNotNullAttribute.cs similarity index 100% rename from ShipEngineSDK/NotNullIfNotNullAttribute.cs rename to ShipEngineSDK/CompilerSupport/NotNullIfNotNullAttribute.cs diff --git a/ShipEngineSDK/CompilerSupport/RequiredMemberAttribute.cs b/ShipEngineSDK/CompilerSupport/RequiredMemberAttribute.cs new file mode 100644 index 00000000..5fd5fe4c --- /dev/null +++ b/ShipEngineSDK/CompilerSupport/RequiredMemberAttribute.cs @@ -0,0 +1,13 @@ +namespace System.Runtime.CompilerServices; + +/// Specifies that a type has required members or that a member is required. +[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Field | AttributeTargets.Property, AllowMultiple = false, Inherited = false)] +#if SYSTEM_PRIVATE_CORELIB + public +#else +internal +#endif + sealed class RequiredMemberAttribute : Attribute +{ + +} \ No newline at end of file diff --git a/ShipEngineSDK/CompilerSupport/SetsRequiredMembersAttribute.cs b/ShipEngineSDK/CompilerSupport/SetsRequiredMembersAttribute.cs new file mode 100644 index 00000000..e22cd407 --- /dev/null +++ b/ShipEngineSDK/CompilerSupport/SetsRequiredMembersAttribute.cs @@ -0,0 +1,16 @@ +namespace System.Diagnostics.CodeAnalysis; + +/// +/// Specifies that this constructor sets all required members for the current type, and callers +/// do not need to set any required members themselves. +/// +[AttributeUsage(AttributeTargets.Constructor, AllowMultiple = false, Inherited = false)] +#if SYSTEM_PRIVATE_CORELIB + public +#else +internal +#endif + sealed class SetsRequiredMembersAttribute : Attribute +{ + +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs b/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs index 6051dcad..bbcc1658 100644 --- a/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs +++ b/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs @@ -34,7 +34,7 @@ public partial class AddFundsToCarrierRequestBody /// The monetary amount, in the specified currency. [JsonPropertyName("amount")] [JsonRequired] - public double Amount { get; set; } + public required double Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html @@ -42,7 +42,7 @@ public partial class AddFundsToCarrierRequestBody /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html [JsonPropertyName("currency")] [JsonRequired] - public string Currency { get; set; } + public required string Currency { get; set; } /// diff --git a/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs b/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs index fc888a37..489a5166 100644 --- a/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs +++ b/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs @@ -34,7 +34,7 @@ public partial class AddFundsToCarrierResponseBody /// The current balance of the account [JsonPropertyName("balance")] [JsonRequired] - public MonetaryValue Balance { get; set; } + public required MonetaryValue Balance { get; set; } /// diff --git a/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs b/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs index e06cbfc4..fc84287f 100644 --- a/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs +++ b/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs @@ -34,7 +34,7 @@ public partial class AddFundsToInsuranceRequestBody /// The monetary amount, in the specified currency. [JsonPropertyName("amount")] [JsonRequired] - public double Amount { get; set; } + public required double Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html @@ -42,7 +42,7 @@ public partial class AddFundsToInsuranceRequestBody /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html [JsonPropertyName("currency")] [JsonRequired] - public string Currency { get; set; } + public required string Currency { get; set; } /// diff --git a/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs b/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs index 0c7e0287..710b73e6 100644 --- a/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs +++ b/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs @@ -34,7 +34,7 @@ public partial class AddFundsToInsuranceResponseBody /// The monetary amount, in the specified currency. [JsonPropertyName("amount")] [JsonRequired] - public double Amount { get; set; } + public required double Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html @@ -42,7 +42,7 @@ public partial class AddFundsToInsuranceResponseBody /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html [JsonPropertyName("currency")] [JsonRequired] - public string Currency { get; set; } + public required string Currency { get; set; } /// diff --git a/ShipEngineSDK/Model/Address.cs b/ShipEngineSDK/Model/Address.cs index 491391dd..70573108 100644 --- a/ShipEngineSDK/Model/Address.cs +++ b/ShipEngineSDK/Model/Address.cs @@ -34,7 +34,7 @@ public partial class Address /// Indicates whether this is a residential address. [JsonPropertyName("address_residential_indicator")] [JsonRequired] - public AddressResidentialIndicator AddressResidentialIndicator { get; set; } = new(); + public required AddressResidentialIndicator AddressResidentialIndicator { get; set; } = new(); /// @@ -46,7 +46,7 @@ public partial class Address /// [JsonPropertyName("address_line1")] [JsonRequired] - public string AddressLine1 { get; set; } + public required string AddressLine1 { get; set; } /// /// The name of the city or locality @@ -57,7 +57,7 @@ public partial class Address /// [JsonPropertyName("city_locality")] [JsonRequired] - public string CityLocality { get; set; } + public required string CityLocality { get; set; } /// /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) @@ -68,7 +68,7 @@ public partial class Address /// [JsonPropertyName("country_code")] [JsonRequired] - public string CountryCode { get; set; } + public required string CountryCode { get; set; } /// /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. @@ -79,7 +79,7 @@ public partial class Address /// [JsonPropertyName("name")] [JsonRequired] - public string Name { get; set; } + public required string Name { get; set; } /// /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. @@ -90,7 +90,7 @@ public partial class Address /// [JsonPropertyName("phone")] [JsonRequired] - public string Phone { get; set; } + public required string Phone { get; set; } /// /// postal code @@ -101,7 +101,7 @@ public partial class Address /// [JsonPropertyName("postal_code")] [JsonRequired] - public string PostalCode { get; set; } + public required string PostalCode { get; set; } /// /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. @@ -112,7 +112,7 @@ public partial class Address /// [JsonPropertyName("state_province")] [JsonRequired] - public string StateProvince { get; set; } + public required string StateProvince { get; set; } /// /// The second line of the street address. For some addresses, this line may not be needed. diff --git a/ShipEngineSDK/Model/AddressToValidate.cs b/ShipEngineSDK/Model/AddressToValidate.cs index c46779d6..1f63ecf1 100644 --- a/ShipEngineSDK/Model/AddressToValidate.cs +++ b/ShipEngineSDK/Model/AddressToValidate.cs @@ -43,7 +43,7 @@ public partial class AddressToValidate /// [JsonPropertyName("address_line1")] [JsonRequired] - public string AddressLine1 { get; set; } + public required string AddressLine1 { get; set; } /// /// The name of the city or locality @@ -54,7 +54,7 @@ public partial class AddressToValidate /// [JsonPropertyName("city_locality")] [JsonRequired] - public string CityLocality { get; set; } + public required string CityLocality { get; set; } /// /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) @@ -65,7 +65,7 @@ public partial class AddressToValidate /// [JsonPropertyName("country_code")] [JsonRequired] - public string CountryCode { get; set; } + public required string CountryCode { get; set; } /// /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. @@ -76,7 +76,7 @@ public partial class AddressToValidate /// [JsonPropertyName("state_province")] [JsonRequired] - public string StateProvince { get; set; } + public required string StateProvince { get; set; } /// /// The second line of the street address. For some addresses, this line may not be needed. diff --git a/ShipEngineSDK/Model/AddressValidatingShipment.cs b/ShipEngineSDK/Model/AddressValidatingShipment.cs index 0812f13d..6cd503d3 100644 --- a/ShipEngineSDK/Model/AddressValidatingShipment.cs +++ b/ShipEngineSDK/Model/AddressValidatingShipment.cs @@ -65,7 +65,7 @@ public partial class AddressValidatingShipment /// [JsonPropertyName("carrier_id")] [JsonRequired] - public string CarrierId { get; set; } + public required string CarrierId { get; set; } /// /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. @@ -76,7 +76,7 @@ public partial class AddressValidatingShipment /// [JsonPropertyName("service_code")] [JsonRequired] - public string ServiceCode { get; set; } + public required string ServiceCode { get; set; } /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. @@ -84,7 +84,7 @@ public partial class AddressValidatingShipment /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. [JsonPropertyName("ship_from")] [JsonRequired] - public ShippingAddress ShipFrom { get; set; } + public required ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address @@ -92,7 +92,7 @@ public partial class AddressValidatingShipment /// The recipient's mailing address [JsonPropertyName("ship_to")] [JsonRequired] - public ShippingAddressTo ShipTo { get; set; } + public required ShippingAddressTo ShipTo { get; set; } /// /// A string that uniquely identifies the shipment @@ -103,7 +103,7 @@ public partial class AddressValidatingShipment /// [JsonPropertyName("shipment_id")] [JsonRequired] - public string ShipmentId { get; set; } + public required string ShipmentId { get; set; } /// /// Advanced shipment options. These are entirely optional. diff --git a/ShipEngineSDK/Model/AddressValidationResult.cs b/ShipEngineSDK/Model/AddressValidationResult.cs index 223b9ccc..64494c4c 100644 --- a/ShipEngineSDK/Model/AddressValidationResult.cs +++ b/ShipEngineSDK/Model/AddressValidationResult.cs @@ -33,7 +33,7 @@ public partial class AddressValidationResult /// [JsonPropertyName("status")] [JsonRequired] - public AddressValidationStatus Status { get; set; } = new(); + public required AddressValidationStatus Status { get; set; } = new(); /// @@ -42,7 +42,7 @@ public partial class AddressValidationResult /// The list of messages that were generated during the address validation request. [JsonPropertyName("messages")] [JsonRequired] - public List Messages { get; set; } + public required List Messages { get; set; } /// /// The original address that was sent for validation @@ -50,7 +50,7 @@ public partial class AddressValidationResult /// The original address that was sent for validation [JsonPropertyName("original_address")] [JsonRequired] - public Address OriginalAddress { get; set; } + public required Address OriginalAddress { get; set; } /// /// The matched address found by the Shipengine API @@ -58,7 +58,7 @@ public partial class AddressValidationResult /// The matched address found by the Shipengine API [JsonPropertyName("matched_address")] [JsonRequired] - public Address MatchedAddress { get; set; } + public required Address MatchedAddress { get; set; } /// diff --git a/ShipEngineSDK/Model/Batch.cs b/ShipEngineSDK/Model/Batch.cs index a0ecc41b..91485727 100644 --- a/ShipEngineSDK/Model/Batch.cs +++ b/ShipEngineSDK/Model/Batch.cs @@ -33,7 +33,7 @@ public partial class Batch /// [JsonPropertyName("label_format")] [JsonRequired] - public LabelFormat LabelFormat { get; set; } = new(); + public required LabelFormat LabelFormat { get; set; } = new(); /// @@ -42,7 +42,7 @@ public partial class Batch /// label layout [JsonPropertyName("label_layout")] [JsonRequired] - public LabelLayout LabelLayout { get; set; } = new(); + public required LabelLayout LabelLayout { get; set; } = new(); /// @@ -50,7 +50,7 @@ public partial class Batch /// [JsonPropertyName("status")] [JsonRequired] - public BatchStatus Status { get; set; } = new(); + public required BatchStatus Status { get; set; } = new(); /// @@ -59,7 +59,7 @@ public partial class Batch /// Link to batch errors endpoint [JsonPropertyName("batch_errors_url")] [JsonRequired] - public OptionalLink BatchErrorsUrl { get; set; } + public required OptionalLink BatchErrorsUrl { get; set; } /// /// A string that uniquely identifies the batch @@ -70,7 +70,7 @@ public partial class Batch /// [JsonPropertyName("batch_id")] [JsonRequired] - public string BatchId { get; set; } + public required string BatchId { get; set; } /// /// Link to batch labels query @@ -78,7 +78,7 @@ public partial class Batch /// Link to batch labels query [JsonPropertyName("batch_labels_url")] [JsonRequired] - public OptionalLink BatchLabelsUrl { get; set; } + public required OptionalLink BatchLabelsUrl { get; set; } /// /// The batch number. @@ -86,7 +86,7 @@ public partial class Batch /// The batch number. [JsonPropertyName("batch_number")] [JsonRequired] - public string BatchNumber { get; set; } + public required string BatchNumber { get; set; } /// /// The batch shipments endpoint @@ -94,7 +94,7 @@ public partial class Batch /// The batch shipments endpoint [JsonPropertyName("batch_shipments_url")] [JsonRequired] - public OptionalLink BatchShipmentsUrl { get; set; } + public required OptionalLink BatchShipmentsUrl { get; set; } /// /// The number of labels generated in the batch @@ -105,7 +105,7 @@ public partial class Batch /// [JsonPropertyName("completed")] [JsonRequired] - public int Completed { get; set; } + public required int Completed { get; set; } /// /// The total of errors, warnings, and completed properties @@ -116,7 +116,7 @@ public partial class Batch /// [JsonPropertyName("count")] [JsonRequired] - public int Count { get; set; } + public required int Count { get; set; } /// /// The date and time the batch was created in ShipEngine @@ -127,7 +127,7 @@ public partial class Batch /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public required DateTimeOffset CreatedAt { get; set; } /// /// The number of errors that occurred while generating the batch @@ -138,7 +138,7 @@ public partial class Batch /// [JsonPropertyName("errors")] [JsonRequired] - public int Errors { get; set; } + public required int Errors { get; set; } /// /// The form download for any customs that are needed @@ -146,7 +146,7 @@ public partial class Batch /// The form download for any customs that are needed [JsonPropertyName("form_download")] [JsonRequired] - public OptionalLink FormDownload { get; set; } + public required OptionalLink FormDownload { get; set; } /// /// The number of forms for customs that are available for download @@ -157,7 +157,7 @@ public partial class Batch /// [JsonPropertyName("forms")] [JsonRequired] - public int Forms { get; set; } + public required int Forms { get; set; } /// /// The label download for the batch @@ -165,7 +165,7 @@ public partial class Batch /// The label download for the batch [JsonPropertyName("label_download")] [JsonRequired] - public LabelDownload LabelDownload { get; set; } + public required LabelDownload LabelDownload { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. @@ -173,7 +173,7 @@ public partial class Batch /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. [JsonPropertyName("paperless_download")] [JsonRequired] - public PaperlessDownload PaperlessDownload { get; set; } + public required PaperlessDownload PaperlessDownload { get; set; } /// /// The errors associated with the failed API call @@ -181,7 +181,7 @@ public partial class Batch /// The errors associated with the failed API call [JsonPropertyName("process_errors")] [JsonRequired] - public List ProcessErrors { get; set; } + public required List ProcessErrors { get; set; } /// /// The number of warnings that occurred while generating the batch @@ -192,7 +192,7 @@ public partial class Batch /// [JsonPropertyName("warnings")] [JsonRequired] - public int Warnings { get; set; } + public required int Warnings { get; set; } /// /// Custom notes you can add for each created batch @@ -203,7 +203,7 @@ public partial class Batch /// [JsonPropertyName("batch_notes")] [JsonRequired] - public string BatchNotes { get; set; } + public required string BatchNotes { get; set; } /// /// A string that uniquely identifies the external batch @@ -211,7 +211,7 @@ public partial class Batch /// A string that uniquely identifies the external batch [JsonPropertyName("external_batch_id")] [JsonRequired] - public string ExternalBatchId { get; set; } + public required string ExternalBatchId { get; set; } /// /// The date and time the batch was processed in ShipEngine @@ -222,7 +222,7 @@ public partial class Batch /// [JsonPropertyName("processed_at")] [JsonRequired] - public DateTimeOffset ProcessedAt { get; set; } + public required DateTimeOffset ProcessedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/BulkRate.cs b/ShipEngineSDK/Model/BulkRate.cs index c7afbbaa..8318941b 100644 --- a/ShipEngineSDK/Model/BulkRate.cs +++ b/ShipEngineSDK/Model/BulkRate.cs @@ -33,7 +33,7 @@ public partial class BulkRate /// [JsonPropertyName("status")] [JsonRequired] - public RateResponseStatus Status { get; set; } = new(); + public required RateResponseStatus Status { get; set; } = new(); /// @@ -45,7 +45,7 @@ public partial class BulkRate /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public required DateTimeOffset CreatedAt { get; set; } /// /// An array of errors that were returned while retrieving the bulk rate @@ -53,7 +53,7 @@ public partial class BulkRate /// An array of errors that were returned while retrieving the bulk rate [JsonPropertyName("errors")] [JsonRequired] - public List Errors { get; set; } + public required List Errors { get; set; } /// /// A string that uniquely identifies the rate request @@ -64,7 +64,7 @@ public partial class BulkRate /// [JsonPropertyName("rate_request_id")] [JsonRequired] - public string RateRequestId { get; set; } + public required string RateRequestId { get; set; } /// /// A string that uniquely identifies the shipment @@ -75,7 +75,7 @@ public partial class BulkRate /// [JsonPropertyName("shipment_id")] [JsonRequired] - public string ShipmentId { get; set; } + public required string ShipmentId { get; set; } /// diff --git a/ShipEngineSDK/Model/CalculateRatesRequestBody.cs b/ShipEngineSDK/Model/CalculateRatesRequestBody.cs index a513a3f2..ef5f9fb0 100644 --- a/ShipEngineSDK/Model/CalculateRatesRequestBody.cs +++ b/ShipEngineSDK/Model/CalculateRatesRequestBody.cs @@ -215,12 +215,18 @@ public override void Write(Utf8JsonWriter writer, CalculateRatesRequestBody valu var jsonDoc = JsonDocument.ParseValue(ref reader); CalculateRatesRequestBody? newCalculateRatesRequestBody = null; + // Deserialize all the common properties of the model so they can be used in object initializers later + var rateOptions = jsonDoc.RootElement.GetProperty("rate_options").Deserialize(DeserializingOptions)!; + int match = 0; var matchedTypes = new List(); try { - newCalculateRatesRequestBody = new CalculateRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); + newCalculateRatesRequestBody = new CalculateRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!) + { + RateOptions = rateOptions, + }; matchedTypes.Add("ShipmentIdRequest"); match++; @@ -233,7 +239,10 @@ public override void Write(Utf8JsonWriter writer, CalculateRatesRequestBody valu try { - newCalculateRatesRequestBody = new CalculateRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); + newCalculateRatesRequestBody = new CalculateRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!) + { + RateOptions = rateOptions, + }; matchedTypes.Add("ShipmentRequest"); match++; @@ -254,8 +263,6 @@ public override void Write(Utf8JsonWriter writer, CalculateRatesRequestBody valu throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); } - newCalculateRatesRequestBody!.RateOptions = jsonDoc.RootElement.GetProperty("rate_options").Deserialize(DeserializingOptions)!; - // deserialization is considered successful at this point if no exception has been thrown. return newCalculateRatesRequestBody; } diff --git a/ShipEngineSDK/Model/CalculateRatesResponseBody.cs b/ShipEngineSDK/Model/CalculateRatesResponseBody.cs index 97f0b880..fbae3380 100644 --- a/ShipEngineSDK/Model/CalculateRatesResponseBody.cs +++ b/ShipEngineSDK/Model/CalculateRatesResponseBody.cs @@ -34,7 +34,7 @@ public partial class CalculateRatesResponseBody /// The type of delivery confirmation that is required for this shipment. [JsonPropertyName("confirmation")] [JsonRequired] - public DeliveryConfirmation Confirmation { get; set; } = new(); + public required DeliveryConfirmation Confirmation { get; set; } = new(); /// @@ -43,7 +43,7 @@ public partial class CalculateRatesResponseBody /// The insurance provider to use for any insured packages in the shipment. [JsonPropertyName("insurance_provider")] [JsonRequired] - public InsuranceProvider InsuranceProvider { get; set; } = new(); + public required InsuranceProvider InsuranceProvider { get; set; } = new(); /// @@ -52,7 +52,7 @@ public partial class CalculateRatesResponseBody /// The current status of the shipment [JsonPropertyName("shipment_status")] [JsonRequired] - public ShipmentStatus ShipmentStatus { get; set; } = new(); + public required ShipmentStatus ShipmentStatus { get; set; } = new(); /// @@ -66,7 +66,7 @@ public partial class CalculateRatesResponseBody /// Advanced shipment options. These are entirely optional. [JsonPropertyName("advanced_options")] [JsonRequired] - public AdvancedShipmentOptions AdvancedOptions { get; set; } + public required AdvancedShipmentOptions AdvancedOptions { get; set; } /// /// The date and time that the shipment was created in ShipEngine. @@ -77,7 +77,7 @@ public partial class CalculateRatesResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public required DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the shipment was created or last modified. @@ -88,7 +88,7 @@ public partial class CalculateRatesResponseBody /// [JsonPropertyName("modified_at")] [JsonRequired] - public DateTimeOffset ModifiedAt { get; set; } + public required DateTimeOffset ModifiedAt { get; set; } /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. @@ -96,7 +96,7 @@ public partial class CalculateRatesResponseBody /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. [JsonPropertyName("packages")] [JsonRequired] - public List Packages { get; set; } + public required List Packages { get; set; } /// /// The rates response @@ -104,7 +104,7 @@ public partial class CalculateRatesResponseBody /// The rates response [JsonPropertyName("rate_response")] [JsonRequired] - public RatesInformation RateResponse { get; set; } + public required RatesInformation RateResponse { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. @@ -112,7 +112,7 @@ public partial class CalculateRatesResponseBody /// The return address for this shipment. Defaults to the `ship_from` address. [JsonPropertyName("return_to")] [JsonRequired] - public ShippingAddress ReturnTo { get; set; } + public required ShippingAddress ReturnTo { get; set; } /// /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -123,7 +123,7 @@ public partial class CalculateRatesResponseBody /// [JsonPropertyName("ship_date")] [JsonRequired] - public DateTimeOffset ShipDate { get; set; } + public required DateTimeOffset ShipDate { get; set; } /// /// A string that uniquely identifies the shipment @@ -134,7 +134,7 @@ public partial class CalculateRatesResponseBody /// [JsonPropertyName("shipment_id")] [JsonRequired] - public string ShipmentId { get; set; } + public required string ShipmentId { get; set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. @@ -142,7 +142,7 @@ public partial class CalculateRatesResponseBody /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. [JsonPropertyName("tags")] [JsonRequired] - public List Tags { get; set; } + public required List Tags { get; set; } /// /// The combined weight of all packages in the shipment @@ -150,7 +150,7 @@ public partial class CalculateRatesResponseBody /// The combined weight of all packages in the shipment [JsonPropertyName("total_weight")] [JsonRequired] - public Weight TotalWeight { get; set; } + public required Weight TotalWeight { get; set; } /// /// The carrier account that is billed for the shipping charges @@ -178,7 +178,7 @@ public partial class CalculateRatesResponseBody /// Customs information. This is usually only needed for international shipments. [JsonPropertyName("customs")] [JsonRequired] - public InternationalShipmentOptions Customs { get; set; } + public required InternationalShipmentOptions Customs { get; set; } /// /// ID that the Order Source assigned diff --git a/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs b/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs index eb431c56..1c0cf78d 100644 --- a/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs +++ b/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs @@ -37,7 +37,7 @@ public partial class CompareBulkRatesRequestBody : AbstractOpenAPISchema /// The rate options [JsonPropertyName("rate_options")] [JsonRequired] - public RateRequestBody RateOptions { get; set; } + public required RateRequestBody RateOptions { get; set; } /// @@ -216,12 +216,18 @@ public override void Write(Utf8JsonWriter writer, CompareBulkRatesRequestBody va var jsonDoc = JsonDocument.ParseValue(ref reader); CompareBulkRatesRequestBody? newCompareBulkRatesRequestBody = null; + // Deserialize all the common properties of the model so they can be used in object initializers later + var rateOptions = jsonDoc.RootElement.GetProperty("rate_options").Deserialize(DeserializingOptions)!; + int match = 0; var matchedTypes = new List(); try { - newCompareBulkRatesRequestBody = new CompareBulkRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); + newCompareBulkRatesRequestBody = new CompareBulkRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!) + { + RateOptions = rateOptions, + }; matchedTypes.Add("RateRequestByShipmentIds"); match++; @@ -234,7 +240,10 @@ public override void Write(Utf8JsonWriter writer, CompareBulkRatesRequestBody va try { - newCompareBulkRatesRequestBody = new CompareBulkRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); + newCompareBulkRatesRequestBody = new CompareBulkRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!) + { + RateOptions = rateOptions, + }; matchedTypes.Add("RateRequestByShipments"); match++; @@ -250,13 +259,12 @@ public override void Write(Utf8JsonWriter writer, CompareBulkRatesRequestBody va throw new InvalidDataException("The JSON string `" + jsonDoc + "` cannot be deserialized into any schema defined."); } + if (match > 1) { throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); } - newCompareBulkRatesRequestBody!.RateOptions = jsonDoc.RootElement.GetProperty("rate_options").Deserialize(DeserializingOptions)!; - // deserialization is considered successful at this point if no exception has been thrown. return newCompareBulkRatesRequestBody; } diff --git a/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs b/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs index a829f414..ed3c9814 100644 --- a/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs @@ -37,7 +37,7 @@ public partial class ConnectAccessWorldwideRequestBody /// [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// /// Access Worldwide Password @@ -45,7 +45,7 @@ public partial class ConnectAccessWorldwideRequestBody /// Access Worldwide Password [JsonPropertyName("password")] [JsonRequired] - public string Password { get; set; } + public required string Password { get; set; } /// /// Access Worldwide Username @@ -53,7 +53,7 @@ public partial class ConnectAccessWorldwideRequestBody /// Access Worldwide Username [JsonPropertyName("username")] [JsonRequired] - public string Username { get; set; } + public required string Username { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs b/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs index d9bd39ba..6952f75b 100644 --- a/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs @@ -37,21 +37,21 @@ public partial class ConnectAmazonBuyShippingRequestBody /// [JsonPropertyName("email")] [JsonRequired] - public string Email { get; set; } + public required string Email { get; set; } /// /// Gets or Sets MerchantSellerId /// [JsonPropertyName("merchant_seller_id")] [JsonRequired] - public string MerchantSellerId { get; set; } + public required string MerchantSellerId { get; set; } /// /// Gets or Sets MwsAuthToken /// [JsonPropertyName("mws_auth_token")] [JsonRequired] - public string MwsAuthToken { get; set; } + public required string MwsAuthToken { get; set; } /// /// Nickname to be associated with the account connection @@ -62,7 +62,7 @@ public partial class ConnectAmazonBuyShippingRequestBody /// [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs b/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs index bcde3d67..e1ad102e 100644 --- a/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs +++ b/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs @@ -34,7 +34,7 @@ public partial class ConnectAmazonShippingUk /// Amazon UK Shipping auth code. [JsonPropertyName("auth_code")] [JsonRequired] - public string AuthCode { get; set; } + public required string AuthCode { get; set; } /// /// The nickname associated with the carrier connection @@ -45,7 +45,7 @@ public partial class ConnectAmazonShippingUk /// [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectApcRequestBody.cs b/ShipEngineSDK/Model/ConnectApcRequestBody.cs index 1750efb2..2338f1de 100644 --- a/ShipEngineSDK/Model/ConnectApcRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectApcRequestBody.cs @@ -37,7 +37,7 @@ public partial class ConnectApcRequestBody /// [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// /// The password for the APC account @@ -48,7 +48,7 @@ public partial class ConnectApcRequestBody /// [JsonPropertyName("password")] [JsonRequired] - public string Password { get; set; } + public required string Password { get; set; } /// /// The username for the APC account @@ -59,7 +59,7 @@ public partial class ConnectApcRequestBody /// [JsonPropertyName("username")] [JsonRequired] - public string Username { get; set; } + public required string Username { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs b/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs index f5b29708..4e6df419 100644 --- a/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectAsendiaRequestBody /// Asendia account number [JsonPropertyName("account_number")] [JsonRequired] - public string AccountNumber { get; set; } + public required string AccountNumber { get; set; } /// /// FTP password @@ -42,7 +42,7 @@ public partial class ConnectAsendiaRequestBody /// FTP password [JsonPropertyName("ftp_password")] [JsonRequired] - public string FtpPassword { get; set; } + public required string FtpPassword { get; set; } /// /// FTP username @@ -50,7 +50,7 @@ public partial class ConnectAsendiaRequestBody /// FTP username [JsonPropertyName("ftp_username")] [JsonRequired] - public string FtpUsername { get; set; } + public required string FtpUsername { get; set; } /// /// The nickname of the Asendia account @@ -61,7 +61,7 @@ public partial class ConnectAsendiaRequestBody /// [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs b/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs index 197549ac..2484a496 100644 --- a/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectAustraliaPostRequestBody /// Account number [JsonPropertyName("account_number")] [JsonRequired] - public string AccountNumber { get; set; } + public required string AccountNumber { get; set; } /// /// API key @@ -42,7 +42,7 @@ public partial class ConnectAustraliaPostRequestBody /// API key [JsonPropertyName("api_key")] [JsonRequired] - public string ApiKey { get; set; } + public required string ApiKey { get; set; } /// /// API secret @@ -50,7 +50,7 @@ public partial class ConnectAustraliaPostRequestBody /// API secret [JsonPropertyName("api_secret")] [JsonRequired] - public string ApiSecret { get; set; } + public required string ApiSecret { get; set; } /// /// Nickname @@ -58,7 +58,7 @@ public partial class ConnectAustraliaPostRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs b/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs index f4dc55fd..c19bee6e 100644 --- a/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectCanadaPostRequestBody /// Canada Post Account Number [JsonPropertyName("account_number")] [JsonRequired] - public string AccountNumber { get; set; } + public required string AccountNumber { get; set; } /// /// Canada Post Account API Key @@ -42,7 +42,7 @@ public partial class ConnectCanadaPostRequestBody /// Canada Post Account API Key [JsonPropertyName("api_key")] [JsonRequired] - public string ApiKey { get; set; } + public required string ApiKey { get; set; } /// /// Canada Post Account API Secret @@ -50,7 +50,7 @@ public partial class ConnectCanadaPostRequestBody /// Canada Post Account API Secret [JsonPropertyName("api_secret")] [JsonRequired] - public string ApiSecret { get; set; } + public required string ApiSecret { get; set; } /// /// Canada Post Account Contract ID @@ -58,7 +58,7 @@ public partial class ConnectCanadaPostRequestBody /// Canada Post Account Contract ID [JsonPropertyName("contract_id")] [JsonRequired] - public string ContractId { get; set; } + public required string ContractId { get; set; } /// /// Nickname @@ -66,7 +66,7 @@ public partial class ConnectCanadaPostRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs b/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs index 94af5d4b..093fd961 100644 --- a/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs @@ -854,6 +854,7 @@ public override void Write(Utf8JsonWriter writer, ConnectCarrierRequestBody valu var jsonDoc = JsonDocument.ParseValue(ref reader); ConnectCarrierRequestBody? newConnectCarrierRequestBody = null; + int match = 0; var matchedTypes = new List(); @@ -1231,7 +1232,6 @@ public override void Write(Utf8JsonWriter writer, ConnectCarrierRequestBody valu throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); } - // deserialization is considered successful at this point if no exception has been thrown. return newConnectCarrierRequestBody; } diff --git a/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs b/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs index 96933418..54da24cf 100644 --- a/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs +++ b/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs @@ -37,7 +37,7 @@ public partial class ConnectCarrierResponseBody /// [JsonPropertyName("carrier_id")] [JsonRequired] - public string CarrierId { get; set; } + public required string CarrierId { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs index 8a6ef903..162b3c83 100644 --- a/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs @@ -39,7 +39,7 @@ public partial class ConnectDhlEcommerceRequestBody /// The client id [JsonPropertyName("client_id")] [JsonRequired] - public string ClientId { get; set; } + public required string ClientId { get; set; } /// /// The distribution center @@ -47,7 +47,7 @@ public partial class ConnectDhlEcommerceRequestBody /// The distribution center [JsonPropertyName("distribution_center")] [JsonRequired] - public string DistributionCenter { get; set; } + public required string DistributionCenter { get; set; } /// /// A nickname to help you identify this account @@ -55,7 +55,7 @@ public partial class ConnectDhlEcommerceRequestBody /// A nickname to help you identify this account [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// /// The account password @@ -63,7 +63,7 @@ public partial class ConnectDhlEcommerceRequestBody /// The account password [JsonPropertyName("password")] [JsonRequired] - public string Password { get; set; } + public required string Password { get; set; } /// /// The pickup number @@ -71,7 +71,7 @@ public partial class ConnectDhlEcommerceRequestBody /// The pickup number [JsonPropertyName("pickup_number")] [JsonRequired] - public string PickupNumber { get; set; } + public required string PickupNumber { get; set; } /// /// The account username @@ -79,7 +79,7 @@ public partial class ConnectDhlEcommerceRequestBody /// The account username [JsonPropertyName("username")] [JsonRequired] - public string Username { get; set; } + public required string Username { get; set; } /// /// Account number diff --git a/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs index 9dbb0bdb..4c9f029c 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectDhlExpressAuRequestBody /// Account number [JsonPropertyName("account_number")] [JsonRequired] - public string AccountNumber { get; set; } + public required string AccountNumber { get; set; } /// /// Nickname @@ -42,7 +42,7 @@ public partial class ConnectDhlExpressAuRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs index 3c30f101..32b447f3 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectDhlExpressCaRequestBody /// Account number [JsonPropertyName("account_number")] [JsonRequired] - public string AccountNumber { get; set; } + public required string AccountNumber { get; set; } /// /// Nickname @@ -42,7 +42,7 @@ public partial class ConnectDhlExpressCaRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs index b2657d21..ce0820af 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectDhlExpressRequestBody /// Account number [JsonPropertyName("account_number")] [JsonRequired] - public string AccountNumber { get; set; } + public required string AccountNumber { get; set; } /// /// Nickname @@ -42,7 +42,7 @@ public partial class ConnectDhlExpressRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) diff --git a/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs index 9ec70e6b..edefd45a 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectDhlExpressUkRequestBody /// Account number [JsonPropertyName("account_number")] [JsonRequired] - public string AccountNumber { get; set; } + public required string AccountNumber { get; set; } /// /// Nickname @@ -42,7 +42,7 @@ public partial class ConnectDhlExpressUkRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// /// Password @@ -50,7 +50,7 @@ public partial class ConnectDhlExpressUkRequestBody /// Password [JsonPropertyName("password")] [JsonRequired] - public string Password { get; set; } + public required string Password { get; set; } /// /// A string that uniquely identifies the site @@ -61,7 +61,7 @@ public partial class ConnectDhlExpressUkRequestBody /// [JsonPropertyName("site_id")] [JsonRequired] - public string SiteId { get; set; } + public required string SiteId { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectDpdRequestBody.cs b/ShipEngineSDK/Model/ConnectDpdRequestBody.cs index 58a2f2fe..ae14627e 100644 --- a/ShipEngineSDK/Model/ConnectDpdRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDpdRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectDpdRequestBody /// Account number [JsonPropertyName("account_number")] [JsonRequired] - public string AccountNumber { get; set; } + public required string AccountNumber { get; set; } /// /// Nickname @@ -42,7 +42,7 @@ public partial class ConnectDpdRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// /// Password @@ -50,7 +50,7 @@ public partial class ConnectDpdRequestBody /// Password [JsonPropertyName("password")] [JsonRequired] - public string Password { get; set; } + public required string Password { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs b/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs index 34d86e1b..6e52b5b1 100644 --- a/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectEndiciaRequestBody /// Account [JsonPropertyName("account")] [JsonRequired] - public string Account { get; set; } + public required string Account { get; set; } /// /// Nickname @@ -42,7 +42,7 @@ public partial class ConnectEndiciaRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// /// Passphrase @@ -50,7 +50,7 @@ public partial class ConnectEndiciaRequestBody /// Passphrase [JsonPropertyName("passphrase")] [JsonRequired] - public string Passphrase { get; set; } + public required string Passphrase { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectFedexRequestBody.cs b/ShipEngineSDK/Model/ConnectFedexRequestBody.cs index f640474c..2d5a8ff5 100644 --- a/ShipEngineSDK/Model/ConnectFedexRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectFedexRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectFedexRequestBody /// Account number [JsonPropertyName("account_number")] [JsonRequired] - public string AccountNumber { get; set; } + public required string AccountNumber { get; set; } /// /// Address @@ -42,7 +42,7 @@ public partial class ConnectFedexRequestBody /// Address [JsonPropertyName("address1")] [JsonRequired] - public string Address1 { get; set; } + public required string Address1 { get; set; } /// /// Boolean signaling agreement to the Fedex End User License Agreement @@ -50,7 +50,7 @@ public partial class ConnectFedexRequestBody /// Boolean signaling agreement to the Fedex End User License Agreement [JsonPropertyName("agree_to_eula")] [JsonRequired] - public bool AgreeToEula { get; set; } + public required bool AgreeToEula { get; set; } /// /// The city @@ -58,7 +58,7 @@ public partial class ConnectFedexRequestBody /// The city [JsonPropertyName("city")] [JsonRequired] - public string City { get; set; } + public required string City { get; set; } /// /// Country code @@ -66,7 +66,7 @@ public partial class ConnectFedexRequestBody /// Country code [JsonPropertyName("country_code")] [JsonRequired] - public string CountryCode { get; set; } + public required string CountryCode { get; set; } /// /// The email address @@ -77,7 +77,7 @@ public partial class ConnectFedexRequestBody /// [JsonPropertyName("email")] [JsonRequired] - public string Email { get; set; } + public required string Email { get; set; } /// /// First name @@ -85,7 +85,7 @@ public partial class ConnectFedexRequestBody /// First name [JsonPropertyName("first_name")] [JsonRequired] - public string FirstName { get; set; } + public required string FirstName { get; set; } /// /// Last name @@ -93,7 +93,7 @@ public partial class ConnectFedexRequestBody /// Last name [JsonPropertyName("last_name")] [JsonRequired] - public string LastName { get; set; } + public required string LastName { get; set; } /// /// Nickname @@ -101,7 +101,7 @@ public partial class ConnectFedexRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// /// Phone number @@ -109,7 +109,7 @@ public partial class ConnectFedexRequestBody /// Phone number [JsonPropertyName("phone")] [JsonRequired] - public string Phone { get; set; } + public required string Phone { get; set; } /// /// Postal Code @@ -117,7 +117,7 @@ public partial class ConnectFedexRequestBody /// Postal Code [JsonPropertyName("postal_code")] [JsonRequired] - public string PostalCode { get; set; } + public required string PostalCode { get; set; } /// /// State @@ -125,7 +125,7 @@ public partial class ConnectFedexRequestBody /// State [JsonPropertyName("state")] [JsonRequired] - public string State { get; set; } + public required string State { get; set; } /// /// Address diff --git a/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs b/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs index c0facadc..e45beada 100644 --- a/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectFedexUkRequestBody /// Account number [JsonPropertyName("account_number")] [JsonRequired] - public string AccountNumber { get; set; } + public required string AccountNumber { get; set; } /// /// Address @@ -42,7 +42,7 @@ public partial class ConnectFedexUkRequestBody /// Address [JsonPropertyName("address1")] [JsonRequired] - public string Address1 { get; set; } + public required string Address1 { get; set; } /// /// Boolean signaling agreement to the Fedex End User License Agreement @@ -50,7 +50,7 @@ public partial class ConnectFedexUkRequestBody /// Boolean signaling agreement to the Fedex End User License Agreement [JsonPropertyName("agree_to_eula")] [JsonRequired] - public bool AgreeToEula { get; set; } + public required bool AgreeToEula { get; set; } /// /// The city @@ -58,7 +58,7 @@ public partial class ConnectFedexUkRequestBody /// The city [JsonPropertyName("city")] [JsonRequired] - public string City { get; set; } + public required string City { get; set; } /// /// Country code @@ -66,7 +66,7 @@ public partial class ConnectFedexUkRequestBody /// Country code [JsonPropertyName("country_code")] [JsonRequired] - public string CountryCode { get; set; } + public required string CountryCode { get; set; } /// /// The email address @@ -77,7 +77,7 @@ public partial class ConnectFedexUkRequestBody /// [JsonPropertyName("email")] [JsonRequired] - public string Email { get; set; } + public required string Email { get; set; } /// /// First name @@ -85,7 +85,7 @@ public partial class ConnectFedexUkRequestBody /// First name [JsonPropertyName("first_name")] [JsonRequired] - public string FirstName { get; set; } + public required string FirstName { get; set; } /// /// Last name @@ -93,7 +93,7 @@ public partial class ConnectFedexUkRequestBody /// Last name [JsonPropertyName("last_name")] [JsonRequired] - public string LastName { get; set; } + public required string LastName { get; set; } /// /// Nickname @@ -101,7 +101,7 @@ public partial class ConnectFedexUkRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// /// Phone number @@ -109,7 +109,7 @@ public partial class ConnectFedexUkRequestBody /// Phone number [JsonPropertyName("phone")] [JsonRequired] - public string Phone { get; set; } + public required string Phone { get; set; } /// /// Postal Code @@ -117,7 +117,7 @@ public partial class ConnectFedexUkRequestBody /// Postal Code [JsonPropertyName("postal_code")] [JsonRequired] - public string PostalCode { get; set; } + public required string PostalCode { get; set; } /// /// State @@ -125,7 +125,7 @@ public partial class ConnectFedexUkRequestBody /// State [JsonPropertyName("state")] [JsonRequired] - public string State { get; set; } + public required string State { get; set; } /// /// Address diff --git a/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs b/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs index 61703c38..52e9704a 100644 --- a/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs @@ -37,7 +37,7 @@ public partial class ConnectFirstmileRequestBody /// [JsonPropertyName("mailer_id")] [JsonRequired] - public string MailerId { get; set; } + public required string MailerId { get; set; } /// /// Nickname @@ -45,7 +45,7 @@ public partial class ConnectFirstmileRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// /// Password @@ -53,7 +53,7 @@ public partial class ConnectFirstmileRequestBody /// Password [JsonPropertyName("password")] [JsonRequired] - public string Password { get; set; } + public required string Password { get; set; } /// /// Profile name diff --git a/ShipEngineSDK/Model/ConnectImexRequestBody.cs b/ShipEngineSDK/Model/ConnectImexRequestBody.cs index 1dc72dd8..c8399f51 100644 --- a/ShipEngineSDK/Model/ConnectImexRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectImexRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectImexRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// /// Password @@ -42,7 +42,7 @@ public partial class ConnectImexRequestBody /// Password [JsonPropertyName("password")] [JsonRequired] - public string Password { get; set; } + public required string Password { get; set; } /// /// Username @@ -50,7 +50,7 @@ public partial class ConnectImexRequestBody /// Username [JsonPropertyName("username")] [JsonRequired] - public string Username { get; set; } + public required string Username { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs b/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs index 5f7bb2fd..31ec8aa0 100644 --- a/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs @@ -37,14 +37,14 @@ public partial class ConnectInsurerRequestBody /// [JsonPropertyName("email")] [JsonRequired] - public string Email { get; set; } + public required string Email { get; set; } /// /// Gets or Sets PolicyId /// [JsonPropertyName("policy_id")] [JsonRequired] - public string PolicyId { get; set; } + public required string PolicyId { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs b/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs index ed7e7d12..077d3dce 100644 --- a/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectLasershipRequestBody /// Address [JsonPropertyName("Address")] [JsonRequired] - public string Address { get; set; } + public required string Address { get; set; } /// /// City @@ -42,7 +42,7 @@ public partial class ConnectLasershipRequestBody /// City [JsonPropertyName("City")] [JsonRequired] - public string City { get; set; } + public required string City { get; set; } /// /// Customer Branch @@ -50,7 +50,7 @@ public partial class ConnectLasershipRequestBody /// Customer Branch [JsonPropertyName("customer_branch")] [JsonRequired] - public string CustomerBranch { get; set; } + public required string CustomerBranch { get; set; } /// /// Critical Entry Time (local time) @@ -58,7 +58,7 @@ public partial class ConnectLasershipRequestBody /// Critical Entry Time (local time) [JsonPropertyName("lasership_critical_entry_time")] [JsonRequired] - public string LasershipCriticalEntryTime { get; set; } + public required string LasershipCriticalEntryTime { get; set; } /// /// Critical Pull Time (local time) @@ -66,7 +66,7 @@ public partial class ConnectLasershipRequestBody /// Critical Pull Time (local time) [JsonPropertyName("lasership_critical_pull_time")] [JsonRequired] - public string LasershipCriticalPullTime { get; set; } + public required string LasershipCriticalPullTime { get; set; } /// /// Nickname @@ -74,7 +74,7 @@ public partial class ConnectLasershipRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// /// PostalCode @@ -82,7 +82,7 @@ public partial class ConnectLasershipRequestBody /// PostalCode [JsonPropertyName("PostalCode")] [JsonRequired] - public string PostalCode { get; set; } + public required string PostalCode { get; set; } /// /// State @@ -90,7 +90,7 @@ public partial class ConnectLasershipRequestBody /// State [JsonPropertyName("State")] [JsonRequired] - public string State { get; set; } + public required string State { get; set; } /// /// Web Service ID (WSID) @@ -98,7 +98,7 @@ public partial class ConnectLasershipRequestBody /// Web Service ID (WSID) [JsonPropertyName("web_services_id")] [JsonRequired] - public string WebServicesId { get; set; } + public required string WebServicesId { get; set; } /// /// Web Service Key (WSKey) @@ -106,7 +106,7 @@ public partial class ConnectLasershipRequestBody /// Web Service Key (WSKey) [JsonPropertyName("web_services_key")] [JsonRequired] - public string WebServicesKey { get; set; } + public required string WebServicesKey { get; set; } /// /// Address2 diff --git a/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs b/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs index 01c67203..dd0e3b5b 100644 --- a/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectNewgisticsRequestBody /// Induction site [JsonPropertyName("induction_site")] [JsonRequired] - public string InductionSite { get; set; } + public required string InductionSite { get; set; } /// /// Nickname @@ -42,7 +42,7 @@ public partial class ConnectNewgisticsRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// /// Mailer id diff --git a/ShipEngineSDK/Model/ConnectOntracRequestBody.cs b/ShipEngineSDK/Model/ConnectOntracRequestBody.cs index 10674810..980099e9 100644 --- a/ShipEngineSDK/Model/ConnectOntracRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectOntracRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectOntracRequestBody /// Account number [JsonPropertyName("account_number")] [JsonRequired] - public string AccountNumber { get; set; } + public required string AccountNumber { get; set; } /// /// Nickname @@ -42,7 +42,7 @@ public partial class ConnectOntracRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// /// Password @@ -50,7 +50,7 @@ public partial class ConnectOntracRequestBody /// Password [JsonPropertyName("password")] [JsonRequired] - public string Password { get; set; } + public required string Password { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs b/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs index 0c0fcbd7..8f6c5fec 100644 --- a/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectPurolatorRequestBody /// Account number [JsonPropertyName("account_number")] [JsonRequired] - public string AccountNumber { get; set; } + public required string AccountNumber { get; set; } /// /// Activation key @@ -42,7 +42,7 @@ public partial class ConnectPurolatorRequestBody /// Activation key [JsonPropertyName("activation_key")] [JsonRequired] - public string ActivationKey { get; set; } + public required string ActivationKey { get; set; } /// /// Nickname @@ -50,7 +50,7 @@ public partial class ConnectPurolatorRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs b/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs index b92d5953..15b376c5 100644 --- a/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectRoyalMailRequestBody /// Account number [JsonPropertyName("account_number")] [JsonRequired] - public string AccountNumber { get; set; } + public required string AccountNumber { get; set; } /// /// City @@ -42,7 +42,7 @@ public partial class ConnectRoyalMailRequestBody /// City [JsonPropertyName("city")] [JsonRequired] - public string City { get; set; } + public required string City { get; set; } /// /// Contact name @@ -50,7 +50,7 @@ public partial class ConnectRoyalMailRequestBody /// Contact name [JsonPropertyName("contact_name")] [JsonRequired] - public string ContactName { get; set; } + public required string ContactName { get; set; } /// /// Nickname @@ -58,7 +58,7 @@ public partial class ConnectRoyalMailRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// /// Postal code @@ -66,7 +66,7 @@ public partial class ConnectRoyalMailRequestBody /// Postal code [JsonPropertyName("postal_code")] [JsonRequired] - public string PostalCode { get; set; } + public required string PostalCode { get; set; } /// /// Company name diff --git a/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs b/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs index f38e6de6..6b507250 100644 --- a/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectRrDonnelleyRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// /// Password @@ -42,7 +42,7 @@ public partial class ConnectRrDonnelleyRequestBody /// Password [JsonPropertyName("password")] [JsonRequired] - public string Password { get; set; } + public required string Password { get; set; } /// /// Username @@ -50,7 +50,7 @@ public partial class ConnectRrDonnelleyRequestBody /// Username [JsonPropertyName("username")] [JsonRequired] - public string Username { get; set; } + public required string Username { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectSekoRequestBody.cs b/ShipEngineSDK/Model/ConnectSekoRequestBody.cs index d275288c..eaeeec9a 100644 --- a/ShipEngineSDK/Model/ConnectSekoRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectSekoRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectSekoRequestBody /// Seko Account Access Key [JsonPropertyName("access_key")] [JsonRequired] - public string AccessKey { get; set; } + public required string AccessKey { get; set; } /// /// Nickname @@ -42,7 +42,7 @@ public partial class ConnectSekoRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectSendleRequestBody.cs b/ShipEngineSDK/Model/ConnectSendleRequestBody.cs index 1eaa360f..398ffa35 100644 --- a/ShipEngineSDK/Model/ConnectSendleRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectSendleRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectSendleRequestBody /// API key [JsonPropertyName("api_key")] [JsonRequired] - public string ApiKey { get; set; } + public required string ApiKey { get; set; } /// /// Nickname @@ -42,7 +42,7 @@ public partial class ConnectSendleRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// /// A string that uniquely identifies the sendle @@ -53,7 +53,7 @@ public partial class ConnectSendleRequestBody /// [JsonPropertyName("sendle_id")] [JsonRequired] - public string SendleId { get; set; } + public required string SendleId { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectStampsRequestBody.cs b/ShipEngineSDK/Model/ConnectStampsRequestBody.cs index a0a429c7..57204aa8 100644 --- a/ShipEngineSDK/Model/ConnectStampsRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectStampsRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectStampsRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// /// Password @@ -42,7 +42,7 @@ public partial class ConnectStampsRequestBody /// Password [JsonPropertyName("password")] [JsonRequired] - public string Password { get; set; } + public required string Password { get; set; } /// /// Username @@ -50,7 +50,7 @@ public partial class ConnectStampsRequestBody /// Username [JsonPropertyName("username")] [JsonRequired] - public string Username { get; set; } + public required string Username { get; set; } /// diff --git a/ShipEngineSDK/Model/ConnectUpsRequestBody.cs b/ShipEngineSDK/Model/ConnectUpsRequestBody.cs index 9fd30709..ca9829bb 100644 --- a/ShipEngineSDK/Model/ConnectUpsRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectUpsRequestBody.cs @@ -34,7 +34,7 @@ public partial class ConnectUpsRequestBody /// Account number [JsonPropertyName("account_number")] [JsonRequired] - public string AccountNumber { get; set; } + public required string AccountNumber { get; set; } /// /// Nickname @@ -42,7 +42,7 @@ public partial class ConnectUpsRequestBody /// Nickname [JsonPropertyName("nickname")] [JsonRequired] - public string Nickname { get; set; } + public required string Nickname { get; set; } /// diff --git a/ShipEngineSDK/Model/ContactDetails.cs b/ShipEngineSDK/Model/ContactDetails.cs index b726f08e..a9d66ae8 100644 --- a/ShipEngineSDK/Model/ContactDetails.cs +++ b/ShipEngineSDK/Model/ContactDetails.cs @@ -37,14 +37,14 @@ public partial class ContactDetails /// [JsonPropertyName("email")] [JsonRequired] - public string Email { get; set; } + public required string Email { get; set; } /// /// Gets or Sets Name /// [JsonPropertyName("name")] [JsonRequired] - public string Name { get; set; } + public required string Name { get; set; } /// /// Phone number associated @@ -52,7 +52,7 @@ public partial class ContactDetails /// Phone number associated [JsonPropertyName("phone")] [JsonRequired] - public string Phone { get; set; } + public required string Phone { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs index 841f85d2..f5b3c7d2 100644 --- a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs @@ -91,7 +91,7 @@ public override bool CanConvert(Type typeToConvert) => /// The image type [JsonPropertyName("image_content_type")] [JsonRequired] - public ImageContentTypeEnum ImageContentType { get; set; } = new(); + public required ImageContentTypeEnum ImageContentType { get; set; } = new(); /// @@ -103,7 +103,7 @@ public override bool CanConvert(Type typeToConvert) => /// [JsonPropertyName("image_data")] [JsonRequired] - public string ImageData { get; set; } + public required string ImageData { get; set; } /// /// A human readable name for the image. @@ -114,7 +114,7 @@ public override bool CanConvert(Type typeToConvert) => /// [JsonPropertyName("name")] [JsonRequired] - public string Name { get; set; } + public required string Name { get; set; } /// /// The date and time that the image was created in ShipEngine. diff --git a/ShipEngineSDK/Model/CreateBatchRequest.cs b/ShipEngineSDK/Model/CreateBatchRequest.cs index c1c8c75c..bba2d398 100644 --- a/ShipEngineSDK/Model/CreateBatchRequest.cs +++ b/ShipEngineSDK/Model/CreateBatchRequest.cs @@ -204,6 +204,7 @@ public override void Write(Utf8JsonWriter writer, CreateBatchRequest value, Json var jsonDoc = JsonDocument.ParseValue(ref reader); CreateBatchRequest? newCreateBatchRequest = null; + int match = 0; var matchedTypes = new List(); @@ -243,7 +244,6 @@ public override void Write(Utf8JsonWriter writer, CreateBatchRequest value, Json throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); } - // deserialization is considered successful at this point if no exception has been thrown. return newCreateBatchRequest; } diff --git a/ShipEngineSDK/Model/CreateBatchResponseBody.cs b/ShipEngineSDK/Model/CreateBatchResponseBody.cs index 753253dc..b6b479b9 100644 --- a/ShipEngineSDK/Model/CreateBatchResponseBody.cs +++ b/ShipEngineSDK/Model/CreateBatchResponseBody.cs @@ -33,7 +33,7 @@ public partial class CreateBatchResponseBody /// [JsonPropertyName("label_format")] [JsonRequired] - public LabelFormat LabelFormat { get; set; } = new(); + public required LabelFormat LabelFormat { get; set; } = new(); /// @@ -42,7 +42,7 @@ public partial class CreateBatchResponseBody /// label layout [JsonPropertyName("label_layout")] [JsonRequired] - public LabelLayout LabelLayout { get; set; } = new(); + public required LabelLayout LabelLayout { get; set; } = new(); /// @@ -50,7 +50,7 @@ public partial class CreateBatchResponseBody /// [JsonPropertyName("status")] [JsonRequired] - public BatchStatus Status { get; set; } = new(); + public required BatchStatus Status { get; set; } = new(); /// @@ -59,7 +59,7 @@ public partial class CreateBatchResponseBody /// Link to batch errors endpoint [JsonPropertyName("batch_errors_url")] [JsonRequired] - public OptionalLink BatchErrorsUrl { get; set; } + public required OptionalLink BatchErrorsUrl { get; set; } /// /// A string that uniquely identifies the batch @@ -70,7 +70,7 @@ public partial class CreateBatchResponseBody /// [JsonPropertyName("batch_id")] [JsonRequired] - public string BatchId { get; set; } + public required string BatchId { get; set; } /// /// Link to batch labels query @@ -78,7 +78,7 @@ public partial class CreateBatchResponseBody /// Link to batch labels query [JsonPropertyName("batch_labels_url")] [JsonRequired] - public OptionalLink BatchLabelsUrl { get; set; } + public required OptionalLink BatchLabelsUrl { get; set; } /// /// The batch number. @@ -86,7 +86,7 @@ public partial class CreateBatchResponseBody /// The batch number. [JsonPropertyName("batch_number")] [JsonRequired] - public string BatchNumber { get; set; } + public required string BatchNumber { get; set; } /// /// The batch shipments endpoint @@ -94,7 +94,7 @@ public partial class CreateBatchResponseBody /// The batch shipments endpoint [JsonPropertyName("batch_shipments_url")] [JsonRequired] - public OptionalLink BatchShipmentsUrl { get; set; } + public required OptionalLink BatchShipmentsUrl { get; set; } /// /// The number of labels generated in the batch @@ -105,7 +105,7 @@ public partial class CreateBatchResponseBody /// [JsonPropertyName("completed")] [JsonRequired] - public int Completed { get; set; } + public required int Completed { get; set; } /// /// The total of errors, warnings, and completed properties @@ -116,7 +116,7 @@ public partial class CreateBatchResponseBody /// [JsonPropertyName("count")] [JsonRequired] - public int Count { get; set; } + public required int Count { get; set; } /// /// The date and time the batch was created in ShipEngine @@ -127,7 +127,7 @@ public partial class CreateBatchResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public required DateTimeOffset CreatedAt { get; set; } /// /// The number of errors that occurred while generating the batch @@ -138,7 +138,7 @@ public partial class CreateBatchResponseBody /// [JsonPropertyName("errors")] [JsonRequired] - public int Errors { get; set; } + public required int Errors { get; set; } /// /// The form download for any customs that are needed @@ -146,7 +146,7 @@ public partial class CreateBatchResponseBody /// The form download for any customs that are needed [JsonPropertyName("form_download")] [JsonRequired] - public OptionalLink FormDownload { get; set; } + public required OptionalLink FormDownload { get; set; } /// /// The number of forms for customs that are available for download @@ -157,7 +157,7 @@ public partial class CreateBatchResponseBody /// [JsonPropertyName("forms")] [JsonRequired] - public int Forms { get; set; } + public required int Forms { get; set; } /// /// The label download for the batch @@ -165,7 +165,7 @@ public partial class CreateBatchResponseBody /// The label download for the batch [JsonPropertyName("label_download")] [JsonRequired] - public LabelDownload LabelDownload { get; set; } + public required LabelDownload LabelDownload { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. @@ -173,7 +173,7 @@ public partial class CreateBatchResponseBody /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. [JsonPropertyName("paperless_download")] [JsonRequired] - public PaperlessDownload PaperlessDownload { get; set; } + public required PaperlessDownload PaperlessDownload { get; set; } /// /// The errors associated with the failed API call @@ -181,7 +181,7 @@ public partial class CreateBatchResponseBody /// The errors associated with the failed API call [JsonPropertyName("process_errors")] [JsonRequired] - public List ProcessErrors { get; set; } + public required List ProcessErrors { get; set; } /// /// The number of warnings that occurred while generating the batch @@ -192,7 +192,7 @@ public partial class CreateBatchResponseBody /// [JsonPropertyName("warnings")] [JsonRequired] - public int Warnings { get; set; } + public required int Warnings { get; set; } /// /// Custom notes you can add for each created batch @@ -203,7 +203,7 @@ public partial class CreateBatchResponseBody /// [JsonPropertyName("batch_notes")] [JsonRequired] - public string BatchNotes { get; set; } + public required string BatchNotes { get; set; } /// /// A string that uniquely identifies the external batch @@ -211,7 +211,7 @@ public partial class CreateBatchResponseBody /// A string that uniquely identifies the external batch [JsonPropertyName("external_batch_id")] [JsonRequired] - public string ExternalBatchId { get; set; } + public required string ExternalBatchId { get; set; } /// /// The date and time the batch was processed in ShipEngine @@ -222,7 +222,7 @@ public partial class CreateBatchResponseBody /// [JsonPropertyName("processed_at")] [JsonRequired] - public DateTimeOffset ProcessedAt { get; set; } + public required DateTimeOffset ProcessedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateLabelRequestBody.cs b/ShipEngineSDK/Model/CreateLabelRequestBody.cs index 3d59d0a9..f26ef2d9 100644 --- a/ShipEngineSDK/Model/CreateLabelRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelRequestBody.cs @@ -79,7 +79,7 @@ public partial class CreateLabelRequestBody /// The shipment information used to generate the label [JsonPropertyName("shipment")] [JsonRequired] - public Shipment Shipment { get; set; } + public required Shipment Shipment { get; set; } /// /// Additional information some carriers may provide by which to identify a given label in their system. diff --git a/ShipEngineSDK/Model/CreateLabelResponseBody.cs b/ShipEngineSDK/Model/CreateLabelResponseBody.cs index a1578f37..6230bcbb 100644 --- a/ShipEngineSDK/Model/CreateLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelResponseBody.cs @@ -34,7 +34,7 @@ public partial class CreateLabelResponseBody /// The label charge event. [JsonPropertyName("charge_event")] [JsonRequired] - public LabelChargeEvent ChargeEvent { get; set; } = new(); + public required LabelChargeEvent ChargeEvent { get; set; } = new(); /// @@ -43,7 +43,7 @@ public partial class CreateLabelResponseBody /// The display format that the label should be shown in. [JsonPropertyName("display_scheme")] [JsonRequired] - public DisplayScheme DisplayScheme { get; set; } = new(); + public required DisplayScheme DisplayScheme { get; set; } = new(); /// @@ -52,7 +52,7 @@ public partial class CreateLabelResponseBody /// 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")] [JsonRequired] - public LabelFormat LabelFormat { get; set; } = new(); + public required LabelFormat LabelFormat { get; set; } = new(); /// @@ -61,7 +61,7 @@ public partial class CreateLabelResponseBody /// 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")] [JsonRequired] - public LabelLayout LabelLayout { get; set; } = new(); + public required LabelLayout LabelLayout { get; set; } = new(); /// @@ -69,7 +69,7 @@ public partial class CreateLabelResponseBody /// [JsonPropertyName("status")] [JsonRequired] - public LabelStatus Status { get; set; } = new(); + public required LabelStatus Status { get; set; } = new(); /// @@ -78,7 +78,7 @@ public partial class CreateLabelResponseBody /// The current status of the package, such as `in_transit` or `delivered` [JsonPropertyName("tracking_status")] [JsonRequired] - public TrackingStatus TrackingStatus { get; set; } = new(); + public required TrackingStatus TrackingStatus { get; set; } = new(); /// @@ -100,7 +100,7 @@ public partial class CreateLabelResponseBody /// [JsonPropertyName("batch_id")] [JsonRequired] - public string BatchId { get; set; } + public required string BatchId { get; set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. @@ -111,7 +111,7 @@ public partial class CreateLabelResponseBody /// [JsonPropertyName("carrier_code")] [JsonRequired] - public string CarrierCode { get; set; } + public required string CarrierCode { get; set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label @@ -122,7 +122,7 @@ public partial class CreateLabelResponseBody /// [JsonPropertyName("carrier_id")] [JsonRequired] - public string CarrierId { get; set; } + public required string CarrierId { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -133,7 +133,7 @@ public partial class CreateLabelResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public required DateTimeOffset CreatedAt { get; set; } /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. @@ -141,7 +141,7 @@ public partial class CreateLabelResponseBody /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. [JsonPropertyName("insurance_cost")] [JsonRequired] - public MonetaryValue InsuranceCost { get; set; } + public required MonetaryValue InsuranceCost { get; set; } /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. @@ -149,7 +149,7 @@ public partial class CreateLabelResponseBody /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. [JsonPropertyName("is_international")] [JsonRequired] - public bool IsInternational { get; set; } + public required bool IsInternational { get; set; } /// /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. @@ -157,14 +157,14 @@ public partial class CreateLabelResponseBody /// 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")] [JsonRequired] - public bool IsReturnLabel { get; set; } + public required bool IsReturnLabel { get; set; } /// /// Gets or Sets LabelDownload /// [JsonPropertyName("label_download")] [JsonRequired] - public LabelDownload LabelDownload { get; set; } + public required LabelDownload LabelDownload { get; set; } /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. @@ -175,7 +175,7 @@ public partial class CreateLabelResponseBody /// [JsonPropertyName("label_id")] [JsonRequired] - public string LabelId { get; set; } + public required string LabelId { get; set; } /// /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. @@ -186,7 +186,7 @@ public partial class CreateLabelResponseBody /// [JsonPropertyName("package_code")] [JsonRequired] - public string PackageCode { get; set; } + public required string PackageCode { get; set; } /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. @@ -194,7 +194,7 @@ public partial class CreateLabelResponseBody /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. [JsonPropertyName("packages")] [JsonRequired] - public List Packages { get; set; } + public required List Packages { get; set; } /// /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. @@ -205,7 +205,7 @@ public partial class CreateLabelResponseBody /// [JsonPropertyName("service_code")] [JsonRequired] - public string ServiceCode { get; set; } + public required string ServiceCode { get; set; } /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -216,7 +216,7 @@ public partial class CreateLabelResponseBody /// [JsonPropertyName("ship_date")] [JsonRequired] - public DateTimeOffset ShipDate { get; set; } + public required DateTimeOffset ShipDate { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. @@ -224,7 +224,7 @@ public partial class CreateLabelResponseBody /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. [JsonPropertyName("shipment_cost")] [JsonRequired] - public MonetaryValue ShipmentCost { get; set; } + public required MonetaryValue ShipmentCost { get; set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) @@ -235,7 +235,7 @@ public partial class CreateLabelResponseBody /// [JsonPropertyName("shipment_id")] [JsonRequired] - public string ShipmentId { get; set; } + public required string ShipmentId { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. @@ -243,7 +243,7 @@ public partial class CreateLabelResponseBody /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. [JsonPropertyName("trackable")] [JsonRequired] - public bool Trackable { get; set; } + public required bool Trackable { get; set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. @@ -254,7 +254,7 @@ public partial class CreateLabelResponseBody /// [JsonPropertyName("tracking_number")] [JsonRequired] - public string TrackingNumber { get; set; } + public required string TrackingNumber { get; set; } /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) @@ -262,7 +262,7 @@ public partial class CreateLabelResponseBody /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) [JsonPropertyName("voided")] [JsonRequired] - public bool Voided { get; set; } + public required bool Voided { get; set; } /// /// Additional information some carriers may provide by which to identify a given label in their system. @@ -277,7 +277,7 @@ public partial class CreateLabelResponseBody /// 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. [JsonPropertyName("form_download")] [JsonRequired] - public Link FormDownload { get; set; } + public required Link FormDownload { get; set; } /// /// 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. @@ -285,7 +285,7 @@ public partial class CreateLabelResponseBody /// 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. [JsonPropertyName("insurance_claim")] [JsonRequired] - public Link InsuranceClaim { get; set; } + public required Link InsuranceClaim { get; set; } /// /// The label image resource that was used to create a custom label image. @@ -296,7 +296,7 @@ public partial class CreateLabelResponseBody /// [JsonPropertyName("label_image_id")] [JsonRequired] - public string LabelImageId { get; set; } + public required string LabelImageId { get; set; } /// /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. @@ -314,7 +314,7 @@ public partial class CreateLabelResponseBody /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. [JsonPropertyName("paperless_download")] [JsonRequired] - public PaperlessDownload PaperlessDownload { get; set; } + public required PaperlessDownload PaperlessDownload { get; set; } /// /// The total shipping cost for the specified comparison_rate_type. @@ -329,7 +329,7 @@ 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. [JsonPropertyName("rma_number")] [JsonRequired] - public string RmaNumber { get; set; } + public required string RmaNumber { get; set; } /// /// The shipment information used to generate the label @@ -365,7 +365,7 @@ public partial class CreateLabelResponseBody /// [JsonPropertyName("voided_at")] [JsonRequired] - public DateTimeOffset VoidedAt { get; set; } + public required DateTimeOffset VoidedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs b/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs index 98c44874..9c128188 100644 --- a/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs +++ b/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs @@ -37,7 +37,7 @@ public partial class CreateManifestByObjectRequestBody /// [JsonPropertyName("carrier_id")] [JsonRequired] - public string CarrierId { get; set; } + public required string CarrierId { get; set; } /// /// The ship date that the shipment will be sent out on @@ -48,7 +48,7 @@ public partial class CreateManifestByObjectRequestBody /// [JsonPropertyName("ship_date")] [JsonRequired] - public DateTimeOffset ShipDate { get; set; } + public required DateTimeOffset ShipDate { get; set; } /// /// A string that uniquely identifies the warehouse @@ -59,7 +59,7 @@ public partial class CreateManifestByObjectRequestBody /// [JsonPropertyName("warehouse_id")] [JsonRequired] - public string WarehouseId { get; set; } + public required string WarehouseId { get; set; } /// /// The list of label ids to exclude from the manifest diff --git a/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs b/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs index 720bdb9d..1ca43572 100644 --- a/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs +++ b/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs @@ -34,7 +34,7 @@ public partial class CreateManifestLabelIdsRequestBody /// The list of label ids to include in the manifest [JsonPropertyName("label_ids")] [JsonRequired] - public List LabelIds { get; set; } + public required List LabelIds { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateManifestRequestBody.cs b/ShipEngineSDK/Model/CreateManifestRequestBody.cs index f46afcd6..389d2d7e 100644 --- a/ShipEngineSDK/Model/CreateManifestRequestBody.cs +++ b/ShipEngineSDK/Model/CreateManifestRequestBody.cs @@ -204,6 +204,7 @@ public override void Write(Utf8JsonWriter writer, CreateManifestRequestBody valu var jsonDoc = JsonDocument.ParseValue(ref reader); CreateManifestRequestBody? newCreateManifestRequestBody = null; + int match = 0; var matchedTypes = new List(); @@ -243,7 +244,6 @@ public override void Write(Utf8JsonWriter writer, CreateManifestRequestBody valu throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); } - // deserialization is considered successful at this point if no exception has been thrown. return newCreateManifestRequestBody; } diff --git a/ShipEngineSDK/Model/CreateManifestResponseBody.cs b/ShipEngineSDK/Model/CreateManifestResponseBody.cs index 115ef417..bc32f5eb 100644 --- a/ShipEngineSDK/Model/CreateManifestResponseBody.cs +++ b/ShipEngineSDK/Model/CreateManifestResponseBody.cs @@ -38,7 +38,7 @@ public partial class CreateManifestResponseBody [JsonPropertyName("carrier_id")] [JsonRequired] [Obsolete] - public string CarrierId { get; set; } + public required string CarrierId { get; set; } /// /// The date-time that the manifest was created @@ -50,7 +50,7 @@ public partial class CreateManifestResponseBody [JsonPropertyName("created_at")] [JsonRequired] [Obsolete] - public DateTimeOffset CreatedAt { get; set; } + public required DateTimeOffset CreatedAt { get; set; } /// /// The errors associated with the failed API call @@ -58,7 +58,7 @@ public partial class CreateManifestResponseBody /// The errors associated with the failed API call [JsonPropertyName("errors")] [JsonRequired] - public List Errors { get; set; } + public required List Errors { get; set; } /// /// A string that uniquely identifies the form @@ -70,7 +70,7 @@ public partial class CreateManifestResponseBody [JsonPropertyName("form_id")] [JsonRequired] [Obsolete] - public string FormId { get; set; } + public required string FormId { get; set; } /// /// Gets or Sets ManifestDownload @@ -78,7 +78,7 @@ public partial class CreateManifestResponseBody [JsonPropertyName("manifest_download")] [JsonRequired] [Obsolete] - public ManifestDownload ManifestDownload { get; set; } + public required ManifestDownload ManifestDownload { get; set; } /// /// A string that uniquely identifies the manifest @@ -90,7 +90,7 @@ public partial class CreateManifestResponseBody [JsonPropertyName("manifest_id")] [JsonRequired] [Obsolete] - public string ManifestId { get; set; } + public required string ManifestId { get; set; } /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur @@ -101,7 +101,7 @@ public partial class CreateManifestResponseBody /// [JsonPropertyName("request_id")] [JsonRequired] - public Guid RequestId { get; set; } + public required Guid RequestId { get; set; } /// /// The date-time that the manifests shipments will be picked up @@ -113,7 +113,7 @@ public partial class CreateManifestResponseBody [JsonPropertyName("ship_date")] [JsonRequired] [Obsolete] - public DateTimeOffset ShipDate { get; set; } + public required DateTimeOffset ShipDate { get; set; } /// /// The number of shipments that are included in this manifest @@ -125,7 +125,7 @@ public partial class CreateManifestResponseBody [JsonPropertyName("shipments")] [JsonRequired] [Obsolete] - public int Shipments { get; set; } + public required int Shipments { get; set; } /// /// A string that uniquely identifies the submission @@ -137,7 +137,7 @@ public partial class CreateManifestResponseBody [JsonPropertyName("submission_id")] [JsonRequired] [Obsolete] - public string SubmissionId { get; set; } + public required string SubmissionId { get; set; } /// /// A string that uniquely identifies the warehouse @@ -149,7 +149,7 @@ public partial class CreateManifestResponseBody [JsonPropertyName("warehouse_id")] [JsonRequired] [Obsolete] - public string WarehouseId { get; set; } + public required string WarehouseId { get; set; } /// /// An array of the label ids used in this manifest. diff --git a/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs b/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs index 2ad3ed4f..2403b59e 100644 --- a/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs +++ b/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs @@ -36,7 +36,7 @@ public partial class CreatePackageTypeRequestBody /// [JsonPropertyName("name")] [JsonRequired] - public string Name { get; set; } + public required string Name { get; set; } /// /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. @@ -47,7 +47,7 @@ public partial class CreatePackageTypeRequestBody /// [JsonPropertyName("package_code")] [JsonRequired] - public string PackageCode { get; set; } + public required string PackageCode { get; set; } /// /// Provides a helpful description for the custom package. diff --git a/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs b/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs index 307fac4e..4e1e6847 100644 --- a/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs +++ b/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs @@ -36,7 +36,7 @@ public partial class CreatePackageTypeResponseBody /// [JsonPropertyName("name")] [JsonRequired] - public string Name { get; set; } + public required string Name { get; set; } /// /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. @@ -47,7 +47,7 @@ public partial class CreatePackageTypeResponseBody /// [JsonPropertyName("package_code")] [JsonRequired] - public string PackageCode { get; set; } + public required string PackageCode { get; set; } /// /// Provides a helpful description for the custom package. diff --git a/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs b/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs index 88a2711a..1e9f495f 100644 --- a/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs +++ b/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs @@ -34,7 +34,7 @@ public partial class CreateShipmentsRequestBody /// An array of shipments to be created. [JsonPropertyName("shipments")] [JsonRequired] - public List Shipments { get; set; } + public required List Shipments { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs b/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs index e7dc4676..8504313c 100644 --- a/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs +++ b/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs @@ -34,7 +34,7 @@ public partial class CreateShipmentsResponseBody /// An array of shipments that were created. [JsonPropertyName("shipments")] [JsonRequired] - public List Shipments { get; set; } + public required List Shipments { get; set; } /// /// Indicates if errors occured while creating the shipments @@ -42,7 +42,7 @@ public partial class CreateShipmentsResponseBody /// Indicates if errors occured while creating the shipments [JsonPropertyName("has_errors")] [JsonRequired] - public bool HasErrors { get; set; } + public required bool HasErrors { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateTagResponseBody.cs b/ShipEngineSDK/Model/CreateTagResponseBody.cs index fdd5ece3..f758b98a 100644 --- a/ShipEngineSDK/Model/CreateTagResponseBody.cs +++ b/ShipEngineSDK/Model/CreateTagResponseBody.cs @@ -37,7 +37,7 @@ public partial class CreateTagResponseBody /// [JsonPropertyName("name")] [JsonRequired] - public string Name { get; set; } + public required string Name { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs b/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs index 7eee7cda..9297d7db 100644 --- a/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs +++ b/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs @@ -37,7 +37,7 @@ public partial class CreateWarehouseRequestBody /// [JsonPropertyName("name")] [JsonRequired] - public string Name { get; set; } + public required string Name { get; set; } /// /// The origin address of the warehouse @@ -45,7 +45,7 @@ public partial class CreateWarehouseRequestBody /// The origin address of the warehouse [JsonPropertyName("origin_address")] [JsonRequired] - public Address OriginAddress { get; set; } + public required Address OriginAddress { get; set; } /// /// Timestamp that indicates when the warehouse was created diff --git a/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs b/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs index f8691c2d..971a50f9 100644 --- a/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs +++ b/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs @@ -37,7 +37,7 @@ public partial class CreateWarehouseResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public required DateTimeOffset CreatedAt { get; set; } /// /// Name of the warehouse @@ -48,7 +48,7 @@ public partial class CreateWarehouseResponseBody /// [JsonPropertyName("name")] [JsonRequired] - public string Name { get; set; } + public required string Name { get; set; } /// /// The origin address of the warehouse @@ -56,7 +56,7 @@ public partial class CreateWarehouseResponseBody /// The origin address of the warehouse [JsonPropertyName("origin_address")] [JsonRequired] - public Address OriginAddress { get; set; } + public required Address OriginAddress { get; set; } /// /// The return address associated with the warehouse @@ -64,7 +64,7 @@ public partial class CreateWarehouseResponseBody /// The return address associated with the warehouse [JsonPropertyName("return_address")] [JsonRequired] - public Address ReturnAddress { get; set; } + public required Address ReturnAddress { get; set; } /// /// A string that uniquely identifies the warehouse @@ -75,7 +75,7 @@ public partial class CreateWarehouseResponseBody /// [JsonPropertyName("warehouse_id")] [JsonRequired] - public string WarehouseId { get; set; } + public required string WarehouseId { get; set; } /// /// Designates which single warehouse is the default on the account diff --git a/ShipEngineSDK/Model/CreateWebhookRequestBody.cs b/ShipEngineSDK/Model/CreateWebhookRequestBody.cs index 84f42e3c..39a49813 100644 --- a/ShipEngineSDK/Model/CreateWebhookRequestBody.cs +++ b/ShipEngineSDK/Model/CreateWebhookRequestBody.cs @@ -33,7 +33,7 @@ public partial class CreateWebhookRequestBody /// [JsonPropertyName("event")] [JsonRequired] - public WebhookEvent Event { get; set; } = new(); + public required WebhookEvent Event { get; set; } = new(); /// @@ -45,7 +45,7 @@ public partial class CreateWebhookRequestBody /// [JsonPropertyName("url")] [JsonRequired] - public string Url { get; set; } + public required string Url { get; set; } /// /// Array of custom webhook headers diff --git a/ShipEngineSDK/Model/CreateWebhookResponseBody.cs b/ShipEngineSDK/Model/CreateWebhookResponseBody.cs index f984855e..9ce0e612 100644 --- a/ShipEngineSDK/Model/CreateWebhookResponseBody.cs +++ b/ShipEngineSDK/Model/CreateWebhookResponseBody.cs @@ -33,7 +33,7 @@ public partial class CreateWebhookResponseBody /// [JsonPropertyName("event")] [JsonRequired] - public WebhookEvent Event { get; set; } = new(); + public required WebhookEvent Event { get; set; } = new(); /// @@ -45,7 +45,7 @@ public partial class CreateWebhookResponseBody /// [JsonPropertyName("url")] [JsonRequired] - public string Url { get; set; } + public required string Url { get; set; } /// /// A string that uniquely identifies the webhook @@ -56,7 +56,7 @@ public partial class CreateWebhookResponseBody /// [JsonPropertyName("webhook_id")] [JsonRequired] - public string WebhookId { get; set; } + public required string WebhookId { get; set; } /// /// Array of custom webhook headers diff --git a/ShipEngineSDK/Model/CustomsItem.cs b/ShipEngineSDK/Model/CustomsItem.cs index 6115188e..0d2ac99f 100644 --- a/ShipEngineSDK/Model/CustomsItem.cs +++ b/ShipEngineSDK/Model/CustomsItem.cs @@ -37,7 +37,7 @@ public partial class CustomsItem /// [JsonPropertyName("customs_item_id")] [JsonRequired] - public string CustomsItemId { get; set; } + public required string CustomsItemId { get; set; } /// /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated diff --git a/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs b/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs index 56a81c82..0156170b 100644 --- a/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs +++ b/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs @@ -34,7 +34,7 @@ public partial class DeletePickupByIdResponseBody /// The errors associated with the failed API call [JsonPropertyName("errors")] [JsonRequired] - public List Errors { get; set; } + public required List Errors { get; set; } /// /// Pickup Resource ID @@ -45,7 +45,7 @@ public partial class DeletePickupByIdResponseBody /// [JsonPropertyName("pickup_id")] [JsonRequired] - public string PickupId { get; set; } + public required string PickupId { get; set; } /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur @@ -56,7 +56,7 @@ public partial class DeletePickupByIdResponseBody /// [JsonPropertyName("request_id")] [JsonRequired] - public Guid RequestId { get; set; } + public required Guid RequestId { get; set; } /// diff --git a/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs b/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs index a3214a6f..8e63b7a1 100644 --- a/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs +++ b/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs @@ -37,7 +37,7 @@ public partial class DeleteScheduledPickupResponseBody /// [JsonPropertyName("pickup_id")] [JsonRequired] - public string PickupId { get; set; } + public required string PickupId { get; set; } /// diff --git a/ShipEngineSDK/Model/Dimensions.cs b/ShipEngineSDK/Model/Dimensions.cs index 92861e9a..476675a7 100644 --- a/ShipEngineSDK/Model/Dimensions.cs +++ b/ShipEngineSDK/Model/Dimensions.cs @@ -33,7 +33,7 @@ public partial class Dimensions /// [JsonPropertyName("unit")] [JsonRequired] - public DimensionUnit Unit { get; set; } = new(); + public required DimensionUnit Unit { get; set; } = new(); /// @@ -42,7 +42,7 @@ public partial class Dimensions /// The height of the package, in the specified unit [JsonPropertyName("height")] [JsonRequired] - public double Height { get; set; } + public required double Height { get; set; } /// /// The length of the package, in the specified unit @@ -50,7 +50,7 @@ public partial class Dimensions /// The length of the package, in the specified unit [JsonPropertyName("length")] [JsonRequired] - public double Length { get; set; } + public required double Length { get; set; } /// /// The width of the package, in the specified unit @@ -58,7 +58,7 @@ public partial class Dimensions /// The width of the package, in the specified unit [JsonPropertyName("width")] [JsonRequired] - public double Width { get; set; } + public required double Width { get; set; } /// diff --git a/ShipEngineSDK/Model/Error.cs b/ShipEngineSDK/Model/Error.cs index e1dde68e..8972ca57 100644 --- a/ShipEngineSDK/Model/Error.cs +++ b/ShipEngineSDK/Model/Error.cs @@ -33,7 +33,7 @@ public partial class Error /// [JsonPropertyName("error_code")] [JsonRequired] - public ErrorCode ErrorCode { get; set; } = new(); + public required ErrorCode ErrorCode { get; set; } = new(); /// @@ -41,7 +41,7 @@ public partial class Error /// [JsonPropertyName("error_source")] [JsonRequired] - public ErrorSource ErrorSource { get; set; } = new(); + public required ErrorSource ErrorSource { get; set; } = new(); /// @@ -49,7 +49,7 @@ public partial class Error /// [JsonPropertyName("error_type")] [JsonRequired] - public ErrorType ErrorType { get; set; } = new(); + public required ErrorType ErrorType { get; set; } = new(); /// @@ -61,7 +61,7 @@ public partial class Error /// [JsonPropertyName("message")] [JsonRequired] - public string Message { get; set; } + public required string Message { get; set; } /// diff --git a/ShipEngineSDK/Model/ErrorResponseBody.cs b/ShipEngineSDK/Model/ErrorResponseBody.cs index 3980d505..82eba960 100644 --- a/ShipEngineSDK/Model/ErrorResponseBody.cs +++ b/ShipEngineSDK/Model/ErrorResponseBody.cs @@ -34,7 +34,7 @@ public partial class ErrorResponseBody /// The errors associated with the failed API call [JsonPropertyName("errors")] [JsonRequired] - public List Errors { get; set; } + public required List Errors { get; set; } /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur @@ -45,7 +45,7 @@ public partial class ErrorResponseBody /// [JsonPropertyName("request_id")] [JsonRequired] - public Guid RequestId { get; set; } + public required Guid RequestId { get; set; } /// diff --git a/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs b/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs index 9ee23263..4e801c82 100644 --- a/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs +++ b/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs @@ -34,7 +34,7 @@ public partial class ErrorWithLabelIdResponseBody /// The errors associated with the failed API call [JsonPropertyName("errors")] [JsonRequired] - public List Errors { get; set; } + public required List Errors { get; set; } /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur @@ -45,7 +45,7 @@ public partial class ErrorWithLabelIdResponseBody /// [JsonPropertyName("request_id")] [JsonRequired] - public Guid RequestId { get; set; } + public required Guid RequestId { get; set; } /// diff --git a/ShipEngineSDK/Model/EstimateRatesRequestBody.cs b/ShipEngineSDK/Model/EstimateRatesRequestBody.cs index 150fb923..017a042d 100644 --- a/ShipEngineSDK/Model/EstimateRatesRequestBody.cs +++ b/ShipEngineSDK/Model/EstimateRatesRequestBody.cs @@ -50,7 +50,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// [JsonPropertyName("from_city_locality")] [JsonRequired] - public string FromCityLocality { get; set; } + public required string FromCityLocality { get; set; } /// /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) @@ -61,7 +61,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// [JsonPropertyName("from_country_code")] [JsonRequired] - public string FromCountryCode { get; set; } + public required string FromCountryCode { get; set; } /// /// postal code @@ -72,7 +72,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// [JsonPropertyName("from_postal_code")] [JsonRequired] - public string FromPostalCode { get; set; } + public required string FromPostalCode { get; set; } /// /// From state province @@ -83,7 +83,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// [JsonPropertyName("from_state_province")] [JsonRequired] - public string FromStateProvince { get; set; } + public required string FromStateProvince { get; set; } /// /// ship date @@ -94,7 +94,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// [JsonPropertyName("ship_date")] [JsonRequired] - public DateTimeOffset ShipDate { get; set; } + public required DateTimeOffset ShipDate { get; set; } /// /// The city locality the package is being shipped to @@ -105,7 +105,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// [JsonPropertyName("to_city_locality")] [JsonRequired] - public string ToCityLocality { get; set; } + public required string ToCityLocality { get; set; } /// /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) @@ -116,7 +116,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// [JsonPropertyName("to_country_code")] [JsonRequired] - public string ToCountryCode { get; set; } + public required string ToCountryCode { get; set; } /// /// postal code @@ -127,7 +127,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// [JsonPropertyName("to_postal_code")] [JsonRequired] - public string ToPostalCode { get; set; } + public required string ToPostalCode { get; set; } /// /// To state province @@ -138,7 +138,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// [JsonPropertyName("to_state_province")] [JsonRequired] - public string ToStateProvince { get; set; } + public required string ToStateProvince { get; set; } /// /// The weight of the package @@ -146,7 +146,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// The weight of the package [JsonPropertyName("weight")] [JsonRequired] - public Weight Weight { get; set; } + public required Weight Weight { get; set; } /// /// The dimensions of the package @@ -368,12 +368,42 @@ public override void Write(Utf8JsonWriter writer, EstimateRatesRequestBody value var jsonDoc = JsonDocument.ParseValue(ref reader); EstimateRatesRequestBody? newEstimateRatesRequestBody = null; + // Deserialize all the common properties of the model so they can be used in object initializers later + var fromCityLocality = jsonDoc.RootElement.GetProperty("from_city_locality").Deserialize(DeserializingOptions)!; + var fromCountryCode = jsonDoc.RootElement.GetProperty("from_country_code").Deserialize(DeserializingOptions)!; + var fromPostalCode = jsonDoc.RootElement.GetProperty("from_postal_code").Deserialize(DeserializingOptions)!; + var fromStateProvince = jsonDoc.RootElement.GetProperty("from_state_province").Deserialize(DeserializingOptions)!; + var shipDate = jsonDoc.RootElement.GetProperty("ship_date").Deserialize(DeserializingOptions)!; + var toCityLocality = jsonDoc.RootElement.GetProperty("to_city_locality").Deserialize(DeserializingOptions)!; + var toCountryCode = jsonDoc.RootElement.GetProperty("to_country_code").Deserialize(DeserializingOptions)!; + var toPostalCode = jsonDoc.RootElement.GetProperty("to_postal_code").Deserialize(DeserializingOptions)!; + var toStateProvince = jsonDoc.RootElement.GetProperty("to_state_province").Deserialize(DeserializingOptions)!; + var weight = jsonDoc.RootElement.GetProperty("weight").Deserialize(DeserializingOptions)!; + var addressResidentialIndicator = jsonDoc.RootElement.GetProperty("address_residential_indicator").Deserialize(DeserializingOptions)!; + var confirmation = jsonDoc.RootElement.GetProperty("confirmation").Deserialize(DeserializingOptions)!; + var dimensions = jsonDoc.RootElement.GetProperty("dimensions").Deserialize(DeserializingOptions)!; + int match = 0; var matchedTypes = new List(); try { - newEstimateRatesRequestBody = new EstimateRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); + newEstimateRatesRequestBody = new EstimateRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!) + { + FromCityLocality = fromCityLocality, + FromCountryCode = fromCountryCode, + FromPostalCode = fromPostalCode, + FromStateProvince = fromStateProvince, + ShipDate = shipDate, + ToCityLocality = toCityLocality, + ToCountryCode = toCountryCode, + ToPostalCode = toPostalCode, + ToStateProvince = toStateProvince, + Weight = weight, + AddressResidentialIndicator = addressResidentialIndicator, + Confirmation = confirmation, + Dimensions = dimensions, + }; matchedTypes.Add("RateEstimateByCarrierId"); match++; @@ -386,7 +416,22 @@ public override void Write(Utf8JsonWriter writer, EstimateRatesRequestBody value try { - newEstimateRatesRequestBody = new EstimateRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!); + newEstimateRatesRequestBody = new EstimateRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!) + { + FromCityLocality = fromCityLocality, + FromCountryCode = fromCountryCode, + FromPostalCode = fromPostalCode, + FromStateProvince = fromStateProvince, + ShipDate = shipDate, + ToCityLocality = toCityLocality, + ToCountryCode = toCountryCode, + ToPostalCode = toPostalCode, + ToStateProvince = toStateProvince, + Weight = weight, + AddressResidentialIndicator = addressResidentialIndicator, + Confirmation = confirmation, + Dimensions = dimensions, + }; matchedTypes.Add("RateEstimateByCarrierIds"); match++; @@ -407,20 +452,6 @@ public override void Write(Utf8JsonWriter writer, EstimateRatesRequestBody value throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); } - newEstimateRatesRequestBody!.FromCityLocality = jsonDoc.RootElement.GetProperty("from_city_locality").Deserialize(DeserializingOptions)!; - newEstimateRatesRequestBody!.FromCountryCode = jsonDoc.RootElement.GetProperty("from_country_code").Deserialize(DeserializingOptions)!; - newEstimateRatesRequestBody!.FromPostalCode = jsonDoc.RootElement.GetProperty("from_postal_code").Deserialize(DeserializingOptions)!; - newEstimateRatesRequestBody!.FromStateProvince = jsonDoc.RootElement.GetProperty("from_state_province").Deserialize(DeserializingOptions)!; - newEstimateRatesRequestBody!.ShipDate = jsonDoc.RootElement.GetProperty("ship_date").Deserialize(DeserializingOptions)!; - newEstimateRatesRequestBody!.ToCityLocality = jsonDoc.RootElement.GetProperty("to_city_locality").Deserialize(DeserializingOptions)!; - newEstimateRatesRequestBody!.ToCountryCode = jsonDoc.RootElement.GetProperty("to_country_code").Deserialize(DeserializingOptions)!; - newEstimateRatesRequestBody!.ToPostalCode = jsonDoc.RootElement.GetProperty("to_postal_code").Deserialize(DeserializingOptions)!; - newEstimateRatesRequestBody!.ToStateProvince = jsonDoc.RootElement.GetProperty("to_state_province").Deserialize(DeserializingOptions)!; - newEstimateRatesRequestBody!.Weight = jsonDoc.RootElement.GetProperty("weight").Deserialize(DeserializingOptions)!; - newEstimateRatesRequestBody!.AddressResidentialIndicator = jsonDoc.RootElement.GetProperty("address_residential_indicator").Deserialize(DeserializingOptions)!; - newEstimateRatesRequestBody!.Confirmation = jsonDoc.RootElement.GetProperty("confirmation").Deserialize(DeserializingOptions)!; - newEstimateRatesRequestBody!.Dimensions = jsonDoc.RootElement.GetProperty("dimensions").Deserialize(DeserializingOptions)!; - // deserialization is considered successful at this point if no exception has been thrown. return newEstimateRatesRequestBody; } diff --git a/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs b/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs index eaab75df..0971f961 100644 --- a/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs @@ -33,7 +33,7 @@ public partial class GetBatchByExternalIdResponseBody /// [JsonPropertyName("label_format")] [JsonRequired] - public LabelFormat LabelFormat { get; set; } = new(); + public required LabelFormat LabelFormat { get; set; } = new(); /// @@ -42,7 +42,7 @@ public partial class GetBatchByExternalIdResponseBody /// label layout [JsonPropertyName("label_layout")] [JsonRequired] - public LabelLayout LabelLayout { get; set; } = new(); + public required LabelLayout LabelLayout { get; set; } = new(); /// @@ -50,7 +50,7 @@ public partial class GetBatchByExternalIdResponseBody /// [JsonPropertyName("status")] [JsonRequired] - public BatchStatus Status { get; set; } = new(); + public required BatchStatus Status { get; set; } = new(); /// @@ -59,7 +59,7 @@ public partial class GetBatchByExternalIdResponseBody /// Link to batch errors endpoint [JsonPropertyName("batch_errors_url")] [JsonRequired] - public OptionalLink BatchErrorsUrl { get; set; } + public required OptionalLink BatchErrorsUrl { get; set; } /// /// A string that uniquely identifies the batch @@ -70,7 +70,7 @@ public partial class GetBatchByExternalIdResponseBody /// [JsonPropertyName("batch_id")] [JsonRequired] - public string BatchId { get; set; } + public required string BatchId { get; set; } /// /// Link to batch labels query @@ -78,7 +78,7 @@ public partial class GetBatchByExternalIdResponseBody /// Link to batch labels query [JsonPropertyName("batch_labels_url")] [JsonRequired] - public OptionalLink BatchLabelsUrl { get; set; } + public required OptionalLink BatchLabelsUrl { get; set; } /// /// The batch number. @@ -86,7 +86,7 @@ public partial class GetBatchByExternalIdResponseBody /// The batch number. [JsonPropertyName("batch_number")] [JsonRequired] - public string BatchNumber { get; set; } + public required string BatchNumber { get; set; } /// /// The batch shipments endpoint @@ -94,7 +94,7 @@ public partial class GetBatchByExternalIdResponseBody /// The batch shipments endpoint [JsonPropertyName("batch_shipments_url")] [JsonRequired] - public OptionalLink BatchShipmentsUrl { get; set; } + public required OptionalLink BatchShipmentsUrl { get; set; } /// /// The number of labels generated in the batch @@ -105,7 +105,7 @@ public partial class GetBatchByExternalIdResponseBody /// [JsonPropertyName("completed")] [JsonRequired] - public int Completed { get; set; } + public required int Completed { get; set; } /// /// The total of errors, warnings, and completed properties @@ -116,7 +116,7 @@ public partial class GetBatchByExternalIdResponseBody /// [JsonPropertyName("count")] [JsonRequired] - public int Count { get; set; } + public required int Count { get; set; } /// /// The date and time the batch was created in ShipEngine @@ -127,7 +127,7 @@ public partial class GetBatchByExternalIdResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public required DateTimeOffset CreatedAt { get; set; } /// /// The number of errors that occurred while generating the batch @@ -138,7 +138,7 @@ public partial class GetBatchByExternalIdResponseBody /// [JsonPropertyName("errors")] [JsonRequired] - public int Errors { get; set; } + public required int Errors { get; set; } /// /// The form download for any customs that are needed @@ -146,7 +146,7 @@ public partial class GetBatchByExternalIdResponseBody /// The form download for any customs that are needed [JsonPropertyName("form_download")] [JsonRequired] - public OptionalLink FormDownload { get; set; } + public required OptionalLink FormDownload { get; set; } /// /// The number of forms for customs that are available for download @@ -157,7 +157,7 @@ public partial class GetBatchByExternalIdResponseBody /// [JsonPropertyName("forms")] [JsonRequired] - public int Forms { get; set; } + public required int Forms { get; set; } /// /// The label download for the batch @@ -165,7 +165,7 @@ public partial class GetBatchByExternalIdResponseBody /// The label download for the batch [JsonPropertyName("label_download")] [JsonRequired] - public LabelDownload LabelDownload { get; set; } + public required LabelDownload LabelDownload { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. @@ -173,7 +173,7 @@ public partial class GetBatchByExternalIdResponseBody /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. [JsonPropertyName("paperless_download")] [JsonRequired] - public PaperlessDownload PaperlessDownload { get; set; } + public required PaperlessDownload PaperlessDownload { get; set; } /// /// The errors associated with the failed API call @@ -181,7 +181,7 @@ public partial class GetBatchByExternalIdResponseBody /// The errors associated with the failed API call [JsonPropertyName("process_errors")] [JsonRequired] - public List ProcessErrors { get; set; } + public required List ProcessErrors { get; set; } /// /// The number of warnings that occurred while generating the batch @@ -192,7 +192,7 @@ public partial class GetBatchByExternalIdResponseBody /// [JsonPropertyName("warnings")] [JsonRequired] - public int Warnings { get; set; } + public required int Warnings { get; set; } /// /// Custom notes you can add for each created batch @@ -203,7 +203,7 @@ public partial class GetBatchByExternalIdResponseBody /// [JsonPropertyName("batch_notes")] [JsonRequired] - public string BatchNotes { get; set; } + public required string BatchNotes { get; set; } /// /// A string that uniquely identifies the external batch @@ -211,7 +211,7 @@ public partial class GetBatchByExternalIdResponseBody /// A string that uniquely identifies the external batch [JsonPropertyName("external_batch_id")] [JsonRequired] - public string ExternalBatchId { get; set; } + public required string ExternalBatchId { get; set; } /// /// The date and time the batch was processed in ShipEngine @@ -222,7 +222,7 @@ public partial class GetBatchByExternalIdResponseBody /// [JsonPropertyName("processed_at")] [JsonRequired] - public DateTimeOffset ProcessedAt { get; set; } + public required DateTimeOffset ProcessedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs b/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs index bd387689..b24c57e5 100644 --- a/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs @@ -33,7 +33,7 @@ public partial class GetBatchByIdResponseBody /// [JsonPropertyName("label_format")] [JsonRequired] - public LabelFormat LabelFormat { get; set; } = new(); + public required LabelFormat LabelFormat { get; set; } = new(); /// @@ -42,7 +42,7 @@ public partial class GetBatchByIdResponseBody /// label layout [JsonPropertyName("label_layout")] [JsonRequired] - public LabelLayout LabelLayout { get; set; } = new(); + public required LabelLayout LabelLayout { get; set; } = new(); /// @@ -50,7 +50,7 @@ public partial class GetBatchByIdResponseBody /// [JsonPropertyName("status")] [JsonRequired] - public BatchStatus Status { get; set; } = new(); + public required BatchStatus Status { get; set; } = new(); /// @@ -59,7 +59,7 @@ public partial class GetBatchByIdResponseBody /// Link to batch errors endpoint [JsonPropertyName("batch_errors_url")] [JsonRequired] - public OptionalLink BatchErrorsUrl { get; set; } + public required OptionalLink BatchErrorsUrl { get; set; } /// /// A string that uniquely identifies the batch @@ -70,7 +70,7 @@ public partial class GetBatchByIdResponseBody /// [JsonPropertyName("batch_id")] [JsonRequired] - public string BatchId { get; set; } + public required string BatchId { get; set; } /// /// Link to batch labels query @@ -78,7 +78,7 @@ public partial class GetBatchByIdResponseBody /// Link to batch labels query [JsonPropertyName("batch_labels_url")] [JsonRequired] - public OptionalLink BatchLabelsUrl { get; set; } + public required OptionalLink BatchLabelsUrl { get; set; } /// /// The batch number. @@ -86,7 +86,7 @@ public partial class GetBatchByIdResponseBody /// The batch number. [JsonPropertyName("batch_number")] [JsonRequired] - public string BatchNumber { get; set; } + public required string BatchNumber { get; set; } /// /// The batch shipments endpoint @@ -94,7 +94,7 @@ public partial class GetBatchByIdResponseBody /// The batch shipments endpoint [JsonPropertyName("batch_shipments_url")] [JsonRequired] - public OptionalLink BatchShipmentsUrl { get; set; } + public required OptionalLink BatchShipmentsUrl { get; set; } /// /// The number of labels generated in the batch @@ -105,7 +105,7 @@ public partial class GetBatchByIdResponseBody /// [JsonPropertyName("completed")] [JsonRequired] - public int Completed { get; set; } + public required int Completed { get; set; } /// /// The total of errors, warnings, and completed properties @@ -116,7 +116,7 @@ public partial class GetBatchByIdResponseBody /// [JsonPropertyName("count")] [JsonRequired] - public int Count { get; set; } + public required int Count { get; set; } /// /// The date and time the batch was created in ShipEngine @@ -127,7 +127,7 @@ public partial class GetBatchByIdResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public required DateTimeOffset CreatedAt { get; set; } /// /// The number of errors that occurred while generating the batch @@ -138,7 +138,7 @@ public partial class GetBatchByIdResponseBody /// [JsonPropertyName("errors")] [JsonRequired] - public int Errors { get; set; } + public required int Errors { get; set; } /// /// The form download for any customs that are needed @@ -146,7 +146,7 @@ public partial class GetBatchByIdResponseBody /// The form download for any customs that are needed [JsonPropertyName("form_download")] [JsonRequired] - public OptionalLink FormDownload { get; set; } + public required OptionalLink FormDownload { get; set; } /// /// The number of forms for customs that are available for download @@ -157,7 +157,7 @@ public partial class GetBatchByIdResponseBody /// [JsonPropertyName("forms")] [JsonRequired] - public int Forms { get; set; } + public required int Forms { get; set; } /// /// The label download for the batch @@ -165,7 +165,7 @@ public partial class GetBatchByIdResponseBody /// The label download for the batch [JsonPropertyName("label_download")] [JsonRequired] - public LabelDownload LabelDownload { get; set; } + public required LabelDownload LabelDownload { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. @@ -173,7 +173,7 @@ public partial class GetBatchByIdResponseBody /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. [JsonPropertyName("paperless_download")] [JsonRequired] - public PaperlessDownload PaperlessDownload { get; set; } + public required PaperlessDownload PaperlessDownload { get; set; } /// /// The errors associated with the failed API call @@ -181,7 +181,7 @@ public partial class GetBatchByIdResponseBody /// The errors associated with the failed API call [JsonPropertyName("process_errors")] [JsonRequired] - public List ProcessErrors { get; set; } + public required List ProcessErrors { get; set; } /// /// The number of warnings that occurred while generating the batch @@ -192,7 +192,7 @@ public partial class GetBatchByIdResponseBody /// [JsonPropertyName("warnings")] [JsonRequired] - public int Warnings { get; set; } + public required int Warnings { get; set; } /// /// Custom notes you can add for each created batch @@ -203,7 +203,7 @@ public partial class GetBatchByIdResponseBody /// [JsonPropertyName("batch_notes")] [JsonRequired] - public string BatchNotes { get; set; } + public required string BatchNotes { get; set; } /// /// A string that uniquely identifies the external batch @@ -211,7 +211,7 @@ public partial class GetBatchByIdResponseBody /// A string that uniquely identifies the external batch [JsonPropertyName("external_batch_id")] [JsonRequired] - public string ExternalBatchId { get; set; } + public required string ExternalBatchId { get; set; } /// /// The date and time the batch was processed in ShipEngine @@ -222,7 +222,7 @@ public partial class GetBatchByIdResponseBody /// [JsonPropertyName("processed_at")] [JsonRequired] - public DateTimeOffset ProcessedAt { get; set; } + public required DateTimeOffset ProcessedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs b/ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs index 25f6c3d4..b1a8666c 100644 --- a/ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs @@ -229,6 +229,7 @@ public override void Write(Utf8JsonWriter writer, GetCarrierSettingsResponseBody var jsonDoc = JsonDocument.ParseValue(ref reader); GetCarrierSettingsResponseBody? newGetCarrierSettingsResponseBody = null; + int match = 0; var matchedTypes = new List(); @@ -281,7 +282,6 @@ public override void Write(Utf8JsonWriter writer, GetCarrierSettingsResponseBody throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); } - // deserialization is considered successful at this point if no exception has been thrown. return newGetCarrierSettingsResponseBody; } diff --git a/ShipEngineSDK/Model/GetCarriersResponseBody.cs b/ShipEngineSDK/Model/GetCarriersResponseBody.cs index 2f98bb4b..b9d12ebc 100644 --- a/ShipEngineSDK/Model/GetCarriersResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarriersResponseBody.cs @@ -34,7 +34,7 @@ public partial class GetCarriersResponseBody /// The carrier response body [JsonPropertyName("carriers")] [JsonRequired] - public List Carriers { get; set; } + public required List Carriers { get; set; } /// /// The errors associated with the failed API call @@ -42,7 +42,7 @@ public partial class GetCarriersResponseBody /// The errors associated with the failed API call [JsonPropertyName("errors")] [JsonRequired] - public List Errors { get; set; } + public required List Errors { get; set; } /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur @@ -53,7 +53,7 @@ public partial class GetCarriersResponseBody /// [JsonPropertyName("request_id")] [JsonRequired] - public Guid RequestId { get; set; } + public required Guid RequestId { get; set; } /// diff --git a/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs b/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs index cdee4650..18212203 100644 --- a/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs +++ b/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs @@ -34,7 +34,7 @@ public partial class GetInsuranceBalanceResponseBody /// The monetary amount, in the specified currency. [JsonPropertyName("amount")] [JsonRequired] - public double Amount { get; set; } + public required double Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html @@ -42,7 +42,7 @@ public partial class GetInsuranceBalanceResponseBody /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html [JsonPropertyName("currency")] [JsonRequired] - public string Currency { get; set; } + public required string Currency { get; set; } /// diff --git a/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs b/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs index bb7771d3..907f58e7 100644 --- a/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs @@ -37,7 +37,7 @@ public partial class GetManifestByIdResponseBody /// [JsonPropertyName("carrier_id")] [JsonRequired] - public string CarrierId { get; set; } + public required string CarrierId { get; set; } /// /// The date-time that the manifest was created @@ -48,7 +48,7 @@ public partial class GetManifestByIdResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public required DateTimeOffset CreatedAt { get; set; } /// /// A string that uniquely identifies the form @@ -59,7 +59,7 @@ public partial class GetManifestByIdResponseBody /// [JsonPropertyName("form_id")] [JsonRequired] - public string FormId { get; set; } + public required string FormId { get; set; } /// /// An array of the label ids used in this manifest. @@ -67,14 +67,14 @@ public partial class GetManifestByIdResponseBody /// An array of the label ids used in this manifest. [JsonPropertyName("label_ids")] [JsonRequired] - public List LabelIds { get; set; } + public required List LabelIds { get; set; } /// /// Gets or Sets ManifestDownload /// [JsonPropertyName("manifest_download")] [JsonRequired] - public ManifestDownload ManifestDownload { get; set; } + public required ManifestDownload ManifestDownload { get; set; } /// /// A string that uniquely identifies the manifest @@ -85,7 +85,7 @@ public partial class GetManifestByIdResponseBody /// [JsonPropertyName("manifest_id")] [JsonRequired] - public string ManifestId { get; set; } + public required string ManifestId { get; set; } /// /// The date-time that the manifests shipments will be picked up @@ -96,7 +96,7 @@ public partial class GetManifestByIdResponseBody /// [JsonPropertyName("ship_date")] [JsonRequired] - public DateTimeOffset ShipDate { get; set; } + public required DateTimeOffset ShipDate { get; set; } /// /// The number of shipments that are included in this manifest @@ -107,7 +107,7 @@ public partial class GetManifestByIdResponseBody /// [JsonPropertyName("shipments")] [JsonRequired] - public int Shipments { get; set; } + public required int Shipments { get; set; } /// /// A string that uniquely identifies the submission @@ -118,7 +118,7 @@ public partial class GetManifestByIdResponseBody /// [JsonPropertyName("submission_id")] [JsonRequired] - public string SubmissionId { get; set; } + public required string SubmissionId { get; set; } /// /// A string that uniquely identifies the warehouse @@ -129,7 +129,7 @@ public partial class GetManifestByIdResponseBody /// [JsonPropertyName("warehouse_id")] [JsonRequired] - public string WarehouseId { get; set; } + public required string WarehouseId { get; set; } /// diff --git a/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs b/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs index 035e311d..3bc0879a 100644 --- a/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs @@ -36,7 +36,7 @@ public partial class GetPackageTypeByIdResponseBody /// [JsonPropertyName("name")] [JsonRequired] - public string Name { get; set; } + public required string Name { get; set; } /// /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. @@ -47,7 +47,7 @@ public partial class GetPackageTypeByIdResponseBody /// [JsonPropertyName("package_code")] [JsonRequired] - public string PackageCode { get; set; } + public required string PackageCode { get; set; } /// /// Provides a helpful description for the custom package. diff --git a/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs b/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs index b2595e28..67fbf790 100644 --- a/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs @@ -37,14 +37,14 @@ public partial class GetPickupByIdResponseBody /// [JsonPropertyName("carrier_id")] [JsonRequired] - public string CarrierId { get; set; } + public required string CarrierId { get; set; } /// /// Gets or Sets ContactDetails /// [JsonPropertyName("contact_details")] [JsonRequired] - public ContactDetails ContactDetails { get; set; } + public required ContactDetails ContactDetails { get; set; } /// /// The date and time that the pickup was created in ShipEngine. @@ -55,7 +55,7 @@ public partial class GetPickupByIdResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public required DateTimeOffset CreatedAt { get; set; } /// /// The errors associated with the failed API call @@ -63,7 +63,7 @@ public partial class GetPickupByIdResponseBody /// The errors associated with the failed API call [JsonPropertyName("errors")] [JsonRequired] - public List Errors { get; set; } + public required List Errors { get; set; } /// /// Label IDs that will be included in the pickup request @@ -71,14 +71,14 @@ public partial class GetPickupByIdResponseBody /// Label IDs that will be included in the pickup request [JsonPropertyName("label_ids")] [JsonRequired] - public List LabelIds { get; set; } + public required List LabelIds { get; set; } /// /// Gets or Sets PickupAddress /// [JsonPropertyName("pickup_address")] [JsonRequired] - public Address PickupAddress { get; set; } + public required Address PickupAddress { get; set; } /// /// Pickup Resource ID @@ -89,14 +89,14 @@ public partial class GetPickupByIdResponseBody /// [JsonPropertyName("pickup_id")] [JsonRequired] - public string PickupId { get; set; } + public required string PickupId { get; set; } /// /// Gets or Sets PickupWindow /// [JsonPropertyName("pickup_window")] [JsonRequired] - public PickupWindow PickupWindow { get; set; } + public required PickupWindow PickupWindow { get; set; } /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur @@ -107,7 +107,7 @@ public partial class GetPickupByIdResponseBody /// [JsonPropertyName("request_id")] [JsonRequired] - public Guid RequestId { get; set; } + public required Guid RequestId { get; set; } /// /// The warehouse_id associated with the pickup @@ -118,7 +118,7 @@ public partial class GetPickupByIdResponseBody /// [JsonPropertyName("warehouse_id")] [JsonRequired] - public string WarehouseId { get; set; } + public required string WarehouseId { get; set; } /// /// The date and time that the pickup was cancelled in ShipEngine. @@ -139,7 +139,7 @@ public partial class GetPickupByIdResponseBody /// [JsonPropertyName("confirmation_number")] [JsonRequired] - public string ConfirmationNumber { get; set; } + public required string ConfirmationNumber { get; set; } /// /// Used by some carriers to give special instructions for a package pickup diff --git a/ShipEngineSDK/Model/GetPickupsResponseBody.cs b/ShipEngineSDK/Model/GetPickupsResponseBody.cs index 5d79aa4a..0414437b 100644 --- a/ShipEngineSDK/Model/GetPickupsResponseBody.cs +++ b/ShipEngineSDK/Model/GetPickupsResponseBody.cs @@ -34,7 +34,7 @@ public partial class GetPickupsResponseBody /// The errors associated with the failed API call [JsonPropertyName("errors")] [JsonRequired] - public List Errors { get; set; } + public required List Errors { get; set; } /// /// Helpful links to other pages of results @@ -42,7 +42,7 @@ public partial class GetPickupsResponseBody /// Helpful links to other pages of results [JsonPropertyName("links")] [JsonRequired] - public PaginationLink Links { get; set; } + public required PaginationLink Links { get; set; } /// /// Current page of the list pickups results @@ -53,7 +53,7 @@ public partial class GetPickupsResponseBody /// [JsonPropertyName("page")] [JsonRequired] - public int Page { get; set; } + public required int Page { get; set; } /// /// Total number of pages for list pickups results @@ -64,7 +64,7 @@ public partial class GetPickupsResponseBody /// [JsonPropertyName("pages")] [JsonRequired] - public int Pages { get; set; } + public required int Pages { get; set; } /// /// An array of pickups associated with the user's account. @@ -72,7 +72,7 @@ public partial class GetPickupsResponseBody /// An array of pickups associated with the user's account. [JsonPropertyName("pickups")] [JsonRequired] - public List Pickups { get; set; } + public required List Pickups { get; set; } /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur @@ -83,7 +83,7 @@ public partial class GetPickupsResponseBody /// [JsonPropertyName("request_id")] [JsonRequired] - public Guid RequestId { get; set; } + public required Guid RequestId { get; set; } /// /// The total number of pickups returned @@ -94,7 +94,7 @@ public partial class GetPickupsResponseBody /// [JsonPropertyName("total")] [JsonRequired] - public long Total { get; set; } + public required long Total { get; set; } /// diff --git a/ShipEngineSDK/Model/GetRateByIdResponseBody.cs b/ShipEngineSDK/Model/GetRateByIdResponseBody.cs index 64b756b5..dc88b2a9 100644 --- a/ShipEngineSDK/Model/GetRateByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetRateByIdResponseBody.cs @@ -33,7 +33,7 @@ public partial class GetRateByIdResponseBody /// [JsonPropertyName("rate_type")] [JsonRequired] - public RateType RateType { get; set; } = new(); + public required RateType RateType { get; set; } = new(); /// @@ -41,7 +41,7 @@ public partial class GetRateByIdResponseBody /// [JsonPropertyName("validation_status")] [JsonRequired] - public ValidationStatus ValidationStatus { get; set; } = new(); + public required ValidationStatus ValidationStatus { get; set; } = new(); /// @@ -50,7 +50,7 @@ public partial class GetRateByIdResponseBody /// carrier code [JsonPropertyName("carrier_code")] [JsonRequired] - public string CarrierCode { get; set; } + public required string CarrierCode { get; set; } /// /// carrier friendly name @@ -58,7 +58,7 @@ public partial class GetRateByIdResponseBody /// carrier friendly name [JsonPropertyName("carrier_friendly_name")] [JsonRequired] - public string CarrierFriendlyName { get; set; } + public required string CarrierFriendlyName { get; set; } /// /// A string that uniquely identifies the carrier @@ -69,7 +69,7 @@ public partial class GetRateByIdResponseBody /// [JsonPropertyName("carrier_id")] [JsonRequired] - public string CarrierId { get; set; } + public required string CarrierId { get; set; } /// /// carrier nickname @@ -77,7 +77,7 @@ public partial class GetRateByIdResponseBody /// carrier nickname [JsonPropertyName("carrier_nickname")] [JsonRequired] - public string CarrierNickname { get; set; } + public required string CarrierNickname { get; set; } /// /// The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price. @@ -85,7 +85,7 @@ public partial class GetRateByIdResponseBody /// The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price. [JsonPropertyName("confirmation_amount")] [JsonRequired] - public MonetaryValue ConfirmationAmount { get; set; } + public required MonetaryValue ConfirmationAmount { get; set; } /// /// The error messages @@ -93,7 +93,7 @@ public partial class GetRateByIdResponseBody /// The error messages [JsonPropertyName("error_messages")] [JsonRequired] - public List ErrorMessages { get; set; } + public required List ErrorMessages { get; set; } /// /// Indicates if the rate is guaranteed. @@ -101,7 +101,7 @@ public partial class GetRateByIdResponseBody /// Indicates if the rate is guaranteed. [JsonPropertyName("guaranteed_service")] [JsonRequired] - public bool GuaranteedService { get; set; } + public required bool GuaranteedService { get; set; } /// /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. @@ -109,7 +109,7 @@ public partial class GetRateByIdResponseBody /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. [JsonPropertyName("insurance_amount")] [JsonRequired] - public MonetaryValue InsuranceAmount { get; set; } + public required MonetaryValue InsuranceAmount { get; set; } /// /// Indicates if the rates been negotiated @@ -117,7 +117,7 @@ public partial class GetRateByIdResponseBody /// Indicates if the rates been negotiated [JsonPropertyName("negotiated_rate")] [JsonRequired] - public bool NegotiatedRate { get; set; } + public required bool NegotiatedRate { get; set; } /// /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. @@ -125,7 +125,7 @@ public partial class GetRateByIdResponseBody /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. [JsonPropertyName("other_amount")] [JsonRequired] - public MonetaryValue OtherAmount { get; set; } + public required MonetaryValue OtherAmount { get; set; } /// /// A string that uniquely identifies the rate @@ -136,7 +136,7 @@ public partial class GetRateByIdResponseBody /// [JsonPropertyName("rate_id")] [JsonRequired] - public string RateId { get; set; } + public required string RateId { get; set; } /// /// service code for the rate @@ -144,7 +144,7 @@ public partial class GetRateByIdResponseBody /// service code for the rate [JsonPropertyName("service_code")] [JsonRequired] - public string ServiceCode { get; set; } + public required string ServiceCode { get; set; } /// /// service type @@ -152,7 +152,7 @@ public partial class GetRateByIdResponseBody /// service type [JsonPropertyName("service_type")] [JsonRequired] - public string ServiceType { get; set; } + public required string ServiceType { get; set; } /// /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. @@ -160,7 +160,7 @@ public partial class GetRateByIdResponseBody /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. [JsonPropertyName("shipping_amount")] [JsonRequired] - public MonetaryValue ShippingAmount { get; set; } + public required MonetaryValue ShippingAmount { get; set; } /// /// Indicates if rate is trackable @@ -168,7 +168,7 @@ public partial class GetRateByIdResponseBody /// Indicates if rate is trackable [JsonPropertyName("trackable")] [JsonRequired] - public bool Trackable { get; set; } + public required bool Trackable { get; set; } /// /// The warning messages @@ -176,7 +176,7 @@ public partial class GetRateByIdResponseBody /// The warning messages [JsonPropertyName("warning_messages")] [JsonRequired] - public List WarningMessages { get; set; } + public required List WarningMessages { get; set; } /// /// The carrier delivery days @@ -214,7 +214,7 @@ public partial class GetRateByIdResponseBody /// [JsonPropertyName("package_type")] [JsonRequired] - public string PackageType { get; set; } + public required string PackageType { get; set; } /// /// The total shipping cost for the specified comparison_rate_type. @@ -246,7 +246,7 @@ public partial class GetRateByIdResponseBody /// [JsonPropertyName("zone")] [JsonRequired] - public int Zone { get; set; } + public required int Zone { get; set; } /// diff --git a/ShipEngineSDK/Model/GetServicePointsRequest.cs b/ShipEngineSDK/Model/GetServicePointsRequest.cs index 44c1d279..557907f7 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequest.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequest.cs @@ -179,6 +179,7 @@ public override void Write(Utf8JsonWriter writer, GetServicePointsRequest value, var jsonDoc = JsonDocument.ParseValue(ref reader); GetServicePointsRequest? newGetServicePointsRequest = null; + int match = 0; var matchedTypes = new List(); @@ -205,7 +206,6 @@ public override void Write(Utf8JsonWriter writer, GetServicePointsRequest value, throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); } - // deserialization is considered successful at this point if no exception has been thrown. return newGetServicePointsRequest; } diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBody.cs b/ShipEngineSDK/Model/GetServicePointsRequestBody.cs index 3d041dd3..1e2d14b4 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBody.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBody.cs @@ -34,7 +34,7 @@ public partial class GetServicePointsRequestBody /// An array of shipping service providers and service codes [JsonPropertyName("providers")] [JsonRequired] - public List Providers { get; set; } + public required List Providers { get; set; } /// /// Gets or Sets Address diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs index 2411831f..c20f623e 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs @@ -37,7 +37,7 @@ public partial class GetServicePointsRequestBodyAddress /// [JsonPropertyName("country_code")] [JsonRequired] - public string CountryCode { get; set; } + public required string CountryCode { get; set; } /// /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. diff --git a/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs b/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs index 512379f8..b69008e9 100644 --- a/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs @@ -34,7 +34,7 @@ public partial class GetShipmentByExternalIdResponseBody /// The type of delivery confirmation that is required for this shipment. [JsonPropertyName("confirmation")] [JsonRequired] - public DeliveryConfirmation Confirmation { get; set; } = new(); + public required DeliveryConfirmation Confirmation { get; set; } = new(); /// @@ -43,7 +43,7 @@ public partial class GetShipmentByExternalIdResponseBody /// The insurance provider to use for any insured packages in the shipment. [JsonPropertyName("insurance_provider")] [JsonRequired] - public InsuranceProvider InsuranceProvider { get; set; } = new(); + public required InsuranceProvider InsuranceProvider { get; set; } = new(); /// @@ -52,7 +52,7 @@ public partial class GetShipmentByExternalIdResponseBody /// The current status of the shipment [JsonPropertyName("shipment_status")] [JsonRequired] - public ShipmentStatus ShipmentStatus { get; set; } = new(); + public required ShipmentStatus ShipmentStatus { get; set; } = new(); /// @@ -66,7 +66,7 @@ public partial class GetShipmentByExternalIdResponseBody /// Advanced shipment options. These are entirely optional. [JsonPropertyName("advanced_options")] [JsonRequired] - public AdvancedShipmentOptions AdvancedOptions { get; set; } + public required AdvancedShipmentOptions AdvancedOptions { get; set; } /// /// The carrier account that is billed for the shipping charges @@ -77,7 +77,7 @@ public partial class GetShipmentByExternalIdResponseBody /// [JsonPropertyName("carrier_id")] [JsonRequired] - public string CarrierId { get; set; } + public required string CarrierId { get; set; } /// /// The date and time that the shipment was created in ShipEngine. @@ -88,7 +88,7 @@ public partial class GetShipmentByExternalIdResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public required DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the shipment was created or last modified. @@ -99,7 +99,7 @@ public partial class GetShipmentByExternalIdResponseBody /// [JsonPropertyName("modified_at")] [JsonRequired] - public DateTimeOffset ModifiedAt { get; set; } + public required DateTimeOffset ModifiedAt { get; set; } /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. @@ -107,7 +107,7 @@ public partial class GetShipmentByExternalIdResponseBody /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. [JsonPropertyName("packages")] [JsonRequired] - public List Packages { get; set; } + public required List Packages { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. @@ -115,7 +115,7 @@ public partial class GetShipmentByExternalIdResponseBody /// The return address for this shipment. Defaults to the `ship_from` address. [JsonPropertyName("return_to")] [JsonRequired] - public ShippingAddress ReturnTo { get; set; } + public required ShippingAddress ReturnTo { get; set; } /// /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. @@ -126,7 +126,7 @@ public partial class GetShipmentByExternalIdResponseBody /// [JsonPropertyName("service_code")] [JsonRequired] - public string ServiceCode { get; set; } + public required string ServiceCode { get; set; } /// /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -137,7 +137,7 @@ public partial class GetShipmentByExternalIdResponseBody /// [JsonPropertyName("ship_date")] [JsonRequired] - public DateTimeOffset ShipDate { get; set; } + public required DateTimeOffset ShipDate { get; set; } /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. @@ -145,7 +145,7 @@ public partial class GetShipmentByExternalIdResponseBody /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. [JsonPropertyName("ship_from")] [JsonRequired] - public ShippingAddress ShipFrom { get; set; } + public required ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address @@ -153,7 +153,7 @@ public partial class GetShipmentByExternalIdResponseBody /// The recipient's mailing address [JsonPropertyName("ship_to")] [JsonRequired] - public ShippingAddressTo ShipTo { get; set; } + public required ShippingAddressTo ShipTo { get; set; } /// /// A string that uniquely identifies the shipment @@ -164,7 +164,7 @@ public partial class GetShipmentByExternalIdResponseBody /// [JsonPropertyName("shipment_id")] [JsonRequired] - public string ShipmentId { get; set; } + public required string ShipmentId { get; set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. @@ -172,7 +172,7 @@ public partial class GetShipmentByExternalIdResponseBody /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. [JsonPropertyName("tags")] [JsonRequired] - public List Tags { get; set; } + public required List Tags { get; set; } /// /// The combined weight of all packages in the shipment @@ -180,7 +180,7 @@ public partial class GetShipmentByExternalIdResponseBody /// The combined weight of all packages in the shipment [JsonPropertyName("total_weight")] [JsonRequired] - public Weight TotalWeight { get; set; } + public required Weight TotalWeight { get; set; } /// /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. @@ -198,7 +198,7 @@ public partial class GetShipmentByExternalIdResponseBody /// Customs information. This is usually only needed for international shipments. [JsonPropertyName("customs")] [JsonRequired] - public InternationalShipmentOptions Customs { get; set; } + public required InternationalShipmentOptions Customs { get; set; } /// /// ID that the Order Source assigned @@ -260,7 +260,7 @@ public partial class GetShipmentByExternalIdResponseBody /// [JsonPropertyName("warehouse_id")] [JsonRequired] - public string WarehouseId { get; set; } + public required string WarehouseId { get; set; } /// diff --git a/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs b/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs index 61d89e50..bba40672 100644 --- a/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs @@ -34,7 +34,7 @@ public partial class GetShipmentByIdResponseBody /// The type of delivery confirmation that is required for this shipment. [JsonPropertyName("confirmation")] [JsonRequired] - public DeliveryConfirmation Confirmation { get; set; } = new(); + public required DeliveryConfirmation Confirmation { get; set; } = new(); /// @@ -43,7 +43,7 @@ public partial class GetShipmentByIdResponseBody /// The insurance provider to use for any insured packages in the shipment. [JsonPropertyName("insurance_provider")] [JsonRequired] - public InsuranceProvider InsuranceProvider { get; set; } = new(); + public required InsuranceProvider InsuranceProvider { get; set; } = new(); /// @@ -52,7 +52,7 @@ public partial class GetShipmentByIdResponseBody /// The current status of the shipment [JsonPropertyName("shipment_status")] [JsonRequired] - public ShipmentStatus ShipmentStatus { get; set; } = new(); + public required ShipmentStatus ShipmentStatus { get; set; } = new(); /// @@ -66,7 +66,7 @@ public partial class GetShipmentByIdResponseBody /// Advanced shipment options. These are entirely optional. [JsonPropertyName("advanced_options")] [JsonRequired] - public AdvancedShipmentOptions AdvancedOptions { get; set; } + public required AdvancedShipmentOptions AdvancedOptions { get; set; } /// /// The carrier account that is billed for the shipping charges @@ -77,7 +77,7 @@ public partial class GetShipmentByIdResponseBody /// [JsonPropertyName("carrier_id")] [JsonRequired] - public string CarrierId { get; set; } + public required string CarrierId { get; set; } /// /// The date and time that the shipment was created in ShipEngine. @@ -88,7 +88,7 @@ public partial class GetShipmentByIdResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public required DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the shipment was created or last modified. @@ -99,7 +99,7 @@ public partial class GetShipmentByIdResponseBody /// [JsonPropertyName("modified_at")] [JsonRequired] - public DateTimeOffset ModifiedAt { get; set; } + public required DateTimeOffset ModifiedAt { get; set; } /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. @@ -107,7 +107,7 @@ public partial class GetShipmentByIdResponseBody /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. [JsonPropertyName("packages")] [JsonRequired] - public List Packages { get; set; } + public required List Packages { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. @@ -115,7 +115,7 @@ public partial class GetShipmentByIdResponseBody /// The return address for this shipment. Defaults to the `ship_from` address. [JsonPropertyName("return_to")] [JsonRequired] - public ShippingAddress ReturnTo { get; set; } + public required ShippingAddress ReturnTo { get; set; } /// /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. @@ -126,7 +126,7 @@ public partial class GetShipmentByIdResponseBody /// [JsonPropertyName("service_code")] [JsonRequired] - public string ServiceCode { get; set; } + public required string ServiceCode { get; set; } /// /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -137,7 +137,7 @@ public partial class GetShipmentByIdResponseBody /// [JsonPropertyName("ship_date")] [JsonRequired] - public DateTimeOffset ShipDate { get; set; } + public required DateTimeOffset ShipDate { get; set; } /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. @@ -145,7 +145,7 @@ public partial class GetShipmentByIdResponseBody /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. [JsonPropertyName("ship_from")] [JsonRequired] - public ShippingAddress ShipFrom { get; set; } + public required ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address @@ -153,7 +153,7 @@ public partial class GetShipmentByIdResponseBody /// The recipient's mailing address [JsonPropertyName("ship_to")] [JsonRequired] - public ShippingAddressTo ShipTo { get; set; } + public required ShippingAddressTo ShipTo { get; set; } /// /// A string that uniquely identifies the shipment @@ -164,7 +164,7 @@ public partial class GetShipmentByIdResponseBody /// [JsonPropertyName("shipment_id")] [JsonRequired] - public string ShipmentId { get; set; } + public required string ShipmentId { get; set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. @@ -172,7 +172,7 @@ public partial class GetShipmentByIdResponseBody /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. [JsonPropertyName("tags")] [JsonRequired] - public List Tags { get; set; } + public required List Tags { get; set; } /// /// The combined weight of all packages in the shipment @@ -180,7 +180,7 @@ public partial class GetShipmentByIdResponseBody /// The combined weight of all packages in the shipment [JsonPropertyName("total_weight")] [JsonRequired] - public Weight TotalWeight { get; set; } + public required Weight TotalWeight { get; set; } /// /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. @@ -198,7 +198,7 @@ public partial class GetShipmentByIdResponseBody /// Customs information. This is usually only needed for international shipments. [JsonPropertyName("customs")] [JsonRequired] - public InternationalShipmentOptions Customs { get; set; } + public required InternationalShipmentOptions Customs { get; set; } /// /// ID that the Order Source assigned @@ -260,7 +260,7 @@ public partial class GetShipmentByIdResponseBody /// [JsonPropertyName("warehouse_id")] [JsonRequired] - public string WarehouseId { get; set; } + public required string WarehouseId { get; set; } /// diff --git a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs index 1fc8a425..048134ea 100644 --- a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs @@ -33,7 +33,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// [JsonPropertyName("status_code")] [JsonRequired] - public StatusCode StatusCode { get; set; } = new(); + public required StatusCode StatusCode { get; set; } = new(); /// @@ -45,7 +45,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// [JsonPropertyName("carrier_status_code")] [JsonRequired] - public string CarrierStatusCode { get; set; } + public required string CarrierStatusCode { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -56,7 +56,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// [JsonPropertyName("estimated_delivery_date")] [JsonRequired] - public DateTimeOffset EstimatedDeliveryDate { get; set; } + public required DateTimeOffset EstimatedDeliveryDate { get; set; } /// /// The events that have occured during the lifetime of this tracking number. @@ -64,7 +64,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// The events that have occured during the lifetime of this tracking number. [JsonPropertyName("events")] [JsonRequired] - public List Events { get; set; } + public required List Events { get; set; } /// /// A tracking number for a package. The format depends on the carrier. @@ -75,7 +75,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// [JsonPropertyName("tracking_number")] [JsonRequired] - public string TrackingNumber { get; set; } + public required string TrackingNumber { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. diff --git a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs index 795d4c53..8946ddcb 100644 --- a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs @@ -33,7 +33,7 @@ public partial class GetTrackingLogResponseBody /// [JsonPropertyName("status_code")] [JsonRequired] - public StatusCode StatusCode { get; set; } = new(); + public required StatusCode StatusCode { get; set; } = new(); /// @@ -45,7 +45,7 @@ public partial class GetTrackingLogResponseBody /// [JsonPropertyName("carrier_code")] [JsonRequired] - public string CarrierCode { get; set; } + public required string CarrierCode { get; set; } /// /// Carrier detail code @@ -56,7 +56,7 @@ public partial class GetTrackingLogResponseBody /// [JsonPropertyName("carrier_detail_code")] [JsonRequired] - public string CarrierDetailCode { get; set; } + public required string CarrierDetailCode { get; set; } /// /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. @@ -67,7 +67,7 @@ public partial class GetTrackingLogResponseBody /// [JsonPropertyName("carrier_id")] [JsonRequired] - public string CarrierId { get; set; } + public required string CarrierId { get; set; } /// /// Carrier status code @@ -78,7 +78,7 @@ public partial class GetTrackingLogResponseBody /// [JsonPropertyName("carrier_status_code")] [JsonRequired] - public string CarrierStatusCode { get; set; } + public required string CarrierStatusCode { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -89,7 +89,7 @@ public partial class GetTrackingLogResponseBody /// [JsonPropertyName("estimated_delivery_date")] [JsonRequired] - public DateTimeOffset EstimatedDeliveryDate { get; set; } + public required DateTimeOffset EstimatedDeliveryDate { get; set; } /// /// The events that have occured during the lifetime of this tracking number. @@ -97,7 +97,7 @@ public partial class GetTrackingLogResponseBody /// The events that have occured during the lifetime of this tracking number. [JsonPropertyName("events")] [JsonRequired] - public List Events { get; set; } + public required List Events { get; set; } /// /// A tracking number for a package. The format depends on the carrier. @@ -108,7 +108,7 @@ public partial class GetTrackingLogResponseBody /// [JsonPropertyName("tracking_number")] [JsonRequired] - public string TrackingNumber { get; set; } + public required string TrackingNumber { get; set; } /// /// Carrier Tracking Url, if available @@ -119,7 +119,7 @@ public partial class GetTrackingLogResponseBody /// [JsonPropertyName("tracking_url")] [JsonRequired] - public string TrackingUrl { get; set; } + public required string TrackingUrl { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. diff --git a/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs b/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs index 88d9461b..4d6c420f 100644 --- a/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs @@ -37,7 +37,7 @@ public partial class GetWarehouseByIdResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public required DateTimeOffset CreatedAt { get; set; } /// /// Name of the warehouse @@ -48,7 +48,7 @@ public partial class GetWarehouseByIdResponseBody /// [JsonPropertyName("name")] [JsonRequired] - public string Name { get; set; } + public required string Name { get; set; } /// /// The origin address of the warehouse @@ -56,7 +56,7 @@ public partial class GetWarehouseByIdResponseBody /// The origin address of the warehouse [JsonPropertyName("origin_address")] [JsonRequired] - public Address OriginAddress { get; set; } + public required Address OriginAddress { get; set; } /// /// The return address associated with the warehouse @@ -64,7 +64,7 @@ public partial class GetWarehouseByIdResponseBody /// The return address associated with the warehouse [JsonPropertyName("return_address")] [JsonRequired] - public Address ReturnAddress { get; set; } + public required Address ReturnAddress { get; set; } /// /// A string that uniquely identifies the warehouse @@ -75,7 +75,7 @@ public partial class GetWarehouseByIdResponseBody /// [JsonPropertyName("warehouse_id")] [JsonRequired] - public string WarehouseId { get; set; } + public required string WarehouseId { get; set; } /// /// Designates which single warehouse is the default on the account diff --git a/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs b/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs index 5e6d22a6..4bf191fd 100644 --- a/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs @@ -33,7 +33,7 @@ public partial class GetWebhookByIdResponseBody /// [JsonPropertyName("event")] [JsonRequired] - public WebhookEvent Event { get; set; } = new(); + public required WebhookEvent Event { get; set; } = new(); /// @@ -45,7 +45,7 @@ public partial class GetWebhookByIdResponseBody /// [JsonPropertyName("url")] [JsonRequired] - public string Url { get; set; } + public required string Url { get; set; } /// /// A string that uniquely identifies the webhook @@ -56,7 +56,7 @@ public partial class GetWebhookByIdResponseBody /// [JsonPropertyName("webhook_id")] [JsonRequired] - public string WebhookId { get; set; } + public required string WebhookId { get; set; } /// /// Array of custom webhook headers diff --git a/ShipEngineSDK/Model/ImporterOfRecords.cs b/ShipEngineSDK/Model/ImporterOfRecords.cs index a53694e6..ca6270d9 100644 --- a/ShipEngineSDK/Model/ImporterOfRecords.cs +++ b/ShipEngineSDK/Model/ImporterOfRecords.cs @@ -37,7 +37,7 @@ public partial class ImporterOfRecords /// [JsonPropertyName("address_line1")] [JsonRequired] - public string AddressLine1 { get; set; } + public required string AddressLine1 { get; set; } /// /// The name of the city or locality @@ -48,7 +48,7 @@ public partial class ImporterOfRecords /// [JsonPropertyName("city_locality")] [JsonRequired] - public string CityLocality { get; set; } + public required string CityLocality { get; set; } /// /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) @@ -59,7 +59,7 @@ public partial class ImporterOfRecords /// [JsonPropertyName("country_code")] [JsonRequired] - public string CountryCode { get; set; } + public required string CountryCode { get; set; } /// /// The name of a contact person at this address. Either `name` or the `company_name` field should always be set. @@ -70,7 +70,7 @@ public partial class ImporterOfRecords /// [JsonPropertyName("name")] [JsonRequired] - public string Name { get; set; } + public required string Name { get; set; } /// /// postal code @@ -81,7 +81,7 @@ public partial class ImporterOfRecords /// [JsonPropertyName("postal_code")] [JsonRequired] - public string PostalCode { get; set; } + public required string PostalCode { get; set; } /// /// The second line of the street address. For some addresses, this line may not be needed. diff --git a/ShipEngineSDK/Model/InternationalShipmentOptions.cs b/ShipEngineSDK/Model/InternationalShipmentOptions.cs index 71be2755..f3817ee0 100644 --- a/ShipEngineSDK/Model/InternationalShipmentOptions.cs +++ b/ShipEngineSDK/Model/InternationalShipmentOptions.cs @@ -34,7 +34,7 @@ public partial class InternationalShipmentOptions /// The type of contents in this shipment. This may impact import duties or customs treatment. [JsonPropertyName("contents")] [JsonRequired] - public PackageContents Contents { get; set; } = new(); + public required PackageContents Contents { get; set; } = new(); /// @@ -43,7 +43,7 @@ public partial class InternationalShipmentOptions /// Indicates what to do if a package is unable to be delivered. [JsonPropertyName("non_delivery")] [JsonRequired] - public NonDelivery NonDelivery { get; set; } = new(); + public required NonDelivery NonDelivery { get; set; } = new(); /// diff --git a/ShipEngineSDK/Model/LabelMessages.cs b/ShipEngineSDK/Model/LabelMessages.cs index fcf80cba..48793a3e 100644 --- a/ShipEngineSDK/Model/LabelMessages.cs +++ b/ShipEngineSDK/Model/LabelMessages.cs @@ -34,7 +34,7 @@ public partial class LabelMessages /// The first line of the custom label message. Some carriers may prefix this line with something like \"REF\", \"Reference\", \"Trx Ref No.\", etc. [JsonPropertyName("reference1")] [JsonRequired] - public string Reference1 { get; set; } + public required string Reference1 { get; set; } /// /// The second line of the custom label message. Some carriers may prefix this line with something like \"INV\", \"Reference 2\", \"Trx Ref No.\", etc. @@ -42,7 +42,7 @@ public partial class LabelMessages /// The second line of the custom label message. Some carriers may prefix this line with something like \"INV\", \"Reference 2\", \"Trx Ref No.\", etc. [JsonPropertyName("reference2")] [JsonRequired] - public string Reference2 { get; set; } + public required string Reference2 { get; set; } /// /// The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc. @@ -50,7 +50,7 @@ public partial class LabelMessages /// The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc. [JsonPropertyName("reference3")] [JsonRequired] - public string Reference3 { get; set; } + public required string Reference3 { get; set; } /// diff --git a/ShipEngineSDK/Model/LabelPackagesInner.cs b/ShipEngineSDK/Model/LabelPackagesInner.cs index f671009f..61a31bbd 100644 --- a/ShipEngineSDK/Model/LabelPackagesInner.cs +++ b/ShipEngineSDK/Model/LabelPackagesInner.cs @@ -34,7 +34,7 @@ public partial class LabelPackagesInner /// The package weight [JsonPropertyName("weight")] [JsonRequired] - public Weight Weight { get; set; } + public required Weight Weight { get; set; } /// /// Alternative identifiers associated with this package. diff --git a/ShipEngineSDK/Model/Link.cs b/ShipEngineSDK/Model/Link.cs index 4e4fcb2a..d32bc67c 100644 --- a/ShipEngineSDK/Model/Link.cs +++ b/ShipEngineSDK/Model/Link.cs @@ -37,7 +37,7 @@ public partial class Link /// [JsonPropertyName("href")] [JsonRequired] - public string Href { get; set; } + public required string Href { get; set; } /// /// The type of resource, or the type of relationship to the parent resource diff --git a/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs b/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs index f00b438c..57a6a505 100644 --- a/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs +++ b/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs @@ -104,14 +104,14 @@ public class ListAccountImagesResponseBodyItem /// Image List [JsonPropertyName("images")] [JsonRequired] - public List Images { get; set; } + public required List Images { get; set; } /// /// Gets or Sets Links /// [JsonPropertyName("links")] [JsonRequired] - public PaginationLink Links { get; set; } + public required PaginationLink Links { get; set; } /// /// The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. @@ -122,7 +122,7 @@ public class ListAccountImagesResponseBodyItem /// [JsonPropertyName("page")] [JsonRequired] - public int Page { get; set; } + public required int Page { get; set; } /// /// The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero. @@ -133,7 +133,7 @@ public class ListAccountImagesResponseBodyItem /// [JsonPropertyName("pages")] [JsonRequired] - public int Pages { get; set; } + public required int Pages { get; set; } /// /// The total number of items across all pages of results @@ -144,7 +144,7 @@ public class ListAccountImagesResponseBodyItem /// [JsonPropertyName("total")] [JsonRequired] - public int Total { get; set; } + public required int Total { get; set; } /// diff --git a/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs b/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs index fe0a5f35..921c2988 100644 --- a/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs +++ b/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs @@ -104,14 +104,14 @@ public class ListAccountSettingsImagesResponseBodyItem /// Image List [JsonPropertyName("images")] [JsonRequired] - public List Images { get; set; } + public required List Images { get; set; } /// /// Gets or Sets Links /// [JsonPropertyName("links")] [JsonRequired] - public PaginationLink Links { get; set; } + public required PaginationLink Links { get; set; } /// /// The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. @@ -122,7 +122,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// [JsonPropertyName("page")] [JsonRequired] - public int Page { get; set; } + public required int Page { get; set; } /// /// The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero. @@ -133,7 +133,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// [JsonPropertyName("pages")] [JsonRequired] - public int Pages { get; set; } + public required int Pages { get; set; } /// /// The total number of items across all pages of results @@ -144,7 +144,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// [JsonPropertyName("total")] [JsonRequired] - public int Total { get; set; } + public required int Total { get; set; } /// diff --git a/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs b/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs index d2a47ee6..b6a9596b 100644 --- a/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs +++ b/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs @@ -34,14 +34,14 @@ public partial class ListBatchErrorsResponseBody /// The errors currently associated with the batch [JsonPropertyName("errors")] [JsonRequired] - public List Errors { get; set; } + public required List Errors { get; set; } /// /// Gets or Sets Links /// [JsonPropertyName("links")] [JsonRequired] - public PaginationLink Links { get; set; } + public required PaginationLink Links { get; set; } /// diff --git a/ShipEngineSDK/Model/ListBatchesResponseBody.cs b/ShipEngineSDK/Model/ListBatchesResponseBody.cs index 6bfa3655..71388935 100644 --- a/ShipEngineSDK/Model/ListBatchesResponseBody.cs +++ b/ShipEngineSDK/Model/ListBatchesResponseBody.cs @@ -34,14 +34,14 @@ public partial class ListBatchesResponseBody /// Batch List [JsonPropertyName("batches")] [JsonRequired] - public List Batches { get; set; } + public required List Batches { get; set; } /// /// Gets or Sets Links /// [JsonPropertyName("links")] [JsonRequired] - public PaginationLink Links { get; set; } + public required PaginationLink Links { get; set; } /// /// The page that is currently being read @@ -52,7 +52,7 @@ public partial class ListBatchesResponseBody /// [JsonPropertyName("page")] [JsonRequired] - public int Page { get; set; } + public required int Page { get; set; } /// /// The total number of batch pages the API call returned @@ -63,7 +63,7 @@ public partial class ListBatchesResponseBody /// [JsonPropertyName("pages")] [JsonRequired] - public int Pages { get; set; } + public required int Pages { get; set; } /// /// The total number of batches the API call returned @@ -74,7 +74,7 @@ public partial class ListBatchesResponseBody /// [JsonPropertyName("total")] [JsonRequired] - public long Total { get; set; } + public required long Total { get; set; } /// diff --git a/ShipEngineSDK/Model/ListCarriersResponseBody.cs b/ShipEngineSDK/Model/ListCarriersResponseBody.cs index 216671e7..90b02e82 100644 --- a/ShipEngineSDK/Model/ListCarriersResponseBody.cs +++ b/ShipEngineSDK/Model/ListCarriersResponseBody.cs @@ -34,7 +34,7 @@ public partial class ListCarriersResponseBody /// The carrier response body [JsonPropertyName("carriers")] [JsonRequired] - public List Carriers { get; set; } + public required List Carriers { get; set; } /// diff --git a/ShipEngineSDK/Model/ListLabelsResponseBody.cs b/ShipEngineSDK/Model/ListLabelsResponseBody.cs index 6e8260d2..65e5eef6 100644 --- a/ShipEngineSDK/Model/ListLabelsResponseBody.cs +++ b/ShipEngineSDK/Model/ListLabelsResponseBody.cs @@ -342,14 +342,14 @@ public class ListLabelsResponseBodyItem /// The labels that matched the query criteria. If no matching labels were found, then this array is empty; otherwise, it contains one page of results. The last page of results may have fewer labels than the `page_size`. [JsonPropertyName("labels")] [JsonRequired] - public List Labels { get; set; } + public required List Labels { get; set; } /// /// Gets or Sets Links /// [JsonPropertyName("links")] [JsonRequired] - public PaginationLink Links { get; set; } + public required PaginationLink Links { get; set; } /// /// The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. @@ -360,7 +360,7 @@ public class ListLabelsResponseBodyItem /// [JsonPropertyName("page")] [JsonRequired] - public int Page { get; set; } + public required int Page { get; set; } /// /// The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero. @@ -371,7 +371,7 @@ public class ListLabelsResponseBodyItem /// [JsonPropertyName("pages")] [JsonRequired] - public int Pages { get; set; } + public required int Pages { get; set; } /// /// The total number of items across all pages of results @@ -382,7 +382,7 @@ public class ListLabelsResponseBodyItem /// [JsonPropertyName("total")] [JsonRequired] - public int Total { get; set; } + public required int Total { get; set; } /// diff --git a/ShipEngineSDK/Model/ListManifestsResponseBody.cs b/ShipEngineSDK/Model/ListManifestsResponseBody.cs index 251585e5..12dc94ee 100644 --- a/ShipEngineSDK/Model/ListManifestsResponseBody.cs +++ b/ShipEngineSDK/Model/ListManifestsResponseBody.cs @@ -34,7 +34,7 @@ public partial class ListManifestsResponseBody /// Helpful links to other pages of results [JsonPropertyName("links")] [JsonRequired] - public PaginationLink Links { get; set; } + public required PaginationLink Links { get; set; } /// /// The list of available manifests @@ -42,7 +42,7 @@ public partial class ListManifestsResponseBody /// The list of available manifests [JsonPropertyName("manifests")] [JsonRequired] - public List Manifests { get; set; } + public required List Manifests { get; set; } /// /// Current page of the list manifests results @@ -53,7 +53,7 @@ public partial class ListManifestsResponseBody /// [JsonPropertyName("page")] [JsonRequired] - public int Page { get; set; } + public required int Page { get; set; } /// /// Total number of pages for list manifests results @@ -64,7 +64,7 @@ public partial class ListManifestsResponseBody /// [JsonPropertyName("pages")] [JsonRequired] - public int Pages { get; set; } + public required int Pages { get; set; } /// /// The total number of manifests returned @@ -75,7 +75,7 @@ public partial class ListManifestsResponseBody /// [JsonPropertyName("total")] [JsonRequired] - public long Total { get; set; } + public required long Total { get; set; } /// diff --git a/ShipEngineSDK/Model/ListPickupResponseBody.cs b/ShipEngineSDK/Model/ListPickupResponseBody.cs index cf08ad3f..ee25122f 100644 --- a/ShipEngineSDK/Model/ListPickupResponseBody.cs +++ b/ShipEngineSDK/Model/ListPickupResponseBody.cs @@ -34,7 +34,7 @@ public partial class ListPickupResponseBody /// Helpful links to other pages of results [JsonPropertyName("links")] [JsonRequired] - public PaginationLink Links { get; set; } + public required PaginationLink Links { get; set; } /// /// Current page of the list pickups results @@ -45,7 +45,7 @@ public partial class ListPickupResponseBody /// [JsonPropertyName("page")] [JsonRequired] - public int Page { get; set; } + public required int Page { get; set; } /// /// Total number of pages for list pickups results @@ -56,7 +56,7 @@ public partial class ListPickupResponseBody /// [JsonPropertyName("pages")] [JsonRequired] - public int Pages { get; set; } + public required int Pages { get; set; } /// /// An array of pickups associated with the user's account. @@ -64,7 +64,7 @@ public partial class ListPickupResponseBody /// An array of pickups associated with the user's account. [JsonPropertyName("pickups")] [JsonRequired] - public List Pickups { get; set; } + public required List Pickups { get; set; } /// /// The total number of pickups returned @@ -75,7 +75,7 @@ public partial class ListPickupResponseBody /// [JsonPropertyName("total")] [JsonRequired] - public long Total { get; set; } + public required long Total { get; set; } /// diff --git a/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs b/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs index bfd00878..3c1a7793 100644 --- a/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs +++ b/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs @@ -33,7 +33,7 @@ public partial class ListShipmentRatesResponseBody /// [JsonPropertyName("status")] [JsonRequired] - public RateResponseStatus Status { get; set; } = new(); + public required RateResponseStatus Status { get; set; } = new(); /// @@ -45,14 +45,14 @@ public partial class ListShipmentRatesResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public string CreatedAt { get; set; } + public required string CreatedAt { get; set; } /// /// Gets or Sets Errors /// [JsonPropertyName("errors")] [JsonRequired] - public List Errors { get; set; } + public required List Errors { get; set; } /// /// An array of invalid shipment rates @@ -60,7 +60,7 @@ public partial class ListShipmentRatesResponseBody /// An array of invalid shipment rates [JsonPropertyName("invalid_rates")] [JsonRequired] - public List InvalidRates { get; set; } + public required List InvalidRates { get; set; } /// /// A string that uniquely identifies the rate request @@ -71,7 +71,7 @@ public partial class ListShipmentRatesResponseBody /// [JsonPropertyName("rate_request_id")] [JsonRequired] - public string RateRequestId { get; set; } + public required string RateRequestId { get; set; } /// /// An array of shipment rates @@ -79,7 +79,7 @@ public partial class ListShipmentRatesResponseBody /// An array of shipment rates [JsonPropertyName("rates")] [JsonRequired] - public List Rates { get; set; } + public required List Rates { get; set; } /// /// A string that uniquely identifies the shipment @@ -90,7 +90,7 @@ public partial class ListShipmentRatesResponseBody /// [JsonPropertyName("shipment_id")] [JsonRequired] - public string ShipmentId { get; set; } + public required string ShipmentId { get; set; } /// diff --git a/ShipEngineSDK/Model/ListShipmentsResponseBody.cs b/ShipEngineSDK/Model/ListShipmentsResponseBody.cs index 3559f773..3102024f 100644 --- a/ShipEngineSDK/Model/ListShipmentsResponseBody.cs +++ b/ShipEngineSDK/Model/ListShipmentsResponseBody.cs @@ -33,21 +33,21 @@ public partial class ListShipmentsResponseBody /// [JsonPropertyName("links")] [JsonRequired] - public PaginationLink Links { get; set; } + public required PaginationLink Links { get; set; } /// /// Gets or Sets Page /// [JsonPropertyName("page")] [JsonRequired] - public int Page { get; set; } + public required int Page { get; set; } /// /// Gets or Sets Pages /// [JsonPropertyName("pages")] [JsonRequired] - public int Pages { get; set; } + public required int Pages { get; set; } /// /// The list of shipments returned by the api call @@ -55,7 +55,7 @@ public partial class ListShipmentsResponseBody /// The list of shipments returned by the api call [JsonPropertyName("shipments")] [JsonRequired] - public List Shipments { get; set; } + public required List Shipments { get; set; } /// /// Total number of shipments returned by the api call @@ -66,7 +66,7 @@ public partial class ListShipmentsResponseBody /// [JsonPropertyName("total")] [JsonRequired] - public long Total { get; set; } + public required long Total { get; set; } /// diff --git a/ShipEngineSDK/Model/ListWarehousesResponseBody.cs b/ShipEngineSDK/Model/ListWarehousesResponseBody.cs index 1cf80ddd..773176a9 100644 --- a/ShipEngineSDK/Model/ListWarehousesResponseBody.cs +++ b/ShipEngineSDK/Model/ListWarehousesResponseBody.cs @@ -34,7 +34,7 @@ public partial class ListWarehousesResponseBody /// The array of warehouses returned by the API call [JsonPropertyName("warehouses")] [JsonRequired] - public List Warehouses { get; set; } + public required List Warehouses { get; set; } /// diff --git a/ShipEngineSDK/Model/MonetaryValue.cs b/ShipEngineSDK/Model/MonetaryValue.cs index 53da3a46..c3db1332 100644 --- a/ShipEngineSDK/Model/MonetaryValue.cs +++ b/ShipEngineSDK/Model/MonetaryValue.cs @@ -34,7 +34,7 @@ public partial class MonetaryValue /// The monetary amount, in the specified currency. [JsonPropertyName("amount")] [JsonRequired] - public double Amount { get; set; } + public required double Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html @@ -42,7 +42,7 @@ public partial class MonetaryValue /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html [JsonPropertyName("currency")] [JsonRequired] - public string Currency { get; set; } + public required string Currency { get; set; } /// diff --git a/ShipEngineSDK/Model/Package.cs b/ShipEngineSDK/Model/Package.cs index 080084fa..392188b9 100644 --- a/ShipEngineSDK/Model/Package.cs +++ b/ShipEngineSDK/Model/Package.cs @@ -34,7 +34,7 @@ public partial class Package /// The package weight [JsonPropertyName("weight")] [JsonRequired] - public Weight Weight { get; set; } + public required Weight Weight { get; set; } /// /// A short description of the package content. Required for shipments moving to, from, and through Mexico. diff --git a/ShipEngineSDK/Model/PackageType.cs b/ShipEngineSDK/Model/PackageType.cs index ad7158fd..facef2b2 100644 --- a/ShipEngineSDK/Model/PackageType.cs +++ b/ShipEngineSDK/Model/PackageType.cs @@ -36,7 +36,7 @@ public partial class PackageType /// [JsonPropertyName("name")] [JsonRequired] - public string Name { get; set; } + public required string Name { get; set; } /// /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. @@ -47,7 +47,7 @@ public partial class PackageType /// [JsonPropertyName("package_code")] [JsonRequired] - public string PackageCode { get; set; } + public required string PackageCode { get; set; } /// /// Provides a helpful description for the custom package. diff --git a/ShipEngineSDK/Model/PagedListResponseBody.cs b/ShipEngineSDK/Model/PagedListResponseBody.cs index f0629ebc..3a7c6529 100644 --- a/ShipEngineSDK/Model/PagedListResponseBody.cs +++ b/ShipEngineSDK/Model/PagedListResponseBody.cs @@ -33,7 +33,7 @@ public partial class PagedListResponseBody /// [JsonPropertyName("links")] [JsonRequired] - public PaginationLink Links { get; set; } + public required PaginationLink Links { get; set; } /// /// The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. @@ -44,7 +44,7 @@ public partial class PagedListResponseBody /// [JsonPropertyName("page")] [JsonRequired] - public int Page { get; set; } + public required int Page { get; set; } /// /// The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero. @@ -55,7 +55,7 @@ public partial class PagedListResponseBody /// [JsonPropertyName("pages")] [JsonRequired] - public int Pages { get; set; } + public required int Pages { get; set; } /// /// The total number of items across all pages of results @@ -66,7 +66,7 @@ public partial class PagedListResponseBody /// [JsonPropertyName("total")] [JsonRequired] - public int Total { get; set; } + public required int Total { get; set; } /// /// Gets or Sets additional properties diff --git a/ShipEngineSDK/Model/PaginationLink.cs b/ShipEngineSDK/Model/PaginationLink.cs index c9ed9b21..e5f5f1e7 100644 --- a/ShipEngineSDK/Model/PaginationLink.cs +++ b/ShipEngineSDK/Model/PaginationLink.cs @@ -34,7 +34,7 @@ public partial class PaginationLink /// The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items. [JsonPropertyName("first")] [JsonRequired] - public Link First { get; set; } + public required Link First { get; set; } /// /// The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items. @@ -42,7 +42,7 @@ public partial class PaginationLink /// The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items. [JsonPropertyName("last")] [JsonRequired] - public Link Last { get; set; } + public required Link Last { get; set; } /// /// The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`. @@ -50,7 +50,7 @@ public partial class PaginationLink /// The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`. [JsonPropertyName("next")] [JsonRequired] - public OptionalLink Next { get; set; } + public required OptionalLink Next { get; set; } /// /// The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater. @@ -58,7 +58,7 @@ public partial class PaginationLink /// The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater. [JsonPropertyName("prev")] [JsonRequired] - public OptionalLink Prev { get; set; } + public required OptionalLink Prev { get; set; } /// diff --git a/ShipEngineSDK/Model/ParseAddressRequestBody.cs b/ShipEngineSDK/Model/ParseAddressRequestBody.cs index 9f72d7d4..02324685 100644 --- a/ShipEngineSDK/Model/ParseAddressRequestBody.cs +++ b/ShipEngineSDK/Model/ParseAddressRequestBody.cs @@ -37,7 +37,7 @@ public partial class ParseAddressRequestBody /// [JsonPropertyName("text")] [JsonRequired] - public string Text { get; set; } + public required string Text { get; set; } /// /// You can optionally provide any already-known address 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. diff --git a/ShipEngineSDK/Model/ParseAddressResponseBody.cs b/ShipEngineSDK/Model/ParseAddressResponseBody.cs index 811cd317..61af77e4 100644 --- a/ShipEngineSDK/Model/ParseAddressResponseBody.cs +++ b/ShipEngineSDK/Model/ParseAddressResponseBody.cs @@ -34,7 +34,7 @@ public partial class ParseAddressResponseBody /// The parsed address. This address may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The address-recognition API does not currently perform any validation of the parsed address, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the address is correct. [JsonPropertyName("address")] [JsonRequired] - public PartialAddress Address { get; set; } + public required PartialAddress Address { get; set; } /// /// All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, or an address line. Each entity includes the original text and the parsed value. @@ -42,7 +42,7 @@ public partial class ParseAddressResponseBody /// All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, or an address line. Each entity includes the original text and the parsed value. [JsonPropertyName("entities")] [JsonRequired] - public List Entities { get; set; } + public required List Entities { get; set; } /// /// A confidence score between zero and one that indicates how certain the API is that it understood the text. @@ -50,7 +50,7 @@ public partial class ParseAddressResponseBody /// A confidence score between zero and one that indicates how certain the API is that it understood the text. [JsonPropertyName("score")] [JsonRequired] - public double Score { get; set; } + public required double Score { get; set; } /// diff --git a/ShipEngineSDK/Model/ParseShipmentRequestBody.cs b/ShipEngineSDK/Model/ParseShipmentRequestBody.cs index d3f84e3c..03a00f63 100644 --- a/ShipEngineSDK/Model/ParseShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/ParseShipmentRequestBody.cs @@ -38,7 +38,7 @@ public partial class ParseShipmentRequestBody /// [JsonPropertyName("text")] [JsonRequired] - public string Text { get; set; } + public required string Text { get; set; } /// /// You can optionally provide a `shipment` object 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. diff --git a/ShipEngineSDK/Model/ParseShipmentResponseBody.cs b/ShipEngineSDK/Model/ParseShipmentResponseBody.cs index 7c7a4173..765a212a 100644 --- a/ShipEngineSDK/Model/ParseShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/ParseShipmentResponseBody.cs @@ -34,7 +34,7 @@ public partial class ParseShipmentResponseBody /// All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, a carrier name, or a package weight. Each entity includes the original text and the parsed value. [JsonPropertyName("entities")] [JsonRequired] - public List Entities { get; set; } + public required List Entities { get; set; } /// /// A confidence score between zero and one that indicates how certain the API is that it understood the text. @@ -42,7 +42,7 @@ public partial class ParseShipmentResponseBody /// A confidence score between zero and one that indicates how certain the API is that it understood the text. [JsonPropertyName("score")] [JsonRequired] - public double Score { get; set; } + public required double Score { get; set; } /// /// The parsed shipment. This shipment may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The shipment-recognition API does not currently perform any validation of the parsed addresses, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the addresses are correct. @@ -50,7 +50,7 @@ public partial class ParseShipmentResponseBody /// The parsed shipment. This shipment may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The shipment-recognition API does not currently perform any validation of the parsed addresses, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the addresses are correct. [JsonPropertyName("shipment")] [JsonRequired] - public PartialShipment Shipment { get; set; } + public required PartialShipment Shipment { get; set; } /// diff --git a/ShipEngineSDK/Model/PickupResponseBody.cs b/ShipEngineSDK/Model/PickupResponseBody.cs index 2d745aac..ddcf261a 100644 --- a/ShipEngineSDK/Model/PickupResponseBody.cs +++ b/ShipEngineSDK/Model/PickupResponseBody.cs @@ -37,14 +37,14 @@ public partial class PickupResponseBody /// [JsonPropertyName("carrier_id")] [JsonRequired] - public string CarrierId { get; set; } + public required string CarrierId { get; set; } /// /// Gets or Sets ContactDetails /// [JsonPropertyName("contact_details")] [JsonRequired] - public ContactDetails ContactDetails { get; set; } + public required ContactDetails ContactDetails { get; set; } /// /// The date and time that the pickup was created in ShipEngine. @@ -55,7 +55,7 @@ public partial class PickupResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public required DateTimeOffset CreatedAt { get; set; } /// /// Label IDs that will be included in the pickup request @@ -63,14 +63,14 @@ public partial class PickupResponseBody /// Label IDs that will be included in the pickup request [JsonPropertyName("label_ids")] [JsonRequired] - public List LabelIds { get; set; } + public required List LabelIds { get; set; } /// /// Gets or Sets PickupAddress /// [JsonPropertyName("pickup_address")] [JsonRequired] - public Address PickupAddress { get; set; } + public required Address PickupAddress { get; set; } /// /// Pickup Resource ID @@ -81,14 +81,14 @@ public partial class PickupResponseBody /// [JsonPropertyName("pickup_id")] [JsonRequired] - public string PickupId { get; set; } + public required string PickupId { get; set; } /// /// Gets or Sets PickupWindow /// [JsonPropertyName("pickup_window")] [JsonRequired] - public PickupWindow PickupWindow { get; set; } + public required PickupWindow PickupWindow { get; set; } /// /// The warehouse_id associated with the pickup @@ -99,7 +99,7 @@ public partial class PickupResponseBody /// [JsonPropertyName("warehouse_id")] [JsonRequired] - public string WarehouseId { get; set; } + public required string WarehouseId { get; set; } /// /// The date and time that the pickup was cancelled in ShipEngine. @@ -120,7 +120,7 @@ public partial class PickupResponseBody /// [JsonPropertyName("confirmation_number")] [JsonRequired] - public string ConfirmationNumber { get; set; } + public required string ConfirmationNumber { get; set; } /// /// Used by some carriers to give special instructions for a package pickup diff --git a/ShipEngineSDK/Model/PickupWindow.cs b/ShipEngineSDK/Model/PickupWindow.cs index e6b460ab..ef5ef829 100644 --- a/ShipEngineSDK/Model/PickupWindow.cs +++ b/ShipEngineSDK/Model/PickupWindow.cs @@ -37,7 +37,7 @@ public partial class PickupWindow /// [JsonPropertyName("end_at")] [JsonRequired] - public DateTimeOffset EndAt { get; set; } + public required DateTimeOffset EndAt { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -48,7 +48,7 @@ public partial class PickupWindow /// [JsonPropertyName("start_at")] [JsonRequired] - public DateTimeOffset StartAt { get; set; } + public required DateTimeOffset StartAt { get; set; } /// diff --git a/ShipEngineSDK/Model/Rate.cs b/ShipEngineSDK/Model/Rate.cs index c37f2ab7..2460b66c 100644 --- a/ShipEngineSDK/Model/Rate.cs +++ b/ShipEngineSDK/Model/Rate.cs @@ -33,7 +33,7 @@ public partial class Rate /// [JsonPropertyName("rate_type")] [JsonRequired] - public RateType RateType { get; set; } = new(); + public required RateType RateType { get; set; } = new(); /// @@ -41,7 +41,7 @@ public partial class Rate /// [JsonPropertyName("validation_status")] [JsonRequired] - public ValidationStatus ValidationStatus { get; set; } = new(); + public required ValidationStatus ValidationStatus { get; set; } = new(); /// @@ -50,7 +50,7 @@ public partial class Rate /// carrier code [JsonPropertyName("carrier_code")] [JsonRequired] - public string CarrierCode { get; set; } + public required string CarrierCode { get; set; } /// /// carrier friendly name @@ -58,7 +58,7 @@ public partial class Rate /// carrier friendly name [JsonPropertyName("carrier_friendly_name")] [JsonRequired] - public string CarrierFriendlyName { get; set; } + public required string CarrierFriendlyName { get; set; } /// /// A string that uniquely identifies the carrier @@ -69,7 +69,7 @@ public partial class Rate /// [JsonPropertyName("carrier_id")] [JsonRequired] - public string CarrierId { get; set; } + public required string CarrierId { get; set; } /// /// carrier nickname @@ -77,7 +77,7 @@ public partial class Rate /// carrier nickname [JsonPropertyName("carrier_nickname")] [JsonRequired] - public string CarrierNickname { get; set; } + public required string CarrierNickname { get; set; } /// /// The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price. @@ -85,7 +85,7 @@ public partial class Rate /// The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price. [JsonPropertyName("confirmation_amount")] [JsonRequired] - public MonetaryValue ConfirmationAmount { get; set; } + public required MonetaryValue ConfirmationAmount { get; set; } /// /// The error messages @@ -93,7 +93,7 @@ public partial class Rate /// The error messages [JsonPropertyName("error_messages")] [JsonRequired] - public List ErrorMessages { get; set; } + public required List ErrorMessages { get; set; } /// /// Indicates if the rate is guaranteed. @@ -101,7 +101,7 @@ public partial class Rate /// Indicates if the rate is guaranteed. [JsonPropertyName("guaranteed_service")] [JsonRequired] - public bool GuaranteedService { get; set; } + public required bool GuaranteedService { get; set; } /// /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. @@ -109,7 +109,7 @@ public partial class Rate /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. [JsonPropertyName("insurance_amount")] [JsonRequired] - public MonetaryValue InsuranceAmount { get; set; } + public required MonetaryValue InsuranceAmount { get; set; } /// /// Indicates if the rates been negotiated @@ -117,7 +117,7 @@ public partial class Rate /// Indicates if the rates been negotiated [JsonPropertyName("negotiated_rate")] [JsonRequired] - public bool NegotiatedRate { get; set; } + public required bool NegotiatedRate { get; set; } /// /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. @@ -125,7 +125,7 @@ public partial class Rate /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. [JsonPropertyName("other_amount")] [JsonRequired] - public MonetaryValue OtherAmount { get; set; } + public required MonetaryValue OtherAmount { get; set; } /// /// A string that uniquely identifies the rate @@ -136,7 +136,7 @@ public partial class Rate /// [JsonPropertyName("rate_id")] [JsonRequired] - public string RateId { get; set; } + public required string RateId { get; set; } /// /// service code for the rate @@ -144,7 +144,7 @@ public partial class Rate /// service code for the rate [JsonPropertyName("service_code")] [JsonRequired] - public string ServiceCode { get; set; } + public required string ServiceCode { get; set; } /// /// service type @@ -152,7 +152,7 @@ public partial class Rate /// service type [JsonPropertyName("service_type")] [JsonRequired] - public string ServiceType { get; set; } + public required string ServiceType { get; set; } /// /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. @@ -160,7 +160,7 @@ public partial class Rate /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. [JsonPropertyName("shipping_amount")] [JsonRequired] - public MonetaryValue ShippingAmount { get; set; } + public required MonetaryValue ShippingAmount { get; set; } /// /// Indicates if rate is trackable @@ -168,7 +168,7 @@ public partial class Rate /// Indicates if rate is trackable [JsonPropertyName("trackable")] [JsonRequired] - public bool Trackable { get; set; } + public required bool Trackable { get; set; } /// /// The warning messages @@ -176,7 +176,7 @@ public partial class Rate /// The warning messages [JsonPropertyName("warning_messages")] [JsonRequired] - public List WarningMessages { get; set; } + public required List WarningMessages { get; set; } /// /// The carrier delivery days @@ -214,7 +214,7 @@ public partial class Rate /// [JsonPropertyName("package_type")] [JsonRequired] - public string PackageType { get; set; } + public required string PackageType { get; set; } /// /// The total shipping cost for the specified comparison_rate_type. @@ -246,7 +246,7 @@ public partial class Rate /// [JsonPropertyName("zone")] [JsonRequired] - public int Zone { get; set; } + public required int Zone { get; set; } /// diff --git a/ShipEngineSDK/Model/RateEstimate.cs b/ShipEngineSDK/Model/RateEstimate.cs index 5a13ba36..f680d00d 100644 --- a/ShipEngineSDK/Model/RateEstimate.cs +++ b/ShipEngineSDK/Model/RateEstimate.cs @@ -33,7 +33,7 @@ public partial class RateEstimate /// [JsonPropertyName("rate_type")] [JsonRequired] - public RateType RateType { get; set; } = new(); + public required RateType RateType { get; set; } = new(); /// @@ -41,7 +41,7 @@ public partial class RateEstimate /// [JsonPropertyName("validation_status")] [JsonRequired] - public ValidationStatus ValidationStatus { get; set; } = new(); + public required ValidationStatus ValidationStatus { get; set; } = new(); /// @@ -50,7 +50,7 @@ public partial class RateEstimate /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. [JsonPropertyName("carrier_code")] [JsonRequired] - public string CarrierCode { get; set; } + public required string CarrierCode { get; set; } /// /// carrier friendly name @@ -58,7 +58,7 @@ public partial class RateEstimate /// carrier friendly name [JsonPropertyName("carrier_friendly_name")] [JsonRequired] - public string CarrierFriendlyName { get; set; } + public required string CarrierFriendlyName { get; set; } /// /// A string that uniquely identifies the carrier @@ -69,7 +69,7 @@ public partial class RateEstimate /// [JsonPropertyName("carrier_id")] [JsonRequired] - public string CarrierId { get; set; } + public required string CarrierId { get; set; } /// /// carrier nickname @@ -77,7 +77,7 @@ public partial class RateEstimate /// carrier nickname [JsonPropertyName("carrier_nickname")] [JsonRequired] - public string CarrierNickname { get; set; } + public required string CarrierNickname { get; set; } /// /// The confirmation amount @@ -85,7 +85,7 @@ public partial class RateEstimate /// The confirmation amount [JsonPropertyName("confirmation_amount")] [JsonRequired] - public MonetaryValue ConfirmationAmount { get; set; } + public required MonetaryValue ConfirmationAmount { get; set; } /// /// The error messages @@ -93,7 +93,7 @@ public partial class RateEstimate /// The error messages [JsonPropertyName("error_messages")] [JsonRequired] - public List ErrorMessages { get; set; } + public required List ErrorMessages { get; set; } /// /// Indicates if the rate is guaranteed. @@ -101,7 +101,7 @@ public partial class RateEstimate /// Indicates if the rate is guaranteed. [JsonPropertyName("guaranteed_service")] [JsonRequired] - public bool GuaranteedService { get; set; } + public required bool GuaranteedService { get; set; } /// /// The insurance amount @@ -109,7 +109,7 @@ public partial class RateEstimate /// The insurance amount [JsonPropertyName("insurance_amount")] [JsonRequired] - public MonetaryValue InsuranceAmount { get; set; } + public required MonetaryValue InsuranceAmount { get; set; } /// /// Indicates if the rates been negotiated @@ -117,7 +117,7 @@ public partial class RateEstimate /// Indicates if the rates been negotiated [JsonPropertyName("negotiated_rate")] [JsonRequired] - public bool NegotiatedRate { get; set; } + public required bool NegotiatedRate { get; set; } /// /// Any other charges associated with this rate @@ -125,7 +125,7 @@ public partial class RateEstimate /// Any other charges associated with this rate [JsonPropertyName("other_amount")] [JsonRequired] - public MonetaryValue OtherAmount { get; set; } + public required MonetaryValue OtherAmount { get; set; } /// /// service code for the rate @@ -133,7 +133,7 @@ public partial class RateEstimate /// service code for the rate [JsonPropertyName("service_code")] [JsonRequired] - public string ServiceCode { get; set; } + public required string ServiceCode { get; set; } /// /// service type @@ -141,7 +141,7 @@ public partial class RateEstimate /// service type [JsonPropertyName("service_type")] [JsonRequired] - public string ServiceType { get; set; } + public required string ServiceType { get; set; } /// /// The shipping amount @@ -149,7 +149,7 @@ public partial class RateEstimate /// The shipping amount [JsonPropertyName("shipping_amount")] [JsonRequired] - public MonetaryValue ShippingAmount { get; set; } + public required MonetaryValue ShippingAmount { get; set; } /// /// Indicates if rate is trackable @@ -157,7 +157,7 @@ public partial class RateEstimate /// Indicates if rate is trackable [JsonPropertyName("trackable")] [JsonRequired] - public bool Trackable { get; set; } + public required bool Trackable { get; set; } /// /// The warning messages @@ -165,7 +165,7 @@ public partial class RateEstimate /// The warning messages [JsonPropertyName("warning_messages")] [JsonRequired] - public List WarningMessages { get; set; } + public required List WarningMessages { get; set; } /// /// The carrier delivery days @@ -203,7 +203,7 @@ public partial class RateEstimate /// [JsonPropertyName("package_type")] [JsonRequired] - public string PackageType { get; set; } + public required string PackageType { get; set; } /// /// ship date @@ -228,7 +228,7 @@ public partial class RateEstimate /// [JsonPropertyName("zone")] [JsonRequired] - public int Zone { get; set; } + public required int Zone { get; set; } /// diff --git a/ShipEngineSDK/Model/RateRequestBody.cs b/ShipEngineSDK/Model/RateRequestBody.cs index 81b9b7eb..ec188f1b 100644 --- a/ShipEngineSDK/Model/RateRequestBody.cs +++ b/ShipEngineSDK/Model/RateRequestBody.cs @@ -34,7 +34,7 @@ public partial class RateRequestBody /// Array of carrier ids to get rates for [JsonPropertyName("carrier_ids")] [JsonRequired] - public List CarrierIds { get; set; } + public required List CarrierIds { get; set; } /// /// Calculate the duties and tariffs for cross border shipments. diff --git a/ShipEngineSDK/Model/RateRequestByShipmentIds.cs b/ShipEngineSDK/Model/RateRequestByShipmentIds.cs index 833702e4..de9f60ab 100644 --- a/ShipEngineSDK/Model/RateRequestByShipmentIds.cs +++ b/ShipEngineSDK/Model/RateRequestByShipmentIds.cs @@ -34,7 +34,7 @@ public partial class RateRequestByShipmentIds /// The array of shipment IDs [JsonPropertyName("shipment_ids")] [JsonRequired] - public List ShipmentIds { get; set; } + public required List ShipmentIds { get; set; } /// diff --git a/ShipEngineSDK/Model/RateRequestByShipments.cs b/ShipEngineSDK/Model/RateRequestByShipments.cs index 87b6adeb..23df6a3b 100644 --- a/ShipEngineSDK/Model/RateRequestByShipments.cs +++ b/ShipEngineSDK/Model/RateRequestByShipments.cs @@ -34,7 +34,7 @@ public partial class RateRequestByShipments /// The array of shipments to get bulk rate estimates for [JsonPropertyName("shipments")] [JsonRequired] - public List Shipments { get; set; } + public required List Shipments { get; set; } /// diff --git a/ShipEngineSDK/Model/RecognizedEntity.cs b/ShipEngineSDK/Model/RecognizedEntity.cs index ed8e61a2..e228936b 100644 --- a/ShipEngineSDK/Model/RecognizedEntity.cs +++ b/ShipEngineSDK/Model/RecognizedEntity.cs @@ -34,7 +34,7 @@ public partial class RecognizedEntity /// The index of the last character of this entity within the original text [JsonPropertyName("end_index")] [JsonRequired] - public int EndIndex { get; set; } + public required int EndIndex { get; set; } /// /// A confidence score between zero and one that indicates how certain the API is that it correctly recognized this entity @@ -42,7 +42,7 @@ public partial class RecognizedEntity /// A confidence score between zero and one that indicates how certain the API is that it correctly recognized this entity [JsonPropertyName("score")] [JsonRequired] - public double Score { get; set; } + public required double Score { get; set; } /// /// The index of the first character of this entity within the original text @@ -50,7 +50,7 @@ public partial class RecognizedEntity /// The index of the first character of this entity within the original text [JsonPropertyName("start_index")] [JsonRequired] - public int StartIndex { get; set; } + public required int StartIndex { get; set; } /// /// The substring from the original text that was recognized as this entity @@ -58,7 +58,7 @@ public partial class RecognizedEntity /// The substring from the original text that was recognized as this entity [JsonPropertyName("text")] [JsonRequired] - public string Text { get; set; } + public required string Text { get; set; } /// /// The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.) @@ -66,7 +66,7 @@ public partial class RecognizedEntity /// The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.) [JsonPropertyName("type")] [JsonRequired] - public string Type { get; set; } + public required string Type { get; set; } /// /// The normalized value of the entity. Most entity results have a `value` field, which is the normalized value of the entity. For example, if the substring \"john doe\" was recognized as a \"person\" entity, then the value might be normalized to have proper capitalization (e.g. \"John Doe\"). Or if the substring \"ft worth\" was recognized as a \"city\" entity, then the value might be normalized to \"Fort Worth\". Some entities have other information in addition to, or instead of a `value`. For example, a \"dimensions\" entity will have separate fields for `length`, `width`, `height`, and `unit`. diff --git a/ShipEngineSDK/Model/ResponseMessage.cs b/ShipEngineSDK/Model/ResponseMessage.cs index 4cf7b1ac..94c940c5 100644 --- a/ShipEngineSDK/Model/ResponseMessage.cs +++ b/ShipEngineSDK/Model/ResponseMessage.cs @@ -33,7 +33,7 @@ public partial class ResponseMessage /// [JsonPropertyName("code")] [JsonRequired] - public AddressValidationCode Code { get; set; } = new(); + public required AddressValidationCode Code { get; set; } = new(); /// @@ -41,7 +41,7 @@ public partial class ResponseMessage /// [JsonPropertyName("type")] [JsonRequired] - public AddressValidationMessageType Type { get; set; } = new(); + public required AddressValidationMessageType Type { get; set; } = new(); /// @@ -49,7 +49,7 @@ public partial class ResponseMessage /// [JsonPropertyName("detail_code")] [JsonRequired] - public AddressValidationDetailCode DetailCode { get; set; } = new(); + public required AddressValidationDetailCode DetailCode { get; set; } = new(); /// @@ -61,7 +61,7 @@ public partial class ResponseMessage /// [JsonPropertyName("message")] [JsonRequired] - public string Message { get; set; } + public required string Message { get; set; } /// diff --git a/ShipEngineSDK/Model/SchedulePickupRequestBody.cs b/ShipEngineSDK/Model/SchedulePickupRequestBody.cs index 08464269..34b62aa6 100644 --- a/ShipEngineSDK/Model/SchedulePickupRequestBody.cs +++ b/ShipEngineSDK/Model/SchedulePickupRequestBody.cs @@ -33,7 +33,7 @@ public partial class SchedulePickupRequestBody /// [JsonPropertyName("contact_details")] [JsonRequired] - public ContactDetails ContactDetails { get; set; } + public required ContactDetails ContactDetails { get; set; } /// /// Label IDs that will be included in the pickup request @@ -41,14 +41,14 @@ public partial class SchedulePickupRequestBody /// Label IDs that will be included in the pickup request [JsonPropertyName("label_ids")] [JsonRequired] - public List LabelIds { get; set; } + public required List LabelIds { get; set; } /// /// Gets or Sets PickupWindow /// [JsonPropertyName("pickup_window")] [JsonRequired] - public PickupWindow PickupWindow { get; set; } + public required PickupWindow PickupWindow { get; set; } /// /// The date and time that the pickup was cancelled in ShipEngine. diff --git a/ShipEngineSDK/Model/SchedulePickupResponseBody.cs b/ShipEngineSDK/Model/SchedulePickupResponseBody.cs index 943b5336..d008e910 100644 --- a/ShipEngineSDK/Model/SchedulePickupResponseBody.cs +++ b/ShipEngineSDK/Model/SchedulePickupResponseBody.cs @@ -34,7 +34,7 @@ public partial class SchedulePickupResponseBody /// The errors associated with the failed API call [JsonPropertyName("errors")] [JsonRequired] - public List Errors { get; set; } + public required List Errors { get; set; } /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur @@ -45,7 +45,7 @@ public partial class SchedulePickupResponseBody /// [JsonPropertyName("request_id")] [JsonRequired] - public Guid RequestId { get; set; } + public required Guid RequestId { get; set; } /// /// The date and time that the pickup was cancelled in ShipEngine. diff --git a/ShipEngineSDK/Model/Shipment.cs b/ShipEngineSDK/Model/Shipment.cs index b528fb95..5daf2b3a 100644 --- a/ShipEngineSDK/Model/Shipment.cs +++ b/ShipEngineSDK/Model/Shipment.cs @@ -34,7 +34,7 @@ public partial class Shipment /// The type of delivery confirmation that is required for this shipment. [JsonPropertyName("confirmation")] [JsonRequired] - public DeliveryConfirmation Confirmation { get; set; } = new(); + public required DeliveryConfirmation Confirmation { get; set; } = new(); /// @@ -43,7 +43,7 @@ public partial class Shipment /// The insurance provider to use for any insured packages in the shipment. [JsonPropertyName("insurance_provider")] [JsonRequired] - public InsuranceProvider InsuranceProvider { get; set; } = new(); + public required InsuranceProvider InsuranceProvider { get; set; } = new(); /// @@ -52,7 +52,7 @@ public partial class Shipment /// The current status of the shipment [JsonPropertyName("shipment_status")] [JsonRequired] - public ShipmentStatus ShipmentStatus { get; set; } = new(); + public required ShipmentStatus ShipmentStatus { get; set; } = new(); /// @@ -66,7 +66,7 @@ public partial class Shipment /// Advanced shipment options. These are entirely optional. [JsonPropertyName("advanced_options")] [JsonRequired] - public AdvancedShipmentOptions AdvancedOptions { get; set; } + public required AdvancedShipmentOptions AdvancedOptions { get; set; } /// /// The carrier account that is billed for the shipping charges @@ -77,7 +77,7 @@ public partial class Shipment /// [JsonPropertyName("carrier_id")] [JsonRequired] - public string CarrierId { get; set; } + public required string CarrierId { get; set; } /// /// The date and time that the shipment was created in ShipEngine. @@ -88,7 +88,7 @@ public partial class Shipment /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public required DateTimeOffset CreatedAt { get; set; } /// /// The date and time that the shipment was created or last modified. @@ -99,7 +99,7 @@ public partial class Shipment /// [JsonPropertyName("modified_at")] [JsonRequired] - public DateTimeOffset ModifiedAt { get; set; } + public required DateTimeOffset ModifiedAt { get; set; } /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. @@ -107,7 +107,7 @@ public partial class Shipment /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. [JsonPropertyName("packages")] [JsonRequired] - public List Packages { get; set; } + public required List Packages { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. @@ -115,7 +115,7 @@ public partial class Shipment /// The return address for this shipment. Defaults to the `ship_from` address. [JsonPropertyName("return_to")] [JsonRequired] - public ShippingAddress ReturnTo { get; set; } + public required ShippingAddress ReturnTo { get; set; } /// /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. @@ -126,7 +126,7 @@ public partial class Shipment /// [JsonPropertyName("service_code")] [JsonRequired] - public string ServiceCode { get; set; } + public required string ServiceCode { get; set; } /// /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -137,7 +137,7 @@ public partial class Shipment /// [JsonPropertyName("ship_date")] [JsonRequired] - public DateTimeOffset ShipDate { get; set; } + public required DateTimeOffset ShipDate { get; set; } /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. @@ -145,7 +145,7 @@ public partial class Shipment /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. [JsonPropertyName("ship_from")] [JsonRequired] - public ShippingAddress ShipFrom { get; set; } + public required ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address @@ -153,7 +153,7 @@ public partial class Shipment /// The recipient's mailing address [JsonPropertyName("ship_to")] [JsonRequired] - public ShippingAddressTo ShipTo { get; set; } + public required ShippingAddressTo ShipTo { get; set; } /// /// A string that uniquely identifies the shipment @@ -164,7 +164,7 @@ public partial class Shipment /// [JsonPropertyName("shipment_id")] [JsonRequired] - public string ShipmentId { get; set; } + public required string ShipmentId { get; set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. @@ -172,7 +172,7 @@ public partial class Shipment /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. [JsonPropertyName("tags")] [JsonRequired] - public List Tags { get; set; } + public required List Tags { get; set; } /// /// The combined weight of all packages in the shipment @@ -180,7 +180,7 @@ public partial class Shipment /// The combined weight of all packages in the shipment [JsonPropertyName("total_weight")] [JsonRequired] - public Weight TotalWeight { get; set; } + public required Weight TotalWeight { get; set; } /// /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. @@ -198,7 +198,7 @@ public partial class Shipment /// Customs information. This is usually only needed for international shipments. [JsonPropertyName("customs")] [JsonRequired] - public InternationalShipmentOptions Customs { get; set; } + public required InternationalShipmentOptions Customs { get; set; } /// /// ID that the Order Source assigned @@ -260,7 +260,7 @@ public partial class Shipment /// [JsonPropertyName("warehouse_id")] [JsonRequired] - public string WarehouseId { get; set; } + public required string WarehouseId { get; set; } /// diff --git a/ShipEngineSDK/Model/ShippingAddress.cs b/ShipEngineSDK/Model/ShippingAddress.cs index 353a7684..bea1cfab 100644 --- a/ShipEngineSDK/Model/ShippingAddress.cs +++ b/ShipEngineSDK/Model/ShippingAddress.cs @@ -34,7 +34,7 @@ public partial class ShippingAddress /// Indicates whether this is a residential address. [JsonPropertyName("address_residential_indicator")] [JsonRequired] - public AddressResidentialIndicator AddressResidentialIndicator { get; set; } = new(); + public required AddressResidentialIndicator AddressResidentialIndicator { get; set; } = new(); /// @@ -46,7 +46,7 @@ public partial class ShippingAddress /// [JsonPropertyName("address_line1")] [JsonRequired] - public string AddressLine1 { get; set; } + public required string AddressLine1 { get; set; } /// /// The name of the city or locality @@ -57,7 +57,7 @@ public partial class ShippingAddress /// [JsonPropertyName("city_locality")] [JsonRequired] - public string CityLocality { get; set; } + public required string CityLocality { get; set; } /// /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) @@ -68,7 +68,7 @@ public partial class ShippingAddress /// [JsonPropertyName("country_code")] [JsonRequired] - public string CountryCode { get; set; } + public required string CountryCode { get; set; } /// /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. @@ -79,7 +79,7 @@ public partial class ShippingAddress /// [JsonPropertyName("name")] [JsonRequired] - public string Name { get; set; } + public required string Name { get; set; } /// /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. @@ -90,7 +90,7 @@ public partial class ShippingAddress /// [JsonPropertyName("phone")] [JsonRequired] - public string Phone { get; set; } + public required string Phone { get; set; } /// /// postal code @@ -101,7 +101,7 @@ public partial class ShippingAddress /// [JsonPropertyName("postal_code")] [JsonRequired] - public string PostalCode { get; set; } + public required string PostalCode { get; set; } /// /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. @@ -112,7 +112,7 @@ public partial class ShippingAddress /// [JsonPropertyName("state_province")] [JsonRequired] - public string StateProvince { get; set; } + public required string StateProvince { get; set; } /// /// The second line of the street address. For some addresses, this line may not be needed. diff --git a/ShipEngineSDK/Model/ShippingAddressTo.cs b/ShipEngineSDK/Model/ShippingAddressTo.cs index 0d312b49..15f138c1 100644 --- a/ShipEngineSDK/Model/ShippingAddressTo.cs +++ b/ShipEngineSDK/Model/ShippingAddressTo.cs @@ -34,7 +34,7 @@ public partial class ShippingAddressTo /// Indicates whether this is a residential address. [JsonPropertyName("address_residential_indicator")] [JsonRequired] - public AddressResidentialIndicator AddressResidentialIndicator { get; set; } = new(); + public required AddressResidentialIndicator AddressResidentialIndicator { get; set; } = new(); /// @@ -46,7 +46,7 @@ public partial class ShippingAddressTo /// [JsonPropertyName("address_line1")] [JsonRequired] - public string AddressLine1 { get; set; } + public required string AddressLine1 { get; set; } /// /// The name of the city or locality @@ -57,7 +57,7 @@ public partial class ShippingAddressTo /// [JsonPropertyName("city_locality")] [JsonRequired] - public string CityLocality { get; set; } + public required string CityLocality { get; set; } /// /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) @@ -68,7 +68,7 @@ public partial class ShippingAddressTo /// [JsonPropertyName("country_code")] [JsonRequired] - public string CountryCode { get; set; } + public required string CountryCode { get; set; } /// /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. @@ -79,7 +79,7 @@ public partial class ShippingAddressTo /// [JsonPropertyName("name")] [JsonRequired] - public string Name { get; set; } + public required string Name { get; set; } /// /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. @@ -90,7 +90,7 @@ public partial class ShippingAddressTo /// [JsonPropertyName("phone")] [JsonRequired] - public string Phone { get; set; } + public required string Phone { get; set; } /// /// postal code @@ -101,7 +101,7 @@ public partial class ShippingAddressTo /// [JsonPropertyName("postal_code")] [JsonRequired] - public string PostalCode { get; set; } + public required string PostalCode { get; set; } /// /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. @@ -112,7 +112,7 @@ public partial class ShippingAddressTo /// [JsonPropertyName("state_province")] [JsonRequired] - public string StateProvince { get; set; } + public required string StateProvince { get; set; } /// /// The second line of the street address. For some addresses, this line may not be needed. diff --git a/ShipEngineSDK/Model/Tag.cs b/ShipEngineSDK/Model/Tag.cs index 6287a6e6..05d25deb 100644 --- a/ShipEngineSDK/Model/Tag.cs +++ b/ShipEngineSDK/Model/Tag.cs @@ -37,7 +37,7 @@ public partial class Tag /// [JsonPropertyName("name")] [JsonRequired] - public string Name { get; set; } + public required string Name { get; set; } /// diff --git a/ShipEngineSDK/Model/TagShipmentResponseBody.cs b/ShipEngineSDK/Model/TagShipmentResponseBody.cs index 3af90404..cb344ed9 100644 --- a/ShipEngineSDK/Model/TagShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/TagShipmentResponseBody.cs @@ -33,7 +33,7 @@ public partial class TagShipmentResponseBody /// [JsonPropertyName("tags")] [JsonRequired] - public List Tags { get; set; } + public required List Tags { get; set; } /// diff --git a/ShipEngineSDK/Model/TaxIdentifier.cs b/ShipEngineSDK/Model/TaxIdentifier.cs index 91795e81..7be7a82c 100644 --- a/ShipEngineSDK/Model/TaxIdentifier.cs +++ b/ShipEngineSDK/Model/TaxIdentifier.cs @@ -33,7 +33,7 @@ public partial class TaxIdentifier /// [JsonPropertyName("identifier_type")] [JsonRequired] - public IdentifierType IdentifierType { get; set; } = new(); + public required IdentifierType IdentifierType { get; set; } = new(); /// @@ -41,7 +41,7 @@ public partial class TaxIdentifier /// [JsonPropertyName("taxable_entity_type")] [JsonRequired] - public TaxableEntityType TaxableEntityType { get; set; } = new(); + public required TaxableEntityType TaxableEntityType { get; set; } = new(); /// @@ -50,7 +50,7 @@ public partial class TaxIdentifier /// The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code. [JsonPropertyName("issuing_authority")] [JsonRequired] - public string IssuingAuthority { get; set; } + public required string IssuingAuthority { get; set; } /// /// The value of the identifier @@ -58,7 +58,7 @@ public partial class TaxIdentifier /// The value of the identifier [JsonPropertyName("value")] [JsonRequired] - public string Value { get; set; } + public required string Value { get; set; } /// diff --git a/ShipEngineSDK/Model/TrackEvent.cs b/ShipEngineSDK/Model/TrackEvent.cs index 3bfb4f5d..7ea6d404 100644 --- a/ShipEngineSDK/Model/TrackEvent.cs +++ b/ShipEngineSDK/Model/TrackEvent.cs @@ -33,7 +33,7 @@ public partial class TrackEvent /// [JsonPropertyName("status_code")] [JsonRequired] - public StatusCode StatusCode { get; set; } = new(); + public required StatusCode StatusCode { get; set; } = new(); /// @@ -45,7 +45,7 @@ public partial class TrackEvent /// [JsonPropertyName("carrier_detail_code")] [JsonRequired] - public string CarrierDetailCode { get; set; } + public required string CarrierDetailCode { get; set; } /// /// Carrier status code @@ -56,7 +56,7 @@ public partial class TrackEvent /// [JsonPropertyName("carrier_status_code")] [JsonRequired] - public string CarrierStatusCode { get; set; } + public required string CarrierStatusCode { get; set; } /// /// carrier status description @@ -67,7 +67,7 @@ public partial class TrackEvent /// [JsonPropertyName("carrier_status_description")] [JsonRequired] - public string CarrierStatusDescription { get; set; } + public required string CarrierStatusDescription { get; set; } /// /// City locality @@ -78,7 +78,7 @@ public partial class TrackEvent /// [JsonPropertyName("city_locality")] [JsonRequired] - public string CityLocality { get; set; } + public required string CityLocality { get; set; } /// /// Timestamp for carrier event @@ -89,7 +89,7 @@ public partial class TrackEvent /// [JsonPropertyName("occurred_at")] [JsonRequired] - public DateTimeOffset OccurredAt { get; set; } + public required DateTimeOffset OccurredAt { get; set; } /// /// Postal code @@ -100,7 +100,7 @@ public partial class TrackEvent /// [JsonPropertyName("postal_code")] [JsonRequired] - public string PostalCode { get; set; } + public required string PostalCode { get; set; } /// /// State province @@ -111,7 +111,7 @@ public partial class TrackEvent /// [JsonPropertyName("state_province")] [JsonRequired] - public string StateProvince { get; set; } + public required string StateProvince { get; set; } /// /// Event Status Description @@ -122,7 +122,7 @@ public partial class TrackEvent /// [JsonPropertyName("status_description")] [JsonRequired] - public string StatusDescription { get; set; } + public required string StatusDescription { get; set; } /// /// Carrier timestamp for the event, it is assumed to be the local time of where the event occurred. diff --git a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs index 891fe3ad..2a0667cf 100644 --- a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs @@ -100,7 +100,7 @@ public override bool CanConvert(Type typeToConvert) => /// [JsonPropertyName("is_default")] [JsonRequired] - public bool IsDefault { get; set; } + public required bool IsDefault { get; set; } /// /// The date and time that the image was created in ShipEngine. diff --git a/ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs index 1f8eb40f..03e6687c 100644 --- a/ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs @@ -279,6 +279,7 @@ public override void Write(Utf8JsonWriter writer, UpdateCarrierSettingsRequestBo var jsonDoc = JsonDocument.ParseValue(ref reader); UpdateCarrierSettingsRequestBody? newUpdateCarrierSettingsRequestBody = null; + int match = 0; var matchedTypes = new List(); @@ -357,7 +358,6 @@ public override void Write(Utf8JsonWriter writer, UpdateCarrierSettingsRequestBo throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); } - // deserialization is considered successful at this point if no exception has been thrown. return newUpdateCarrierSettingsRequestBody; } diff --git a/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs b/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs index b76ed883..29119ca2 100644 --- a/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs +++ b/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs @@ -36,7 +36,7 @@ public partial class UpdatePackageTypeRequestBody /// [JsonPropertyName("name")] [JsonRequired] - public string Name { get; set; } + public required string Name { get; set; } /// /// A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. @@ -47,7 +47,7 @@ public partial class UpdatePackageTypeRequestBody /// [JsonPropertyName("package_code")] [JsonRequired] - public string PackageCode { get; set; } + public required string PackageCode { get; set; } /// /// Provides a helpful description for the custom package. diff --git a/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs b/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs index 47ba137e..68df545e 100644 --- a/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs @@ -62,7 +62,7 @@ public partial class UpdateShipmentRequestBody /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. [JsonPropertyName("ship_from")] [JsonRequired] - public ShippingAddress ShipFrom { get; set; } + public required ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address @@ -70,7 +70,7 @@ public partial class UpdateShipmentRequestBody /// The recipient's mailing address [JsonPropertyName("ship_to")] [JsonRequired] - public ShippingAddressTo ShipTo { get; set; } + public required ShippingAddressTo ShipTo { get; set; } /// /// Advanced shipment options. These are entirely optional. diff --git a/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs b/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs index 6a662a95..1fa43b5b 100644 --- a/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs @@ -34,7 +34,7 @@ public partial class UpdateShipmentResponseBody /// The type of delivery confirmation that is required for this shipment. [JsonPropertyName("confirmation")] [JsonRequired] - public DeliveryConfirmation Confirmation { get; set; } = new(); + public required DeliveryConfirmation Confirmation { get; set; } = new(); /// @@ -43,7 +43,7 @@ public partial class UpdateShipmentResponseBody /// The insurance provider to use for any insured packages in the shipment. [JsonPropertyName("insurance_provider")] [JsonRequired] - public InsuranceProvider InsuranceProvider { get; set; } = new(); + public required InsuranceProvider InsuranceProvider { get; set; } = new(); /// @@ -52,7 +52,7 @@ public partial class UpdateShipmentResponseBody /// The current status of the shipment [JsonPropertyName("shipment_status")] [JsonRequired] - public ShipmentStatus ShipmentStatus { get; set; } = new(); + public required ShipmentStatus ShipmentStatus { get; set; } = new(); /// @@ -66,7 +66,7 @@ public partial class UpdateShipmentResponseBody /// The address validation [JsonPropertyName("address_validation")] [JsonRequired] - public AddressValidationResult AddressValidation { get; set; } + public required AddressValidationResult AddressValidation { get; set; } /// /// Advanced shipment options. These are entirely optional. @@ -74,7 +74,7 @@ public partial class UpdateShipmentResponseBody /// Advanced shipment options. These are entirely optional. [JsonPropertyName("advanced_options")] [JsonRequired] - public AdvancedShipmentOptions AdvancedOptions { get; set; } + public required AdvancedShipmentOptions AdvancedOptions { get; set; } /// /// The carrier account that is billed for the shipping charges @@ -85,7 +85,7 @@ public partial class UpdateShipmentResponseBody /// [JsonPropertyName("carrier_id")] [JsonRequired] - public string CarrierId { get; set; } + public required string CarrierId { get; set; } /// /// The date and time that the shipment was created in ShipEngine. @@ -96,7 +96,7 @@ public partial class UpdateShipmentResponseBody /// [JsonPropertyName("created_at")] [JsonRequired] - public DateTimeOffset CreatedAt { get; set; } + public required DateTimeOffset CreatedAt { get; set; } /// /// An array of errors that occurred while creating shipment. @@ -105,7 +105,7 @@ public partial class UpdateShipmentResponseBody [JsonPropertyName("errors")] [JsonRequired] [Obsolete] - public List Errors { get; set; } + public required List Errors { get; set; } /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. @@ -113,7 +113,7 @@ public partial class UpdateShipmentResponseBody /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. [JsonPropertyName("packages")] [JsonRequired] - public List Packages { get; set; } + public required List Packages { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. @@ -121,7 +121,7 @@ public partial class UpdateShipmentResponseBody /// The return address for this shipment. Defaults to the `ship_from` address. [JsonPropertyName("return_to")] [JsonRequired] - public ShippingAddress ReturnTo { get; set; } + public required ShippingAddress ReturnTo { get; set; } /// /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. @@ -132,7 +132,7 @@ public partial class UpdateShipmentResponseBody /// [JsonPropertyName("service_code")] [JsonRequired] - public string ServiceCode { get; set; } + public required string ServiceCode { get; set; } /// /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -143,7 +143,7 @@ public partial class UpdateShipmentResponseBody /// [JsonPropertyName("ship_date")] [JsonRequired] - public DateTimeOffset ShipDate { get; set; } + public required DateTimeOffset ShipDate { get; set; } /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. @@ -151,7 +151,7 @@ public partial class UpdateShipmentResponseBody /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. [JsonPropertyName("ship_from")] [JsonRequired] - public ShippingAddress ShipFrom { get; set; } + public required ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address @@ -159,7 +159,7 @@ public partial class UpdateShipmentResponseBody /// The recipient's mailing address [JsonPropertyName("ship_to")] [JsonRequired] - public ShippingAddressTo ShipTo { get; set; } + public required ShippingAddressTo ShipTo { get; set; } /// /// A string that uniquely identifies the shipment @@ -170,7 +170,7 @@ public partial class UpdateShipmentResponseBody /// [JsonPropertyName("shipment_id")] [JsonRequired] - public string ShipmentId { get; set; } + public required string ShipmentId { get; set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. @@ -178,7 +178,7 @@ public partial class UpdateShipmentResponseBody /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. [JsonPropertyName("tags")] [JsonRequired] - public List Tags { get; set; } + public required List Tags { get; set; } /// /// The combined weight of all packages in the shipment @@ -186,7 +186,7 @@ public partial class UpdateShipmentResponseBody /// The combined weight of all packages in the shipment [JsonPropertyName("total_weight")] [JsonRequired] - public Weight TotalWeight { get; set; } + public required Weight TotalWeight { get; set; } /// /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. @@ -204,7 +204,7 @@ public partial class UpdateShipmentResponseBody /// Customs information. This is usually only needed for international shipments. [JsonPropertyName("customs")] [JsonRequired] - public InternationalShipmentOptions Customs { get; set; } + public required InternationalShipmentOptions Customs { get; set; } /// /// ID that the Order Source assigned diff --git a/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs b/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs index 006448b3..268ea7c9 100644 --- a/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs @@ -37,7 +37,7 @@ public partial class UpdateWarehouseRequestBody /// [JsonPropertyName("name")] [JsonRequired] - public string Name { get; set; } + public required string Name { get; set; } /// /// The origin address of the warehouse @@ -45,7 +45,7 @@ public partial class UpdateWarehouseRequestBody /// The origin address of the warehouse [JsonPropertyName("origin_address")] [JsonRequired] - public Address OriginAddress { get; set; } + public required Address OriginAddress { get; set; } /// /// Timestamp that indicates when the warehouse was created diff --git a/ShipEngineSDK/Model/VoidLabelResponseBody.cs b/ShipEngineSDK/Model/VoidLabelResponseBody.cs index 64133641..1827acc2 100644 --- a/ShipEngineSDK/Model/VoidLabelResponseBody.cs +++ b/ShipEngineSDK/Model/VoidLabelResponseBody.cs @@ -43,7 +43,7 @@ public partial class VoidLabelResponseBody /// [JsonPropertyName("approved")] [JsonRequired] - public bool Approved { get; set; } + public required bool Approved { get; set; } /// /// Gets or Sets Message @@ -53,7 +53,7 @@ public partial class VoidLabelResponseBody /// [JsonPropertyName("message")] [JsonRequired] - public string Message { get; set; } + public required string Message { get; set; } /// diff --git a/ShipEngineSDK/Model/WebhookHeader.cs b/ShipEngineSDK/Model/WebhookHeader.cs index 99e950ad..44aa0c67 100644 --- a/ShipEngineSDK/Model/WebhookHeader.cs +++ b/ShipEngineSDK/Model/WebhookHeader.cs @@ -37,7 +37,7 @@ public partial class WebhookHeader /// [JsonPropertyName("key")] [JsonRequired] - public string Key { get; set; } + public required string Key { get; set; } /// /// Value of a header @@ -48,7 +48,7 @@ public partial class WebhookHeader /// [JsonPropertyName("value")] [JsonRequired] - public string Value { get; set; } + public required string Value { get; set; } /// diff --git a/ShipEngineSDK/Model/Weight.cs b/ShipEngineSDK/Model/Weight.cs index ce6a0300..89696e4a 100644 --- a/ShipEngineSDK/Model/Weight.cs +++ b/ShipEngineSDK/Model/Weight.cs @@ -33,7 +33,7 @@ public partial class Weight /// [JsonPropertyName("unit")] [JsonRequired] - public WeightUnit Unit { get; set; } = new(); + public required WeightUnit Unit { get; set; } = new(); /// @@ -42,7 +42,7 @@ public partial class Weight /// The weight, in the specified unit [JsonPropertyName("value")] [JsonRequired] - public double Value { get; set; } + public required double Value { get; set; } /// diff --git a/generation/templates/modelGeneric.mustache b/generation/templates/modelGeneric.mustache index b99d061f..78223a1f 100644 --- a/generation/templates/modelGeneric.mustache +++ b/generation/templates/modelGeneric.mustache @@ -48,7 +48,7 @@ {{#deprecated}} [Obsolete] {{/deprecated}} - public {{{complexType}}}{{^complexType}}{{{datatypeWithEnum}}}{{/complexType}}{{^isContainer}}{{^required}}?{{/required}}{{/isContainer}} {{name}} { get; set; }{{#required}} = new(); + public{{#required}} required{{/required}} {{{complexType}}}{{^complexType}}{{{datatypeWithEnum}}}{{/complexType}}{{^isContainer}}{{^required}}?{{/required}}{{/isContainer}} {{name}} { get; set; }{{#required}} = new(); {{/required}} {{/isEnum}} @@ -79,7 +79,7 @@ {{#deprecated}} [Obsolete] {{/deprecated}} - public {{{dataType}}}{{#isNullable}}?{{/isNullable}} {{name}} { get; set; } + public{{#required}} required{{/required}} {{{dataType}}}{{#isNullable}}?{{/isNullable}} {{name}} { get; set; } {{#-last}} } @@ -102,7 +102,7 @@ {{#deprecated}} [Obsolete] {{/deprecated}} - public {{#items.vars}}{{#-first}}List<{{classname}}Item>{{/-first}}{{/items.vars}}{{^items.vars}}{{{dataType}}}{{/items.vars}}{{^required}}?{{/required}} {{name}} { get; set; } + public{{#required}} required{{/required}} {{#items.vars}}{{#-first}}List<{{classname}}Item>{{/-first}}{{/items.vars}}{{^items.vars}}{{{dataType}}}{{/items.vars}}{{^required}}?{{/required}} {{name}} { get; set; } {{/isEnum}} {{/isInherited}} diff --git a/generation/templates/modelOneOf.mustache b/generation/templates/modelOneOf.mustache index 94ca1121..aa6fdcb0 100644 --- a/generation/templates/modelOneOf.mustache +++ b/generation/templates/modelOneOf.mustache @@ -44,7 +44,7 @@ {{#deprecated}} [Obsolete] {{/deprecated}} - public {{{complexType}}}{{^complexType}}{{{datatypeWithEnum}}}{{/complexType}}{{^isContainer}}{{^required}}?{{/required}}{{/isContainer}} {{name}} { get; set; }{{#required}} = new(); + public{{#required}} required{{/required}} {{{complexType}}}{{^complexType}}{{{datatypeWithEnum}}}{{/complexType}}{{^isContainer}}{{^required}}?{{/required}}{{/isContainer}} {{name}} { get; set; }{{#required}} = new(); {{/required}} {{/isEnum}} @@ -70,7 +70,7 @@ {{#deprecated}} [Obsolete] {{/deprecated}} - public {{{dataType}}}{{^required}}?{{/required}} {{name}} { get; set; } + public{{#required}} required{{/required}} {{{dataType}}}{{^required}}?{{/required}} {{name}} { get; set; } {{/isEnum}} {{/isInherited}} @@ -330,13 +330,25 @@ public class {{classname}}JsonConverter : JsonConverter<{{classname}}> var jsonDoc = JsonDocument.ParseValue(ref reader); {{classname}}? new{{classname}} = null; +{{#composedSchemas.allOf}} + // Deserialize all the common properties of the model so they can be used in object initializers later + {{#allVars}} + var {{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}} = jsonDoc.RootElement.GetProperty("{{baseName}}").Deserialize<{{#isEnum}}{{{complexType}}}{{^complexType}}{{{datatypeWithEnum}}}{{/complexType}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}>(DeserializingOptions)!; + {{/allVars}} +{{/composedSchemas.allOf}} + int match = 0; var matchedTypes = new List(); {{#composedSchemas.oneOf}} try { - new{{classname}} = new {{classname}}(jsonDoc.Deserialize<{{{dataType}}}>(DeserializingOptions)!); + new{{classname}} = new {{classname}}(jsonDoc.Deserialize<{{{dataType}}}>(DeserializingOptions)!){{#model.composedSchemas.allOf}} + { + {{#allVars}} + {{name}} = {{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}}, + {{/allVars}} + }{{/model.composedSchemas.allOf}}; matchedTypes.Add("{{{dataType}}}"); match++; @@ -358,12 +370,6 @@ public class {{classname}}JsonConverter : JsonConverter<{{classname}}> throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); } -{{#composedSchemas.allOf}} - {{#allVars}} - new{{classname}}!.{{name}} = jsonDoc.RootElement.GetProperty("{{baseName}}").Deserialize<{{#isEnum}}{{{complexType}}}{{^complexType}}{{{datatypeWithEnum}}}{{/complexType}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}>(DeserializingOptions)!; - {{/allVars}} -{{/composedSchemas.allOf}} - // deserialization is considered successful at this point if no exception has been thrown. return new{{classname}}; } From ecdb32574c5ce8ed8b9f98db8e36cd50fae093b7 Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Tue, 16 Jul 2024 17:07:30 -0500 Subject: [PATCH 08/42] Mark API method parameters as optional --- ShipEngineSDK/Api/AccountApi.cs | 6 +- ShipEngineSDK/Api/BatchesApi.cs | 48 ++--- ShipEngineSDK/Api/CarrierAccountsApi.cs | 14 +- ShipEngineSDK/Api/CarriersApi.cs | 12 +- ShipEngineSDK/Api/DownloadsApi.cs | 18 +- ShipEngineSDK/Api/LabelsApi.cs | 70 +++---- ShipEngineSDK/Api/ManifestsApi.cs | 30 +-- ShipEngineSDK/Api/PackagePickupsApi.cs | 24 +-- ShipEngineSDK/Api/PackageTypesApi.cs | 6 +- ShipEngineSDK/Api/RatesApi.cs | 2 +- ShipEngineSDK/Api/ServicePointsApi.cs | 6 +- ShipEngineSDK/Api/ShipmentsApi.cs | 62 +++--- ShipEngineSDK/Api/TagsApi.cs | 8 +- ShipEngineSDK/Api/TokensApi.cs | 10 +- ShipEngineSDK/Api/TrackingApi.cs | 36 ++-- ShipEngineSDK/Api/WarehousesApi.cs | 8 +- ShipEngineSDK/Api/WebhooksApi.cs | 6 +- .../CompilerFeatureRequiredAttribute.cs | 3 + ShipEngineSDK/Model/AccountSettingsImages.cs | 3 + .../Model/CompareBulkRatesRequestBody.cs | 1 - .../CreateAccountSettingsImageRequestBody.cs | 3 + .../GetAccountSettingsImagesResponseBody.cs | 3 + ...ervicePointByIdResponseBodyServicePoint.cs | 6 + .../Model/ListAccountImagesResponseBody.cs | 17 +- .../ListAccountSettingsImagesResponseBody.cs | 17 +- ShipEngineSDK/Model/ListLabelsResponseBody.cs | 63 +++--- ...icePointsResponseBodyServicePointsInner.cs | 6 + ShipEngineSDK/Model/PagedListResponseBody.cs | 2 +- ...artialShippingAddressToGeolocationInner.cs | 3 + .../UpdateAccountSettingsImageRequestBody.cs | 3 + ShipEngineSDK/PublicAPI.Unshipped.txt | 186 ------------------ generation/templates/api.mustache | 38 ++-- generation/templates/modelGeneric.mustache | 7 +- generation/templates/modelInnerEnum.mustache | 3 + generation/templates/modelOneOf.mustache | 2 +- 35 files changed, 295 insertions(+), 437 deletions(-) diff --git a/ShipEngineSDK/Api/AccountApi.cs b/ShipEngineSDK/Api/AccountApi.cs index 777b3b51..87b50977 100644 --- a/ShipEngineSDK/Api/AccountApi.cs +++ b/ShipEngineSDK/Api/AccountApi.cs @@ -232,7 +232,7 @@ public async Task DeleteAccountImageById(HttpClient methodClient, string RequestOptions requestOptions = new("/v1/account/settings/images/{label_image_id}"); - requestOptions.PathParameters.Add("label_image_id", ShipEngineSDK.ClientUtils.ParameterToString(labelImageId)); // path parameter + requestOptions.PathParameters.Add("label_image_id", ClientUtils.ParameterToString(labelImageId)); // path parameter requestOptions.Operation = "AccountApi.DeleteAccountImageById"; @@ -274,7 +274,7 @@ public async Task GetAccountSettingsImages RequestOptions requestOptions = new("/v1/account/settings/images/{label_image_id}"); - requestOptions.PathParameters.Add("label_image_id", ShipEngineSDK.ClientUtils.ParameterToString(labelImageId)); // path parameter + requestOptions.PathParameters.Add("label_image_id", ClientUtils.ParameterToString(labelImageId)); // path parameter requestOptions.Operation = "AccountApi.GetAccountSettingsImagesById"; @@ -390,7 +390,7 @@ public async Task UpdateAccountSettingsImagesById(HttpClient methodClien RequestOptions requestOptions = new("/v1/account/settings/images/{label_image_id}"); - requestOptions.PathParameters.Add("label_image_id", ShipEngineSDK.ClientUtils.ParameterToString(labelImageId)); // path parameter + requestOptions.PathParameters.Add("label_image_id", ClientUtils.ParameterToString(labelImageId)); // path parameter requestOptions.Data = JsonSerializer.Serialize(updateAccountSettingsImageRequestBody, JsonSerializerOptions); requestOptions.Operation = "AccountApi.UpdateAccountSettingsImagesById"; diff --git a/ShipEngineSDK/Api/BatchesApi.cs b/ShipEngineSDK/Api/BatchesApi.cs index 948fbabd..e1baca55 100644 --- a/ShipEngineSDK/Api/BatchesApi.cs +++ b/ShipEngineSDK/Api/BatchesApi.cs @@ -143,7 +143,7 @@ public partial interface IShipEngine /// 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) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchErrorsResponseBody) - Task ListBatchErrors(string batchId, int pagesize, int page, CancellationToken cancellationToken = default); + Task ListBatchErrors(string batchId, int? pagesize, int? page, CancellationToken cancellationToken = default); /// /// Get Batch Errors Error handling in batches are handled differently than in a single synchronous request. You must retrieve the status of your batch by [getting a batch](https://www.shipengine.com/docs/reference/get-batch-by-id/) and getting an overview of the statuses or you can list errors directly here below to get detailed information about the errors. @@ -156,7 +156,7 @@ public partial interface IShipEngine /// 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) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchErrorsResponseBody) - Task ListBatchErrors(HttpClient methodClient, string batchId, int pagesize, int page, CancellationToken cancellationToken = default); + Task ListBatchErrors(HttpClient methodClient, string batchId, int? pagesize, int? page, CancellationToken cancellationToken = default); /// /// List Batches List Batches associated with your Shipengine account @@ -171,7 +171,7 @@ public partial interface IShipEngine /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchesResponseBody) - Task ListBatches(BatchStatus status, BatchesSortBy sortBy, SortDir sortDir, string batchNumber, int page, int pageSize, CancellationToken cancellationToken = default); + Task ListBatches(BatchStatus? status, BatchesSortBy? sortBy, SortDir? sortDir, string? batchNumber, int? page, int? pageSize, CancellationToken cancellationToken = default); /// /// List Batches List Batches associated with your Shipengine account @@ -187,7 +187,7 @@ public partial interface IShipEngine /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchesResponseBody) - Task ListBatches(HttpClient methodClient, BatchStatus status, BatchesSortBy sortBy, SortDir sortDir, string batchNumber, int page, int pageSize, CancellationToken cancellationToken = default); + Task ListBatches(HttpClient methodClient, BatchStatus? status, BatchesSortBy? sortBy, SortDir? sortDir, string? batchNumber, int? page, int? pageSize, CancellationToken cancellationToken = default); /// /// Process Batch ID Labels Process Batch ID Labels @@ -304,7 +304,7 @@ public async Task AddToBatch(HttpClient methodClient, AddToBatchRequestB RequestOptions requestOptions = new("/v1/batches/{batch_id}/add"); - requestOptions.PathParameters.Add("batch_id", ShipEngineSDK.ClientUtils.ParameterToString(batchId)); // path parameter + requestOptions.PathParameters.Add("batch_id", ClientUtils.ParameterToString(batchId)); // path parameter requestOptions.Data = JsonSerializer.Serialize(addToBatchRequestBody, JsonSerializerOptions); requestOptions.Operation = "BatchesApi.AddToBatch"; @@ -389,7 +389,7 @@ public async Task DeleteBatch(HttpClient methodClient, string batchId, C RequestOptions requestOptions = new("/v1/batches/{batch_id}"); - requestOptions.PathParameters.Add("batch_id", ShipEngineSDK.ClientUtils.ParameterToString(batchId)); // path parameter + requestOptions.PathParameters.Add("batch_id", ClientUtils.ParameterToString(batchId)); // path parameter requestOptions.Operation = "BatchesApi.DeleteBatch"; @@ -431,7 +431,7 @@ public async Task GetBatchByExternalId(HttpCli RequestOptions requestOptions = new("/v1/batches/external_batch_id/{external_batch_id}"); - requestOptions.PathParameters.Add("external_batch_id", ShipEngineSDK.ClientUtils.ParameterToString(externalBatchId)); // path parameter + requestOptions.PathParameters.Add("external_batch_id", ClientUtils.ParameterToString(externalBatchId)); // path parameter requestOptions.Operation = "BatchesApi.GetBatchByExternalId"; @@ -473,7 +473,7 @@ public async Task GetBatchById(HttpClient methodClient RequestOptions requestOptions = new("/v1/batches/{batch_id}"); - requestOptions.PathParameters.Add("batch_id", ShipEngineSDK.ClientUtils.ParameterToString(batchId)); // path parameter + requestOptions.PathParameters.Add("batch_id", ClientUtils.ParameterToString(batchId)); // path parameter requestOptions.Operation = "BatchesApi.GetBatchById"; @@ -492,7 +492,7 @@ public async Task GetBatchById(HttpClient methodClient /// 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) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchErrorsResponseBody) - public Task ListBatchErrors(string batchId, int pagesize = default, int page = default, CancellationToken cancellationToken = default) + public Task ListBatchErrors(string batchId, int? pagesize = default, int? page = default, CancellationToken cancellationToken = default) { return ListBatchErrors(_client, batchId, pagesize, page, cancellationToken); } @@ -508,7 +508,7 @@ public Task ListBatchErrors(string batchId, int pag /// 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) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchErrorsResponseBody) - public async Task ListBatchErrors(HttpClient methodClient, string batchId, int pagesize = default, int page = default, CancellationToken cancellationToken = default) + public async Task ListBatchErrors(HttpClient methodClient, string batchId, int? pagesize = default, int? page = default, CancellationToken cancellationToken = default) { // verify the required parameter 'batchId' is set if (batchId == null) @@ -519,14 +519,14 @@ public async Task ListBatchErrors(HttpClient method RequestOptions requestOptions = new("/v1/batches/{batch_id}/errors"); - requestOptions.PathParameters.Add("batch_id", ShipEngineSDK.ClientUtils.ParameterToString(batchId)); // path parameter + requestOptions.PathParameters.Add("batch_id", ClientUtils.ParameterToString(batchId)); // path parameter if (pagesize != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "pagesize", pagesize)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "pagesize", pagesize)); } if (page != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page", page)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "page", page)); } requestOptions.Operation = "BatchesApi.ListBatchErrors"; @@ -549,7 +549,7 @@ public async Task ListBatchErrors(HttpClient method /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchesResponseBody) - public Task ListBatches(BatchStatus status = default, BatchesSortBy sortBy = default, SortDir sortDir = default, string batchNumber = default, int page = default, int pageSize = default, CancellationToken cancellationToken = default) + public Task ListBatches(BatchStatus? status = default, BatchesSortBy? sortBy = default, SortDir? sortDir = default, string? batchNumber = default, int? page = default, int? pageSize = default, CancellationToken cancellationToken = default) { return ListBatches(_client, status, sortBy, sortDir, batchNumber, page, pageSize, cancellationToken); } @@ -568,34 +568,34 @@ public Task ListBatches(BatchStatus status = default, B /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListBatchesResponseBody) - public async Task ListBatches(HttpClient methodClient, BatchStatus status = default, BatchesSortBy sortBy = default, SortDir sortDir = default, string batchNumber = default, int page = default, int pageSize = default, CancellationToken cancellationToken = default) + public async Task ListBatches(HttpClient methodClient, BatchStatus? status = default, BatchesSortBy? sortBy = default, SortDir? sortDir = default, string? batchNumber = default, int? page = default, int? pageSize = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/batches"); if (status != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "status", status)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "status", status)); } if (sortBy != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "sort_by", sortBy)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "sort_by", sortBy)); } if (sortDir != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "sort_dir", sortDir)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "sort_dir", sortDir)); } if (batchNumber != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "batch_number", batchNumber)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "batch_number", batchNumber)); } if (page != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page", page)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "page", page)); } if (pageSize != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page_size", pageSize)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "page_size", pageSize)); } requestOptions.Operation = "BatchesApi.ListBatches"; @@ -646,7 +646,7 @@ public async Task ProcessBatch(HttpClient methodClient, ProcessBatchRequ RequestOptions requestOptions = new("/v1/batches/{batch_id}/process/labels"); - requestOptions.PathParameters.Add("batch_id", ShipEngineSDK.ClientUtils.ParameterToString(batchId)); // path parameter + requestOptions.PathParameters.Add("batch_id", ClientUtils.ParameterToString(batchId)); // path parameter requestOptions.Data = JsonSerializer.Serialize(processBatchRequestBody, JsonSerializerOptions); requestOptions.Operation = "BatchesApi.ProcessBatch"; @@ -697,7 +697,7 @@ public async Task RemoveFromBatch(HttpClient methodClient, RemoveFromBat RequestOptions requestOptions = new("/v1/batches/{batch_id}/remove"); - requestOptions.PathParameters.Add("batch_id", ShipEngineSDK.ClientUtils.ParameterToString(batchId)); // path parameter + requestOptions.PathParameters.Add("batch_id", ClientUtils.ParameterToString(batchId)); // path parameter requestOptions.Data = JsonSerializer.Serialize(removeFromBatchRequestBody, JsonSerializerOptions); requestOptions.Operation = "BatchesApi.RemoveFromBatch"; @@ -740,7 +740,7 @@ public async Task UpdateBatch(HttpClient methodClient, string batchId, C RequestOptions requestOptions = new("/v1/batches/{batch_id}"); - requestOptions.PathParameters.Add("batch_id", ShipEngineSDK.ClientUtils.ParameterToString(batchId)); // path parameter + requestOptions.PathParameters.Add("batch_id", ClientUtils.ParameterToString(batchId)); // path parameter requestOptions.Operation = "BatchesApi.UpdateBatch"; diff --git a/ShipEngineSDK/Api/CarrierAccountsApi.cs b/ShipEngineSDK/Api/CarrierAccountsApi.cs index 308a5001..6d213520 100644 --- a/ShipEngineSDK/Api/CarrierAccountsApi.cs +++ b/ShipEngineSDK/Api/CarrierAccountsApi.cs @@ -168,7 +168,7 @@ public async Task ConnectCarrier(HttpClient methodCl RequestOptions requestOptions = new("/v1/connections/carriers/{carrier_name}"); - requestOptions.PathParameters.Add("carrier_name", ShipEngineSDK.ClientUtils.ParameterToString(carrierName)); // path parameter + requestOptions.PathParameters.Add("carrier_name", ClientUtils.ParameterToString(carrierName)); // path parameter requestOptions.Data = JsonSerializer.Serialize(connectCarrierRequestBody, JsonSerializerOptions); requestOptions.Operation = "CarrierAccountsApi.ConnectCarrier"; @@ -219,8 +219,8 @@ public async Task DisconnectCarrier(HttpClient methodClient, CarrierName RequestOptions requestOptions = new("/v1/connections/carriers/{carrier_name}/{carrier_id}"); - requestOptions.PathParameters.Add("carrier_name", ShipEngineSDK.ClientUtils.ParameterToString(carrierName)); // path parameter - requestOptions.PathParameters.Add("carrier_id", ShipEngineSDK.ClientUtils.ParameterToString(carrierId)); // path parameter + requestOptions.PathParameters.Add("carrier_name", ClientUtils.ParameterToString(carrierName)); // path parameter + requestOptions.PathParameters.Add("carrier_id", ClientUtils.ParameterToString(carrierId)); // path parameter requestOptions.Operation = "CarrierAccountsApi.DisconnectCarrier"; @@ -270,8 +270,8 @@ public async Task GetCarrierSettings(HttpClient RequestOptions requestOptions = new("/v1/connections/carriers/{carrier_name}/{carrier_id}/settings"); - requestOptions.PathParameters.Add("carrier_name", ShipEngineSDK.ClientUtils.ParameterToString(carrierName)); // path parameter - requestOptions.PathParameters.Add("carrier_id", ShipEngineSDK.ClientUtils.ParameterToString(carrierId)); // path parameter + requestOptions.PathParameters.Add("carrier_name", ClientUtils.ParameterToString(carrierName)); // path parameter + requestOptions.PathParameters.Add("carrier_id", ClientUtils.ParameterToString(carrierId)); // path parameter requestOptions.Operation = "CarrierAccountsApi.GetCarrierSettings"; @@ -329,8 +329,8 @@ public async Task UpdateCarrierSettings(HttpClient methodClient, Carrier RequestOptions requestOptions = new("/v1/connections/carriers/{carrier_name}/{carrier_id}/settings"); - requestOptions.PathParameters.Add("carrier_name", ShipEngineSDK.ClientUtils.ParameterToString(carrierName)); // path parameter - requestOptions.PathParameters.Add("carrier_id", ShipEngineSDK.ClientUtils.ParameterToString(carrierId)); // path parameter + requestOptions.PathParameters.Add("carrier_name", ClientUtils.ParameterToString(carrierName)); // path parameter + requestOptions.PathParameters.Add("carrier_id", ClientUtils.ParameterToString(carrierId)); // path parameter requestOptions.Data = JsonSerializer.Serialize(updateCarrierSettingsRequestBody, JsonSerializerOptions); requestOptions.Operation = "CarrierAccountsApi.UpdateCarrierSettings"; diff --git a/ShipEngineSDK/Api/CarriersApi.cs b/ShipEngineSDK/Api/CarriersApi.cs index c90da671..34f86704 100644 --- a/ShipEngineSDK/Api/CarriersApi.cs +++ b/ShipEngineSDK/Api/CarriersApi.cs @@ -221,7 +221,7 @@ public async Task AddFundsToCarrier(HttpClient me RequestOptions requestOptions = new("/v1/carriers/{carrier_id}/add_funds"); - requestOptions.PathParameters.Add("carrier_id", ShipEngineSDK.ClientUtils.ParameterToString(carrierId)); // path parameter + requestOptions.PathParameters.Add("carrier_id", ClientUtils.ParameterToString(carrierId)); // path parameter requestOptions.Data = JsonSerializer.Serialize(addFundsToCarrierRequestBody, JsonSerializerOptions); requestOptions.Operation = "CarriersApi.AddFundsToCarrier"; @@ -264,7 +264,7 @@ public async Task DisconnectCarrierById(HttpClient methodClient, string RequestOptions requestOptions = new("/v1/carriers/{carrier_id}"); - requestOptions.PathParameters.Add("carrier_id", ShipEngineSDK.ClientUtils.ParameterToString(carrierId)); // path parameter + requestOptions.PathParameters.Add("carrier_id", ClientUtils.ParameterToString(carrierId)); // path parameter requestOptions.Operation = "CarriersApi.DisconnectCarrierById"; @@ -306,7 +306,7 @@ public async Task GetCarrierById(HttpClient methodCl RequestOptions requestOptions = new("/v1/carriers/{carrier_id}"); - requestOptions.PathParameters.Add("carrier_id", ShipEngineSDK.ClientUtils.ParameterToString(carrierId)); // path parameter + requestOptions.PathParameters.Add("carrier_id", ClientUtils.ParameterToString(carrierId)); // path parameter requestOptions.Operation = "CarriersApi.GetCarrierById"; @@ -348,7 +348,7 @@ public async Task GetCarrierOptions(HttpClient me RequestOptions requestOptions = new("/v1/carriers/{carrier_id}/options"); - requestOptions.PathParameters.Add("carrier_id", ShipEngineSDK.ClientUtils.ParameterToString(carrierId)); // path parameter + requestOptions.PathParameters.Add("carrier_id", ClientUtils.ParameterToString(carrierId)); // path parameter requestOptions.Operation = "CarriersApi.GetCarrierOptions"; @@ -390,7 +390,7 @@ public async Task ListCarrierPackageTypes(H RequestOptions requestOptions = new("/v1/carriers/{carrier_id}/packages"); - requestOptions.PathParameters.Add("carrier_id", ShipEngineSDK.ClientUtils.ParameterToString(carrierId)); // path parameter + requestOptions.PathParameters.Add("carrier_id", ClientUtils.ParameterToString(carrierId)); // path parameter requestOptions.Operation = "CarriersApi.ListCarrierPackageTypes"; @@ -432,7 +432,7 @@ public async Task ListCarrierServices(HttpClien RequestOptions requestOptions = new("/v1/carriers/{carrier_id}/services"); - requestOptions.PathParameters.Add("carrier_id", ShipEngineSDK.ClientUtils.ParameterToString(carrierId)); // path parameter + requestOptions.PathParameters.Add("carrier_id", ClientUtils.ParameterToString(carrierId)); // path parameter requestOptions.Operation = "CarriersApi.ListCarrierServices"; diff --git a/ShipEngineSDK/Api/DownloadsApi.cs b/ShipEngineSDK/Api/DownloadsApi.cs index 874704e8..0f657409 100644 --- a/ShipEngineSDK/Api/DownloadsApi.cs +++ b/ShipEngineSDK/Api/DownloadsApi.cs @@ -38,7 +38,7 @@ public partial interface IShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (System.IO.Stream) - Task DownloadFile(string subdir, string filename, string dir, int rotation, string download, CancellationToken cancellationToken = default); + Task DownloadFile(string subdir, string filename, string dir, int? rotation, string? download, CancellationToken cancellationToken = default); /// /// Download File Get File @@ -53,7 +53,7 @@ public partial interface IShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (System.IO.Stream) - Task DownloadFile(HttpClient methodClient, string subdir, string filename, string dir, int rotation, string download, CancellationToken cancellationToken = default); + Task DownloadFile(HttpClient methodClient, string subdir, string filename, string dir, int? rotation, string? download, CancellationToken cancellationToken = default); } @@ -74,7 +74,7 @@ public partial class ShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (System.IO.Stream) - public Task DownloadFile(string subdir, string filename, string dir, int rotation = default, string download = default, CancellationToken cancellationToken = default) + public Task DownloadFile(string subdir, string filename, string dir, int? rotation = default, string? download = default, CancellationToken cancellationToken = default) { return DownloadFile(_client, subdir, filename, dir, rotation, download, cancellationToken); } @@ -92,7 +92,7 @@ public partial class ShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (System.IO.Stream) - public async Task DownloadFile(HttpClient methodClient, string subdir, string filename, string dir, int rotation = default, string download = default, CancellationToken cancellationToken = default) + public async Task DownloadFile(HttpClient methodClient, string subdir, string filename, string dir, int? rotation = default, string? download = default, CancellationToken cancellationToken = default) { // verify the required parameter 'subdir' is set if (subdir == null) @@ -115,16 +115,16 @@ public partial class ShipEngine RequestOptions requestOptions = new("/v1/downloads/{dir}/{subdir}/{filename}"); - requestOptions.PathParameters.Add("subdir", ShipEngineSDK.ClientUtils.ParameterToString(subdir)); // path parameter - requestOptions.PathParameters.Add("filename", ShipEngineSDK.ClientUtils.ParameterToString(filename)); // path parameter - requestOptions.PathParameters.Add("dir", ShipEngineSDK.ClientUtils.ParameterToString(dir)); // path parameter + requestOptions.PathParameters.Add("subdir", ClientUtils.ParameterToString(subdir)); // path parameter + requestOptions.PathParameters.Add("filename", ClientUtils.ParameterToString(filename)); // path parameter + requestOptions.PathParameters.Add("dir", ClientUtils.ParameterToString(dir)); // path parameter if (rotation != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "rotation", rotation)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "rotation", rotation)); } if (download != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "download", download)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "download", download)); } requestOptions.Operation = "DownloadsApi.DownloadFile"; diff --git a/ShipEngineSDK/Api/LabelsApi.cs b/ShipEngineSDK/Api/LabelsApi.cs index 96002097..efa8016c 100644 --- a/ShipEngineSDK/Api/LabelsApi.cs +++ b/ShipEngineSDK/Api/LabelsApi.cs @@ -125,7 +125,7 @@ public partial interface IShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetLabelByExternalShipmentIdResponseBody) - Task GetLabelByExternalShipmentId(string externalShipmentId, LabelDownloadType labelDownloadType, CancellationToken cancellationToken = default); + Task GetLabelByExternalShipmentId(string externalShipmentId, LabelDownloadType? labelDownloadType, CancellationToken cancellationToken = default); /// /// Get Label By External Shipment ID Find a label by using the external shipment id that was used during label creation @@ -137,7 +137,7 @@ public partial interface IShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetLabelByExternalShipmentIdResponseBody) - Task GetLabelByExternalShipmentId(HttpClient methodClient, string externalShipmentId, LabelDownloadType labelDownloadType, CancellationToken cancellationToken = default); + Task GetLabelByExternalShipmentId(HttpClient methodClient, string externalShipmentId, LabelDownloadType? labelDownloadType, CancellationToken cancellationToken = default); /// /// Get Label By ID Retrieve information for individual labels. @@ -148,7 +148,7 @@ public partial interface IShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetLabelByIdResponseBody) - Task GetLabelById(string labelId, LabelDownloadType labelDownloadType, CancellationToken cancellationToken = default); + Task GetLabelById(string labelId, LabelDownloadType? labelDownloadType, CancellationToken cancellationToken = default); /// /// Get Label By ID Retrieve information for individual labels. @@ -160,7 +160,7 @@ public partial interface IShipEngine /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetLabelByIdResponseBody) - Task GetLabelById(HttpClient methodClient, string labelId, LabelDownloadType labelDownloadType, CancellationToken cancellationToken = default); + Task GetLabelById(HttpClient methodClient, string labelId, LabelDownloadType? labelDownloadType, CancellationToken cancellationToken = default); /// /// Get Label Tracking Information Retrieve the label's tracking information @@ -204,7 +204,7 @@ public partial interface IShipEngine /// Controls which field the query is sorted by. (optional, default to created_at) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListLabelsResponseBody) - Task ListLabels(DateTimeOffset createdAtStart, DateTimeOffset createdAtEnd, LabelStatus labelStatus, SortDir sortDir, string serviceCode, string carrierId, string trackingNumber, string batchId, string rateId, string shipmentId, string warehouseId, int page, int pageSize, string sortBy, CancellationToken cancellationToken = default); + Task ListLabels(DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, LabelStatus? labelStatus, SortDir? sortDir, string? serviceCode, string? carrierId, string? trackingNumber, string? batchId, string? rateId, string? shipmentId, string? warehouseId, int? page, int? pageSize, string? sortBy, CancellationToken cancellationToken = default); /// /// List labels This endpoint returns a list of labels that you've [created](https://www.shipengine.com/docs/labels/create-a-label/). You can optionally filter the results as well as control their sort order and the number of results returned at a time. By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want to get your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id` @@ -228,7 +228,7 @@ public partial interface IShipEngine /// Controls which field the query is sorted by. (optional, default to created_at) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListLabelsResponseBody) - Task ListLabels(HttpClient methodClient, DateTimeOffset createdAtStart, DateTimeOffset createdAtEnd, LabelStatus labelStatus, SortDir sortDir, string serviceCode, string carrierId, string trackingNumber, string batchId, string rateId, string shipmentId, string warehouseId, int page, int pageSize, string sortBy, CancellationToken cancellationToken = default); + Task ListLabels(HttpClient methodClient, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, LabelStatus? labelStatus, SortDir? sortDir, string? serviceCode, string? carrierId, string? trackingNumber, string? batchId, string? rateId, string? shipmentId, string? warehouseId, int? page, int? pageSize, string? sortBy, CancellationToken cancellationToken = default); /// /// Void a Label By ID Void a label by ID to get a refund. @@ -341,7 +341,7 @@ public async Task CreateLabelFromRate(HttpClien RequestOptions requestOptions = new("/v1/labels/rates/{rate_id}"); - requestOptions.PathParameters.Add("rate_id", ShipEngineSDK.ClientUtils.ParameterToString(rateId)); // path parameter + requestOptions.PathParameters.Add("rate_id", ClientUtils.ParameterToString(rateId)); // path parameter requestOptions.Data = JsonSerializer.Serialize(createLabelFromRateRequestBody, JsonSerializerOptions); requestOptions.Operation = "LabelsApi.CreateLabelFromRate"; @@ -392,7 +392,7 @@ public async Task CreateLabelFromShipment(H RequestOptions requestOptions = new("/v1/labels/shipment/{shipment_id}"); - requestOptions.PathParameters.Add("shipment_id", ShipEngineSDK.ClientUtils.ParameterToString(shipmentId)); // path parameter + requestOptions.PathParameters.Add("shipment_id", ClientUtils.ParameterToString(shipmentId)); // path parameter requestOptions.Data = JsonSerializer.Serialize(createLabelFromShipmentRequestBody, JsonSerializerOptions); requestOptions.Operation = "LabelsApi.CreateLabelFromShipment"; @@ -443,7 +443,7 @@ public async Task CreateReturnLabel(HttpClient me RequestOptions requestOptions = new("/v1/labels/{label_id}/return"); - requestOptions.PathParameters.Add("label_id", ShipEngineSDK.ClientUtils.ParameterToString(labelId)); // path parameter + requestOptions.PathParameters.Add("label_id", ClientUtils.ParameterToString(labelId)); // path parameter requestOptions.Data = JsonSerializer.Serialize(createReturnLabelRequestBody, JsonSerializerOptions); requestOptions.Operation = "LabelsApi.CreateReturnLabel"; @@ -462,7 +462,7 @@ public async Task CreateReturnLabel(HttpClient me /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetLabelByExternalShipmentIdResponseBody) - public Task GetLabelByExternalShipmentId(string externalShipmentId, LabelDownloadType labelDownloadType = default, CancellationToken cancellationToken = default) + public Task GetLabelByExternalShipmentId(string externalShipmentId, LabelDownloadType? labelDownloadType = default, CancellationToken cancellationToken = default) { return GetLabelByExternalShipmentId(_client, externalShipmentId, labelDownloadType, cancellationToken); } @@ -477,7 +477,7 @@ public Task GetLabelByExternalShipment /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetLabelByExternalShipmentIdResponseBody) - public async Task GetLabelByExternalShipmentId(HttpClient methodClient, string externalShipmentId, LabelDownloadType labelDownloadType = default, CancellationToken cancellationToken = default) + public async Task GetLabelByExternalShipmentId(HttpClient methodClient, string externalShipmentId, LabelDownloadType? labelDownloadType = default, CancellationToken cancellationToken = default) { // verify the required parameter 'externalShipmentId' is set if (externalShipmentId == null) @@ -488,10 +488,10 @@ public async Task GetLabelByExternalSh RequestOptions requestOptions = new("/v1/labels/external_shipment_id/{external_shipment_id}"); - requestOptions.PathParameters.Add("external_shipment_id", ShipEngineSDK.ClientUtils.ParameterToString(externalShipmentId)); // path parameter + requestOptions.PathParameters.Add("external_shipment_id", ClientUtils.ParameterToString(externalShipmentId)); // path parameter if (labelDownloadType != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "label_download_type", labelDownloadType)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "label_download_type", labelDownloadType)); } requestOptions.Operation = "LabelsApi.GetLabelByExternalShipmentId"; @@ -510,7 +510,7 @@ public async Task GetLabelByExternalSh /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetLabelByIdResponseBody) - public Task GetLabelById(string labelId, LabelDownloadType labelDownloadType = default, CancellationToken cancellationToken = default) + public Task GetLabelById(string labelId, LabelDownloadType? labelDownloadType = default, CancellationToken cancellationToken = default) { return GetLabelById(_client, labelId, labelDownloadType, cancellationToken); } @@ -525,7 +525,7 @@ public Task GetLabelById(string labelId, LabelDownload /// (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetLabelByIdResponseBody) - public async Task GetLabelById(HttpClient methodClient, string labelId, LabelDownloadType labelDownloadType = default, CancellationToken cancellationToken = default) + public async Task GetLabelById(HttpClient methodClient, string labelId, LabelDownloadType? labelDownloadType = default, CancellationToken cancellationToken = default) { // verify the required parameter 'labelId' is set if (labelId == null) @@ -536,10 +536,10 @@ public async Task GetLabelById(HttpClient methodClient RequestOptions requestOptions = new("/v1/labels/{label_id}"); - requestOptions.PathParameters.Add("label_id", ShipEngineSDK.ClientUtils.ParameterToString(labelId)); // path parameter + requestOptions.PathParameters.Add("label_id", ClientUtils.ParameterToString(labelId)); // path parameter if (labelDownloadType != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "label_download_type", labelDownloadType)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "label_download_type", labelDownloadType)); } requestOptions.Operation = "LabelsApi.GetLabelById"; @@ -582,7 +582,7 @@ public async Task GetTrackingLogFromLabel(H RequestOptions requestOptions = new("/v1/labels/{label_id}/track"); - requestOptions.PathParameters.Add("label_id", ShipEngineSDK.ClientUtils.ParameterToString(labelId)); // path parameter + requestOptions.PathParameters.Add("label_id", ClientUtils.ParameterToString(labelId)); // path parameter requestOptions.Operation = "LabelsApi.GetTrackingLogFromLabel"; @@ -612,7 +612,7 @@ public async Task GetTrackingLogFromLabel(H /// Controls which field the query is sorted by. (optional, default to created_at) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListLabelsResponseBody) - public Task ListLabels(DateTimeOffset createdAtStart = default, DateTimeOffset createdAtEnd = default, LabelStatus labelStatus = default, SortDir sortDir = default, string serviceCode = default, string carrierId = default, string trackingNumber = default, string batchId = default, string rateId = default, string shipmentId = default, string warehouseId = default, int page = default, int pageSize = default, string sortBy = default, CancellationToken cancellationToken = default) + public Task ListLabels(DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, LabelStatus? labelStatus = default, SortDir? sortDir = default, string? serviceCode = default, string? carrierId = default, string? trackingNumber = default, string? batchId = default, string? rateId = default, string? shipmentId = default, string? warehouseId = default, int? page = default, int? pageSize = default, string? sortBy = default, CancellationToken cancellationToken = default) { return ListLabels(_client, createdAtStart, createdAtEnd, labelStatus, sortDir, serviceCode, carrierId, trackingNumber, batchId, rateId, shipmentId, warehouseId, page, pageSize, sortBy, cancellationToken); } @@ -639,66 +639,66 @@ public Task ListLabels(DateTimeOffset createdAtStart = d /// Controls which field the query is sorted by. (optional, default to created_at) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListLabelsResponseBody) - public async Task ListLabels(HttpClient methodClient, DateTimeOffset createdAtStart = default, DateTimeOffset createdAtEnd = default, LabelStatus labelStatus = default, SortDir sortDir = default, string serviceCode = default, string carrierId = default, string trackingNumber = default, string batchId = default, string rateId = default, string shipmentId = default, string warehouseId = default, int page = default, int pageSize = default, string sortBy = default, CancellationToken cancellationToken = default) + public async Task ListLabels(HttpClient methodClient, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, LabelStatus? labelStatus = default, SortDir? sortDir = default, string? serviceCode = default, string? carrierId = default, string? trackingNumber = default, string? batchId = default, string? rateId = default, string? shipmentId = default, string? warehouseId = default, int? page = default, int? pageSize = default, string? sortBy = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/labels"); if (createdAtStart != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "created_at_start", createdAtStart)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "created_at_start", createdAtStart)); } if (createdAtEnd != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "created_at_end", createdAtEnd)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "created_at_end", createdAtEnd)); } if (labelStatus != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "label_status", labelStatus)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "label_status", labelStatus)); } if (sortDir != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "sort_dir", sortDir)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "sort_dir", sortDir)); } if (serviceCode != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "service_code", serviceCode)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "service_code", serviceCode)); } if (carrierId != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "carrier_id", carrierId)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "carrier_id", carrierId)); } if (trackingNumber != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "tracking_number", trackingNumber)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "tracking_number", trackingNumber)); } if (batchId != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "batch_id", batchId)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "batch_id", batchId)); } if (rateId != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "rate_id", rateId)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "rate_id", rateId)); } if (shipmentId != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "shipment_id", shipmentId)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "shipment_id", shipmentId)); } if (warehouseId != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "warehouse_id", warehouseId)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "warehouse_id", warehouseId)); } if (page != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page", page)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "page", page)); } if (pageSize != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page_size", pageSize)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "page_size", pageSize)); } if (sortBy != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "sort_by", sortBy)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "sort_by", sortBy)); } requestOptions.Operation = "LabelsApi.ListLabels"; @@ -741,7 +741,7 @@ public async Task VoidLabel(HttpClient methodClient, stri RequestOptions requestOptions = new("/v1/labels/{label_id}/void"); - requestOptions.PathParameters.Add("label_id", ShipEngineSDK.ClientUtils.ParameterToString(labelId)); // path parameter + requestOptions.PathParameters.Add("label_id", ClientUtils.ParameterToString(labelId)); // path parameter requestOptions.Operation = "LabelsApi.VoidLabel"; diff --git a/ShipEngineSDK/Api/ManifestsApi.cs b/ShipEngineSDK/Api/ManifestsApi.cs index dc77b088..06b4b5b0 100644 --- a/ShipEngineSDK/Api/ManifestsApi.cs +++ b/ShipEngineSDK/Api/ManifestsApi.cs @@ -105,7 +105,7 @@ public partial interface IShipEngine /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListManifestsResponseBody) - Task ListManifests(DateTimeOffset shipDateStart, DateTimeOffset shipDateEnd, DateTimeOffset createdAtStart, DateTimeOffset createdAtEnd, List labelIds, string warehouseId, string carrierId, int page, int pageSize, CancellationToken cancellationToken = default); + Task ListManifests(DateTimeOffset? shipDateStart, DateTimeOffset? shipDateEnd, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, List? labelIds, string? warehouseId, string? carrierId, int? page, int? pageSize, CancellationToken cancellationToken = default); /// /// List Manifests Similar to querying shipments, we allow you to query manifests since there will likely be a large number over a long period of time. @@ -124,7 +124,7 @@ public partial interface IShipEngine /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListManifestsResponseBody) - Task ListManifests(HttpClient methodClient, DateTimeOffset shipDateStart, DateTimeOffset shipDateEnd, DateTimeOffset createdAtStart, DateTimeOffset createdAtEnd, List labelIds, string warehouseId, string carrierId, int page, int pageSize, CancellationToken cancellationToken = default); + Task ListManifests(HttpClient methodClient, DateTimeOffset? shipDateStart, DateTimeOffset? shipDateEnd, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, List? labelIds, string? warehouseId, string? carrierId, int? page, int? pageSize, CancellationToken cancellationToken = default); } @@ -208,7 +208,7 @@ public async Task GetManifestById(HttpClient method RequestOptions requestOptions = new("/v1/manifests/{manifest_id}"); - requestOptions.PathParameters.Add("manifest_id", ShipEngineSDK.ClientUtils.ParameterToString(manifestId)); // path parameter + requestOptions.PathParameters.Add("manifest_id", ClientUtils.ParameterToString(manifestId)); // path parameter requestOptions.Operation = "ManifestsApi.GetManifestById"; @@ -250,7 +250,7 @@ public async Task GetManifestRequestById(HttpClient RequestOptions requestOptions = new("/v1/manifests/requests/{manifest_request_id}"); - requestOptions.PathParameters.Add("manifest_request_id", ShipEngineSDK.ClientUtils.ParameterToString(manifestRequestId)); // path parameter + requestOptions.PathParameters.Add("manifest_request_id", ClientUtils.ParameterToString(manifestRequestId)); // path parameter requestOptions.Operation = "ManifestsApi.GetManifestRequestById"; @@ -275,7 +275,7 @@ public async Task GetManifestRequestById(HttpClient /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListManifestsResponseBody) - public Task ListManifests(DateTimeOffset shipDateStart = default, DateTimeOffset shipDateEnd = default, DateTimeOffset createdAtStart = default, DateTimeOffset createdAtEnd = default, List labelIds = default, string warehouseId = default, string carrierId = default, int page = default, int pageSize = default, CancellationToken cancellationToken = default) + public Task ListManifests(DateTimeOffset? shipDateStart = default, DateTimeOffset? shipDateEnd = default, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, List? labelIds = default, string? warehouseId = default, string? carrierId = default, int? page = default, int? pageSize = default, CancellationToken cancellationToken = default) { return ListManifests(_client, shipDateStart, shipDateEnd, createdAtStart, createdAtEnd, labelIds, warehouseId, carrierId, page, pageSize, cancellationToken); } @@ -297,46 +297,46 @@ public Task ListManifests(DateTimeOffset shipDateStar /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListManifestsResponseBody) - public async Task ListManifests(HttpClient methodClient, DateTimeOffset shipDateStart = default, DateTimeOffset shipDateEnd = default, DateTimeOffset createdAtStart = default, DateTimeOffset createdAtEnd = default, List labelIds = default, string warehouseId = default, string carrierId = default, int page = default, int pageSize = default, CancellationToken cancellationToken = default) + public async Task ListManifests(HttpClient methodClient, DateTimeOffset? shipDateStart = default, DateTimeOffset? shipDateEnd = default, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, List? labelIds = default, string? warehouseId = default, string? carrierId = default, int? page = default, int? pageSize = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/manifests"); if (shipDateStart != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "ship_date_start", shipDateStart)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "ship_date_start", shipDateStart)); } if (shipDateEnd != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "ship_date_end", shipDateEnd)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "ship_date_end", shipDateEnd)); } if (createdAtStart != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "created_at_start", createdAtStart)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "created_at_start", createdAtStart)); } if (createdAtEnd != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "created_at_end", createdAtEnd)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "created_at_end", createdAtEnd)); } if (labelIds != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("multi", "label_ids", labelIds)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("multi", "label_ids", labelIds)); } if (warehouseId != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "warehouse_id", warehouseId)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "warehouse_id", warehouseId)); } if (carrierId != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "carrier_id", carrierId)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "carrier_id", carrierId)); } if (page != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page", page)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "page", page)); } if (pageSize != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page_size", pageSize)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "page_size", pageSize)); } requestOptions.Operation = "ManifestsApi.ListManifests"; diff --git a/ShipEngineSDK/Api/PackagePickupsApi.cs b/ShipEngineSDK/Api/PackagePickupsApi.cs index 1e9458e0..356fa53a 100644 --- a/ShipEngineSDK/Api/PackagePickupsApi.cs +++ b/ShipEngineSDK/Api/PackagePickupsApi.cs @@ -81,7 +81,7 @@ public partial interface IShipEngine /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetPickupsResponseBody) - Task ListScheduledPickups(DateTimeOffset createdAtStart, DateTimeOffset createdAtEnd, string carrierId, string warehouseId, int page, int pageSize, CancellationToken cancellationToken = default); + Task ListScheduledPickups(DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, string? carrierId, string? warehouseId, int? page, int? pageSize, CancellationToken cancellationToken = default); /// /// List Scheduled Pickups List all pickups that have been scheduled for this carrier @@ -97,7 +97,7 @@ public partial interface IShipEngine /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetPickupsResponseBody) - Task ListScheduledPickups(HttpClient methodClient, DateTimeOffset createdAtStart, DateTimeOffset createdAtEnd, string carrierId, string warehouseId, int page, int pageSize, CancellationToken cancellationToken = default); + Task ListScheduledPickups(HttpClient methodClient, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, string? carrierId, string? warehouseId, int? page, int? pageSize, CancellationToken cancellationToken = default); /// /// Schedule a Pickup Schedule a package pickup with a carrier @@ -160,7 +160,7 @@ public async Task DeleteScheduledPickup(HttpClient RequestOptions requestOptions = new("/v1/pickups/{pickup_id}"); - requestOptions.PathParameters.Add("pickup_id", ShipEngineSDK.ClientUtils.ParameterToString(pickupId)); // path parameter + requestOptions.PathParameters.Add("pickup_id", ClientUtils.ParameterToString(pickupId)); // path parameter requestOptions.Operation = "PackagePickupsApi.DeleteScheduledPickup"; @@ -202,7 +202,7 @@ public async Task GetPickupById(HttpClient methodClie RequestOptions requestOptions = new("/v1/pickups/{pickup_id}"); - requestOptions.PathParameters.Add("pickup_id", ShipEngineSDK.ClientUtils.ParameterToString(pickupId)); // path parameter + requestOptions.PathParameters.Add("pickup_id", ClientUtils.ParameterToString(pickupId)); // path parameter requestOptions.Operation = "PackagePickupsApi.GetPickupById"; @@ -224,7 +224,7 @@ public async Task GetPickupById(HttpClient methodClie /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetPickupsResponseBody) - public Task ListScheduledPickups(DateTimeOffset createdAtStart = default, DateTimeOffset createdAtEnd = default, string carrierId = default, string warehouseId = default, int page = default, int pageSize = default, CancellationToken cancellationToken = default) + public Task ListScheduledPickups(DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, string? carrierId = default, string? warehouseId = default, int? page = default, int? pageSize = default, CancellationToken cancellationToken = default) { return ListScheduledPickups(_client, createdAtStart, createdAtEnd, carrierId, warehouseId, page, pageSize, cancellationToken); } @@ -243,34 +243,34 @@ public Task ListScheduledPickups(DateTimeOffset createdA /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetPickupsResponseBody) - public async Task ListScheduledPickups(HttpClient methodClient, DateTimeOffset createdAtStart = default, DateTimeOffset createdAtEnd = default, string carrierId = default, string warehouseId = default, int page = default, int pageSize = default, CancellationToken cancellationToken = default) + public async Task ListScheduledPickups(HttpClient methodClient, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, string? carrierId = default, string? warehouseId = default, int? page = default, int? pageSize = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/pickups"); if (createdAtStart != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "created_at_start", createdAtStart)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "created_at_start", createdAtStart)); } if (createdAtEnd != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "created_at_end", createdAtEnd)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "created_at_end", createdAtEnd)); } if (carrierId != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "carrier_id", carrierId)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "carrier_id", carrierId)); } if (warehouseId != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "warehouse_id", warehouseId)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "warehouse_id", warehouseId)); } if (page != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page", page)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "page", page)); } if (pageSize != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page_size", pageSize)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "page_size", pageSize)); } requestOptions.Operation = "PackagePickupsApi.ListScheduledPickups"; diff --git a/ShipEngineSDK/Api/PackageTypesApi.cs b/ShipEngineSDK/Api/PackageTypesApi.cs index 1bcf4d35..5ffce8a0 100644 --- a/ShipEngineSDK/Api/PackageTypesApi.cs +++ b/ShipEngineSDK/Api/PackageTypesApi.cs @@ -213,7 +213,7 @@ public async Task DeletePackageType(HttpClient methodClient, string pack RequestOptions requestOptions = new("/v1/packages/{package_id}"); - requestOptions.PathParameters.Add("package_id", ShipEngineSDK.ClientUtils.ParameterToString(packageId)); // path parameter + requestOptions.PathParameters.Add("package_id", ClientUtils.ParameterToString(packageId)); // path parameter requestOptions.Operation = "PackageTypesApi.DeletePackageType"; @@ -255,7 +255,7 @@ public async Task GetPackageTypeById(HttpClient RequestOptions requestOptions = new("/v1/packages/{package_id}"); - requestOptions.PathParameters.Add("package_id", ShipEngineSDK.ClientUtils.ParameterToString(packageId)); // path parameter + requestOptions.PathParameters.Add("package_id", ClientUtils.ParameterToString(packageId)); // path parameter requestOptions.Operation = "PackageTypesApi.GetPackageTypeById"; @@ -338,7 +338,7 @@ public async Task UpdatePackageType(HttpClient methodClient, UpdatePacka RequestOptions requestOptions = new("/v1/packages/{package_id}"); - requestOptions.PathParameters.Add("package_id", ShipEngineSDK.ClientUtils.ParameterToString(packageId)); // path parameter + requestOptions.PathParameters.Add("package_id", ClientUtils.ParameterToString(packageId)); // path parameter requestOptions.Data = JsonSerializer.Serialize(updatePackageTypeRequestBody, JsonSerializerOptions); requestOptions.Operation = "PackageTypesApi.UpdatePackageType"; diff --git a/ShipEngineSDK/Api/RatesApi.cs b/ShipEngineSDK/Api/RatesApi.cs index 1e5d2c64..d4f5d82c 100644 --- a/ShipEngineSDK/Api/RatesApi.cs +++ b/ShipEngineSDK/Api/RatesApi.cs @@ -276,7 +276,7 @@ public async Task GetRateById(HttpClient methodClient, RequestOptions requestOptions = new("/v1/rates/{rate_id}"); - requestOptions.PathParameters.Add("rate_id", ShipEngineSDK.ClientUtils.ParameterToString(rateId)); // path parameter + requestOptions.PathParameters.Add("rate_id", ClientUtils.ParameterToString(rateId)); // path parameter requestOptions.Operation = "RatesApi.GetRateById"; diff --git a/ShipEngineSDK/Api/ServicePointsApi.cs b/ShipEngineSDK/Api/ServicePointsApi.cs index f23c48af..119614fa 100644 --- a/ShipEngineSDK/Api/ServicePointsApi.cs +++ b/ShipEngineSDK/Api/ServicePointsApi.cs @@ -128,9 +128,9 @@ public async Task ServicePointsGetById(HttpClie RequestOptions requestOptions = new("/v1/service_points/{carrier_code}/{country_code}/{service_point_id}"); - requestOptions.PathParameters.Add("carrier_code", ShipEngineSDK.ClientUtils.ParameterToString(carrierCode)); // path parameter - requestOptions.PathParameters.Add("country_code", ShipEngineSDK.ClientUtils.ParameterToString(countryCode)); // path parameter - requestOptions.PathParameters.Add("service_point_id", ShipEngineSDK.ClientUtils.ParameterToString(servicePointId)); // path parameter + requestOptions.PathParameters.Add("carrier_code", ClientUtils.ParameterToString(carrierCode)); // path parameter + requestOptions.PathParameters.Add("country_code", ClientUtils.ParameterToString(countryCode)); // path parameter + requestOptions.PathParameters.Add("service_point_id", ClientUtils.ParameterToString(servicePointId)); // path parameter requestOptions.Operation = "ServicePointsApi.ServicePointsGetById"; diff --git a/ShipEngineSDK/Api/ShipmentsApi.cs b/ShipEngineSDK/Api/ShipmentsApi.cs index ab599152..781ee63b 100644 --- a/ShipEngineSDK/Api/ShipmentsApi.cs +++ b/ShipEngineSDK/Api/ShipmentsApi.cs @@ -119,7 +119,7 @@ public partial interface IShipEngine /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentRatesResponseBody) - Task ListShipmentRates(string shipmentId, DateTimeOffset createdAtStart, CancellationToken cancellationToken = default); + Task ListShipmentRates(string shipmentId, DateTimeOffset? createdAtStart, CancellationToken cancellationToken = default); /// /// Get Shipment Rates Get Rates for the shipment information associated with the shipment ID @@ -131,7 +131,7 @@ public partial interface IShipEngine /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentRatesResponseBody) - Task ListShipmentRates(HttpClient methodClient, string shipmentId, DateTimeOffset createdAtStart, CancellationToken cancellationToken = default); + Task ListShipmentRates(HttpClient methodClient, string shipmentId, DateTimeOffset? createdAtStart, CancellationToken cancellationToken = default); /// /// List Shipments Get list of Shipments @@ -152,7 +152,7 @@ public partial interface IShipEngine /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentsResponseBody) - Task ListShipments(DateTimeOffset createdAtStart, DateTimeOffset createdAtEnd, DateTimeOffset modifiedAtStart, DateTimeOffset modifiedAtEnd, ShipmentStatus shipmentStatus, ShipmentsSortBy sortBy, SortDir sortDir, string batchId, string tag, string salesOrderId, int page, int pageSize, CancellationToken cancellationToken = default); + Task ListShipments(DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, DateTimeOffset? modifiedAtStart, DateTimeOffset? modifiedAtEnd, ShipmentStatus? shipmentStatus, ShipmentsSortBy? sortBy, SortDir? sortDir, string? batchId, string? tag, string? salesOrderId, int? page, int? pageSize, CancellationToken cancellationToken = default); /// /// List Shipments Get list of Shipments @@ -174,7 +174,7 @@ public partial interface IShipEngine /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentsResponseBody) - Task ListShipments(HttpClient methodClient, DateTimeOffset createdAtStart, DateTimeOffset createdAtEnd, DateTimeOffset modifiedAtStart, DateTimeOffset modifiedAtEnd, ShipmentStatus shipmentStatus, ShipmentsSortBy sortBy, SortDir sortDir, string batchId, string tag, string salesOrderId, int page, int pageSize, CancellationToken cancellationToken = default); + Task ListShipments(HttpClient methodClient, DateTimeOffset? createdAtStart, DateTimeOffset? createdAtEnd, DateTimeOffset? modifiedAtStart, DateTimeOffset? modifiedAtEnd, ShipmentStatus? shipmentStatus, ShipmentsSortBy? sortBy, SortDir? sortDir, string? batchId, string? tag, string? salesOrderId, int? page, int? pageSize, CancellationToken cancellationToken = default); /// /// Parse shipping info The shipment-recognition API makes it easy for you to extract shipping data from unstructured text, including people's names, addresses, package weights and dimensions, insurance and delivery requirements, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's shipment-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed shipment data is returned in the same structure that's used for other ShipEngine APIs, so you can easily use the parsed data to create a shipping label. > **Note:** Shipment recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland. @@ -348,7 +348,7 @@ public async Task CancelShipments(HttpClient methodClient, string shipme RequestOptions requestOptions = new("/v1/shipments/{shipment_id}/cancel"); - requestOptions.PathParameters.Add("shipment_id", ShipEngineSDK.ClientUtils.ParameterToString(shipmentId)); // path parameter + requestOptions.PathParameters.Add("shipment_id", ClientUtils.ParameterToString(shipmentId)); // path parameter requestOptions.Operation = "ShipmentsApi.CancelShipments"; @@ -432,7 +432,7 @@ public async Task GetShipmentByExternalId(H RequestOptions requestOptions = new("/v1/shipments/external_shipment_id/{external_shipment_id}"); - requestOptions.PathParameters.Add("external_shipment_id", ShipEngineSDK.ClientUtils.ParameterToString(externalShipmentId)); // path parameter + requestOptions.PathParameters.Add("external_shipment_id", ClientUtils.ParameterToString(externalShipmentId)); // path parameter requestOptions.Operation = "ShipmentsApi.GetShipmentByExternalId"; @@ -474,7 +474,7 @@ public async Task GetShipmentById(HttpClient method RequestOptions requestOptions = new("/v1/shipments/{shipment_id}"); - requestOptions.PathParameters.Add("shipment_id", ShipEngineSDK.ClientUtils.ParameterToString(shipmentId)); // path parameter + requestOptions.PathParameters.Add("shipment_id", ClientUtils.ParameterToString(shipmentId)); // path parameter requestOptions.Operation = "ShipmentsApi.GetShipmentById"; @@ -492,7 +492,7 @@ public async Task GetShipmentById(HttpClient method /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentRatesResponseBody) - public Task ListShipmentRates(string shipmentId, DateTimeOffset createdAtStart = default, CancellationToken cancellationToken = default) + public Task ListShipmentRates(string shipmentId, DateTimeOffset? createdAtStart = default, CancellationToken cancellationToken = default) { return ListShipmentRates(_client, shipmentId, createdAtStart, cancellationToken); } @@ -507,7 +507,7 @@ public Task ListShipmentRates(string shipmentId, /// Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentRatesResponseBody) - public async Task ListShipmentRates(HttpClient methodClient, string shipmentId, DateTimeOffset createdAtStart = default, CancellationToken cancellationToken = default) + public async Task ListShipmentRates(HttpClient methodClient, string shipmentId, DateTimeOffset? createdAtStart = default, CancellationToken cancellationToken = default) { // verify the required parameter 'shipmentId' is set if (shipmentId == null) @@ -518,10 +518,10 @@ public async Task ListShipmentRates(HttpClient me RequestOptions requestOptions = new("/v1/shipments/{shipment_id}/rates"); - requestOptions.PathParameters.Add("shipment_id", ShipEngineSDK.ClientUtils.ParameterToString(shipmentId)); // path parameter + requestOptions.PathParameters.Add("shipment_id", ClientUtils.ParameterToString(shipmentId)); // path parameter if (createdAtStart != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "created_at_start", createdAtStart)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "created_at_start", createdAtStart)); } requestOptions.Operation = "ShipmentsApi.ListShipmentRates"; @@ -550,7 +550,7 @@ public async Task ListShipmentRates(HttpClient me /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentsResponseBody) - public Task ListShipments(DateTimeOffset createdAtStart = default, DateTimeOffset createdAtEnd = default, DateTimeOffset modifiedAtStart = default, DateTimeOffset modifiedAtEnd = default, ShipmentStatus shipmentStatus = default, ShipmentsSortBy sortBy = default, SortDir sortDir = default, string batchId = default, string tag = default, string salesOrderId = default, int page = default, int pageSize = default, CancellationToken cancellationToken = default) + public Task ListShipments(DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, DateTimeOffset? modifiedAtStart = default, DateTimeOffset? modifiedAtEnd = default, ShipmentStatus? shipmentStatus = default, ShipmentsSortBy? sortBy = default, SortDir? sortDir = default, string? batchId = default, string? tag = default, string? salesOrderId = default, int? page = default, int? pageSize = default, CancellationToken cancellationToken = default) { return ListShipments(_client, createdAtStart, createdAtEnd, modifiedAtStart, modifiedAtEnd, shipmentStatus, sortBy, sortDir, batchId, tag, salesOrderId, page, pageSize, cancellationToken); } @@ -575,58 +575,58 @@ public Task ListShipments(DateTimeOffset createdAtSta /// The number of results to return per response. (optional, default to 25) /// Cancellation Token to cancel the request. /// Task of ApiResponse (ListShipmentsResponseBody) - public async Task ListShipments(HttpClient methodClient, DateTimeOffset createdAtStart = default, DateTimeOffset createdAtEnd = default, DateTimeOffset modifiedAtStart = default, DateTimeOffset modifiedAtEnd = default, ShipmentStatus shipmentStatus = default, ShipmentsSortBy sortBy = default, SortDir sortDir = default, string batchId = default, string tag = default, string salesOrderId = default, int page = default, int pageSize = default, CancellationToken cancellationToken = default) + public async Task ListShipments(HttpClient methodClient, DateTimeOffset? createdAtStart = default, DateTimeOffset? createdAtEnd = default, DateTimeOffset? modifiedAtStart = default, DateTimeOffset? modifiedAtEnd = default, ShipmentStatus? shipmentStatus = default, ShipmentsSortBy? sortBy = default, SortDir? sortDir = default, string? batchId = default, string? tag = default, string? salesOrderId = default, int? page = default, int? pageSize = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/shipments"); if (createdAtStart != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "created_at_start", createdAtStart)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "created_at_start", createdAtStart)); } if (createdAtEnd != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "created_at_end", createdAtEnd)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "created_at_end", createdAtEnd)); } if (modifiedAtStart != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "modified_at_start", modifiedAtStart)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "modified_at_start", modifiedAtStart)); } if (modifiedAtEnd != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "modified_at_end", modifiedAtEnd)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "modified_at_end", modifiedAtEnd)); } if (shipmentStatus != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "shipment_status", shipmentStatus)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "shipment_status", shipmentStatus)); } if (sortBy != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "sort_by", sortBy)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "sort_by", sortBy)); } if (sortDir != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "sort_dir", sortDir)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "sort_dir", sortDir)); } if (batchId != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "batch_id", batchId)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "batch_id", batchId)); } if (tag != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "tag", tag)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "tag", tag)); } if (salesOrderId != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "sales_order_id", salesOrderId)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "sales_order_id", salesOrderId)); } if (page != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page", page)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "page", page)); } if (pageSize != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "page_size", pageSize)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "page_size", pageSize)); } requestOptions.Operation = "ShipmentsApi.ListShipments"; @@ -711,7 +711,7 @@ public async Task ShipmentsListTags(HttpClient methodCl RequestOptions requestOptions = new("/v1/shipments/{shipment_id}/tags"); - requestOptions.PathParameters.Add("shipment_id", ShipEngineSDK.ClientUtils.ParameterToString(shipmentId)); // path parameter + requestOptions.PathParameters.Add("shipment_id", ClientUtils.ParameterToString(shipmentId)); // path parameter requestOptions.Operation = "ShipmentsApi.ShipmentsListTags"; @@ -803,8 +803,8 @@ public async Task TagShipment(HttpClient methodClient, RequestOptions requestOptions = new("/v1/shipments/{shipment_id}/tags/{tag_name}"); - requestOptions.PathParameters.Add("shipment_id", ShipEngineSDK.ClientUtils.ParameterToString(shipmentId)); // path parameter - requestOptions.PathParameters.Add("tag_name", ShipEngineSDK.ClientUtils.ParameterToString(tagName)); // path parameter + requestOptions.PathParameters.Add("shipment_id", ClientUtils.ParameterToString(shipmentId)); // path parameter + requestOptions.PathParameters.Add("tag_name", ClientUtils.ParameterToString(tagName)); // path parameter requestOptions.Operation = "ShipmentsApi.TagShipment"; @@ -854,8 +854,8 @@ public async Task UntagShipment(HttpClient methodClient, string shipment RequestOptions requestOptions = new("/v1/shipments/{shipment_id}/tags/{tag_name}"); - requestOptions.PathParameters.Add("shipment_id", ShipEngineSDK.ClientUtils.ParameterToString(shipmentId)); // path parameter - requestOptions.PathParameters.Add("tag_name", ShipEngineSDK.ClientUtils.ParameterToString(tagName)); // path parameter + requestOptions.PathParameters.Add("shipment_id", ClientUtils.ParameterToString(shipmentId)); // path parameter + requestOptions.PathParameters.Add("tag_name", ClientUtils.ParameterToString(tagName)); // path parameter requestOptions.Operation = "ShipmentsApi.UntagShipment"; @@ -905,7 +905,7 @@ public async Task UpdateShipment(HttpClient methodCl RequestOptions requestOptions = new("/v1/shipments/{shipment_id}"); - requestOptions.PathParameters.Add("shipment_id", ShipEngineSDK.ClientUtils.ParameterToString(shipmentId)); // path parameter + requestOptions.PathParameters.Add("shipment_id", ClientUtils.ParameterToString(shipmentId)); // path parameter requestOptions.Data = JsonSerializer.Serialize(updateShipmentRequestBody, JsonSerializerOptions); requestOptions.Operation = "ShipmentsApi.UpdateShipment"; diff --git a/ShipEngineSDK/Api/TagsApi.cs b/ShipEngineSDK/Api/TagsApi.cs index c1144fd7..84723269 100644 --- a/ShipEngineSDK/Api/TagsApi.cs +++ b/ShipEngineSDK/Api/TagsApi.cs @@ -150,7 +150,7 @@ public async Task CreateTag(HttpClient methodClient, stri RequestOptions requestOptions = new("/v1/tags/{tag_name}"); - requestOptions.PathParameters.Add("tag_name", ShipEngineSDK.ClientUtils.ParameterToString(tagName)); // path parameter + requestOptions.PathParameters.Add("tag_name", ClientUtils.ParameterToString(tagName)); // path parameter requestOptions.Operation = "TagsApi.CreateTag"; @@ -192,7 +192,7 @@ public async Task DeleteTag(HttpClient methodClient, string tagName, Can RequestOptions requestOptions = new("/v1/tags/{tag_name}"); - requestOptions.PathParameters.Add("tag_name", ShipEngineSDK.ClientUtils.ParameterToString(tagName)); // path parameter + requestOptions.PathParameters.Add("tag_name", ClientUtils.ParameterToString(tagName)); // path parameter requestOptions.Operation = "TagsApi.DeleteTag"; @@ -275,8 +275,8 @@ public async Task RenameTag(HttpClient methodClient, string tagName, str RequestOptions requestOptions = new("/v1/tags/{tag_name}/{new_tag_name}"); - requestOptions.PathParameters.Add("tag_name", ShipEngineSDK.ClientUtils.ParameterToString(tagName)); // path parameter - requestOptions.PathParameters.Add("new_tag_name", ShipEngineSDK.ClientUtils.ParameterToString(newTagName)); // path parameter + requestOptions.PathParameters.Add("tag_name", ClientUtils.ParameterToString(tagName)); // path parameter + requestOptions.PathParameters.Add("new_tag_name", ClientUtils.ParameterToString(newTagName)); // path parameter requestOptions.Operation = "TagsApi.RenameTag"; diff --git a/ShipEngineSDK/Api/TokensApi.cs b/ShipEngineSDK/Api/TokensApi.cs index 6edfdcd5..cbb276cf 100644 --- a/ShipEngineSDK/Api/TokensApi.cs +++ b/ShipEngineSDK/Api/TokensApi.cs @@ -34,7 +34,7 @@ public partial interface IShipEngine /// Include a redirect url to the application formatted with the ephemeral token. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (TokensGetEphemeralTokenResponseBodyYaml) - Task TokensGetEphemeralToken(Redirect redirect, CancellationToken cancellationToken = default); + Task TokensGetEphemeralToken(Redirect? redirect, CancellationToken cancellationToken = default); /// /// Get Ephemeral Token This endpoint returns a token that can be passed to an application for authorized access. The lifetime of this token is 10 seconds. @@ -45,7 +45,7 @@ public partial interface IShipEngine /// Include a redirect url to the application formatted with the ephemeral token. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (TokensGetEphemeralTokenResponseBodyYaml) - Task TokensGetEphemeralToken(HttpClient methodClient, Redirect redirect, CancellationToken cancellationToken = default); + Task TokensGetEphemeralToken(HttpClient methodClient, Redirect? redirect, CancellationToken cancellationToken = default); } @@ -62,7 +62,7 @@ public partial class ShipEngine /// Include a redirect url to the application formatted with the ephemeral token. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (TokensGetEphemeralTokenResponseBodyYaml) - public Task TokensGetEphemeralToken(Redirect redirect = default, CancellationToken cancellationToken = default) + public Task TokensGetEphemeralToken(Redirect? redirect = default, CancellationToken cancellationToken = default) { return TokensGetEphemeralToken(_client, redirect, cancellationToken); } @@ -76,14 +76,14 @@ public Task TokensGetEphemeralToken(Red /// Include a redirect url to the application formatted with the ephemeral token. (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (TokensGetEphemeralTokenResponseBodyYaml) - public async Task TokensGetEphemeralToken(HttpClient methodClient, Redirect redirect = default, CancellationToken cancellationToken = default) + public async Task TokensGetEphemeralToken(HttpClient methodClient, Redirect? redirect = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/tokens/ephemeral"); if (redirect != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "redirect", redirect)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "redirect", redirect)); } requestOptions.Operation = "TokensApi.TokensGetEphemeralToken"; diff --git a/ShipEngineSDK/Api/TrackingApi.cs b/ShipEngineSDK/Api/TrackingApi.cs index c3e211e4..bafaa75d 100644 --- a/ShipEngineSDK/Api/TrackingApi.cs +++ b/ShipEngineSDK/Api/TrackingApi.cs @@ -35,7 +35,7 @@ public partial interface IShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetTrackingLogResponseBody) - Task GetTrackingLog(string carrierCode, string trackingNumber, CancellationToken cancellationToken = default); + Task GetTrackingLog(string? carrierCode, string? trackingNumber, CancellationToken cancellationToken = default); /// /// Get Tracking Information Retrieve package tracking information @@ -47,7 +47,7 @@ public partial interface IShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetTrackingLogResponseBody) - Task GetTrackingLog(HttpClient methodClient, string carrierCode, string trackingNumber, CancellationToken cancellationToken = default); + Task GetTrackingLog(HttpClient methodClient, string? carrierCode, string? trackingNumber, CancellationToken cancellationToken = default); /// /// Start Tracking a Package Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package, and receive notifications via webhooks whenever the shipping status changes. @@ -58,7 +58,7 @@ public partial interface IShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task StartTracking(string carrierCode, string trackingNumber, CancellationToken cancellationToken = default); + Task StartTracking(string? carrierCode, string? trackingNumber, CancellationToken cancellationToken = default); /// /// Start Tracking a Package Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package, and receive notifications via webhooks whenever the shipping status changes. @@ -70,7 +70,7 @@ public partial interface IShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task StartTracking(HttpClient methodClient, string carrierCode, string trackingNumber, CancellationToken cancellationToken = default); + Task StartTracking(HttpClient methodClient, string? carrierCode, string? trackingNumber, CancellationToken cancellationToken = default); /// /// Stop Tracking a Package Unsubscribe from tracking updates for a package. @@ -81,7 +81,7 @@ public partial interface IShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task StopTracking(string carrierCode, string trackingNumber, CancellationToken cancellationToken = default); + Task StopTracking(string? carrierCode, string? trackingNumber, CancellationToken cancellationToken = default); /// /// Stop Tracking a Package Unsubscribe from tracking updates for a package. @@ -93,7 +93,7 @@ public partial interface IShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - Task StopTracking(HttpClient methodClient, string carrierCode, string trackingNumber, CancellationToken cancellationToken = default); + Task StopTracking(HttpClient methodClient, string? carrierCode, string? trackingNumber, CancellationToken cancellationToken = default); } @@ -111,7 +111,7 @@ public partial class ShipEngine /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetTrackingLogResponseBody) - public Task GetTrackingLog(string carrierCode = default, string trackingNumber = default, CancellationToken cancellationToken = default) + public Task GetTrackingLog(string? carrierCode = default, string? trackingNumber = default, CancellationToken cancellationToken = default) { return GetTrackingLog(_client, carrierCode, trackingNumber, cancellationToken); } @@ -126,18 +126,18 @@ public Task GetTrackingLog(string carrierCode = defa /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (GetTrackingLogResponseBody) - public async Task GetTrackingLog(HttpClient methodClient, string carrierCode = default, string trackingNumber = default, CancellationToken cancellationToken = default) + public async Task GetTrackingLog(HttpClient methodClient, string? carrierCode = default, string? trackingNumber = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/tracking"); if (carrierCode != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "carrier_code", carrierCode)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "carrier_code", carrierCode)); } if (trackingNumber != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "tracking_number", trackingNumber)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "tracking_number", trackingNumber)); } requestOptions.Operation = "TrackingApi.GetTrackingLog"; @@ -156,7 +156,7 @@ public async Task GetTrackingLog(HttpClient methodCl /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public Task StartTracking(string carrierCode = default, string trackingNumber = default, CancellationToken cancellationToken = default) + public Task StartTracking(string? carrierCode = default, string? trackingNumber = default, CancellationToken cancellationToken = default) { return StartTracking(_client, carrierCode, trackingNumber, cancellationToken); } @@ -171,18 +171,18 @@ public Task StartTracking(string carrierCode = default, string trackingN /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public async Task StartTracking(HttpClient methodClient, string carrierCode = default, string trackingNumber = default, CancellationToken cancellationToken = default) + public async Task StartTracking(HttpClient methodClient, string? carrierCode = default, string? trackingNumber = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/tracking/start"); if (carrierCode != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "carrier_code", carrierCode)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "carrier_code", carrierCode)); } if (trackingNumber != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "tracking_number", trackingNumber)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "tracking_number", trackingNumber)); } requestOptions.Operation = "TrackingApi.StartTracking"; @@ -201,7 +201,7 @@ public async Task StartTracking(HttpClient methodClient, string carrierC /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public Task StopTracking(string carrierCode = default, string trackingNumber = default, CancellationToken cancellationToken = default) + public Task StopTracking(string? carrierCode = default, string? trackingNumber = default, CancellationToken cancellationToken = default) { return StopTracking(_client, carrierCode, trackingNumber, cancellationToken); } @@ -216,18 +216,18 @@ public Task StopTracking(string carrierCode = default, string trackingNu /// The tracking number associated with a shipment (optional) /// Cancellation Token to cancel the request. /// Task of ApiResponse (string) - public async Task StopTracking(HttpClient methodClient, string carrierCode = default, string trackingNumber = default, CancellationToken cancellationToken = default) + public async Task StopTracking(HttpClient methodClient, string? carrierCode = default, string? trackingNumber = default, CancellationToken cancellationToken = default) { RequestOptions requestOptions = new("/v1/tracking/stop"); if (carrierCode != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "carrier_code", carrierCode)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "carrier_code", carrierCode)); } if (trackingNumber != null) { - requestOptions.QueryParameters.Add(ShipEngineSDK.ClientUtils.ParameterToMultiMap("", "tracking_number", trackingNumber)); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("", "tracking_number", trackingNumber)); } requestOptions.Operation = "TrackingApi.StopTracking"; diff --git a/ShipEngineSDK/Api/WarehousesApi.cs b/ShipEngineSDK/Api/WarehousesApi.cs index 0d669ceb..a9bbb6a6 100644 --- a/ShipEngineSDK/Api/WarehousesApi.cs +++ b/ShipEngineSDK/Api/WarehousesApi.cs @@ -236,7 +236,7 @@ public async Task DeleteWarehouse(HttpClient methodClient, string wareho RequestOptions requestOptions = new("/v1/warehouses/{warehouse_id}"); - requestOptions.PathParameters.Add("warehouse_id", ShipEngineSDK.ClientUtils.ParameterToString(warehouseId)); // path parameter + requestOptions.PathParameters.Add("warehouse_id", ClientUtils.ParameterToString(warehouseId)); // path parameter requestOptions.Operation = "WarehousesApi.DeleteWarehouse"; @@ -278,7 +278,7 @@ public async Task GetWarehouseById(HttpClient meth RequestOptions requestOptions = new("/v1/warehouses/{warehouse_id}"); - requestOptions.PathParameters.Add("warehouse_id", ShipEngineSDK.ClientUtils.ParameterToString(warehouseId)); // path parameter + requestOptions.PathParameters.Add("warehouse_id", ClientUtils.ParameterToString(warehouseId)); // path parameter requestOptions.Operation = "WarehousesApi.GetWarehouseById"; @@ -361,7 +361,7 @@ public async Task UpdateWarehouse(HttpClient methodClient, UpdateWarehou RequestOptions requestOptions = new("/v1/warehouses/{warehouse_id}"); - requestOptions.PathParameters.Add("warehouse_id", ShipEngineSDK.ClientUtils.ParameterToString(warehouseId)); // path parameter + requestOptions.PathParameters.Add("warehouse_id", ClientUtils.ParameterToString(warehouseId)); // path parameter requestOptions.Data = JsonSerializer.Serialize(updateWarehouseRequestBody, JsonSerializerOptions); requestOptions.Operation = "WarehousesApi.UpdateWarehouse"; @@ -412,7 +412,7 @@ public async Task UpdateWarehouseSettings(HttpClient methodClient, Updat RequestOptions requestOptions = new("/v1/warehouses/{warehouse_id}/settings"); - requestOptions.PathParameters.Add("warehouse_id", ShipEngineSDK.ClientUtils.ParameterToString(warehouseId)); // path parameter + requestOptions.PathParameters.Add("warehouse_id", ClientUtils.ParameterToString(warehouseId)); // path parameter requestOptions.Data = JsonSerializer.Serialize(updateWarehouseSettingsRequestBody, JsonSerializerOptions); requestOptions.Operation = "WarehousesApi.UpdateWarehouseSettings"; diff --git a/ShipEngineSDK/Api/WebhooksApi.cs b/ShipEngineSDK/Api/WebhooksApi.cs index e4c11726..c0d992f9 100644 --- a/ShipEngineSDK/Api/WebhooksApi.cs +++ b/ShipEngineSDK/Api/WebhooksApi.cs @@ -213,7 +213,7 @@ public async Task DeleteWebhook(HttpClient methodClient, string webhookI RequestOptions requestOptions = new("/v1/environment/webhooks/{webhook_id}"); - requestOptions.PathParameters.Add("webhook_id", ShipEngineSDK.ClientUtils.ParameterToString(webhookId)); // path parameter + requestOptions.PathParameters.Add("webhook_id", ClientUtils.ParameterToString(webhookId)); // path parameter requestOptions.Operation = "WebhooksApi.DeleteWebhook"; @@ -255,7 +255,7 @@ public async Task GetWebhookById(HttpClient methodCl RequestOptions requestOptions = new("/v1/environment/webhooks/{webhook_id}"); - requestOptions.PathParameters.Add("webhook_id", ShipEngineSDK.ClientUtils.ParameterToString(webhookId)); // path parameter + requestOptions.PathParameters.Add("webhook_id", ClientUtils.ParameterToString(webhookId)); // path parameter requestOptions.Operation = "WebhooksApi.GetWebhookById"; @@ -338,7 +338,7 @@ public async Task UpdateWebhook(HttpClient methodClient, UpdateWebhookRe RequestOptions requestOptions = new("/v1/environment/webhooks/{webhook_id}"); - requestOptions.PathParameters.Add("webhook_id", ShipEngineSDK.ClientUtils.ParameterToString(webhookId)); // path parameter + requestOptions.PathParameters.Add("webhook_id", ClientUtils.ParameterToString(webhookId)); // path parameter requestOptions.Data = JsonSerializer.Serialize(updateWebhookRequestBody, JsonSerializerOptions); requestOptions.Operation = "WebhooksApi.UpdateWebhook"; diff --git a/ShipEngineSDK/CompilerSupport/CompilerFeatureRequiredAttribute.cs b/ShipEngineSDK/CompilerSupport/CompilerFeatureRequiredAttribute.cs index 5a6e87af..d03294e4 100644 --- a/ShipEngineSDK/CompilerSupport/CompilerFeatureRequiredAttribute.cs +++ b/ShipEngineSDK/CompilerSupport/CompilerFeatureRequiredAttribute.cs @@ -6,6 +6,9 @@ namespace System.Runtime.CompilerServices; [AttributeUsage(AttributeTargets.All, AllowMultiple = true, Inherited = false)] public sealed class CompilerFeatureRequiredAttribute : Attribute { + /// + /// Constructor + /// public CompilerFeatureRequiredAttribute(string featureName) { FeatureName = featureName; diff --git a/ShipEngineSDK/Model/AccountSettingsImages.cs b/ShipEngineSDK/Model/AccountSettingsImages.cs index 028e7d3e..769d4b36 100644 --- a/ShipEngineSDK/Model/AccountSettingsImages.cs +++ b/ShipEngineSDK/Model/AccountSettingsImages.cs @@ -69,6 +69,9 @@ public ImageContentTypeEnum(string value) public static ImageContentTypeEnum Jpeg { get; } = new("image/jpeg"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } diff --git a/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs b/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs index 1c0cf78d..97e69404 100644 --- a/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs +++ b/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs @@ -259,7 +259,6 @@ public override void Write(Utf8JsonWriter writer, CompareBulkRatesRequestBody va throw new InvalidDataException("The JSON string `" + jsonDoc + "` cannot be deserialized into any schema defined."); } - if (match > 1) { throw new InvalidDataException("The JSON string `" + jsonDoc + "` incorrectly matches more than one schema (should be exactly one match): " + matchedTypes); diff --git a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs index f5b3c7d2..cc9e777a 100644 --- a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs @@ -69,6 +69,9 @@ public ImageContentTypeEnum(string value) public static ImageContentTypeEnum Jpeg { get; } = new("image/jpeg"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } diff --git a/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs b/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs index 0c0c5049..7d56506c 100644 --- a/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs +++ b/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs @@ -69,6 +69,9 @@ public ImageContentTypeEnum(string value) public static ImageContentTypeEnum Jpeg { get; } = new("image/jpeg"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } diff --git a/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs b/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs index e6f706a9..dace42f3 100644 --- a/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs +++ b/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs @@ -86,6 +86,9 @@ public FeaturesEnum(string value) public static FeaturesEnum AfterHoursDropbox { get; } = new("after_hours_dropbox"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } @@ -143,6 +146,9 @@ public TypeEnum(string value) public static TypeEnum Locker { get; } = new("locker"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } diff --git a/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs b/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs index 57a6a505..84369533 100644 --- a/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs +++ b/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs @@ -28,6 +28,9 @@ namespace ShipEngineSDK.Model; public partial class ListAccountImagesResponseBody { + /// + /// Type of data of the elements in the list + /// public class ListAccountImagesResponseBodyItem { /// @@ -38,7 +41,7 @@ public class ListAccountImagesResponseBodyItem /// img_DtBXupDBxREpHnwEXhTfgK /// [JsonPropertyName("label_image_id")] - public string LabelImageId { get; set; } + public string? LabelImageId { get; set; } /// /// A human readable name for the image. @@ -48,7 +51,7 @@ public class ListAccountImagesResponseBodyItem /// My logo /// [JsonPropertyName("name")] - public string Name { get; set; } + public string? Name { get; set; } /// /// Indicates whether this image is set as default. @@ -58,14 +61,14 @@ public class ListAccountImagesResponseBodyItem /// false /// [JsonPropertyName("is_default")] - public bool IsDefault { get; set; } + public bool? IsDefault { get; set; } /// /// The file type of the image. /// /// The file type of the image. [JsonPropertyName("image_content_type")] - public string ImageContentType { get; set; } + public string? ImageContentType { get; set; } /// /// A base64 encoded string representation of the image. @@ -75,7 +78,7 @@ public class ListAccountImagesResponseBodyItem /// iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg== /// [JsonPropertyName("image_data")] - public string ImageData { get; set; } + public string? ImageData { get; set; } /// /// The date and time that the image was created in ShipEngine. @@ -85,7 +88,7 @@ public class ListAccountImagesResponseBodyItem /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The date and time that the image was modified in ShipEngine. @@ -95,7 +98,7 @@ public class ListAccountImagesResponseBodyItem /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at")] - public DateTimeOffset ModifiedAt { get; set; } + public DateTimeOffset? ModifiedAt { get; set; } } /// diff --git a/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs b/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs index 921c2988..cfd6529c 100644 --- a/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs +++ b/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs @@ -28,6 +28,9 @@ namespace ShipEngineSDK.Model; public partial class ListAccountSettingsImagesResponseBody { + /// + /// Type of data of the elements in the list + /// public class ListAccountSettingsImagesResponseBodyItem { /// @@ -38,7 +41,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// img_DtBXupDBxREpHnwEXhTfgK /// [JsonPropertyName("label_image_id")] - public string LabelImageId { get; set; } + public string? LabelImageId { get; set; } /// /// A human readable name for the image. @@ -48,7 +51,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// My logo /// [JsonPropertyName("name")] - public string Name { get; set; } + public string? Name { get; set; } /// /// Indicates whether this image is set as default. @@ -58,14 +61,14 @@ public class ListAccountSettingsImagesResponseBodyItem /// false /// [JsonPropertyName("is_default")] - public bool IsDefault { get; set; } + public bool? IsDefault { get; set; } /// /// The file type of the image. /// /// The file type of the image. [JsonPropertyName("image_content_type")] - public string ImageContentType { get; set; } + public string? ImageContentType { get; set; } /// /// A base64 encoded string representation of the image. @@ -75,7 +78,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg== /// [JsonPropertyName("image_data")] - public string ImageData { get; set; } + public string? ImageData { get; set; } /// /// The date and time that the image was created in ShipEngine. @@ -85,7 +88,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The date and time that the image was modified in ShipEngine. @@ -95,7 +98,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at")] - public DateTimeOffset ModifiedAt { get; set; } + public DateTimeOffset? ModifiedAt { get; set; } } /// diff --git a/ShipEngineSDK/Model/ListLabelsResponseBody.cs b/ShipEngineSDK/Model/ListLabelsResponseBody.cs index 65e5eef6..1bb5a45f 100644 --- a/ShipEngineSDK/Model/ListLabelsResponseBody.cs +++ b/ShipEngineSDK/Model/ListLabelsResponseBody.cs @@ -28,6 +28,9 @@ namespace ShipEngineSDK.Model; public partial class ListLabelsResponseBody { + /// + /// Type of data of the elements in the list + /// public class ListLabelsResponseBodyItem { /// @@ -38,13 +41,13 @@ public class ListLabelsResponseBodyItem /// se-28529731 /// [JsonPropertyName("label_id")] - public string LabelId { get; set; } + public string? LabelId { get; set; } /// /// Gets or Sets Status /// [JsonPropertyName("status")] - public LabelStatus Status { get; set; } + public LabelStatus? Status { get; set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) @@ -54,14 +57,14 @@ public class ListLabelsResponseBodyItem /// se-28529731 /// [JsonPropertyName("shipment_id")] - public string ShipmentId { get; set; } + public string? ShipmentId { get; set; } /// /// The shipment information used to generate the label /// /// The shipment information used to generate the label [JsonPropertyName("shipment")] - public Shipment Shipment { get; set; } + public Shipment? Shipment { get; set; } /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -71,7 +74,7 @@ public class ListLabelsResponseBodyItem /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date")] - public DateTimeOffset ShipDate { get; set; } + public DateTimeOffset? ShipDate { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -81,28 +84,28 @@ public class ListLabelsResponseBodyItem /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at")] - public DateTimeOffset CreatedAt { get; set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. [JsonPropertyName("shipment_cost")] - public MonetaryValue ShipmentCost { get; set; } + public MonetaryValue? ShipmentCost { get; set; } /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. [JsonPropertyName("insurance_cost")] - public MonetaryValue InsuranceCost { get; set; } + public MonetaryValue? InsuranceCost { get; set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue RequestedComparisonAmount { get; set; } + public MonetaryValue? RequestedComparisonAmount { get; set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. @@ -112,14 +115,14 @@ public class ListLabelsResponseBodyItem /// 782758401696 /// [JsonPropertyName("tracking_number")] - public string TrackingNumber { get; set; } + public string? TrackingNumber { get; set; } /// /// 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")] - public bool IsReturnLabel { get; set; } + public bool? IsReturnLabel { get; set; } /// /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. @@ -133,7 +136,7 @@ public class ListLabelsResponseBodyItem /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. [JsonPropertyName("is_international")] - public bool IsInternational { get; set; } + public bool? IsInternational { get; set; } /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. @@ -143,7 +146,7 @@ public class ListLabelsResponseBodyItem /// se-28529731 /// [JsonPropertyName("batch_id")] - public string BatchId { get; set; } + public string? BatchId { get; set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label @@ -153,14 +156,14 @@ public class ListLabelsResponseBodyItem /// se-28529731 /// [JsonPropertyName("carrier_id")] - public string CarrierId { get; set; } + public string? CarrierId { get; set; } /// /// The label charge event. /// /// The label charge event. [JsonPropertyName("charge_event")] - public LabelChargeEvent ChargeEvent { get; set; } + public LabelChargeEvent? ChargeEvent { get; set; } /// /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. @@ -170,7 +173,7 @@ public class ListLabelsResponseBodyItem /// se-28529731 /// [JsonPropertyName("outbound_label_id")] - public string OutboundLabelId { get; set; } + public string? OutboundLabelId { get; set; } /// /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. @@ -180,7 +183,7 @@ public class ListLabelsResponseBodyItem /// usps_first_class_mail /// [JsonPropertyName("service_code")] - public string ServiceCode { get; set; } + public string? ServiceCode { get; set; } /// /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. @@ -188,7 +191,7 @@ public class ListLabelsResponseBodyItem /// 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")] [Obsolete] - public bool TestLabel { get; set; } + public bool? TestLabel { get; set; } /// /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. @@ -198,20 +201,20 @@ public class ListLabelsResponseBodyItem /// small_flat_rate_box /// [JsonPropertyName("package_code")] - public string PackageCode { get; set; } + public string? PackageCode { get; set; } /// /// Gets or Sets ValidateAddress /// [JsonPropertyName("validate_address")] - public ValidateAddress ValidateAddress { get; set; } + public ValidateAddress? ValidateAddress { get; set; } /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) [JsonPropertyName("voided")] - public bool Voided { get; set; } + public bool? Voided { get; set; } /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided @@ -227,35 +230,35 @@ public class ListLabelsResponseBodyItem /// Gets or Sets LabelDownloadType /// [JsonPropertyName("label_download_type")] - public LabelDownloadType LabelDownloadType { get; set; } + 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")] - public LabelFormat LabelFormat { get; set; } + public LabelFormat? LabelFormat { get; set; } /// /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. [JsonPropertyName("display_scheme")] - public DisplayScheme DisplayScheme { get; set; } + public DisplayScheme? DisplayScheme { 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")] - public LabelLayout LabelLayout { get; set; } + public LabelLayout? LabelLayout { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. [JsonPropertyName("trackable")] - public bool Trackable { get; set; } + public bool? Trackable { get; set; } /// /// The label image resource that was used to create a custom label image. @@ -275,20 +278,20 @@ public class ListLabelsResponseBodyItem /// dhl_express /// [JsonPropertyName("carrier_code")] - public string CarrierCode { get; set; } + public string? CarrierCode { get; set; } /// /// The current status of the package, such as `in_transit` or `delivered` /// /// The current status of the package, such as `in_transit` or `delivered` [JsonPropertyName("tracking_status")] - public TrackingStatus TrackingStatus { get; set; } + public TrackingStatus? TrackingStatus { get; set; } /// /// Gets or Sets LabelDownload /// [JsonPropertyName("label_download")] - public LabelDownload LabelDownload { get; set; } + public LabelDownload? LabelDownload { 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. @@ -316,7 +319,7 @@ public class ListLabelsResponseBodyItem /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. [JsonPropertyName("packages")] - public List Packages { get; set; } + public List? Packages { get; set; } /// /// Additional information some carriers may provide by which to identify a given label in their system. diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs index 8e17b6cb..f6f0b8d1 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs @@ -86,6 +86,9 @@ public FeaturesEnum(string value) public static FeaturesEnum AfterHoursDropbox { get; } = new("after_hours_dropbox"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } @@ -143,6 +146,9 @@ public TypeEnum(string value) public static TypeEnum Locker { get; } = new("locker"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } diff --git a/ShipEngineSDK/Model/PagedListResponseBody.cs b/ShipEngineSDK/Model/PagedListResponseBody.cs index 3a7c6529..8c2ec0fb 100644 --- a/ShipEngineSDK/Model/PagedListResponseBody.cs +++ b/ShipEngineSDK/Model/PagedListResponseBody.cs @@ -72,7 +72,7 @@ public partial class PagedListResponseBody /// Gets or Sets additional properties /// [JsonExtensionData] - public IDictionary AdditionalProperties { get; set; } + public IDictionary AdditionalProperties { get; set; } = new Dictionary(); /// diff --git a/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs b/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs index cfa6f194..6417d24a 100644 --- a/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs +++ b/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs @@ -63,6 +63,9 @@ public TypeEnum(string value) public static TypeEnum What3words { get; } = new("what3words"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } diff --git a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs index 2a0667cf..9d90dd87 100644 --- a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs @@ -69,6 +69,9 @@ public ImageContentTypeEnum(string value) public static ImageContentTypeEnum Jpeg { get; } = new("image/jpeg"); + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } diff --git a/ShipEngineSDK/PublicAPI.Unshipped.txt b/ShipEngineSDK/PublicAPI.Unshipped.txt index c5d7f171..3987b98d 100644 --- a/ShipEngineSDK/PublicAPI.Unshipped.txt +++ b/ShipEngineSDK/PublicAPI.Unshipped.txt @@ -443,283 +443,190 @@ ShipEngineSDK.Enums.ErrorType.BusinessRules = 3 -> ShipEngineSDK.Enums.ErrorType ShipEngineSDK.Enums.ErrorType.Security = 1 -> ShipEngineSDK.Enums.ErrorType ShipEngineSDK.Enums.ErrorType.System = 4 -> ShipEngineSDK.Enums.ErrorType ShipEngineSDK.Enums.ErrorType.Validation = 2 -> ShipEngineSDK.Enums.ErrorType -ShipEngineSDK.IShipEngine.AddFundsToCarrier(ShipEngineSDK.Config! methodConfig, string! carrierId, ShipEngineSDK.Model.AddFundsToCarrierRequestBody! addFundsToCarrierRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.AddFundsToCarrier(string! carrierId, ShipEngineSDK.Model.AddFundsToCarrierRequestBody! addFundsToCarrierRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.AddFundsToCarrier(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, ShipEngineSDK.Model.AddFundsToCarrierRequestBody! addFundsToCarrierRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.AddFundsToInsurance(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.AddFundsToInsuranceRequestBody! addFundsToInsuranceRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.AddFundsToInsurance(ShipEngineSDK.Model.AddFundsToInsuranceRequestBody! addFundsToInsuranceRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.AddFundsToInsurance(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.AddFundsToInsuranceRequestBody! addFundsToInsuranceRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.AddToBatch(ShipEngineSDK.Config! methodConfig, string! batchId, ShipEngineSDK.Model.AddToBatchRequestBody! addToBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.AddToBatch(string! batchId, ShipEngineSDK.Model.AddToBatchRequestBody! addToBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.AddToBatch(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, ShipEngineSDK.Model.AddToBatchRequestBody! addToBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.CalculateRates(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CalculateRatesRequestBody! calculateRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CalculateRates(ShipEngineSDK.Model.CalculateRatesRequestBody! calculateRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CalculateRates(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CalculateRatesRequestBody! calculateRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.CancelShipments(ShipEngineSDK.Config! methodConfig, string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CancelShipments(string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CancelShipments(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.CompareBulkRates(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CompareBulkRatesRequestBody! compareBulkRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! ShipEngineSDK.IShipEngine.CompareBulkRates(ShipEngineSDK.Model.CompareBulkRatesRequestBody! compareBulkRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! ShipEngineSDK.IShipEngine.CompareBulkRates(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CompareBulkRatesRequestBody! compareBulkRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! -ShipEngineSDK.IShipEngine.ConnectCarrier(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierName! carrierName, ShipEngineSDK.Model.ConnectCarrierRequestBody! connectCarrierRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ConnectCarrier(ShipEngineSDK.Model.CarrierName! carrierName, ShipEngineSDK.Model.ConnectCarrierRequestBody! connectCarrierRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ConnectCarrier(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierName! carrierName, ShipEngineSDK.Model.ConnectCarrierRequestBody! connectCarrierRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ConnectInsurer(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ConnectInsurerRequestBody! connectInsurerRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ConnectInsurer(ShipEngineSDK.Model.ConnectInsurerRequestBody! connectInsurerRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ConnectInsurer(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ConnectInsurerRequestBody! connectInsurerRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.CreateAccountImage(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateAccountSettingsImageRequestBody! createAccountSettingsImageRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateAccountImage(ShipEngineSDK.Model.CreateAccountSettingsImageRequestBody! createAccountSettingsImageRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateAccountImage(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateAccountSettingsImageRequestBody! createAccountSettingsImageRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.CreateBatch(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateBatchRequest! createBatchRequest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateBatch(ShipEngineSDK.Model.CreateBatchRequest! createBatchRequest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateBatch(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateBatchRequest! createBatchRequest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.CreateLabel(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateLabelRequestBody! createLabelRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateLabel(ShipEngineSDK.Model.CreateLabelRequestBody! createLabelRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateLabel(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateLabelRequestBody! createLabelRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.CreateLabelFromRate(ShipEngineSDK.Config! methodConfig, string! rateId, ShipEngineSDK.Model.CreateLabelFromRateRequestBody! createLabelFromRateRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateLabelFromRate(string! rateId, ShipEngineSDK.Model.CreateLabelFromRateRequestBody! createLabelFromRateRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateLabelFromRate(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! rateId, ShipEngineSDK.Model.CreateLabelFromRateRequestBody! createLabelFromRateRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.CreateLabelFromShipment(ShipEngineSDK.Config! methodConfig, string! shipmentId, ShipEngineSDK.Model.CreateLabelFromShipmentRequestBody! createLabelFromShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateLabelFromShipment(string! shipmentId, ShipEngineSDK.Model.CreateLabelFromShipmentRequestBody! createLabelFromShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateLabelFromShipment(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, ShipEngineSDK.Model.CreateLabelFromShipmentRequestBody! createLabelFromShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.CreateManifest(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateManifestRequestBody! createManifestRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateManifest(ShipEngineSDK.Model.CreateManifestRequestBody! createManifestRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateManifest(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateManifestRequestBody! createManifestRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.CreatePackageType(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreatePackageTypeRequestBody! createPackageTypeRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreatePackageType(ShipEngineSDK.Model.CreatePackageTypeRequestBody! createPackageTypeRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreatePackageType(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreatePackageTypeRequestBody! createPackageTypeRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.CreateReturnLabel(ShipEngineSDK.Config! methodConfig, string! labelId, ShipEngineSDK.Model.CreateReturnLabelRequestBody! createReturnLabelRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateReturnLabel(string! labelId, ShipEngineSDK.Model.CreateReturnLabelRequestBody! createReturnLabelRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateReturnLabel(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelId, ShipEngineSDK.Model.CreateReturnLabelRequestBody! createReturnLabelRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.CreateShipments(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateShipmentsRequestBody! createShipmentsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateShipments(ShipEngineSDK.Model.CreateShipmentsRequestBody! createShipmentsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateShipments(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateShipmentsRequestBody! createShipmentsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.CreateTag(ShipEngineSDK.Config! methodConfig, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateTag(string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateTag(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.CreateWarehouse(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateWarehouseRequestBody! createWarehouseRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateWarehouse(ShipEngineSDK.Model.CreateWarehouseRequestBody! createWarehouseRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateWarehouse(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateWarehouseRequestBody! createWarehouseRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.CreateWebhook(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateWebhookRequestBody! createWebhookRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateWebhook(ShipEngineSDK.Model.CreateWebhookRequestBody! createWebhookRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.CreateWebhook(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateWebhookRequestBody! createWebhookRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.DeleteAccountImageById(ShipEngineSDK.Config! methodConfig, string! labelImageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DeleteAccountImageById(string! labelImageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DeleteAccountImageById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelImageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.DeleteBatch(ShipEngineSDK.Config! methodConfig, string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DeleteBatch(string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DeleteBatch(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.DeletePackageType(ShipEngineSDK.Config! methodConfig, string! packageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DeletePackageType(string! packageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DeletePackageType(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! packageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.DeleteScheduledPickup(ShipEngineSDK.Config! methodConfig, string! pickupId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DeleteScheduledPickup(string! pickupId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DeleteScheduledPickup(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! pickupId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.DeleteTag(ShipEngineSDK.Config! methodConfig, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DeleteTag(string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DeleteTag(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.DeleteWarehouse(ShipEngineSDK.Config! methodConfig, string! warehouseId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DeleteWarehouse(string! warehouseId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DeleteWarehouse(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! warehouseId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.DeleteWebhook(ShipEngineSDK.Config! methodConfig, string! webhookId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DeleteWebhook(string! webhookId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DeleteWebhook(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! webhookId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.DisconnectCarrier(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierName! carrierName, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DisconnectCarrier(ShipEngineSDK.Model.CarrierName! carrierName, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DisconnectCarrier(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierName! carrierName, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.DisconnectCarrierById(ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DisconnectCarrierById(string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DisconnectCarrierById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.DisconnectInsurer(ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DisconnectInsurer(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DisconnectInsurer(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.DownloadFile(ShipEngineSDK.Config! methodConfig, string! subdir, string! filename, string! dir, string! download, int? rotation, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DownloadFile(string! subdir, string! filename, string! dir, string! download, int? rotation, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.DownloadFile(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! subdir, string! filename, string! dir, string! download, int? rotation, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.EstimateRates(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.EstimateRatesRequestBody! estimateRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! ShipEngineSDK.IShipEngine.EstimateRates(ShipEngineSDK.Model.EstimateRatesRequestBody! estimateRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! ShipEngineSDK.IShipEngine.EstimateRates(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.EstimateRatesRequestBody! estimateRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! -ShipEngineSDK.IShipEngine.GetAccountSettingsImagesById(ShipEngineSDK.Config! methodConfig, string! labelImageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetAccountSettingsImagesById(string! labelImageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetAccountSettingsImagesById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelImageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.GetBatchByExternalId(ShipEngineSDK.Config! methodConfig, string! externalBatchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetBatchByExternalId(string! externalBatchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetBatchByExternalId(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! externalBatchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.GetBatchById(ShipEngineSDK.Config! methodConfig, string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetBatchById(string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetBatchById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.GetCarrierById(ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetCarrierById(string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetCarrierById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.GetCarrierOptions(ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetCarrierOptions(string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetCarrierOptions(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.GetCarrierSettings(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierNameWithSettings! carrierName, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetCarrierSettings(ShipEngineSDK.Model.CarrierNameWithSettings! carrierName, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetCarrierSettings(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierNameWithSettings! carrierName, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.GetInsuranceBalance(ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetInsuranceBalance(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetInsuranceBalance(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.GetLabelByExternalShipmentId(ShipEngineSDK.Config! methodConfig, string! externalShipmentId, ShipEngineSDK.Model.LabelDownloadType? labelDownloadType, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetLabelByExternalShipmentId(string! externalShipmentId, ShipEngineSDK.Model.LabelDownloadType? labelDownloadType, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetLabelByExternalShipmentId(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! externalShipmentId, ShipEngineSDK.Model.LabelDownloadType? labelDownloadType, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.GetLabelById(ShipEngineSDK.Config! methodConfig, string! labelId, ShipEngineSDK.Model.LabelDownloadType? labelDownloadType, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetLabelById(string! labelId, ShipEngineSDK.Model.LabelDownloadType? labelDownloadType, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetLabelById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelId, ShipEngineSDK.Model.LabelDownloadType? labelDownloadType, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.GetManifestById(ShipEngineSDK.Config! methodConfig, string! manifestId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetManifestById(string! manifestId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetManifestById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! manifestId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.GetManifestRequestById(ShipEngineSDK.Config! methodConfig, string! manifestRequestId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetManifestRequestById(string! manifestRequestId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetManifestRequestById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! manifestRequestId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.GetPackageTypeById(ShipEngineSDK.Config! methodConfig, string! packageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetPackageTypeById(string! packageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetPackageTypeById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! packageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.GetPickupById(ShipEngineSDK.Config! methodConfig, string! pickupId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetPickupById(string! pickupId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetPickupById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! pickupId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.GetRateById(ShipEngineSDK.Config! methodConfig, string! rateId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetRateById(string! rateId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetRateById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! rateId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.GetShipmentByExternalId(ShipEngineSDK.Config! methodConfig, string! externalShipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetShipmentByExternalId(string! externalShipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetShipmentByExternalId(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! externalShipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.GetShipmentById(ShipEngineSDK.Config! methodConfig, string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetShipmentById(string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetShipmentById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.GetTrackingLog(ShipEngineSDK.Config! methodConfig, string! carrierCode, string! trackingNumber, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetTrackingLog(string! carrierCode, string! trackingNumber, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetTrackingLog(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierCode, string! trackingNumber, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.GetTrackingLogFromLabel(ShipEngineSDK.Config! methodConfig, string! labelId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetTrackingLogFromLabel(string! labelId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetTrackingLogFromLabel(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.GetWarehouseById(ShipEngineSDK.Config! methodConfig, string! warehouseId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetWarehouseById(string! warehouseId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetWarehouseById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! warehouseId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.GetWebhookById(ShipEngineSDK.Config! methodConfig, string! webhookId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetWebhookById(string! webhookId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.GetWebhookById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! webhookId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ListAccountImages(ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListAccountImages(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListAccountImages(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ListAccountSettings(ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListAccountSettings(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListAccountSettings(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ListBatchErrors(ShipEngineSDK.Config! methodConfig, string! batchId, int? page, int? pagesize, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListBatchErrors(string! batchId, int? page, int? pagesize, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListBatchErrors(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, int? page, int? pagesize, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ListBatches(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.BatchStatus? status, int? page, int? pageSize, ShipEngineSDK.Model.SortDir? sortDir, string! batchNumber, ShipEngineSDK.Model.BatchesSortBy? sortBy, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListBatches(ShipEngineSDK.Model.BatchStatus? status, int? page, int? pageSize, ShipEngineSDK.Model.SortDir? sortDir, string! batchNumber, ShipEngineSDK.Model.BatchesSortBy? sortBy, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListBatches(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.BatchStatus? status, int? page, int? pageSize, ShipEngineSDK.Model.SortDir? sortDir, string! batchNumber, ShipEngineSDK.Model.BatchesSortBy? sortBy, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ListCarrierPackageTypes(ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListCarrierPackageTypes(string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListCarrierPackageTypes(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ListCarriers(ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListCarriers(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListCarriers(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ListCarrierServices(ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListCarrierServices(string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListCarrierServices(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ListLabels(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.LabelStatus? labelStatus, string! serviceCode, string! carrierId, string! trackingNumber, string! batchId, string! rateId, string! shipmentId, string! warehouseId, System.DateTime? createdAtStart, System.DateTime? createdAtEnd, int? page, int? pageSize, ShipEngineSDK.Model.SortDir? sortDir, string! sortBy, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListLabels(ShipEngineSDK.Model.LabelStatus? labelStatus, string! serviceCode, string! carrierId, string! trackingNumber, string! batchId, string! rateId, string! shipmentId, string! warehouseId, System.DateTime? createdAtStart, System.DateTime? createdAtEnd, int? page, int? pageSize, ShipEngineSDK.Model.SortDir? sortDir, string! sortBy, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListLabels(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.LabelStatus? labelStatus, string! serviceCode, string! carrierId, string! trackingNumber, string! batchId, string! rateId, string! shipmentId, string! warehouseId, System.DateTime? createdAtStart, System.DateTime? createdAtEnd, int? page, int? pageSize, ShipEngineSDK.Model.SortDir? sortDir, string! sortBy, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ListManifests(ShipEngineSDK.Config! methodConfig, string! warehouseId, System.DateTime? shipDateStart, System.DateTime? shipDateEnd, System.DateTime? createdAtStart, System.DateTime? createdAtEnd, string! carrierId, int? page, int? pageSize, System.Collections.Generic.List! labelIds, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListManifests(string! warehouseId, System.DateTime? shipDateStart, System.DateTime? shipDateEnd, System.DateTime? createdAtStart, System.DateTime? createdAtEnd, string! carrierId, int? page, int? pageSize, System.Collections.Generic.List! labelIds, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListManifests(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! warehouseId, System.DateTime? shipDateStart, System.DateTime? shipDateEnd, System.DateTime? createdAtStart, System.DateTime? createdAtEnd, string! carrierId, int? page, int? pageSize, System.Collections.Generic.List! labelIds, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ListPackageTypes(ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListPackageTypes(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListPackageTypes(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ListScheduledPickups(ShipEngineSDK.Config! methodConfig, string! carrierId, string! warehouseId, System.DateTime? createdAtStart, System.DateTime? createdAtEnd, int? page, int? pageSize, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListScheduledPickups(string! carrierId, string! warehouseId, System.DateTime? createdAtStart, System.DateTime? createdAtEnd, int? page, int? pageSize, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListScheduledPickups(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, string! warehouseId, System.DateTime? createdAtStart, System.DateTime? createdAtEnd, int? page, int? pageSize, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ListShipmentRates(ShipEngineSDK.Config! methodConfig, string! shipmentId, System.DateTime? createdAtStart, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListShipmentRates(string! shipmentId, System.DateTime? createdAtStart, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListShipmentRates(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, System.DateTime? createdAtStart, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ListShipments(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ShipmentStatus? shipmentStatus, string! batchId, string! tag, System.DateTime? createdAtStart, System.DateTime? createdAtEnd, System.DateTime? modifiedAtStart, System.DateTime? modifiedAtEnd, int? page, int? pageSize, string! salesOrderId, ShipEngineSDK.Model.SortDir? sortDir, ShipEngineSDK.Model.ShipmentsSortBy? sortBy, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListShipments(ShipEngineSDK.Model.ShipmentStatus? shipmentStatus, string! batchId, string! tag, System.DateTime? createdAtStart, System.DateTime? createdAtEnd, System.DateTime? modifiedAtStart, System.DateTime? modifiedAtEnd, int? page, int? pageSize, string! salesOrderId, ShipEngineSDK.Model.SortDir? sortDir, ShipEngineSDK.Model.ShipmentsSortBy? sortBy, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListShipments(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ShipmentStatus? shipmentStatus, string! batchId, string! tag, System.DateTime? createdAtStart, System.DateTime? createdAtEnd, System.DateTime? modifiedAtStart, System.DateTime? modifiedAtEnd, int? page, int? pageSize, string! salesOrderId, ShipEngineSDK.Model.SortDir? sortDir, ShipEngineSDK.Model.ShipmentsSortBy? sortBy, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ListTags(ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListTags(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListTags(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ListWarehouses(ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListWarehouses(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ListWarehouses(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ListWebhooks(ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! ShipEngineSDK.IShipEngine.ListWebhooks(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! ShipEngineSDK.IShipEngine.ListWebhooks(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! -ShipEngineSDK.IShipEngine.ParseAddress(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ParseAddressRequestBody! parseAddressRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ParseAddress(ShipEngineSDK.Model.ParseAddressRequestBody! parseAddressRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ParseAddress(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ParseAddressRequestBody! parseAddressRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ParseShipment(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ParseShipmentRequestBody! parseShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ParseShipment(ShipEngineSDK.Model.ParseShipmentRequestBody! parseShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ParseShipment(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ParseShipmentRequestBody! parseShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ProcessBatch(ShipEngineSDK.Config! methodConfig, string! batchId, ShipEngineSDK.Model.ProcessBatchRequestBody! processBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ProcessBatch(string! batchId, ShipEngineSDK.Model.ProcessBatchRequestBody! processBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ProcessBatch(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, ShipEngineSDK.Model.ProcessBatchRequestBody! processBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.RemoveFromBatch(ShipEngineSDK.Config! methodConfig, string! batchId, ShipEngineSDK.Model.RemoveFromBatchRequestBody! removeFromBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.RemoveFromBatch(string! batchId, ShipEngineSDK.Model.RemoveFromBatchRequestBody! removeFromBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.RemoveFromBatch(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, ShipEngineSDK.Model.RemoveFromBatchRequestBody! removeFromBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.RenameTag(ShipEngineSDK.Config! methodConfig, string! tagName, string! newTagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.RenameTag(string! tagName, string! newTagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.RenameTag(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! tagName, string! newTagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.SchedulePickup(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.SchedulePickupRequestBody! schedulePickupRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.SchedulePickup(ShipEngineSDK.Model.SchedulePickupRequestBody! schedulePickupRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.SchedulePickup(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.SchedulePickupRequestBody! schedulePickupRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ServicePointsGetById(ShipEngineSDK.Config! methodConfig, string! carrierCode, string! countryCode, string! servicePointId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ServicePointsGetById(string! carrierCode, string! countryCode, string! servicePointId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ServicePointsGetById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierCode, string! countryCode, string! servicePointId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ServicePointsList(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.GetServicePointsRequest! getServicePointsRequest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ServicePointsList(ShipEngineSDK.Model.GetServicePointsRequest! getServicePointsRequest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ServicePointsList(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.GetServicePointsRequest! getServicePointsRequest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ShipmentsListTags(ShipEngineSDK.Config! methodConfig, string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ShipmentsListTags(string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ShipmentsListTags(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ShipmentsUpdateTags(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.UpdateShipmentsTagsRequestBody! updateShipmentsTagsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ShipmentsUpdateTags(ShipEngineSDK.Model.UpdateShipmentsTagsRequestBody! updateShipmentsTagsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.ShipmentsUpdateTags(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.UpdateShipmentsTagsRequestBody! updateShipmentsTagsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.StartTracking(ShipEngineSDK.Config! methodConfig, string! carrierCode, string! trackingNumber, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.StartTracking(string! carrierCode, string! trackingNumber, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.StartTracking(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierCode, string! trackingNumber, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.StopTracking(ShipEngineSDK.Config! methodConfig, string! carrierCode, string! trackingNumber, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.StopTracking(string! carrierCode, string! trackingNumber, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.StopTracking(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierCode, string! trackingNumber, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.TagShipment(ShipEngineSDK.Config! methodConfig, string! shipmentId, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.TagShipment(string! shipmentId, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.TagShipment(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.TokensGetEphemeralToken(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.Redirect? redirect, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.TokensGetEphemeralToken(ShipEngineSDK.Model.Redirect? redirect, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.TokensGetEphemeralToken(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.Redirect? redirect, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.UntagShipment(ShipEngineSDK.Config! methodConfig, string! shipmentId, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.UntagShipment(string! shipmentId, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.UntagShipment(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.UpdateAccountSettingsImagesById(ShipEngineSDK.Config! methodConfig, string! labelImageId, ShipEngineSDK.Model.UpdateAccountSettingsImageRequestBody! updateAccountSettingsImageRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.UpdateAccountSettingsImagesById(string! labelImageId, ShipEngineSDK.Model.UpdateAccountSettingsImageRequestBody! updateAccountSettingsImageRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.UpdateAccountSettingsImagesById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelImageId, ShipEngineSDK.Model.UpdateAccountSettingsImageRequestBody! updateAccountSettingsImageRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.UpdateBatch(ShipEngineSDK.Config! methodConfig, string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.UpdateBatch(string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.UpdateBatch(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.UpdateCarrierSettings(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierNameWithSettings! carrierName, string! carrierId, ShipEngineSDK.Model.UpdateCarrierSettingsRequestBody! updateCarrierSettingsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.UpdateCarrierSettings(ShipEngineSDK.Model.CarrierNameWithSettings! carrierName, string! carrierId, ShipEngineSDK.Model.UpdateCarrierSettingsRequestBody! updateCarrierSettingsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.UpdateCarrierSettings(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierNameWithSettings! carrierName, string! carrierId, ShipEngineSDK.Model.UpdateCarrierSettingsRequestBody! updateCarrierSettingsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.UpdatePackageType(ShipEngineSDK.Config! methodConfig, string! packageId, ShipEngineSDK.Model.UpdatePackageTypeRequestBody! updatePackageTypeRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.UpdatePackageType(string! packageId, ShipEngineSDK.Model.UpdatePackageTypeRequestBody! updatePackageTypeRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.UpdatePackageType(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! packageId, ShipEngineSDK.Model.UpdatePackageTypeRequestBody! updatePackageTypeRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.UpdateShipment(ShipEngineSDK.Config! methodConfig, string! shipmentId, ShipEngineSDK.Model.UpdateShipmentRequestBody! updateShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.UpdateShipment(string! shipmentId, ShipEngineSDK.Model.UpdateShipmentRequestBody! updateShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.UpdateShipment(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, ShipEngineSDK.Model.UpdateShipmentRequestBody! updateShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.UpdateWarehouse(ShipEngineSDK.Config! methodConfig, string! warehouseId, ShipEngineSDK.Model.UpdateWarehouseRequestBody! updateWarehouseRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.UpdateWarehouse(string! warehouseId, ShipEngineSDK.Model.UpdateWarehouseRequestBody! updateWarehouseRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.UpdateWarehouse(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! warehouseId, ShipEngineSDK.Model.UpdateWarehouseRequestBody! updateWarehouseRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.UpdateWarehouseSettings(ShipEngineSDK.Config! methodConfig, string! warehouseId, ShipEngineSDK.Model.UpdateWarehouseSettingsRequestBody! updateWarehouseSettingsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.UpdateWarehouseSettings(string! warehouseId, ShipEngineSDK.Model.UpdateWarehouseSettingsRequestBody! updateWarehouseSettingsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.UpdateWarehouseSettings(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! warehouseId, ShipEngineSDK.Model.UpdateWarehouseSettingsRequestBody! updateWarehouseSettingsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.UpdateWebhook(ShipEngineSDK.Config! methodConfig, string! webhookId, ShipEngineSDK.Model.UpdateWebhookRequestBody! updateWebhookRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.UpdateWebhook(string! webhookId, ShipEngineSDK.Model.UpdateWebhookRequestBody! updateWebhookRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.UpdateWebhook(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! webhookId, ShipEngineSDK.Model.UpdateWebhookRequestBody! updateWebhookRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.IShipEngine.ValidateAddress(ShipEngineSDK.Config! methodConfig, System.Collections.Generic.List! addressToValidate, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! ShipEngineSDK.IShipEngine.ValidateAddress(System.Collections.Generic.List! addressToValidate, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! ShipEngineSDK.IShipEngine.ValidateAddress(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Collections.Generic.List! addressToValidate, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! -ShipEngineSDK.IShipEngine.VoidLabel(ShipEngineSDK.Config! methodConfig, string! labelId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.VoidLabel(string! labelId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.VoidLabel(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.Model.AbstractOpenAPISchema @@ -5211,283 +5118,190 @@ ShipEngineSDK.RequestOptions.Operation.set -> void ShipEngineSDK.RequestOptions.PathParameters.get -> System.Collections.Generic.Dictionary! ShipEngineSDK.RequestOptions.QueryParameters.get -> ShipEngineSDK.Client.Multimap! ShipEngineSDK.RequestOptions.RequestOptions(string! path) -> void -ShipEngineSDK.ShipEngine.AddFundsToCarrier(ShipEngineSDK.Config! methodConfig, string! carrierId, ShipEngineSDK.Model.AddFundsToCarrierRequestBody! addFundsToCarrierRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.AddFundsToCarrier(string! carrierId, ShipEngineSDK.Model.AddFundsToCarrierRequestBody! addFundsToCarrierRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.AddFundsToCarrier(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, ShipEngineSDK.Model.AddFundsToCarrierRequestBody! addFundsToCarrierRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.AddFundsToInsurance(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.AddFundsToInsuranceRequestBody! addFundsToInsuranceRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.AddFundsToInsurance(ShipEngineSDK.Model.AddFundsToInsuranceRequestBody! addFundsToInsuranceRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.AddFundsToInsurance(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.AddFundsToInsuranceRequestBody! addFundsToInsuranceRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.AddToBatch(ShipEngineSDK.Config! methodConfig, string! batchId, ShipEngineSDK.Model.AddToBatchRequestBody! addToBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.AddToBatch(string! batchId, ShipEngineSDK.Model.AddToBatchRequestBody! addToBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.AddToBatch(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, ShipEngineSDK.Model.AddToBatchRequestBody! addToBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CalculateRates(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CalculateRatesRequestBody! calculateRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CalculateRates(ShipEngineSDK.Model.CalculateRatesRequestBody! calculateRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CalculateRates(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CalculateRatesRequestBody! calculateRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CancelShipments(ShipEngineSDK.Config! methodConfig, string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CancelShipments(string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CancelShipments(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CompareBulkRates(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CompareBulkRatesRequestBody! compareBulkRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! ShipEngineSDK.ShipEngine.CompareBulkRates(ShipEngineSDK.Model.CompareBulkRatesRequestBody! compareBulkRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! ShipEngineSDK.ShipEngine.CompareBulkRates(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CompareBulkRatesRequestBody! compareBulkRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! -ShipEngineSDK.ShipEngine.ConnectCarrier(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierName! carrierName, ShipEngineSDK.Model.ConnectCarrierRequestBody! connectCarrierRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ConnectCarrier(ShipEngineSDK.Model.CarrierName! carrierName, ShipEngineSDK.Model.ConnectCarrierRequestBody! connectCarrierRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ConnectCarrier(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierName! carrierName, ShipEngineSDK.Model.ConnectCarrierRequestBody! connectCarrierRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ConnectInsurer(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ConnectInsurerRequestBody! connectInsurerRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ConnectInsurer(ShipEngineSDK.Model.ConnectInsurerRequestBody! connectInsurerRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ConnectInsurer(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ConnectInsurerRequestBody! connectInsurerRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateAccountImage(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateAccountSettingsImageRequestBody! createAccountSettingsImageRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateAccountImage(ShipEngineSDK.Model.CreateAccountSettingsImageRequestBody! createAccountSettingsImageRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateAccountImage(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateAccountSettingsImageRequestBody! createAccountSettingsImageRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateBatch(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateBatchRequest! createBatchRequest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateBatch(ShipEngineSDK.Model.CreateBatchRequest! createBatchRequest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateBatch(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateBatchRequest! createBatchRequest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateLabel(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateLabelRequestBody! createLabelRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateLabel(ShipEngineSDK.Model.CreateLabelRequestBody! createLabelRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateLabel(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateLabelRequestBody! createLabelRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateLabelFromRate(ShipEngineSDK.Config! methodConfig, string! rateId, ShipEngineSDK.Model.CreateLabelFromRateRequestBody! createLabelFromRateRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateLabelFromRate(string! rateId, ShipEngineSDK.Model.CreateLabelFromRateRequestBody! createLabelFromRateRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateLabelFromRate(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! rateId, ShipEngineSDK.Model.CreateLabelFromRateRequestBody! createLabelFromRateRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateLabelFromShipment(ShipEngineSDK.Config! methodConfig, string! shipmentId, ShipEngineSDK.Model.CreateLabelFromShipmentRequestBody! createLabelFromShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateLabelFromShipment(string! shipmentId, ShipEngineSDK.Model.CreateLabelFromShipmentRequestBody! createLabelFromShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateLabelFromShipment(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, ShipEngineSDK.Model.CreateLabelFromShipmentRequestBody! createLabelFromShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateManifest(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateManifestRequestBody! createManifestRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateManifest(ShipEngineSDK.Model.CreateManifestRequestBody! createManifestRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateManifest(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateManifestRequestBody! createManifestRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreatePackageType(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreatePackageTypeRequestBody! createPackageTypeRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreatePackageType(ShipEngineSDK.Model.CreatePackageTypeRequestBody! createPackageTypeRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreatePackageType(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreatePackageTypeRequestBody! createPackageTypeRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateReturnLabel(ShipEngineSDK.Config! methodConfig, string! labelId, ShipEngineSDK.Model.CreateReturnLabelRequestBody! createReturnLabelRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateReturnLabel(string! labelId, ShipEngineSDK.Model.CreateReturnLabelRequestBody! createReturnLabelRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateReturnLabel(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelId, ShipEngineSDK.Model.CreateReturnLabelRequestBody! createReturnLabelRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateShipments(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateShipmentsRequestBody! createShipmentsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateShipments(ShipEngineSDK.Model.CreateShipmentsRequestBody! createShipmentsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateShipments(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateShipmentsRequestBody! createShipmentsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateTag(ShipEngineSDK.Config! methodConfig, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateTag(string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateTag(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateWarehouse(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateWarehouseRequestBody! createWarehouseRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateWarehouse(ShipEngineSDK.Model.CreateWarehouseRequestBody! createWarehouseRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateWarehouse(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateWarehouseRequestBody! createWarehouseRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateWebhook(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateWebhookRequestBody! createWebhookRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateWebhook(ShipEngineSDK.Model.CreateWebhookRequestBody! createWebhookRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.CreateWebhook(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateWebhookRequestBody! createWebhookRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeleteAccountImageById(ShipEngineSDK.Config! methodConfig, string! labelImageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DeleteAccountImageById(string! labelImageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DeleteAccountImageById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelImageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeleteBatch(ShipEngineSDK.Config! methodConfig, string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DeleteBatch(string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DeleteBatch(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeletePackageType(ShipEngineSDK.Config! methodConfig, string! packageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DeletePackageType(string! packageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DeletePackageType(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! packageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeleteScheduledPickup(ShipEngineSDK.Config! methodConfig, string! pickupId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DeleteScheduledPickup(string! pickupId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DeleteScheduledPickup(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! pickupId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeleteTag(ShipEngineSDK.Config! methodConfig, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DeleteTag(string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DeleteTag(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeleteWarehouse(ShipEngineSDK.Config! methodConfig, string! warehouseId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DeleteWarehouse(string! warehouseId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DeleteWarehouse(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! warehouseId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeleteWebhook(ShipEngineSDK.Config! methodConfig, string! webhookId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DeleteWebhook(string! webhookId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DeleteWebhook(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! webhookId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DisconnectCarrier(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierName! carrierName, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DisconnectCarrier(ShipEngineSDK.Model.CarrierName! carrierName, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DisconnectCarrier(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierName! carrierName, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DisconnectCarrierById(ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DisconnectCarrierById(string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DisconnectCarrierById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DisconnectInsurer(ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DisconnectInsurer(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DisconnectInsurer(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DownloadFile(ShipEngineSDK.Config! methodConfig, string! subdir, string! filename, string! dir, string! download = null, int? rotation = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DownloadFile(string! subdir, string! filename, string! dir, string! download = null, int? rotation = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.DownloadFile(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! subdir, string! filename, string! dir, string! download = null, int? rotation = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.EstimateRates(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.EstimateRatesRequestBody! estimateRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! ShipEngineSDK.ShipEngine.EstimateRates(ShipEngineSDK.Model.EstimateRatesRequestBody! estimateRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! ShipEngineSDK.ShipEngine.EstimateRates(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.EstimateRatesRequestBody! estimateRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! -ShipEngineSDK.ShipEngine.GetAccountSettingsImagesById(ShipEngineSDK.Config! methodConfig, string! labelImageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetAccountSettingsImagesById(string! labelImageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetAccountSettingsImagesById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelImageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetBatchByExternalId(ShipEngineSDK.Config! methodConfig, string! externalBatchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetBatchByExternalId(string! externalBatchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetBatchByExternalId(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! externalBatchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetBatchById(ShipEngineSDK.Config! methodConfig, string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetBatchById(string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetBatchById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetCarrierById(ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetCarrierById(string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetCarrierById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetCarrierOptions(ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetCarrierOptions(string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetCarrierOptions(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetCarrierSettings(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierNameWithSettings! carrierName, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetCarrierSettings(ShipEngineSDK.Model.CarrierNameWithSettings! carrierName, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetCarrierSettings(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierNameWithSettings! carrierName, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetInsuranceBalance(ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetInsuranceBalance(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetInsuranceBalance(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetLabelByExternalShipmentId(ShipEngineSDK.Config! methodConfig, string! externalShipmentId, ShipEngineSDK.Model.LabelDownloadType? labelDownloadType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetLabelByExternalShipmentId(string! externalShipmentId, ShipEngineSDK.Model.LabelDownloadType? labelDownloadType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetLabelByExternalShipmentId(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! externalShipmentId, ShipEngineSDK.Model.LabelDownloadType? labelDownloadType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetLabelById(ShipEngineSDK.Config! methodConfig, string! labelId, ShipEngineSDK.Model.LabelDownloadType? labelDownloadType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetLabelById(string! labelId, ShipEngineSDK.Model.LabelDownloadType? labelDownloadType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetLabelById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelId, ShipEngineSDK.Model.LabelDownloadType? labelDownloadType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetManifestById(ShipEngineSDK.Config! methodConfig, string! manifestId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetManifestById(string! manifestId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetManifestById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! manifestId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetManifestRequestById(ShipEngineSDK.Config! methodConfig, string! manifestRequestId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetManifestRequestById(string! manifestRequestId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetManifestRequestById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! manifestRequestId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetPackageTypeById(ShipEngineSDK.Config! methodConfig, string! packageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetPackageTypeById(string! packageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetPackageTypeById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! packageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetPickupById(ShipEngineSDK.Config! methodConfig, string! pickupId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetPickupById(string! pickupId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetPickupById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! pickupId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetRateById(ShipEngineSDK.Config! methodConfig, string! rateId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetRateById(string! rateId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetRateById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! rateId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetShipmentByExternalId(ShipEngineSDK.Config! methodConfig, string! externalShipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetShipmentByExternalId(string! externalShipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetShipmentByExternalId(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! externalShipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetShipmentById(ShipEngineSDK.Config! methodConfig, string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetShipmentById(string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetShipmentById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetTrackingLog(ShipEngineSDK.Config! methodConfig, string! carrierCode = null, string! trackingNumber = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetTrackingLog(string! carrierCode = null, string! trackingNumber = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetTrackingLog(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierCode = null, string! trackingNumber = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetTrackingLogFromLabel(ShipEngineSDK.Config! methodConfig, string! labelId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetTrackingLogFromLabel(string! labelId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetTrackingLogFromLabel(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetWarehouseById(ShipEngineSDK.Config! methodConfig, string! warehouseId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetWarehouseById(string! warehouseId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetWarehouseById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! warehouseId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetWebhookById(ShipEngineSDK.Config! methodConfig, string! webhookId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetWebhookById(string! webhookId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.GetWebhookById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! webhookId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListAccountImages(ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListAccountImages(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListAccountImages(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListAccountSettings(ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListAccountSettings(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListAccountSettings(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListBatchErrors(ShipEngineSDK.Config! methodConfig, string! batchId, int? page = null, int? pagesize = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListBatchErrors(string! batchId, int? page = null, int? pagesize = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListBatchErrors(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, int? page = null, int? pagesize = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListBatches(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.BatchStatus? status = null, int? page = null, int? pageSize = null, ShipEngineSDK.Model.SortDir? sortDir = null, string! batchNumber = null, ShipEngineSDK.Model.BatchesSortBy? sortBy = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListBatches(ShipEngineSDK.Model.BatchStatus? status = null, int? page = null, int? pageSize = null, ShipEngineSDK.Model.SortDir? sortDir = null, string! batchNumber = null, ShipEngineSDK.Model.BatchesSortBy? sortBy = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListBatches(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.BatchStatus? status = null, int? page = null, int? pageSize = null, ShipEngineSDK.Model.SortDir? sortDir = null, string! batchNumber = null, ShipEngineSDK.Model.BatchesSortBy? sortBy = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListCarrierPackageTypes(ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListCarrierPackageTypes(string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListCarrierPackageTypes(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListCarriers(ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListCarriers(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListCarriers(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListCarrierServices(ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListCarrierServices(string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListCarrierServices(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListLabels(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.LabelStatus? labelStatus = null, string! serviceCode = null, string! carrierId = null, string! trackingNumber = null, string! batchId = null, string! rateId = null, string! shipmentId = null, string! warehouseId = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, int? page = null, int? pageSize = null, ShipEngineSDK.Model.SortDir? sortDir = null, string! sortBy = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListLabels(ShipEngineSDK.Model.LabelStatus? labelStatus = null, string! serviceCode = null, string! carrierId = null, string! trackingNumber = null, string! batchId = null, string! rateId = null, string! shipmentId = null, string! warehouseId = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, int? page = null, int? pageSize = null, ShipEngineSDK.Model.SortDir? sortDir = null, string! sortBy = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListLabels(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.LabelStatus? labelStatus = null, string! serviceCode = null, string! carrierId = null, string! trackingNumber = null, string! batchId = null, string! rateId = null, string! shipmentId = null, string! warehouseId = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, int? page = null, int? pageSize = null, ShipEngineSDK.Model.SortDir? sortDir = null, string! sortBy = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListManifests(ShipEngineSDK.Config! methodConfig, string! warehouseId = null, System.DateTime? shipDateStart = null, System.DateTime? shipDateEnd = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, string! carrierId = null, int? page = null, int? pageSize = null, System.Collections.Generic.List! labelIds = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListManifests(string! warehouseId = null, System.DateTime? shipDateStart = null, System.DateTime? shipDateEnd = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, string! carrierId = null, int? page = null, int? pageSize = null, System.Collections.Generic.List! labelIds = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListManifests(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! warehouseId = null, System.DateTime? shipDateStart = null, System.DateTime? shipDateEnd = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, string! carrierId = null, int? page = null, int? pageSize = null, System.Collections.Generic.List! labelIds = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListPackageTypes(ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListPackageTypes(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListPackageTypes(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListScheduledPickups(ShipEngineSDK.Config! methodConfig, string! carrierId = null, string! warehouseId = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, int? page = null, int? pageSize = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListScheduledPickups(string! carrierId = null, string! warehouseId = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, int? page = null, int? pageSize = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListScheduledPickups(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId = null, string! warehouseId = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, int? page = null, int? pageSize = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListShipmentRates(ShipEngineSDK.Config! methodConfig, string! shipmentId, System.DateTime? createdAtStart = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListShipmentRates(string! shipmentId, System.DateTime? createdAtStart = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListShipmentRates(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, System.DateTime? createdAtStart = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListShipments(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ShipmentStatus? shipmentStatus = null, string! batchId = null, string! tag = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, System.DateTime? modifiedAtStart = null, System.DateTime? modifiedAtEnd = null, int? page = null, int? pageSize = null, string! salesOrderId = null, ShipEngineSDK.Model.SortDir? sortDir = null, ShipEngineSDK.Model.ShipmentsSortBy? sortBy = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListShipments(ShipEngineSDK.Model.ShipmentStatus? shipmentStatus = null, string! batchId = null, string! tag = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, System.DateTime? modifiedAtStart = null, System.DateTime? modifiedAtEnd = null, int? page = null, int? pageSize = null, string! salesOrderId = null, ShipEngineSDK.Model.SortDir? sortDir = null, ShipEngineSDK.Model.ShipmentsSortBy? sortBy = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListShipments(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ShipmentStatus? shipmentStatus = null, string! batchId = null, string! tag = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, System.DateTime? modifiedAtStart = null, System.DateTime? modifiedAtEnd = null, int? page = null, int? pageSize = null, string! salesOrderId = null, ShipEngineSDK.Model.SortDir? sortDir = null, ShipEngineSDK.Model.ShipmentsSortBy? sortBy = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListTags(ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListTags(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListTags(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListWarehouses(ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListWarehouses(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ListWarehouses(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListWebhooks(ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! ShipEngineSDK.ShipEngine.ListWebhooks(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! ShipEngineSDK.ShipEngine.ListWebhooks(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! -ShipEngineSDK.ShipEngine.ParseAddress(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ParseAddressRequestBody! parseAddressRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ParseAddress(ShipEngineSDK.Model.ParseAddressRequestBody! parseAddressRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ParseAddress(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ParseAddressRequestBody! parseAddressRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ParseShipment(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ParseShipmentRequestBody! parseShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ParseShipment(ShipEngineSDK.Model.ParseShipmentRequestBody! parseShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ParseShipment(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ParseShipmentRequestBody! parseShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ProcessBatch(ShipEngineSDK.Config! methodConfig, string! batchId, ShipEngineSDK.Model.ProcessBatchRequestBody! processBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ProcessBatch(string! batchId, ShipEngineSDK.Model.ProcessBatchRequestBody! processBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ProcessBatch(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, ShipEngineSDK.Model.ProcessBatchRequestBody! processBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.RemoveFromBatch(ShipEngineSDK.Config! methodConfig, string! batchId, ShipEngineSDK.Model.RemoveFromBatchRequestBody! removeFromBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.RemoveFromBatch(string! batchId, ShipEngineSDK.Model.RemoveFromBatchRequestBody! removeFromBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.RemoveFromBatch(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, ShipEngineSDK.Model.RemoveFromBatchRequestBody! removeFromBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.RenameTag(ShipEngineSDK.Config! methodConfig, string! tagName, string! newTagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.RenameTag(string! tagName, string! newTagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.RenameTag(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! tagName, string! newTagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.SchedulePickup(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.SchedulePickupRequestBody! schedulePickupRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.SchedulePickup(ShipEngineSDK.Model.SchedulePickupRequestBody! schedulePickupRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.SchedulePickup(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.SchedulePickupRequestBody! schedulePickupRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ServicePointsGetById(ShipEngineSDK.Config! methodConfig, string! carrierCode, string! countryCode, string! servicePointId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ServicePointsGetById(string! carrierCode, string! countryCode, string! servicePointId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ServicePointsGetById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierCode, string! countryCode, string! servicePointId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ServicePointsList(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.GetServicePointsRequest! getServicePointsRequest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ServicePointsList(ShipEngineSDK.Model.GetServicePointsRequest! getServicePointsRequest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ServicePointsList(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.GetServicePointsRequest! getServicePointsRequest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ShipmentsListTags(ShipEngineSDK.Config! methodConfig, string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ShipmentsListTags(string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ShipmentsListTags(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ShipmentsUpdateTags(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.UpdateShipmentsTagsRequestBody! updateShipmentsTagsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ShipmentsUpdateTags(ShipEngineSDK.Model.UpdateShipmentsTagsRequestBody! updateShipmentsTagsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.ShipmentsUpdateTags(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.UpdateShipmentsTagsRequestBody! updateShipmentsTagsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.StartTracking(ShipEngineSDK.Config! methodConfig, string! carrierCode = null, string! trackingNumber = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.StartTracking(string! carrierCode = null, string! trackingNumber = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.StartTracking(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierCode = null, string! trackingNumber = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.StopTracking(ShipEngineSDK.Config! methodConfig, string! carrierCode = null, string! trackingNumber = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.StopTracking(string! carrierCode = null, string! trackingNumber = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.StopTracking(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierCode = null, string! trackingNumber = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.TagShipment(ShipEngineSDK.Config! methodConfig, string! shipmentId, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.TagShipment(string! shipmentId, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.TagShipment(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.TokensGetEphemeralToken(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.Redirect? redirect = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.TokensGetEphemeralToken(ShipEngineSDK.Model.Redirect? redirect = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.TokensGetEphemeralToken(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.Redirect? redirect = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UntagShipment(ShipEngineSDK.Config! methodConfig, string! shipmentId, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.UntagShipment(string! shipmentId, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.UntagShipment(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateAccountSettingsImagesById(ShipEngineSDK.Config! methodConfig, string! labelImageId, ShipEngineSDK.Model.UpdateAccountSettingsImageRequestBody! updateAccountSettingsImageRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.UpdateAccountSettingsImagesById(string! labelImageId, ShipEngineSDK.Model.UpdateAccountSettingsImageRequestBody! updateAccountSettingsImageRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.UpdateAccountSettingsImagesById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelImageId, ShipEngineSDK.Model.UpdateAccountSettingsImageRequestBody! updateAccountSettingsImageRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateBatch(ShipEngineSDK.Config! methodConfig, string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.UpdateBatch(string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.UpdateBatch(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateCarrierSettings(ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierNameWithSettings! carrierName, string! carrierId, ShipEngineSDK.Model.UpdateCarrierSettingsRequestBody! updateCarrierSettingsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.UpdateCarrierSettings(ShipEngineSDK.Model.CarrierNameWithSettings! carrierName, string! carrierId, ShipEngineSDK.Model.UpdateCarrierSettingsRequestBody! updateCarrierSettingsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.UpdateCarrierSettings(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierNameWithSettings! carrierName, string! carrierId, ShipEngineSDK.Model.UpdateCarrierSettingsRequestBody! updateCarrierSettingsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdatePackageType(ShipEngineSDK.Config! methodConfig, string! packageId, ShipEngineSDK.Model.UpdatePackageTypeRequestBody! updatePackageTypeRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.UpdatePackageType(string! packageId, ShipEngineSDK.Model.UpdatePackageTypeRequestBody! updatePackageTypeRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.UpdatePackageType(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! packageId, ShipEngineSDK.Model.UpdatePackageTypeRequestBody! updatePackageTypeRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateShipment(ShipEngineSDK.Config! methodConfig, string! shipmentId, ShipEngineSDK.Model.UpdateShipmentRequestBody! updateShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.UpdateShipment(string! shipmentId, ShipEngineSDK.Model.UpdateShipmentRequestBody! updateShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.UpdateShipment(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, ShipEngineSDK.Model.UpdateShipmentRequestBody! updateShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateWarehouse(ShipEngineSDK.Config! methodConfig, string! warehouseId, ShipEngineSDK.Model.UpdateWarehouseRequestBody! updateWarehouseRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.UpdateWarehouse(string! warehouseId, ShipEngineSDK.Model.UpdateWarehouseRequestBody! updateWarehouseRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.UpdateWarehouse(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! warehouseId, ShipEngineSDK.Model.UpdateWarehouseRequestBody! updateWarehouseRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateWarehouseSettings(ShipEngineSDK.Config! methodConfig, string! warehouseId, ShipEngineSDK.Model.UpdateWarehouseSettingsRequestBody! updateWarehouseSettingsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.UpdateWarehouseSettings(string! warehouseId, ShipEngineSDK.Model.UpdateWarehouseSettingsRequestBody! updateWarehouseSettingsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.UpdateWarehouseSettings(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! warehouseId, ShipEngineSDK.Model.UpdateWarehouseSettingsRequestBody! updateWarehouseSettingsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateWebhook(ShipEngineSDK.Config! methodConfig, string! webhookId, ShipEngineSDK.Model.UpdateWebhookRequestBody! updateWebhookRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.UpdateWebhook(string! webhookId, ShipEngineSDK.Model.UpdateWebhookRequestBody! updateWebhookRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.UpdateWebhook(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! webhookId, ShipEngineSDK.Model.UpdateWebhookRequestBody! updateWebhookRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ValidateAddress(ShipEngineSDK.Config! methodConfig, System.Collections.Generic.List! addressToValidate, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! ShipEngineSDK.ShipEngine.ValidateAddress(System.Collections.Generic.List! addressToValidate, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! ShipEngineSDK.ShipEngine.ValidateAddress(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Collections.Generic.List! addressToValidate, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! -ShipEngineSDK.ShipEngine.VoidLabel(ShipEngineSDK.Config! methodConfig, string! labelId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.VoidLabel(string! labelId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngine.VoidLabel(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.ShipEngineException.ErrorCode.get -> ShipEngineSDK.Enums.ErrorCode diff --git a/generation/templates/api.mustache b/generation/templates/api.mustache index a4ab4edd..5403fd35 100644 --- a/generation/templates/api.mustache +++ b/generation/templates/api.mustache @@ -37,7 +37,7 @@ namespace {{packageName}}; {{#isDeprecated}} [Obsolete] {{/isDeprecated}} - Task<{{{returnType}}}{{^returnType}}Object{{/returnType}}> {{operationId}}({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}CancellationToken cancellationToken = default); + Task<{{{returnType}}}{{^returnType}}Object{{/returnType}}> {{operationId}}({{#allParams}}{{{dataType}}}{{^required}}?{{/required}} {{paramName}}, {{/allParams}}CancellationToken cancellationToken = default); /// /// {{summary}} {{notes}} @@ -53,7 +53,7 @@ namespace {{packageName}}; {{#isDeprecated}} [Obsolete] {{/isDeprecated}} - Task<{{{returnType}}}{{^returnType}}Object{{/returnType}}> {{operationId}}(HttpClient methodClient, {{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}CancellationToken cancellationToken = default); + Task<{{{returnType}}}{{^returnType}}Object{{/returnType}}> {{operationId}}(HttpClient methodClient, {{#allParams}}{{{dataType}}}{{^required}}?{{/required}} {{paramName}}, {{/allParams}}CancellationToken cancellationToken = default); {{/operation}} } @@ -77,7 +77,7 @@ namespace {{packageName}}; {{#isDeprecated}} [Obsolete] {{/isDeprecated}} - public Task<{{{returnType}}}{{^returnType}}Object{{/returnType}}> {{operationId}}({{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = default{{/optionalMethodArgument}}{{/required}}, {{/allParams}}CancellationToken cancellationToken = default) + public Task<{{{returnType}}}{{^returnType}}Object{{/returnType}}> {{operationId}}({{#allParams}}{{{dataType}}}{{^required}}?{{/required}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = default{{/optionalMethodArgument}}{{/required}}, {{/allParams}}CancellationToken cancellationToken = default) { return {{operationId}}(_client, {{#allParams}}{{paramName}}, {{/allParams}}cancellationToken); } @@ -96,7 +96,7 @@ namespace {{packageName}}; {{#isDeprecated}} [Obsolete] {{/isDeprecated}} - public async Task<{{{returnType}}}{{^returnType}}Object{{/returnType}}> {{operationId}}(HttpClient methodClient, {{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = default{{/optionalMethodArgument}}{{/required}}, {{/allParams}}CancellationToken cancellationToken = default) + public async Task<{{{returnType}}}{{^returnType}}Object{{/returnType}}> {{operationId}}(HttpClient methodClient, {{#allParams}}{{{dataType}}}{{^required}}?{{/required}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = default{{/optionalMethodArgument}}{{/required}}, {{/allParams}}CancellationToken cancellationToken = default) { {{#allParams}} {{#required}} @@ -116,38 +116,38 @@ namespace {{packageName}}; {{#constantParams}} {{#isPathParam}} // Set client side default value of Path Param "{{baseName}}". - requestOptions.PathParameters.Add("{{baseName}}", {{packageName}}.ClientUtils.ParameterToString({{#_enum}}"{{{.}}}"{{/_enum}})); // Constant path parameter + requestOptions.PathParameters.Add("{{baseName}}", ClientUtils.ParameterToString({{#_enum}}"{{{.}}}"{{/_enum}})); // Constant path parameter {{/isPathParam}} {{/constantParams}} {{#pathParams}} {{#required}} - requestOptions.PathParameters.Add("{{baseName}}", {{packageName}}.ClientUtils.ParameterToString({{paramName}})); // path parameter + requestOptions.PathParameters.Add("{{baseName}}", ClientUtils.ParameterToString({{paramName}})); // path parameter {{/required}} {{^required}} if ({{paramName}} != null) { - requestOptions.PathParameters.Add("{{baseName}}", {{packageName}}.ClientUtils.ParameterToString({{paramName}})); // path parameter + requestOptions.PathParameters.Add("{{baseName}}", ClientUtils.ParameterToString({{paramName}})); // path parameter } {{/required}} {{/pathParams}} {{#constantParams}} {{#isQueryParam}} // Set client side default value of Query Param "{{baseName}}". - requestOptions.QueryParameters.Add("{{baseName}}", {{packageName}}.ClientUtils.ParameterToString({{#_enum}}"{{{.}}}"{{/_enum}})); // Constant query parameter + requestOptions.QueryParameters.Add("{{baseName}}", ClientUtils.ParameterToString({{#_enum}}"{{{.}}}"{{/_enum}})); // Constant query parameter {{/isQueryParam}} {{/constantParams}} {{#queryParams}} {{#required}} {{#isDeepObject}} {{#items.vars}} - requestOptions.QueryParameters.Add({{packageName}}.ClientUtils.ParameterToMultiMap("{{collectionFormat}}", "{{baseName}}", {{paramName}}.{{name}})); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("{{collectionFormat}}", "{{baseName}}", {{paramName}}.{{name}})); {{/items.vars}} {{^items}} - requestOptions.QueryParameters.Add({{packageName}}.ClientUtils.ParameterToMultiMap("deepObject", "{{baseName}}", {{paramName}})); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("deepObject", "{{baseName}}", {{paramName}})); {{/items}} {{/isDeepObject}} {{^isDeepObject}} - requestOptions.QueryParameters.Add({{packageName}}.ClientUtils.ParameterToMultiMap("{{collectionFormat}}", "{{baseName}}", {{paramName}})); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("{{collectionFormat}}", "{{baseName}}", {{paramName}})); {{/isDeepObject}} {{/required}} {{^required}} @@ -157,15 +157,15 @@ namespace {{packageName}}; {{#items.vars}} if ({{paramName}}.{{name}} != null) { - requestOptions.QueryParameters.Add({{packageName}}.ClientUtils.ParameterToMultiMap("{{collectionFormat}}", "{{paramName}}[{{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}}]", {{paramName}}.{{name}})); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("{{collectionFormat}}", "{{paramName}}[{{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}}]", {{paramName}}.{{name}})); } {{/items.vars}} {{^items}} - requestOptions.QueryParameters.Add({{packageName}}.ClientUtils.ParameterToMultiMap("deepObject", "{{baseName}}", {{paramName}})); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("deepObject", "{{baseName}}", {{paramName}})); {{/items}} {{/isDeepObject}} {{^isDeepObject}} - requestOptions.QueryParameters.Add({{packageName}}.ClientUtils.ParameterToMultiMap("{{collectionFormat}}", "{{baseName}}", {{paramName}})); + requestOptions.QueryParameters.Add(ClientUtils.ParameterToMultiMap("{{collectionFormat}}", "{{baseName}}", {{paramName}})); {{/isDeepObject}} } {{/required}} @@ -173,17 +173,17 @@ namespace {{packageName}}; {{#constantParams}} {{#isHeaderParam}} // Set client side default value of Header Param "{{baseName}}". - requestOptions.HeaderParameters.Add("{{baseName}}", {{packageName}}.ClientUtils.ParameterToString({{#_enum}}"{{{.}}}"{{/_enum}})); // Constant header parameter + requestOptions.HeaderParameters.Add("{{baseName}}", ClientUtils.ParameterToString({{#_enum}}"{{{.}}}"{{/_enum}})); // Constant header parameter {{/isHeaderParam}} {{/constantParams}} {{#headerParams}} {{#required}} - requestOptions.HeaderParameters.Add("{{baseName}}", {{packageName}}.ClientUtils.ParameterToString({{paramName}})); // header parameter + requestOptions.HeaderParameters.Add("{{baseName}}", ClientUtils.ParameterToString({{paramName}})); // header parameter {{/required}} {{^required}} if ({{paramName}} != null) { - requestOptions.HeaderParameters.Add("{{baseName}}", {{packageName}}.ClientUtils.ParameterToString({{paramName}})); // header parameter + requestOptions.HeaderParameters.Add("{{baseName}}", ClientUtils.ParameterToString({{paramName}})); // header parameter } {{/required}} {{/headerParams}} @@ -205,7 +205,7 @@ namespace {{packageName}}; {{/isArray}} {{/isFile}} {{^isFile}} - requestOptions.FormParameters.Add("{{baseName}}", {{packageName}}.ClientUtils.{{#isPrimitiveType}}ParameterToString{{/isPrimitiveType}}{{^isPrimitiveType}}Serialize{{/isPrimitiveType}}({{paramName}})); // form parameter + requestOptions.FormParameters.Add("{{baseName}}", ClientUtils.{{#isPrimitiveType}}ParameterToString{{/isPrimitiveType}}{{^isPrimitiveType}}Serialize{{/isPrimitiveType}}({{paramName}})); // form parameter {{/isFile}} {{/required}} {{^required}} @@ -227,7 +227,7 @@ namespace {{packageName}}; {{/isArray}} {{/isFile}} {{^isFile}} - requestOptions.FormParameters.Add("{{baseName}}", {{packageName}}.ClientUtils.{{#isPrimitiveType}}ParameterToString{{/isPrimitiveType}}{{^isPrimitiveType}}Serialize{{/isPrimitiveType}}({{paramName}})); // form parameter + requestOptions.FormParameters.Add("{{baseName}}", ClientUtils.{{#isPrimitiveType}}ParameterToString{{/isPrimitiveType}}{{^isPrimitiveType}}Serialize{{/isPrimitiveType}}({{paramName}})); // form parameter {{/isFile}} } {{/required}} diff --git a/generation/templates/modelGeneric.mustache b/generation/templates/modelGeneric.mustache index 78223a1f..3994c613 100644 --- a/generation/templates/modelGeneric.mustache +++ b/generation/templates/modelGeneric.mustache @@ -59,6 +59,9 @@ {{^isEnum}} {{#items.vars}} {{#-first}} + /// + /// Type of data of the elements in the list + /// public class {{classname}}Item { {{/-first}} @@ -79,7 +82,7 @@ {{#deprecated}} [Obsolete] {{/deprecated}} - public{{#required}} required{{/required}} {{{dataType}}}{{#isNullable}}?{{/isNullable}} {{name}} { get; set; } + public{{#required}} required{{/required}} {{{dataType}}}{{^required}}?{{/required}} {{name}} { get; set; } {{#-last}} } @@ -112,7 +115,7 @@ /// Gets or Sets additional properties /// [JsonExtensionData] - public IDictionary AdditionalProperties { get; set; } + public IDictionary AdditionalProperties { get; set; } = new Dictionary(); {{/isAdditionalPropertiesTrue}} diff --git a/generation/templates/modelInnerEnum.mustache b/generation/templates/modelInnerEnum.mustache index 03b785de..951d919e 100644 --- a/generation/templates/modelInnerEnum.mustache +++ b/generation/templates/modelInnerEnum.mustache @@ -50,6 +50,9 @@ {{/enumVars}} {{/allowableValues}} + /// + /// Get a string representation of the current value + /// public override string ToString() => _value; } diff --git a/generation/templates/modelOneOf.mustache b/generation/templates/modelOneOf.mustache index aa6fdcb0..2e4ea0f7 100644 --- a/generation/templates/modelOneOf.mustache +++ b/generation/templates/modelOneOf.mustache @@ -81,7 +81,7 @@ /// Gets or Sets additional properties /// [JsonExtensionData] - public IDictionary AdditionalProperties { get; set; } + public IDictionary AdditionalProperties { get; set; } = new Dictionary(); {{/isAdditionalPropertiesTrue}} From db1765246b2e582d5b0527b32c73d9b4508c4f88 Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Wed, 17 Jul 2024 10:31:40 -0500 Subject: [PATCH 09/42] Remove blank line --- ShipEngineSDK/Model/CalculateRatesRequestBody.cs | 1 - ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs | 1 - ShipEngineSDK/Model/ConnectCarrierRequestBody.cs | 1 - ShipEngineSDK/Model/CreateBatchRequest.cs | 1 - ShipEngineSDK/Model/CreateManifestRequestBody.cs | 1 - ShipEngineSDK/Model/EstimateRatesRequestBody.cs | 1 - ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs | 1 - ShipEngineSDK/Model/GetServicePointsRequest.cs | 1 - ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs | 1 - generation/templates/modelOneOf.mustache | 1 - 10 files changed, 10 deletions(-) diff --git a/ShipEngineSDK/Model/CalculateRatesRequestBody.cs b/ShipEngineSDK/Model/CalculateRatesRequestBody.cs index ef5f9fb0..20bb603b 100644 --- a/ShipEngineSDK/Model/CalculateRatesRequestBody.cs +++ b/ShipEngineSDK/Model/CalculateRatesRequestBody.cs @@ -119,7 +119,6 @@ public override string ToString() var sb = new StringBuilder(); sb.Append("class CalculateRatesRequestBody {\n"); sb.Append(" ActualInstance: ").Append(this.ActualInstance).Append("\n"); - sb.Append(" RateOptions: ").Append(this.RateOptions).Append("\n"); sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs b/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs index 97e69404..3c788337 100644 --- a/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs +++ b/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs @@ -120,7 +120,6 @@ public override string ToString() var sb = new StringBuilder(); sb.Append("class CompareBulkRatesRequestBody {\n"); sb.Append(" ActualInstance: ").Append(this.ActualInstance).Append("\n"); - sb.Append(" RateOptions: ").Append(this.RateOptions).Append("\n"); sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs b/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs index 093fd961..3cd52b83 100644 --- a/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs @@ -761,7 +761,6 @@ public override string ToString() var sb = new StringBuilder(); sb.Append("class ConnectCarrierRequestBody {\n"); sb.Append(" ActualInstance: ").Append(this.ActualInstance).Append("\n"); - sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateBatchRequest.cs b/ShipEngineSDK/Model/CreateBatchRequest.cs index bba2d398..6ab9d8de 100644 --- a/ShipEngineSDK/Model/CreateBatchRequest.cs +++ b/ShipEngineSDK/Model/CreateBatchRequest.cs @@ -111,7 +111,6 @@ public override string ToString() var sb = new StringBuilder(); sb.Append("class CreateBatchRequest {\n"); sb.Append(" ActualInstance: ").Append(this.ActualInstance).Append("\n"); - sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/CreateManifestRequestBody.cs b/ShipEngineSDK/Model/CreateManifestRequestBody.cs index 389d2d7e..135e33ab 100644 --- a/ShipEngineSDK/Model/CreateManifestRequestBody.cs +++ b/ShipEngineSDK/Model/CreateManifestRequestBody.cs @@ -111,7 +111,6 @@ public override string ToString() var sb = new StringBuilder(); sb.Append("class CreateManifestRequestBody {\n"); sb.Append(" ActualInstance: ").Append(this.ActualInstance).Append("\n"); - sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/EstimateRatesRequestBody.cs b/ShipEngineSDK/Model/EstimateRatesRequestBody.cs index 017a042d..08a769ec 100644 --- a/ShipEngineSDK/Model/EstimateRatesRequestBody.cs +++ b/ShipEngineSDK/Model/EstimateRatesRequestBody.cs @@ -236,7 +236,6 @@ public override string ToString() var sb = new StringBuilder(); sb.Append("class EstimateRatesRequestBody {\n"); sb.Append(" ActualInstance: ").Append(this.ActualInstance).Append("\n"); - sb.Append(" FromCityLocality: ").Append(this.FromCityLocality).Append("\n"); sb.Append(" FromCountryCode: ").Append(this.FromCountryCode).Append("\n"); sb.Append(" FromPostalCode: ").Append(this.FromPostalCode).Append("\n"); diff --git a/ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs b/ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs index b1a8666c..96e89bb5 100644 --- a/ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs @@ -136,7 +136,6 @@ public override string ToString() var sb = new StringBuilder(); sb.Append("class GetCarrierSettingsResponseBody {\n"); sb.Append(" ActualInstance: ").Append(this.ActualInstance).Append("\n"); - sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/GetServicePointsRequest.cs b/ShipEngineSDK/Model/GetServicePointsRequest.cs index 557907f7..5fbb6462 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequest.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequest.cs @@ -86,7 +86,6 @@ public override string ToString() var sb = new StringBuilder(); sb.Append("class GetServicePointsRequest {\n"); sb.Append(" ActualInstance: ").Append(this.ActualInstance).Append("\n"); - sb.Append("}\n"); return sb.ToString(); } diff --git a/ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs index 03e6687c..014abebc 100644 --- a/ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs @@ -186,7 +186,6 @@ public override string ToString() var sb = new StringBuilder(); sb.Append("class UpdateCarrierSettingsRequestBody {\n"); sb.Append(" ActualInstance: ").Append(this.ActualInstance).Append("\n"); - sb.Append("}\n"); return sb.ToString(); } diff --git a/generation/templates/modelOneOf.mustache b/generation/templates/modelOneOf.mustache index 2e4ea0f7..2580a153 100644 --- a/generation/templates/modelOneOf.mustache +++ b/generation/templates/modelOneOf.mustache @@ -165,7 +165,6 @@ var sb = new StringBuilder(); sb.Append("class {{classname}} {\n"); sb.Append(" ActualInstance: ").Append(this.ActualInstance).Append("\n"); - {{#composedSchemas.allOf}} {{#allVars}} sb.Append(" {{name}}: ").Append(this.{{name}}).Append("\n"); From 730bb774be8cf8877c87d7566488896757a9d7f6 Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Wed, 17 Jul 2024 15:21:24 -0500 Subject: [PATCH 10/42] Don't require readonly properties --- ShipEngineSDK.Test/SerializationTests.cs | 260 ++++++++++++++++++ ShipEngineSDK/Model/AccountSettings.cs | 5 +- ShipEngineSDK/Model/AccountSettingsImages.cs | 23 +- .../Model/AddFundsToCarrierRequestBody.cs | 6 +- .../Model/AddFundsToCarrierResponseBody.cs | 5 +- .../Model/AddFundsToInsuranceRequestBody.cs | 6 +- .../Model/AddFundsToInsuranceResponseBody.cs | 6 +- ShipEngineSDK/Model/AddToBatchRequestBody.cs | 4 +- ShipEngineSDK/Model/Address.cs | 37 +-- .../Model/AddressResidentialIndicator.cs | 8 +- ShipEngineSDK/Model/AddressToValidate.cs | 31 +-- .../Model/AddressValidatingShipment.cs | 88 +++--- ShipEngineSDK/Model/AddressValidationCode.cs | 8 +- .../Model/AddressValidationDetailCode.cs | 8 +- .../Model/AddressValidationMessageType.cs | 8 +- .../Model/AddressValidationResult.cs | 21 +- .../Model/AddressValidationStatus.cs | 8 +- .../Model/AdvancedShipmentOptions.cs | 52 ++-- ...cedShipmentOptionsDangerousGoodsContact.cs | 4 +- .../AdvancedShipmentOptionsFedexFreight.cs | 4 +- ShipEngineSDK/Model/AllowedIncoterms.cs | 8 +- ShipEngineSDK/Model/AlternativeIdentifier.cs | 4 +- ShipEngineSDK/Model/AlternativeIdentifiers.cs | 4 +- .../Model/AncillaryServiceEndorsement.cs | 8 +- ShipEngineSDK/Model/Batch.cs | 110 +++----- ShipEngineSDK/Model/BatchResponseError.cs | 12 +- ShipEngineSDK/Model/BatchStatus.cs | 8 +- ShipEngineSDK/Model/BatchesSortBy.cs | 8 +- ShipEngineSDK/Model/BillToParty.cs | 8 +- ShipEngineSDK/Model/BulkRate.cs | 28 +- .../Model/CalculateRatesRequestBody.cs | 2 +- .../Model/CalculateRatesResponseBody.cs | 98 +++---- ShipEngineSDK/Model/Carrier.cs | 56 ++-- ShipEngineSDK/Model/CarrierAdvancedOption.cs | 12 +- ShipEngineSDK/Model/CarrierName.cs | 8 +- .../Model/CarrierNameWithSettings.cs | 8 +- ShipEngineSDK/Model/CollectOnDelivery.cs | 7 +- .../Model/CollectOnDeliveryPaymentType.cs | 8 +- .../Model/CompareBulkRatesRequestBody.cs | 3 +- .../ConnectAccessWorldwideRequestBody.cs | 9 +- .../ConnectAmazonBuyShippingRequestBody.cs | 12 +- .../Model/ConnectAmazonShippingUk.cs | 6 +- ShipEngineSDK/Model/ConnectApcRequestBody.cs | 9 +- .../Model/ConnectAsendiaRequestBody.cs | 12 +- .../Model/ConnectAustraliaPostRequestBody.cs | 12 +- .../Model/ConnectCanadaPostRequestBody.cs | 15 +- .../Model/ConnectCarrierResponseBody.cs | 3 +- .../Model/ConnectDhlEcommerceRequestBody.cs | 42 ++- .../Model/ConnectDhlExpressAuRequestBody.cs | 6 +- .../Model/ConnectDhlExpressCaRequestBody.cs | 6 +- .../Model/ConnectDhlExpressRequestBody.cs | 12 +- .../Model/ConnectDhlExpressUkRequestBody.cs | 12 +- ShipEngineSDK/Model/ConnectDpdRequestBody.cs | 9 +- .../Model/ConnectEndiciaRequestBody.cs | 9 +- .../Model/ConnectFedexRequestBody.cs | 42 +-- .../Model/ConnectFedexUkRequestBody.cs | 42 +-- .../Model/ConnectFirstmileRequestBody.cs | 11 +- ShipEngineSDK/Model/ConnectImexRequestBody.cs | 9 +- .../Model/ConnectInsurerRequestBody.cs | 6 +- .../Model/ConnectLasershipRequestBody.cs | 62 ++--- .../Model/ConnectNewgisticsRequestBody.cs | 10 +- .../Model/ConnectOntracRequestBody.cs | 9 +- .../Model/ConnectPurolatorRequestBody.cs | 9 +- .../Model/ConnectRoyalMailRequestBody.cs | 29 +- .../Model/ConnectRrDonnelleyRequestBody.cs | 9 +- ShipEngineSDK/Model/ConnectSekoRequestBody.cs | 6 +- .../Model/ConnectSendleRequestBody.cs | 9 +- .../Model/ConnectStampsRequestBody.cs | 9 +- ShipEngineSDK/Model/ConnectUpsRequestBody.cs | 6 +- ShipEngineSDK/Model/ContactDetails.cs | 9 +- .../CreateAccountSettingsImageRequestBody.cs | 28 +- .../Model/CreateAndProcessBatchRequestBody.cs | 10 +- ...AndProcessBatchRequestBodyProcessLabels.cs | 19 +- .../Model/CreateAndValidateShipment.cs | 85 +++--- ShipEngineSDK/Model/CreateBatchRequestBody.cs | 8 +- .../Model/CreateBatchResponseBody.cs | 110 +++----- .../Model/CreateLabelFromRateRequestBody.cs | 25 +- .../Model/CreateLabelFromRateResponseBody.cs | 153 ++++++----- .../CreateLabelFromShipmentRequestBody.cs | 25 +- .../CreateLabelFromShipmentResponseBody.cs | 153 ++++++----- ShipEngineSDK/Model/CreateLabelRequestBody.cs | 158 ++++++----- .../Model/CreateLabelResponseBody.cs | 191 ++++++------- .../CreateManifestByObjectRequestBody.cs | 13 +- .../CreateManifestLabelIdsRequestBody.cs | 3 +- .../Model/CreateManifestResponseBody.cs | 55 ++-- .../Model/CreatePackageTypeRequestBody.cs | 12 +- .../Model/CreatePackageTypeResponseBody.cs | 12 +- .../Model/CreateReturnLabelRequestBody.cs | 27 +- .../Model/CreateReturnLabelResponseBody.cs | 153 ++++++----- .../Model/CreateShipmentResponseBodyFields.cs | 7 +- .../Model/CreateShipmentsRequestBody.cs | 3 +- .../Model/CreateShipmentsResponseBody.cs | 6 +- ShipEngineSDK/Model/CreateTagResponseBody.cs | 3 +- .../Model/CreateWarehouseRequestBody.cs | 18 +- .../Model/CreateWarehouseResponseBody.cs | 21 +- .../Model/CreateWebhookRequestBody.cs | 13 +- .../Model/CreateWebhookResponseBody.cs | 18 +- ShipEngineSDK/Model/CustomsItem.cs | 25 +- ShipEngineSDK/Model/DangerousAmount.cs | 4 +- ShipEngineSDK/Model/DangerousGoods.cs | 50 ++-- ShipEngineSDK/Model/DefaultLabelLayout.cs | 8 +- .../Model/DeletePickupByIdResponseBody.cs | 11 +- .../DeleteScheduledPickupResponseBody.cs | 3 +- ShipEngineSDK/Model/DeliveryConfirmation.cs | 8 +- ShipEngineSDK/Model/DeprecatedManifest.cs | 34 +-- .../Model/DhlExpressAccountSettings.cs | 6 +- .../Model/DhlExpressSettingsResponseBody.cs | 6 +- ShipEngineSDK/Model/DimensionUnit.cs | 8 +- ShipEngineSDK/Model/Dimensions.cs | 17 +- ShipEngineSDK/Model/DisplayScheme.cs | 8 +- ShipEngineSDK/Model/Error.cs | 29 +- ShipEngineSDK/Model/ErrorCode.cs | 8 +- ShipEngineSDK/Model/ErrorResponseBody.cs | 8 +- ShipEngineSDK/Model/ErrorSource.cs | 8 +- ShipEngineSDK/Model/ErrorType.cs | 8 +- .../Model/ErrorWithLabelIdResponseBody.cs | 8 +- .../Model/EstimateRatesRequestBody.cs | 36 +-- ShipEngineSDK/Model/FedexAccountSettings.cs | 23 +- .../Model/FedexAccountSettingsRequestBody.cs | 23 +- ShipEngineSDK/Model/FedexPickupType.cs | 8 +- .../Model/FedexSettingsResponseBody.cs | 23 +- .../GetAccountSettingsImagesResponseBody.cs | 23 +- .../Model/GetAccountSettingsResponseBody.cs | 5 +- .../Model/GetBatchByExternalIdResponseBody.cs | 110 +++----- .../Model/GetBatchByIdResponseBody.cs | 110 +++----- .../Model/GetCarrierByIdResponseBody.cs | 56 ++-- .../Model/GetCarrierOptionsResponseBody.cs | 4 +- .../Model/GetCarriersResponseBody.cs | 13 +- .../Model/GetInsuranceBalanceResponseBody.cs | 6 +- ...etLabelByExternalShipmentIdResponseBody.cs | 153 ++++++----- .../Model/GetLabelByIdResponseBody.cs | 153 ++++++----- .../Model/GetManifestByIdResponseBody.cs | 50 ++-- .../Model/GetPackageTypeByIdResponseBody.cs | 12 +- .../Model/GetPickupByIdResponseBody.cs | 57 ++-- ShipEngineSDK/Model/GetPickupsResponseBody.cs | 31 +-- .../Model/GetRateByIdResponseBody.cs | 130 ++++----- .../Model/GetServicePointByIdResponseBody.cs | 2 +- ...ervicePointByIdResponseBodyServicePoint.cs | 33 +-- .../Model/GetServicePointsRequestBody.cs | 17 +- .../GetServicePointsRequestBodyAddress.cs | 15 +- ...tServicePointsRequestBodyProvidersInner.cs | 4 +- .../GetServicePointsRequestBodyShipment.cs | 2 +- .../GetShipmentByExternalIdResponseBody.cs | 100 +++---- .../Model/GetShipmentByIdResponseBody.cs | 100 +++---- .../GetTrackingLogFromLabelResponseBody.cs | 52 ++-- .../Model/GetTrackingLogResponseBody.cs | 56 ++-- .../Model/GetWarehouseByIdResponseBody.cs | 21 +- .../Model/GetWebhookByIdResponseBody.cs | 18 +- ShipEngineSDK/Model/IdentifierType.cs | 8 +- ShipEngineSDK/Model/ImporterOfRecords.cs | 27 +- ShipEngineSDK/Model/InsuranceProvider.cs | 8 +- .../Model/InternationalShipmentOptions.cs | 32 +-- .../Model/InvoiceAdditionalDetails.cs | 10 +- ShipEngineSDK/Model/Label.cs | 153 ++++++----- ShipEngineSDK/Model/LabelChargeEvent.cs | 8 +- ShipEngineSDK/Model/LabelDownload.cs | 8 +- ShipEngineSDK/Model/LabelDownloadType.cs | 8 +- ShipEngineSDK/Model/LabelFormat.cs | 8 +- ShipEngineSDK/Model/LabelLayout.cs | 8 +- ShipEngineSDK/Model/LabelMessages.cs | 9 +- ShipEngineSDK/Model/LabelPackagesInner.cs | 43 ++- ShipEngineSDK/Model/LabelStatus.cs | 8 +- ShipEngineSDK/Model/Link.cs | 5 +- .../Model/ListAccountImagesResponseBody.cs | 37 ++- .../Model/ListAccountSettingsBody.cs | 5 +- .../ListAccountSettingsImagesResponseBody.cs | 37 ++- .../Model/ListBatchErrorsResponseBody.cs | 10 +- .../Model/ListBatchesResponseBody.cs | 25 +- .../ListCarrierPackageTypesResponseBody.cs | 4 +- .../Model/ListCarrierServicesResponseBody.cs | 4 +- .../Model/ListCarriersResponseBody.cs | 5 +- ShipEngineSDK/Model/ListLabelsResponseBody.cs | 144 +++++----- .../Model/ListManifestsResponseBody.cs | 25 +- .../Model/ListPackageTypesResponseBody.cs | 4 +- ShipEngineSDK/Model/ListPickupResponseBody.cs | 23 +- .../Model/ListServicePointsResponseBody.cs | 10 +- ...icePointsResponseBodyServicePointsInner.cs | 35 +-- ...eBodyServicePointsInnerHoursOfOperation.cs | 14 +- ...ePointsInnerHoursOfOperationMondayInner.cs | 4 +- .../Model/ListShipmentRatesResponseBody.cs | 34 +-- .../Model/ListShipmentsResponseBody.cs | 25 +- ShipEngineSDK/Model/ListTagsResponseBody.cs | 2 +- .../Model/ListWarehousesResponseBody.cs | 5 +- ShipEngineSDK/Model/Manifest.cs | 40 +-- ShipEngineSDK/Model/ManifestDownload.cs | 2 +- ShipEngineSDK/Model/ManifestRequest.cs | 9 +- ShipEngineSDK/Model/ManifestRequestStatus.cs | 8 +- ShipEngineSDK/Model/Manifests.cs | 2 +- ShipEngineSDK/Model/ManifestsRequests.cs | 2 +- ShipEngineSDK/Model/ModifyBatch.cs | 4 +- ShipEngineSDK/Model/MonetaryValue.cs | 6 +- ShipEngineSDK/Model/NonDelivery.cs | 8 +- ShipEngineSDK/Model/OptionalLink.cs | 4 +- ShipEngineSDK/Model/OrderSourceName.cs | 8 +- ShipEngineSDK/Model/OriginType.cs | 8 +- ShipEngineSDK/Model/Package.cs | 39 ++- ShipEngineSDK/Model/PackageContents.cs | 8 +- ShipEngineSDK/Model/PackageType.cs | 12 +- ShipEngineSDK/Model/PackagingGroup.cs | 8 +- .../Model/PackagingInstructionSection.cs | 8 +- ShipEngineSDK/Model/PagedListResponseBody.cs | 12 +- ShipEngineSDK/Model/PaginationLink.cs | 12 +- ShipEngineSDK/Model/PaperlessDownload.cs | 6 +- .../Model/ParseAddressRequestBody.cs | 5 +- .../Model/ParseAddressResponseBody.cs | 9 +- .../Model/ParseShipmentRequestBody.cs | 5 +- .../Model/ParseShipmentResponseBody.cs | 9 +- ShipEngineSDK/Model/PartialAddress.cs | 27 +- ShipEngineSDK/Model/PartialShipment.cs | 78 +++--- ShipEngineSDK/Model/PartialShippingAddress.cs | 2 +- .../Model/PartialShippingAddressTo.cs | 4 +- ...artialShippingAddressToGeolocationInner.cs | 7 +- ShipEngineSDK/Model/PaymentAmount.cs | 4 +- ShipEngineSDK/Model/Pickup.cs | 44 +-- ShipEngineSDK/Model/PickupResponseBody.cs | 49 ++-- ShipEngineSDK/Model/PickupWindow.cs | 6 +- ShipEngineSDK/Model/PickupWindows.cs | 4 +- .../Model/ProcessBatchRequestBody.cs | 17 +- ShipEngineSDK/Model/Products.cs | 26 +- .../Model/PurchaseLabelWithoutShipment.cs | 25 +- ShipEngineSDK/Model/Rate.cs | 130 ++++----- ShipEngineSDK/Model/RateEstimate.cs | 121 ++++---- .../Model/RateEstimateByCarrierId.cs | 3 +- .../Model/RateEstimateByCarrierIds.cs | 2 +- ShipEngineSDK/Model/RateEstimateOptions.cs | 32 ++- ShipEngineSDK/Model/RateRequestBody.cs | 13 +- .../Model/RateRequestByShipmentIds.cs | 3 +- ShipEngineSDK/Model/RateRequestByShipments.cs | 3 +- ShipEngineSDK/Model/RateRequestOptions.cs | 2 +- ShipEngineSDK/Model/RateRequestRateOptions.cs | 2 +- ShipEngineSDK/Model/RateResponse.cs | 2 +- ShipEngineSDK/Model/RateResponseStatus.cs | 8 +- ShipEngineSDK/Model/RateType.cs | 8 +- ShipEngineSDK/Model/RatesInformation.cs | 27 +- ShipEngineSDK/Model/ReasonCode.cs | 8 +- ShipEngineSDK/Model/RecognizedEntity.cs | 17 +- ShipEngineSDK/Model/Redirect.cs | 8 +- ShipEngineSDK/Model/RegulationLevel.cs | 8 +- .../Model/RemoveFromBatchRequestBody.cs | 4 +- ShipEngineSDK/Model/ResponseMessage.cs | 29 +- .../Model/SchedulePickupRequestBody.cs | 43 ++- .../Model/SchedulePickupResponseBody.cs | 48 ++-- ShipEngineSDK/Model/Service.cs | 26 +- ShipEngineSDK/Model/Shipment.cs | 100 +++---- ShipEngineSDK/Model/ShipmentIdRequest.cs | 2 +- ShipEngineSDK/Model/ShipmentItem.cs | 21 +- ShipEngineSDK/Model/ShipmentRequest.cs | 2 +- ShipEngineSDK/Model/ShipmentStatus.cs | 8 +- ShipEngineSDK/Model/ShipmentsSortBy.cs | 8 +- ShipEngineSDK/Model/ShippingAddress.cs | 39 +-- ShipEngineSDK/Model/ShippingAddressTo.cs | 41 ++- ShipEngineSDK/Model/SmartPostHub.cs | 8 +- ShipEngineSDK/Model/SortDir.cs | 8 +- ShipEngineSDK/Model/StatusCode.cs | 8 +- ShipEngineSDK/Model/Tag.cs | 3 +- .../Model/TagShipmentResponseBody.cs | 3 +- ShipEngineSDK/Model/TaxIdentifier.cs | 22 +- ShipEngineSDK/Model/TaxableEntityType.cs | 8 +- ...TokensGetEphemeralTokenResponseBodyYaml.cs | 4 +- ShipEngineSDK/Model/TrackEvent.cs | 68 ++--- ShipEngineSDK/Model/TrackingInformation.cs | 45 +-- ShipEngineSDK/Model/TrackingStatus.cs | 8 +- ShipEngineSDK/Model/TransportMean.cs | 8 +- .../UpdateAccountSettingsImageRequestBody.cs | 24 +- .../UpdateAmazonBuyShippingRequestBody.cs | 2 +- .../UpdateDhlExpressSettingsRequestBody.cs | 6 +- .../Model/UpdateFedexSettingsRequestBody.cs | 23 +- .../UpdateNewgisticsSettingsRequestBody.cs | 4 +- .../Model/UpdatePackageTypeRequestBody.cs | 12 +- ShipEngineSDK/Model/UpdateShipmentFields.cs | 5 +- .../Model/UpdateShipmentRequestBody.cs | 85 +++--- .../Model/UpdateShipmentResponseBody.cs | 107 +++---- ShipEngineSDK/Model/UpdateShipmentsTags.cs | 2 +- .../Model/UpdateShipmentsTagsRequestBody.cs | 2 +- .../UpdateShipmentsTagsShipmentsTagsInner.cs | 4 +- .../Model/UpdateUpsSettingsRequestBody.cs | 30 +- .../Model/UpdateWarehouseRequestBody.cs | 18 +- .../UpdateWarehouseSettingsRequestBody.cs | 2 +- .../Model/UpdateWebhookRequestBody.cs | 4 +- ShipEngineSDK/Model/UpsAccountSettings.cs | 30 +- ShipEngineSDK/Model/UpsInvoice.cs | 10 +- ShipEngineSDK/Model/UpsPickupType.cs | 8 +- .../Model/UpsSettingsResponseBody.cs | 30 +- ShipEngineSDK/Model/ValidateAddress.cs | 8 +- ShipEngineSDK/Model/ValidateShipmentFields.cs | 5 +- ShipEngineSDK/Model/ValidationStatus.cs | 8 +- ShipEngineSDK/Model/VoidLabelResponseBody.cs | 17 +- ShipEngineSDK/Model/Warehouse.cs | 16 +- ShipEngineSDK/Model/Webhook.cs | 13 +- ShipEngineSDK/Model/WebhookEvent.cs | 8 +- ShipEngineSDK/Model/WebhookHeader.cs | 6 +- ShipEngineSDK/Model/Weight.cs | 11 +- ShipEngineSDK/Model/WeightUnit.cs | 8 +- ShipEngineSDK/ShipEngineClient.cs | 3 +- generation/templates/modelEnum.mustache | 8 +- generation/templates/modelGeneric.mustache | 36 +-- generation/templates/modelOneOf.mustache | 21 +- generation/templates/partial_getSet.mustache | 1 + .../templates/partial_jsonAttributes.mustache | 1 + .../templates/partial_optional.mustache | 1 + .../partial_requiredAttribute.mustache | 1 + 301 files changed, 3631 insertions(+), 3707 deletions(-) create mode 100644 ShipEngineSDK.Test/SerializationTests.cs create mode 100644 generation/templates/partial_getSet.mustache create mode 100644 generation/templates/partial_jsonAttributes.mustache create mode 100644 generation/templates/partial_optional.mustache create mode 100644 generation/templates/partial_requiredAttribute.mustache diff --git a/ShipEngineSDK.Test/SerializationTests.cs b/ShipEngineSDK.Test/SerializationTests.cs new file mode 100644 index 00000000..e0cbec83 --- /dev/null +++ b/ShipEngineSDK.Test/SerializationTests.cs @@ -0,0 +1,260 @@ +namespace ShipEngineSDK.Test +{ + using Model; + using System; + using System.Collections.Generic; + using System.Text.Json; + using Xunit; + + public class SerializationTests + { + public class WithGenericModel + { + public class WithReadOnlyProperties + { + [Fact] + public void WhenSerializing_ItShouldIgnoreReadOnlyProperties() + { + var batch = new Batch + { + BatchLabelsUrl = new OptionalLink { Href = "http://example.com/labels" }, + BatchShipmentsUrl = new OptionalLink { Href = "http://example.com/shipments" } + }; + + var result = JsonSerializer.Serialize(batch, ShipEngineClient.JsonSerializerOptions); + + Assert.Equal(@"{ + ""batch_labels_url"": { + ""href"": ""http://example.com/labels"" + }, + ""batch_shipments_url"": { + ""href"": ""http://example.com/shipments"" + } +}", result); + } + + [Fact] + public void WhenDeserializing_ItIncludeReadOnlyProperties() + { + const string json = @"{ + ""label_format"": ""png"", + ""label_layout"": ""letter"", + ""status"": ""open"", + ""batch_labels_url"": { + ""href"": ""http://example.com/labels"" + }, + ""batch_shipments_url"": { + ""href"": ""http://example.com/shipments"" + } + }"; + + var batch = JsonSerializer.Deserialize(json, ShipEngineClient.JsonSerializerOptions); + + Assert.Equal(LabelFormat.Png, batch.LabelFormat); + Assert.Equal(LabelLayout.Letter, batch.LabelLayout); + Assert.Equal(BatchStatus.Open, batch.Status); + Assert.Equal("http://example.com/labels", batch.BatchLabelsUrl.Href); + Assert.Equal("http://example.com/shipments", batch.BatchShipmentsUrl.Href); + } + } + + public class WithWriteOnlyProperties + { + [Fact] + public void WhenSerializing_ItShouldIncludeWriteOnlyProperties() + { + var pickup = new SchedulePickupRequestBody + { + PickupWindow = new PickupWindow + { + StartAt = new DateTimeOffset(2024, 7, 17, 12, 27, 35, TimeSpan.Zero), + EndAt = new DateTimeOffset(2024, 7, 19, 12, 27, 35, TimeSpan.Zero), + }, + ContactDetails = new ContactDetails + { + Name = "John Doe", + Email = "jdoe@example.com", + Phone = "314-555-1234" + }, + LabelIds = new List { "se-1234567" } + }; + + var result = JsonSerializer.Serialize(pickup, ShipEngineClient.JsonSerializerOptions); + + Assert.Equal(@"{ + ""contact_details"": { + ""email"": ""jdoe@example.com"", + ""name"": ""John Doe"", + ""phone"": ""314-555-1234"" + }, + ""label_ids"": [ + ""se-1234567"" + ], + ""pickup_window"": { + ""end_at"": ""2024-07-19T12:27:35+00:00"", + ""start_at"": ""2024-07-17T12:27:35+00:00"" + } +}", result); + } + + [Fact] + public void WhenDeserializing_ItShouldNotIncludeWriteOnlyProperties() + { + var json = @"{ + ""pickup_window"": { + ""end_at"": ""2024-07-19T12:27:35+00:00"", + ""start_at"": ""2024-07-17T12:27:35+00:00"" + } +}"; + + var pickup = JsonSerializer.Deserialize(json, ShipEngineClient.JsonSerializerOptions); + + Assert.Equal("se-12345", pickup.CarrierId); + Assert.Null(pickup.PickupWindow); + } + } + } + + public class WithOneOfModel + { + [Fact] + public void WhenSerializing_ItShouldSerializeShipmentId() + { + var body = new CalculateRatesRequestBody(new ShipmentIdRequest + { + ShipmentId = "se-1234567" + }) + { + RateOptions = new RateRequestBody + { + CarrierIds = new List { "se-99999" } + } + }; + + var result = JsonSerializer.Serialize(body, ShipEngineClient.JsonSerializerOptions); + + Assert.Equal(@"{ + ""rate_options"": { + ""carrier_ids"": [ + ""se-99999"" + ] + }, + ""shipment_id"": ""se-1234567"" +}", result); + } + + [Fact] + public void WhenSerializing_ItShouldSerializeShipment() + { + var body = new CalculateRatesRequestBody(new ShipmentRequest + { + Shipment = new AddressValidatingShipment + { + CarrierId = "se-88888", + ServiceCode = "overnight", + ShipFrom = new ShippingAddress + { + AddressResidentialIndicator = AddressResidentialIndicator.No, + AddressLine1 = "123 Main St.", + CityLocality = "St. Louis", + CountryCode = "US", + Name = "John Doe", + Phone = "314-555-1234", + PostalCode = "63102", + StateProvince = "MO" + }, + ShipTo = new ShippingAddressTo + { + AddressResidentialIndicator = AddressResidentialIndicator.Yes, + AddressLine1 = "456 Central", + CityLocality = "St. Louis", + CountryCode = "US", + Name = "Jane Doe", + Phone = "314-555-5678", + PostalCode = "63033", + StateProvince = "MO" + } + } + }) + { + RateOptions = new RateRequestBody + { + CarrierIds = new List { "se-99999" } + } + }; + + var result = JsonSerializer.Serialize(body, ShipEngineClient.JsonSerializerOptions); + + Assert.Equal(@"{ + ""rate_options"": { + ""carrier_ids"": [ + ""se-99999"" + ] + }, + ""shipment"": { + ""carrier_id"": ""se-88888"", + ""service_code"": ""overnight"", + ""ship_from"": { + ""address_line1"": ""123 Main St."", + ""address_residential_indicator"": ""no"", + ""city_locality"": ""St. Louis"", + ""country_code"": ""US"", + ""name"": ""John Doe"", + ""phone"": ""314-555-1234"", + ""postal_code"": ""63102"", + ""state_province"": ""MO"" + }, + ""ship_to"": { + ""address_line1"": ""456 Central"", + ""address_residential_indicator"": ""yes"", + ""city_locality"": ""St. Louis"", + ""country_code"": ""US"", + ""name"": ""Jane Doe"", + ""phone"": ""314-555-5678"", + ""postal_code"": ""63033"", + ""state_province"": ""MO"" + } + } +}", result); + } + + [Fact] + public void WhenDeserializing_ItShouldDeserializeShipmentId() + { + var json = @"{ + ""rate_options"": { + ""carrier_ids"": [ + ""se-99999"" + ] + }, + ""shipment_id"": ""se-1234567"" +}"; + + var result = JsonSerializer.Deserialize(json, ShipEngineClient.JsonSerializerOptions); + + Assert.NotNull(result.GetShipmentIdRequest()); + Assert.Contains("se-99999", result.RateOptions.CarrierIds); + } + + [Fact] + public void WhenDeserializing_ItShouldDeserializeShipment() + { + var json = @"{ + ""rate_options"": { + ""carrier_ids"": [ + ""se-99999"" + ] + }, + ""shipment"": { + ""carrier_id"": ""se-88888"" + } +}"; + + var result = JsonSerializer.Deserialize(json, ShipEngineClient.JsonSerializerOptions); + + Assert.NotNull(result.GetShipmentRequest()); + Assert.Contains("se-99999", result.RateOptions.CarrierIds); + } + } + } +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/AccountSettings.cs b/ShipEngineSDK/Model/AccountSettings.cs index 197e54d9..83044028 100644 --- a/ShipEngineSDK/Model/AccountSettings.cs +++ b/ShipEngineSDK/Model/AccountSettings.cs @@ -29,11 +29,12 @@ public partial class AccountSettings { /// - /// Gets or Sets DefaultLabelLayout CLOVUS + /// Gets or Sets DefaultLabelLayout /// - [JsonPropertyName("default_label_layout")] + [JsonPropertyName("default_label_layout"), JsonPropertyOrder(1)] public DefaultLabelLayout? DefaultLabelLayout { get; set; } + /// /// Returns the string presentation of the object /// diff --git a/ShipEngineSDK/Model/AccountSettingsImages.cs b/ShipEngineSDK/Model/AccountSettingsImages.cs index 769d4b36..501219ba 100644 --- a/ShipEngineSDK/Model/AccountSettingsImages.cs +++ b/ShipEngineSDK/Model/AccountSettingsImages.cs @@ -89,11 +89,12 @@ public override bool CanConvert(Type typeToConvert) => /// - /// The image type CLOVUS + /// The image type /// /// The image type - [JsonPropertyName("image_content_type")] + [JsonPropertyName("image_content_type"), JsonPropertyOrder(2)] public ImageContentTypeEnum? ImageContentType { get; set; } + /// /// The date and time that the image was created in ShipEngine. /// @@ -101,8 +102,8 @@ public override bool CanConvert(Type typeToConvert) => /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// A base64 encoded string representation of the image. @@ -111,7 +112,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg== /// - [JsonPropertyName("image_data")] + [JsonPropertyName("image_data"), JsonPropertyOrder(3)] public string? ImageData { get; set; } /// @@ -121,7 +122,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// false /// - [JsonPropertyName("is_default")] + [JsonPropertyName("is_default"), JsonPropertyOrder(4)] public bool? IsDefault { get; set; } /// @@ -131,8 +132,8 @@ public override bool CanConvert(Type typeToConvert) => /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id")] - public string? LabelImageId { get; set; } + [JsonPropertyName("label_image_id"), JsonInclude] + public string? LabelImageId { get; private set; } /// /// The date and time that the image was modified in ShipEngine. @@ -141,8 +142,8 @@ public override bool CanConvert(Type typeToConvert) => /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("modified_at")] - public DateTimeOffset? ModifiedAt { get; set; } + [JsonPropertyName("modified_at"), JsonInclude] + public DateTimeOffset? ModifiedAt { get; private set; } /// /// A human readable name for the image. @@ -151,7 +152,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// My logo /// - [JsonPropertyName("name")] + [JsonPropertyName("name"), JsonPropertyOrder(7)] public string? Name { get; set; } diff --git a/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs b/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs index bbcc1658..27a9a343 100644 --- a/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs +++ b/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs @@ -32,16 +32,14 @@ public partial class AddFundsToCarrierRequestBody /// The monetary amount, in the specified currency. /// /// The monetary amount, in the specified currency. - [JsonPropertyName("amount")] - [JsonRequired] + [JsonPropertyName("amount"), JsonRequired, JsonPropertyOrder(1)] public required double Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("currency")] - [JsonRequired] + [JsonPropertyName("currency"), JsonRequired, JsonPropertyOrder(2)] public required string Currency { get; set; } diff --git a/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs b/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs index 489a5166..85e77ebf 100644 --- a/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs +++ b/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs @@ -32,9 +32,8 @@ public partial class AddFundsToCarrierResponseBody /// The current balance of the account /// /// The current balance of the account - [JsonPropertyName("balance")] - [JsonRequired] - public required MonetaryValue Balance { get; set; } + [JsonPropertyName("balance"), JsonInclude] + public MonetaryValue? Balance { get; private set; } /// diff --git a/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs b/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs index fc84287f..e2ff3640 100644 --- a/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs +++ b/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs @@ -32,16 +32,14 @@ public partial class AddFundsToInsuranceRequestBody /// The monetary amount, in the specified currency. /// /// The monetary amount, in the specified currency. - [JsonPropertyName("amount")] - [JsonRequired] + [JsonPropertyName("amount"), JsonRequired, JsonPropertyOrder(1)] public required double Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("currency")] - [JsonRequired] + [JsonPropertyName("currency"), JsonRequired, JsonPropertyOrder(2)] public required string Currency { get; set; } diff --git a/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs b/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs index 710b73e6..36bd1b15 100644 --- a/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs +++ b/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs @@ -32,16 +32,14 @@ public partial class AddFundsToInsuranceResponseBody /// The monetary amount, in the specified currency. /// /// The monetary amount, in the specified currency. - [JsonPropertyName("amount")] - [JsonRequired] + [JsonPropertyName("amount"), JsonRequired, JsonPropertyOrder(1)] public required double Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("currency")] - [JsonRequired] + [JsonPropertyName("currency"), JsonRequired, JsonPropertyOrder(2)] public required string Currency { get; set; } diff --git a/ShipEngineSDK/Model/AddToBatchRequestBody.cs b/ShipEngineSDK/Model/AddToBatchRequestBody.cs index ab25f639..c7541760 100644 --- a/ShipEngineSDK/Model/AddToBatchRequestBody.cs +++ b/ShipEngineSDK/Model/AddToBatchRequestBody.cs @@ -32,14 +32,14 @@ public partial class AddToBatchRequestBody /// Array of Rate IDs to be modifed on the batch /// /// Array of Rate IDs to be modifed on the batch - [JsonPropertyName("rate_ids")] + [JsonPropertyName("rate_ids"), JsonPropertyOrder(1)] public List? RateIds { get; set; } /// /// The Shipment Ids to be modified on the batch /// /// The Shipment Ids to be modified on the batch - [JsonPropertyName("shipment_ids")] + [JsonPropertyName("shipment_ids"), JsonPropertyOrder(2)] public List? ShipmentIds { get; set; } diff --git a/ShipEngineSDK/Model/Address.cs b/ShipEngineSDK/Model/Address.cs index 70573108..255f165a 100644 --- a/ShipEngineSDK/Model/Address.cs +++ b/ShipEngineSDK/Model/Address.cs @@ -29,13 +29,11 @@ public partial class Address { /// - /// Indicates whether this is a residential address. CLOVUS + /// Indicates whether this is a residential address. /// /// Indicates whether this is a residential address. - [JsonPropertyName("address_residential_indicator")] - [JsonRequired] - public required AddressResidentialIndicator AddressResidentialIndicator { get; set; } = new(); - + [JsonPropertyName("address_residential_indicator"), JsonRequired, JsonPropertyOrder(2)] + public required AddressResidentialIndicator AddressResidentialIndicator { get; set; } /// /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. @@ -44,8 +42,7 @@ public partial class Address /// /// 1999 Bishop Grandin Blvd. /// - [JsonPropertyName("address_line1")] - [JsonRequired] + [JsonPropertyName("address_line1"), JsonRequired, JsonPropertyOrder(1)] public required string AddressLine1 { get; set; } /// @@ -55,8 +52,7 @@ public partial class Address /// /// Winnipeg /// - [JsonPropertyName("city_locality")] - [JsonRequired] + [JsonPropertyName("city_locality"), JsonRequired, JsonPropertyOrder(3)] public required string CityLocality { get; set; } /// @@ -66,8 +62,7 @@ public partial class Address /// /// CA /// - [JsonPropertyName("country_code")] - [JsonRequired] + [JsonPropertyName("country_code"), JsonRequired, JsonPropertyOrder(4)] public required string CountryCode { get; set; } /// @@ -77,8 +72,7 @@ public partial class Address /// /// John Doe /// - [JsonPropertyName("name")] - [JsonRequired] + [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(5)] public required string Name { get; set; } /// @@ -88,8 +82,7 @@ public partial class Address /// /// +1 204-253-9411 ext. 123 /// - [JsonPropertyName("phone")] - [JsonRequired] + [JsonPropertyName("phone"), JsonRequired, JsonPropertyOrder(6)] public required string Phone { get; set; } /// @@ -99,8 +92,7 @@ public partial class Address /// /// 78756-3717 /// - [JsonPropertyName("postal_code")] - [JsonRequired] + [JsonPropertyName("postal_code"), JsonRequired, JsonPropertyOrder(7)] public required string PostalCode { get; set; } /// @@ -110,8 +102,7 @@ public partial class Address /// /// Manitoba /// - [JsonPropertyName("state_province")] - [JsonRequired] + [JsonPropertyName("state_province"), JsonRequired, JsonPropertyOrder(8)] public required string StateProvince { get; set; } /// @@ -121,7 +112,7 @@ public partial class Address /// /// Unit 408 /// - [JsonPropertyName("address_line2")] + [JsonPropertyName("address_line2"), JsonPropertyOrder(9)] public string? AddressLine2 { get; set; } /// @@ -131,7 +122,7 @@ public partial class Address /// /// Building #7 /// - [JsonPropertyName("address_line3")] + [JsonPropertyName("address_line3"), JsonPropertyOrder(10)] public string? AddressLine3 { get; set; } /// @@ -141,7 +132,7 @@ public partial class Address /// /// The Home Depot /// - [JsonPropertyName("company_name")] + [JsonPropertyName("company_name"), JsonPropertyOrder(11)] public string? CompanyName { get; set; } /// @@ -151,7 +142,7 @@ public partial class Address /// /// example@example.com /// - [JsonPropertyName("email")] + [JsonPropertyName("email"), JsonPropertyOrder(12)] public string? Email { get; set; } diff --git a/ShipEngineSDK/Model/AddressResidentialIndicator.cs b/ShipEngineSDK/Model/AddressResidentialIndicator.cs index 19993ba4..5765f3e7 100644 --- a/ShipEngineSDK/Model/AddressResidentialIndicator.cs +++ b/ShipEngineSDK/Model/AddressResidentialIndicator.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(AddressResidentialIndicatorJsonConverter))] public class AddressResidentialIndicator { - private string _value; + private readonly string _value; /// /// Create a new instance of AddressResidentialIndicator with a predefined value. @@ -74,6 +74,12 @@ public AddressResidentialIndicator(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is AddressResidentialIndicator other && _value == other._value; } internal class AddressResidentialIndicatorJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/AddressToValidate.cs b/ShipEngineSDK/Model/AddressToValidate.cs index 1f63ecf1..e324d159 100644 --- a/ShipEngineSDK/Model/AddressToValidate.cs +++ b/ShipEngineSDK/Model/AddressToValidate.cs @@ -29,11 +29,12 @@ public partial class AddressToValidate { /// - /// Indicates whether this is a residential address. CLOVUS + /// Indicates whether this is a residential address. /// /// Indicates whether this is a residential address. - [JsonPropertyName("address_residential_indicator")] + [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(7)] public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } + /// /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. /// @@ -41,8 +42,7 @@ public partial class AddressToValidate /// /// 1999 Bishop Grandin Blvd. /// - [JsonPropertyName("address_line1")] - [JsonRequired] + [JsonPropertyName("address_line1"), JsonRequired, JsonPropertyOrder(1)] public required string AddressLine1 { get; set; } /// @@ -52,8 +52,7 @@ public partial class AddressToValidate /// /// Winnipeg /// - [JsonPropertyName("city_locality")] - [JsonRequired] + [JsonPropertyName("city_locality"), JsonRequired, JsonPropertyOrder(2)] public required string CityLocality { get; set; } /// @@ -63,8 +62,7 @@ public partial class AddressToValidate /// /// CA /// - [JsonPropertyName("country_code")] - [JsonRequired] + [JsonPropertyName("country_code"), JsonRequired, JsonPropertyOrder(3)] public required string CountryCode { get; set; } /// @@ -74,8 +72,7 @@ public partial class AddressToValidate /// /// Manitoba /// - [JsonPropertyName("state_province")] - [JsonRequired] + [JsonPropertyName("state_province"), JsonRequired, JsonPropertyOrder(4)] public required string StateProvince { get; set; } /// @@ -85,7 +82,7 @@ public partial class AddressToValidate /// /// Unit 408 /// - [JsonPropertyName("address_line2")] + [JsonPropertyName("address_line2"), JsonPropertyOrder(5)] public string? AddressLine2 { get; set; } /// @@ -95,7 +92,7 @@ public partial class AddressToValidate /// /// Building #7 /// - [JsonPropertyName("address_line3")] + [JsonPropertyName("address_line3"), JsonPropertyOrder(6)] public string? AddressLine3 { get; set; } /// @@ -105,7 +102,7 @@ public partial class AddressToValidate /// /// The Home Depot /// - [JsonPropertyName("company_name")] + [JsonPropertyName("company_name"), JsonPropertyOrder(8)] public string? CompanyName { get; set; } /// @@ -115,7 +112,7 @@ public partial class AddressToValidate /// /// example@example.com /// - [JsonPropertyName("email")] + [JsonPropertyName("email"), JsonPropertyOrder(9)] public string? Email { get; set; } /// @@ -125,7 +122,7 @@ public partial class AddressToValidate /// /// John Doe /// - [JsonPropertyName("name")] + [JsonPropertyName("name"), JsonPropertyOrder(10)] public string? Name { get; set; } /// @@ -135,7 +132,7 @@ public partial class AddressToValidate /// /// +1 204-253-9411 ext. 123 /// - [JsonPropertyName("phone")] + [JsonPropertyName("phone"), JsonPropertyOrder(11)] public string? Phone { get; set; } /// @@ -145,7 +142,7 @@ public partial class AddressToValidate /// /// 78756-3717 /// - [JsonPropertyName("postal_code")] + [JsonPropertyName("postal_code"), JsonPropertyOrder(12)] public string? PostalCode { get; set; } diff --git a/ShipEngineSDK/Model/AddressValidatingShipment.cs b/ShipEngineSDK/Model/AddressValidatingShipment.cs index 6cd503d3..709ae39d 100644 --- a/ShipEngineSDK/Model/AddressValidatingShipment.cs +++ b/ShipEngineSDK/Model/AddressValidatingShipment.cs @@ -29,33 +29,38 @@ public partial class AddressValidatingShipment { /// - /// The type of delivery confirmation that is required for this shipment. CLOVUS + /// The type of delivery confirmation that is required for this shipment. /// /// The type of delivery confirmation that is required for this shipment. - [JsonPropertyName("confirmation")] + [JsonPropertyName("confirmation"), JsonPropertyOrder(8)] public DeliveryConfirmation? Confirmation { get; set; } + /// - /// The insurance provider to use for any insured packages in the shipment. CLOVUS + /// The insurance provider to use for any insured packages in the shipment. /// /// The insurance provider to use for any insured packages in the shipment. - [JsonPropertyName("insurance_provider")] + [JsonPropertyName("insurance_provider"), JsonPropertyOrder(13)] public InsuranceProvider? InsuranceProvider { get; set; } + /// - /// Gets or Sets OrderSourceCode CLOVUS + /// Gets or Sets OrderSourceCode /// - [JsonPropertyName("order_source_code")] + [JsonPropertyName("order_source_code"), JsonPropertyOrder(17)] public OrderSourceName? OrderSourceCode { get; set; } + /// - /// The current status of the shipment CLOVUS + /// The current status of the shipment /// /// The current status of the shipment - [JsonPropertyName("shipment_status")] - public ShipmentStatus? ShipmentStatus { get; set; } + [JsonPropertyName("shipment_status"), JsonInclude] + public ShipmentStatus? ShipmentStatus { get; private set; } + /// - /// Gets or Sets ValidateAddress CLOVUS + /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address")] + [JsonPropertyName("validate_address"), JsonPropertyOrder(27)] public ValidateAddress? ValidateAddress { get; set; } + /// /// The carrier account that is billed for the shipping charges /// @@ -63,8 +68,7 @@ public partial class AddressValidatingShipment /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [JsonRequired] + [JsonPropertyName("carrier_id"), JsonRequired, JsonPropertyOrder(1)] public required string CarrierId { get; set; } /// @@ -74,24 +78,21 @@ public partial class AddressValidatingShipment /// /// usps_first_class_mail /// - [JsonPropertyName("service_code")] - [JsonRequired] + [JsonPropertyName("service_code"), JsonRequired, JsonPropertyOrder(2)] public required string ServiceCode { get; set; } /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from")] - [JsonRequired] + [JsonPropertyName("ship_from"), JsonRequired, JsonPropertyOrder(3)] public required ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address /// /// The recipient's mailing address - [JsonPropertyName("ship_to")] - [JsonRequired] + [JsonPropertyName("ship_to"), JsonRequired, JsonPropertyOrder(4)] public required ShippingAddressTo ShipTo { get; set; } /// @@ -101,15 +102,14 @@ public partial class AddressValidatingShipment /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - [JsonRequired] - public required string ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private set; } /// /// Advanced shipment options. These are entirely optional. /// /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options")] + [JsonPropertyName("advanced_options"), JsonPropertyOrder(6)] public AdvancedShipmentOptions? AdvancedOptions { get; set; } /// @@ -119,7 +119,7 @@ public partial class AddressValidatingShipment /// /// retail /// - [JsonPropertyName("comparison_rate_type")] + [JsonPropertyName("comparison_rate_type"), JsonPropertyOrder(7)] public string? ComparisonRateType { get; set; } /// @@ -129,42 +129,42 @@ public partial class AddressValidatingShipment /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// Customs information. This is usually only needed for international shipments. /// /// Customs information. This is usually only needed for international shipments. - [JsonPropertyName("customs")] + [JsonPropertyName("customs"), JsonPropertyOrder(10)] public InternationalShipmentOptions? Customs { get; set; } /// /// ID that the Order Source assigned /// /// ID that the Order Source assigned - [JsonPropertyName("external_order_id")] + [JsonPropertyName("external_order_id"), JsonPropertyOrder(11)] public string? ExternalOrderId { get; set; } /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("external_shipment_id")] + [JsonPropertyName("external_shipment_id"), JsonPropertyOrder(12)] public string? ExternalShipmentId { get; set; } /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. - [JsonPropertyName("is_return")] + [JsonPropertyName("is_return"), JsonPropertyOrder(14)] public bool? IsReturn { get; set; } /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - [JsonPropertyName("items")] + [JsonPropertyName("items"), JsonPropertyOrder(15)] public List? Items { get; set; } /// @@ -174,21 +174,21 @@ public partial class AddressValidatingShipment /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("modified_at")] - public DateTimeOffset? ModifiedAt { get; set; } + [JsonPropertyName("modified_at"), JsonInclude] + public DateTimeOffset? ModifiedAt { get; private set; } /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] + [JsonPropertyName("packages"), JsonPropertyOrder(18)] public List? Packages { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. /// /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to")] + [JsonPropertyName("return_to"), JsonPropertyOrder(19)] public ShippingAddress? ReturnTo { get; set; } /// @@ -198,14 +198,14 @@ public partial class AddressValidatingShipment /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date")] + [JsonPropertyName("ship_date"), JsonPropertyOrder(20)] public DateTimeOffset? ShipDate { get; set; } /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("shipment_number")] + [JsonPropertyName("shipment_number"), JsonPropertyOrder(21)] public string? ShipmentNumber { get; set; } /// @@ -215,28 +215,28 @@ public partial class AddressValidatingShipment /// /// se-28529731 /// - [JsonPropertyName("shipping_rule_id")] + [JsonPropertyName("shipping_rule_id"), JsonPropertyOrder(23)] public string? ShippingRuleId { get; set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. - [JsonPropertyName("tags")] - public List? Tags { get; set; } + [JsonPropertyName("tags"), JsonInclude] + public List? Tags { get; private set; } /// /// Gets or Sets TaxIdentifiers /// - [JsonPropertyName("tax_identifiers")] + [JsonPropertyName("tax_identifiers"), JsonPropertyOrder(25)] public List? TaxIdentifiers { get; set; } /// /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment - [JsonPropertyName("total_weight")] - public Weight? TotalWeight { get; set; } + [JsonPropertyName("total_weight"), JsonInclude] + public Weight? TotalWeight { get; private set; } /// /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. @@ -245,7 +245,7 @@ public partial class AddressValidatingShipment /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] + [JsonPropertyName("warehouse_id"), JsonPropertyOrder(28)] public string? WarehouseId { get; set; } diff --git a/ShipEngineSDK/Model/AddressValidationCode.cs b/ShipEngineSDK/Model/AddressValidationCode.cs index 77010c33..8e9467c2 100644 --- a/ShipEngineSDK/Model/AddressValidationCode.cs +++ b/ShipEngineSDK/Model/AddressValidationCode.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(AddressValidationCodeJsonConverter))] public class AddressValidationCode { - private string _value; + private readonly string _value; /// /// Create a new instance of AddressValidationCode with a predefined value. @@ -134,6 +134,12 @@ public AddressValidationCode(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is AddressValidationCode other && _value == other._value; } internal class AddressValidationCodeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/AddressValidationDetailCode.cs b/ShipEngineSDK/Model/AddressValidationDetailCode.cs index cd4c30e5..c46db4bd 100644 --- a/ShipEngineSDK/Model/AddressValidationDetailCode.cs +++ b/ShipEngineSDK/Model/AddressValidationDetailCode.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(AddressValidationDetailCodeJsonConverter))] public class AddressValidationDetailCode { - private string _value; + private readonly string _value; /// /// Create a new instance of AddressValidationDetailCode with a predefined value. @@ -404,6 +404,12 @@ public AddressValidationDetailCode(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is AddressValidationDetailCode other && _value == other._value; } internal class AddressValidationDetailCodeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/AddressValidationMessageType.cs b/ShipEngineSDK/Model/AddressValidationMessageType.cs index 777473ec..e95cfacb 100644 --- a/ShipEngineSDK/Model/AddressValidationMessageType.cs +++ b/ShipEngineSDK/Model/AddressValidationMessageType.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(AddressValidationMessageTypeJsonConverter))] public class AddressValidationMessageType { - private string _value; + private readonly string _value; /// /// Create a new instance of AddressValidationMessageType with a predefined value. @@ -74,6 +74,12 @@ public AddressValidationMessageType(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is AddressValidationMessageType other && _value == other._value; } internal class AddressValidationMessageTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/AddressValidationResult.cs b/ShipEngineSDK/Model/AddressValidationResult.cs index 64494c4c..01c4ef12 100644 --- a/ShipEngineSDK/Model/AddressValidationResult.cs +++ b/ShipEngineSDK/Model/AddressValidationResult.cs @@ -29,36 +29,31 @@ public partial class AddressValidationResult { /// - /// Gets or Sets Status CLOVUS + /// Gets or Sets Status /// - [JsonPropertyName("status")] - [JsonRequired] - public required AddressValidationStatus Status { get; set; } = new(); - + [JsonPropertyName("status"), JsonRequired, JsonPropertyOrder(3)] + public required AddressValidationStatus Status { get; set; } /// /// The list of messages that were generated during the address validation request. /// /// The list of messages that were generated during the address validation request. - [JsonPropertyName("messages")] - [JsonRequired] - public required List Messages { get; set; } + [JsonPropertyName("messages"), JsonInclude] + public List? Messages { get; private set; } /// /// The original address that was sent for validation /// /// The original address that was sent for validation - [JsonPropertyName("original_address")] - [JsonRequired] + [JsonPropertyName("original_address"), JsonRequired, JsonPropertyOrder(2)] public required Address OriginalAddress { get; set; } /// /// The matched address found by the Shipengine API /// /// The matched address found by the Shipengine API - [JsonPropertyName("matched_address")] - [JsonRequired] - public required Address MatchedAddress { get; set; } + [JsonPropertyName("matched_address"), JsonInclude] + public Address? MatchedAddress { get; private set; } /// diff --git a/ShipEngineSDK/Model/AddressValidationStatus.cs b/ShipEngineSDK/Model/AddressValidationStatus.cs index aa90f11e..3aedd121 100644 --- a/ShipEngineSDK/Model/AddressValidationStatus.cs +++ b/ShipEngineSDK/Model/AddressValidationStatus.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(AddressValidationStatusJsonConverter))] public class AddressValidationStatus { - private string _value; + private readonly string _value; /// /// Create a new instance of AddressValidationStatus with a predefined value. @@ -80,6 +80,12 @@ public AddressValidationStatus(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is AddressValidationStatus other && _value == other._value; } internal class AddressValidationStatusJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptions.cs b/ShipEngineSDK/Model/AdvancedShipmentOptions.cs index 0a18c11b..c51ecb6e 100644 --- a/ShipEngineSDK/Model/AdvancedShipmentOptions.cs +++ b/ShipEngineSDK/Model/AdvancedShipmentOptions.cs @@ -29,28 +29,30 @@ public partial class AdvancedShipmentOptions { /// - /// Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set. CLOVUS + /// Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set. /// /// Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set. - [JsonPropertyName("bill_to_party")] + [JsonPropertyName("bill_to_party"), JsonPropertyOrder(4)] public BillToParty? BillToParty { get; set; } + /// - /// Gets or Sets OriginType CLOVUS + /// Gets or Sets OriginType /// - [JsonPropertyName("origin_type")] + [JsonPropertyName("origin_type"), JsonPropertyOrder(19)] public OriginType? OriginType { get; set; } + /// /// Indicate to the carrier that this shipment requires additional handling. /// /// Indicate to the carrier that this shipment requires additional handling. - [JsonPropertyName("additional_handling")] + [JsonPropertyName("additional_handling"), JsonPropertyOrder(1)] public bool? AdditionalHandling { get; set; } /// /// This field is used to [bill shipping costs to a third party](https://www.shipengine.com/docs/shipping/bill-to-third-party/). This field must be used in conjunction with the `bill_to_country_code`, `bill_to_party`, and `bill_to_postal_code` fields. /// /// This field is used to [bill shipping costs to a third party](https://www.shipengine.com/docs/shipping/bill-to-third-party/). This field must be used in conjunction with the `bill_to_country_code`, `bill_to_party`, and `bill_to_postal_code` fields. - [JsonPropertyName("bill_to_account")] + [JsonPropertyName("bill_to_account"), JsonPropertyOrder(2)] public string? BillToAccount { get; set; } /// @@ -60,88 +62,88 @@ public partial class AdvancedShipmentOptions /// /// CA /// - [JsonPropertyName("bill_to_country_code")] + [JsonPropertyName("bill_to_country_code"), JsonPropertyOrder(3)] public string? BillToCountryCode { get; set; } /// /// The postal code of the third-party that is responsible for shipping costs. /// /// The postal code of the third-party that is responsible for shipping costs. - [JsonPropertyName("bill_to_postal_code")] + [JsonPropertyName("bill_to_postal_code"), JsonPropertyOrder(5)] public string? BillToPostalCode { get; set; } /// /// Gets or Sets CollectOnDelivery /// - [JsonPropertyName("collect_on_delivery")] + [JsonPropertyName("collect_on_delivery"), JsonPropertyOrder(6)] public CollectOnDelivery? CollectOnDelivery { get; set; } /// /// Indicates that the shipment contains alcohol. /// /// Indicates that the shipment contains alcohol. - [JsonPropertyName("contains_alcohol")] + [JsonPropertyName("contains_alcohol"), JsonPropertyOrder(7)] public bool? ContainsAlcohol { get; set; } /// /// An arbitrary field that can be used to store information about the shipment. /// /// An arbitrary field that can be used to store information about the shipment. - [JsonPropertyName("custom_field1")] + [JsonPropertyName("custom_field1"), JsonPropertyOrder(8)] public string? CustomField1 { get; set; } /// /// An arbitrary field that can be used to store information about the shipment. /// /// An arbitrary field that can be used to store information about the shipment. - [JsonPropertyName("custom_field2")] + [JsonPropertyName("custom_field2"), JsonPropertyOrder(9)] public string? CustomField2 { get; set; } /// /// An arbitrary field that can be used to store information about the shipment. /// /// An arbitrary field that can be used to store information about the shipment. - [JsonPropertyName("custom_field3")] + [JsonPropertyName("custom_field3"), JsonPropertyOrder(10)] public string? CustomField3 { get; set; } /// /// Indicates if the Dangerous goods are present in the shipment /// /// Indicates if the Dangerous goods are present in the shipment - [JsonPropertyName("dangerous_goods")] + [JsonPropertyName("dangerous_goods"), JsonPropertyOrder(11)] public bool? DangerousGoods { get; set; } /// /// Gets or Sets DangerousGoodsContact /// - [JsonPropertyName("dangerous_goods_contact")] + [JsonPropertyName("dangerous_goods_contact"), JsonPropertyOrder(12)] public AdvancedShipmentOptionsDangerousGoodsContact? DangerousGoodsContact { get; set; } /// /// Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express. /// /// Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express. - [JsonPropertyName("delivered_duty_paid")] + [JsonPropertyName("delivered_duty_paid"), JsonPropertyOrder(13)] public bool? DeliveredDutyPaid { get; set; } /// /// Indicates if the shipment contain dry ice /// /// Indicates if the shipment contain dry ice - [JsonPropertyName("dry_ice")] + [JsonPropertyName("dry_ice"), JsonPropertyOrder(14)] public bool? DryIce { get; set; } /// /// The weight of the dry ice in the shipment /// /// The weight of the dry ice in the shipment - [JsonPropertyName("dry_ice_weight")] + [JsonPropertyName("dry_ice_weight"), JsonPropertyOrder(15)] public Weight? DryIceWeight { get; set; } /// /// Gets or Sets FedexFreight /// - [JsonPropertyName("fedex_freight")] + [JsonPropertyName("fedex_freight"), JsonPropertyOrder(16)] public AdvancedShipmentOptionsFedexFreight? FedexFreight { get; set; } /// @@ -151,41 +153,41 @@ public partial class AdvancedShipmentOptions /// /// 77.5 /// - [JsonPropertyName("freight_class")] + [JsonPropertyName("freight_class"), JsonPropertyOrder(17)] public string? FreightClass { get; set; } /// /// Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details. /// /// Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details. - [JsonPropertyName("non_machinable")] + [JsonPropertyName("non_machinable"), JsonPropertyOrder(18)] public bool? NonMachinable { get; set; } /// /// Enables Saturday delivery, if supported by the carrier. /// /// Enables Saturday delivery, if supported by the carrier. - [JsonPropertyName("saturday_delivery")] + [JsonPropertyName("saturday_delivery"), JsonPropertyOrder(20)] public bool? SaturdayDelivery { get; set; } /// /// Gets or Sets ShipperRelease /// - [JsonPropertyName("shipper_release")] + [JsonPropertyName("shipper_release"), JsonPropertyOrder(21)] public bool? ShipperRelease { get; set; } /// /// Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached /// /// Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached - [JsonPropertyName("third_party_consignee")] + [JsonPropertyName("third_party_consignee"), JsonPropertyOrder(22)] public bool? ThirdPartyConsignee { get; set; } /// /// Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified. /// /// Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified. - [JsonPropertyName("use_ups_ground_freight_pricing")] + [JsonPropertyName("use_ups_ground_freight_pricing"), JsonPropertyOrder(23)] public bool? UseUpsGroundFreightPricing { get; set; } diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs b/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs index 68d8ee64..f532e911 100644 --- a/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs +++ b/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs @@ -32,14 +32,14 @@ public partial class AdvancedShipmentOptionsDangerousGoodsContact /// Name of the contact /// /// Name of the contact - [JsonPropertyName("name")] + [JsonPropertyName("name"), JsonPropertyOrder(1)] public string? Name { get; set; } /// /// Phone number of the contact /// /// Phone number of the contact - [JsonPropertyName("phone")] + [JsonPropertyName("phone"), JsonPropertyOrder(2)] public string? Phone { get; set; } diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs b/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs index fc37c4ce..802e2e7f 100644 --- a/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs +++ b/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs @@ -31,13 +31,13 @@ public partial class AdvancedShipmentOptionsFedexFreight /// /// Gets or Sets BookingConfirmation /// - [JsonPropertyName("booking_confirmation")] + [JsonPropertyName("booking_confirmation"), JsonPropertyOrder(1)] public string? BookingConfirmation { get; set; } /// /// Gets or Sets ShipperLoadAndCount /// - [JsonPropertyName("shipper_load_and_count")] + [JsonPropertyName("shipper_load_and_count"), JsonPropertyOrder(2)] public string? ShipperLoadAndCount { get; set; } diff --git a/ShipEngineSDK/Model/AllowedIncoterms.cs b/ShipEngineSDK/Model/AllowedIncoterms.cs index 603a03b0..5cd68917 100644 --- a/ShipEngineSDK/Model/AllowedIncoterms.cs +++ b/ShipEngineSDK/Model/AllowedIncoterms.cs @@ -28,7 +28,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(AllowedIncotermsJsonConverter))] public class AllowedIncoterms { - private string _value; + private readonly string _value; /// /// Create a new instance of AllowedIncoterms with a predefined value. @@ -145,6 +145,12 @@ public AllowedIncoterms(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is AllowedIncoterms other && _value == other._value; } internal class AllowedIncotermsJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/AlternativeIdentifier.cs b/ShipEngineSDK/Model/AlternativeIdentifier.cs index df6f3b67..483ae03e 100644 --- a/ShipEngineSDK/Model/AlternativeIdentifier.cs +++ b/ShipEngineSDK/Model/AlternativeIdentifier.cs @@ -35,7 +35,7 @@ public partial class AlternativeIdentifier /// /// last_mile_tracking_number /// - [JsonPropertyName("type")] + [JsonPropertyName("type"), JsonPropertyOrder(1)] public string? Type { get; set; } /// @@ -45,7 +45,7 @@ public partial class AlternativeIdentifier /// /// 12345678912345678912 /// - [JsonPropertyName("value")] + [JsonPropertyName("value"), JsonPropertyOrder(2)] public string? Value { get; set; } diff --git a/ShipEngineSDK/Model/AlternativeIdentifiers.cs b/ShipEngineSDK/Model/AlternativeIdentifiers.cs index f3fc1886..9a5c05b3 100644 --- a/ShipEngineSDK/Model/AlternativeIdentifiers.cs +++ b/ShipEngineSDK/Model/AlternativeIdentifiers.cs @@ -32,8 +32,8 @@ public partial class AlternativeIdentifiers /// Alternative identifiers associated with this package. /// /// Alternative identifiers associated with this package. - [JsonPropertyName("alternative_identifiers")] - public List? VarAlternativeIdentifiers { get; set; } + [JsonPropertyName("alternative_identifiers"), JsonInclude] + public List? VarAlternativeIdentifiers { get; private set; } /// diff --git a/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs b/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs index a216e1f1..c6fdf034 100644 --- a/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs +++ b/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(AncillaryServiceEndorsementJsonConverter))] public class AncillaryServiceEndorsement { - private string _value; + private readonly string _value; /// /// Create a new instance of AncillaryServiceEndorsement with a predefined value. @@ -92,6 +92,12 @@ public AncillaryServiceEndorsement(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is AncillaryServiceEndorsement other && _value == other._value; } internal class AncillaryServiceEndorsementJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/Batch.cs b/ShipEngineSDK/Model/Batch.cs index 91485727..d44f8c27 100644 --- a/ShipEngineSDK/Model/Batch.cs +++ b/ShipEngineSDK/Model/Batch.cs @@ -29,37 +29,30 @@ public partial class Batch { /// - /// Gets or Sets LabelFormat CLOVUS + /// Gets or Sets LabelFormat /// - [JsonPropertyName("label_format")] - [JsonRequired] - public required LabelFormat LabelFormat { get; set; } = new(); - + [JsonPropertyName("label_format"), JsonInclude] + public LabelFormat? LabelFormat { get; private set; } /// - /// label layout CLOVUS + /// label layout /// /// label layout - [JsonPropertyName("label_layout")] - [JsonRequired] - public required LabelLayout LabelLayout { get; set; } = new(); - + [JsonPropertyName("label_layout"), JsonInclude] + public LabelLayout? LabelLayout { get; private set; } /// - /// Gets or Sets Status CLOVUS + /// Gets or Sets Status /// - [JsonPropertyName("status")] - [JsonRequired] - public required BatchStatus Status { get; set; } = new(); - + [JsonPropertyName("status"), JsonInclude] + public BatchStatus? Status { get; private set; } /// /// Link to batch errors endpoint /// /// Link to batch errors endpoint - [JsonPropertyName("batch_errors_url")] - [JsonRequired] - public required OptionalLink BatchErrorsUrl { get; set; } + [JsonPropertyName("batch_errors_url"), JsonInclude] + public OptionalLink? BatchErrorsUrl { get; private set; } /// /// A string that uniquely identifies the batch @@ -68,32 +61,28 @@ public partial class Batch /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - [JsonRequired] - public required string BatchId { get; set; } + [JsonPropertyName("batch_id"), JsonInclude] + public string? BatchId { get; private set; } /// /// Link to batch labels query /// /// Link to batch labels query - [JsonPropertyName("batch_labels_url")] - [JsonRequired] + [JsonPropertyName("batch_labels_url"), JsonRequired, JsonPropertyOrder(3)] public required OptionalLink BatchLabelsUrl { get; set; } /// /// The batch number. /// /// The batch number. - [JsonPropertyName("batch_number")] - [JsonRequired] - public required string BatchNumber { get; set; } + [JsonPropertyName("batch_number"), JsonInclude] + public string? BatchNumber { get; private set; } /// /// The batch shipments endpoint /// /// The batch shipments endpoint - [JsonPropertyName("batch_shipments_url")] - [JsonRequired] + [JsonPropertyName("batch_shipments_url"), JsonRequired, JsonPropertyOrder(5)] public required OptionalLink BatchShipmentsUrl { get; set; } /// @@ -103,9 +92,8 @@ public partial class Batch /// /// 1 /// - [JsonPropertyName("completed")] - [JsonRequired] - public required int Completed { get; set; } + [JsonPropertyName("completed"), JsonInclude] + public int? Completed { get; private set; } /// /// The total of errors, warnings, and completed properties @@ -114,9 +102,8 @@ public partial class Batch /// /// 2 /// - [JsonPropertyName("count")] - [JsonRequired] - public required int Count { get; set; } + [JsonPropertyName("count"), JsonInclude] + public int? Count { get; private set; } /// /// The date and time the batch was created in ShipEngine @@ -125,9 +112,8 @@ public partial class Batch /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - [JsonRequired] - public required DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// The number of errors that occurred while generating the batch @@ -136,17 +122,15 @@ public partial class Batch /// /// 2 /// - [JsonPropertyName("errors")] - [JsonRequired] - public required int Errors { get; set; } + [JsonPropertyName("errors"), JsonInclude] + public int? Errors { get; private set; } /// /// The form download for any customs that are needed /// /// The form download for any customs that are needed - [JsonPropertyName("form_download")] - [JsonRequired] - public required OptionalLink FormDownload { get; set; } + [JsonPropertyName("form_download"), JsonInclude] + public OptionalLink? FormDownload { get; private set; } /// /// The number of forms for customs that are available for download @@ -155,33 +139,29 @@ public partial class Batch /// /// 3 /// - [JsonPropertyName("forms")] - [JsonRequired] - public required int Forms { get; set; } + [JsonPropertyName("forms"), JsonInclude] + public int? Forms { get; private set; } /// /// The label download for the batch /// /// The label download for the batch - [JsonPropertyName("label_download")] - [JsonRequired] - public required LabelDownload LabelDownload { get; set; } + [JsonPropertyName("label_download"), JsonInclude] + public LabelDownload? LabelDownload { get; private set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - [JsonRequired] - public required PaperlessDownload PaperlessDownload { get; set; } + [JsonPropertyName("paperless_download"), JsonInclude] + public PaperlessDownload? PaperlessDownload { get; private set; } /// /// The errors associated with the failed API call /// /// The errors associated with the failed API call - [JsonPropertyName("process_errors")] - [JsonRequired] - public required List ProcessErrors { get; set; } + [JsonPropertyName("process_errors"), JsonInclude] + public List? ProcessErrors { get; private set; } /// /// The number of warnings that occurred while generating the batch @@ -190,9 +170,8 @@ public partial class Batch /// /// 1 /// - [JsonPropertyName("warnings")] - [JsonRequired] - public required int Warnings { get; set; } + [JsonPropertyName("warnings"), JsonInclude] + public int? Warnings { get; private set; } /// /// Custom notes you can add for each created batch @@ -201,17 +180,15 @@ public partial class Batch /// /// Batch for morning shipment /// - [JsonPropertyName("batch_notes")] - [JsonRequired] - public required string BatchNotes { get; set; } + [JsonPropertyName("batch_notes"), JsonInclude] + public string? BatchNotes { get; private set; } /// /// A string that uniquely identifies the external batch /// /// A string that uniquely identifies the external batch - [JsonPropertyName("external_batch_id")] - [JsonRequired] - public required string ExternalBatchId { get; set; } + [JsonPropertyName("external_batch_id"), JsonInclude] + public string? ExternalBatchId { get; private set; } /// /// The date and time the batch was processed in ShipEngine @@ -220,9 +197,8 @@ public partial class Batch /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("processed_at")] - [JsonRequired] - public required DateTimeOffset ProcessedAt { get; set; } + [JsonPropertyName("processed_at"), JsonInclude] + public DateTimeOffset? ProcessedAt { get; private set; } /// diff --git a/ShipEngineSDK/Model/BatchResponseError.cs b/ShipEngineSDK/Model/BatchResponseError.cs index f6694f54..2f989ac9 100644 --- a/ShipEngineSDK/Model/BatchResponseError.cs +++ b/ShipEngineSDK/Model/BatchResponseError.cs @@ -35,15 +35,15 @@ public partial class BatchResponseError /// /// Recipient address has not been verified. /// - [JsonPropertyName("error")] - public string? Error { get; set; } + [JsonPropertyName("error"), JsonInclude] + public string? Error { get; private set; } /// /// An external shipment id associated with the shipment /// /// An external shipment id associated with the shipment - [JsonPropertyName("external_shipment_id")] - public string? ExternalShipmentId { get; set; } + [JsonPropertyName("external_shipment_id"), JsonInclude] + public string? ExternalShipmentId { get; private set; } /// /// A string that uniquely identifies the shipment @@ -52,8 +52,8 @@ public partial class BatchResponseError /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string? ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private set; } /// diff --git a/ShipEngineSDK/Model/BatchStatus.cs b/ShipEngineSDK/Model/BatchStatus.cs index fa43248a..bba5579c 100644 --- a/ShipEngineSDK/Model/BatchStatus.cs +++ b/ShipEngineSDK/Model/BatchStatus.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(BatchStatusJsonConverter))] public class BatchStatus { - private string _value; + private readonly string _value; /// /// Create a new instance of BatchStatus with a predefined value. @@ -104,6 +104,12 @@ public BatchStatus(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is BatchStatus other && _value == other._value; } internal class BatchStatusJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/BatchesSortBy.cs b/ShipEngineSDK/Model/BatchesSortBy.cs index c5057a31..e9e60bcf 100644 --- a/ShipEngineSDK/Model/BatchesSortBy.cs +++ b/ShipEngineSDK/Model/BatchesSortBy.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(BatchesSortByJsonConverter))] public class BatchesSortBy { - private string _value; + private readonly string _value; /// /// Create a new instance of BatchesSortBy with a predefined value. @@ -74,6 +74,12 @@ public BatchesSortBy(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is BatchesSortBy other && _value == other._value; } internal class BatchesSortByJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/BillToParty.cs b/ShipEngineSDK/Model/BillToParty.cs index 42bca333..45ffd441 100644 --- a/ShipEngineSDK/Model/BillToParty.cs +++ b/ShipEngineSDK/Model/BillToParty.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(BillToPartyJsonConverter))] public class BillToParty { - private string _value; + private readonly string _value; /// /// Create a new instance of BillToParty with a predefined value. @@ -68,6 +68,12 @@ public BillToParty(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is BillToParty other && _value == other._value; } internal class BillToPartyJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/BulkRate.cs b/ShipEngineSDK/Model/BulkRate.cs index 8318941b..014a7290 100644 --- a/ShipEngineSDK/Model/BulkRate.cs +++ b/ShipEngineSDK/Model/BulkRate.cs @@ -29,12 +29,10 @@ public partial class BulkRate { /// - /// Gets or Sets Status CLOVUS + /// Gets or Sets Status /// - [JsonPropertyName("status")] - [JsonRequired] - public required RateResponseStatus Status { get; set; } = new(); - + [JsonPropertyName("status"), JsonInclude] + public RateResponseStatus? Status { get; private set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -43,17 +41,15 @@ public partial class BulkRate /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - [JsonRequired] - public required DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// An array of errors that were returned while retrieving the bulk rate /// /// An array of errors that were returned while retrieving the bulk rate - [JsonPropertyName("errors")] - [JsonRequired] - public required List Errors { get; set; } + [JsonPropertyName("errors"), JsonInclude] + public List? Errors { get; private set; } /// /// A string that uniquely identifies the rate request @@ -62,9 +58,8 @@ public partial class BulkRate /// /// se-28529731 /// - [JsonPropertyName("rate_request_id")] - [JsonRequired] - public required string RateRequestId { get; set; } + [JsonPropertyName("rate_request_id"), JsonInclude] + public string? RateRequestId { get; private set; } /// /// A string that uniquely identifies the shipment @@ -73,9 +68,8 @@ public partial class BulkRate /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - [JsonRequired] - public required string ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private set; } /// diff --git a/ShipEngineSDK/Model/CalculateRatesRequestBody.cs b/ShipEngineSDK/Model/CalculateRatesRequestBody.cs index 20bb603b..39c399f5 100644 --- a/ShipEngineSDK/Model/CalculateRatesRequestBody.cs +++ b/ShipEngineSDK/Model/CalculateRatesRequestBody.cs @@ -35,7 +35,7 @@ public partial class CalculateRatesRequestBody : AbstractOpenAPISchema /// The rate options /// /// The rate options - [JsonPropertyName("rate_options")] + [JsonPropertyName("rate_options"), JsonPropertyOrder(1)] public RateRequestBody? RateOptions { get; set; } diff --git a/ShipEngineSDK/Model/CalculateRatesResponseBody.cs b/ShipEngineSDK/Model/CalculateRatesResponseBody.cs index fbae3380..43e4e59f 100644 --- a/ShipEngineSDK/Model/CalculateRatesResponseBody.cs +++ b/ShipEngineSDK/Model/CalculateRatesResponseBody.cs @@ -29,43 +29,37 @@ public partial class CalculateRatesResponseBody { /// - /// The type of delivery confirmation that is required for this shipment. CLOVUS + /// The type of delivery confirmation that is required for this shipment. /// /// The type of delivery confirmation that is required for this shipment. - [JsonPropertyName("confirmation")] - [JsonRequired] - public required DeliveryConfirmation Confirmation { get; set; } = new(); - + [JsonPropertyName("confirmation"), JsonRequired, JsonPropertyOrder(2)] + public required DeliveryConfirmation Confirmation { get; set; } /// - /// The insurance provider to use for any insured packages in the shipment. CLOVUS + /// The insurance provider to use for any insured packages in the shipment. /// /// The insurance provider to use for any insured packages in the shipment. - [JsonPropertyName("insurance_provider")] - [JsonRequired] - public required InsuranceProvider InsuranceProvider { get; set; } = new(); - + [JsonPropertyName("insurance_provider"), JsonRequired, JsonPropertyOrder(4)] + public required InsuranceProvider InsuranceProvider { get; set; } /// - /// The current status of the shipment CLOVUS + /// The current status of the shipment /// /// The current status of the shipment - [JsonPropertyName("shipment_status")] - [JsonRequired] - public required ShipmentStatus ShipmentStatus { get; set; } = new(); - + [JsonPropertyName("shipment_status"), JsonInclude] + public ShipmentStatus? ShipmentStatus { get; private set; } /// - /// Gets or Sets OrderSourceCode CLOVUS + /// Gets or Sets OrderSourceCode /// - [JsonPropertyName("order_source_code")] + [JsonPropertyName("order_source_code"), JsonPropertyOrder(21)] public OrderSourceName? OrderSourceCode { get; set; } + /// /// Advanced shipment options. These are entirely optional. /// /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options")] - [JsonRequired] + [JsonPropertyName("advanced_options"), JsonRequired, JsonPropertyOrder(1)] public required AdvancedShipmentOptions AdvancedOptions { get; set; } /// @@ -75,9 +69,8 @@ public partial class CalculateRatesResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - [JsonRequired] - public required DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// The date and time that the shipment was created or last modified. @@ -86,32 +79,28 @@ public partial class CalculateRatesResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("modified_at")] - [JsonRequired] - public required DateTimeOffset ModifiedAt { get; set; } + [JsonPropertyName("modified_at"), JsonInclude] + public DateTimeOffset? ModifiedAt { get; private set; } /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - [JsonRequired] + [JsonPropertyName("packages"), JsonRequired, JsonPropertyOrder(6)] public required List Packages { get; set; } /// /// The rates response /// /// The rates response - [JsonPropertyName("rate_response")] - [JsonRequired] + [JsonPropertyName("rate_response"), JsonRequired, JsonPropertyOrder(7)] public required RatesInformation RateResponse { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. /// /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to")] - [JsonRequired] + [JsonPropertyName("return_to"), JsonRequired, JsonPropertyOrder(8)] public required ShippingAddress ReturnTo { get; set; } /// @@ -121,8 +110,7 @@ public partial class CalculateRatesResponseBody /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date")] - [JsonRequired] + [JsonPropertyName("ship_date"), JsonRequired, JsonPropertyOrder(9)] public required DateTimeOffset ShipDate { get; set; } /// @@ -132,25 +120,22 @@ public partial class CalculateRatesResponseBody /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - [JsonRequired] - public required string ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. - [JsonPropertyName("tags")] - [JsonRequired] - public required List Tags { get; set; } + [JsonPropertyName("tags"), JsonInclude] + public List? Tags { get; private set; } /// /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment - [JsonPropertyName("total_weight")] - [JsonRequired] - public required Weight TotalWeight { get; set; } + [JsonPropertyName("total_weight"), JsonInclude] + public Weight? TotalWeight { get; private set; } /// /// The carrier account that is billed for the shipping charges @@ -159,7 +144,7 @@ public partial class CalculateRatesResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] + [JsonPropertyName("carrier_id"), JsonPropertyOrder(14)] public string? CarrierId { get; set; } /// @@ -169,43 +154,42 @@ public partial class CalculateRatesResponseBody /// /// retail /// - [JsonPropertyName("comparison_rate_type")] + [JsonPropertyName("comparison_rate_type"), JsonPropertyOrder(15)] public string? ComparisonRateType { get; set; } /// /// Customs information. This is usually only needed for international shipments. /// /// Customs information. This is usually only needed for international shipments. - [JsonPropertyName("customs")] - [JsonRequired] + [JsonPropertyName("customs"), JsonRequired, JsonPropertyOrder(16)] public required InternationalShipmentOptions Customs { get; set; } /// /// ID that the Order Source assigned /// /// ID that the Order Source assigned - [JsonPropertyName("external_order_id")] + [JsonPropertyName("external_order_id"), JsonPropertyOrder(17)] public string? ExternalOrderId { get; set; } /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("external_shipment_id")] + [JsonPropertyName("external_shipment_id"), JsonPropertyOrder(18)] public string? ExternalShipmentId { get; set; } /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. - [JsonPropertyName("is_return")] + [JsonPropertyName("is_return"), JsonPropertyOrder(19)] public bool? IsReturn { get; set; } /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - [JsonPropertyName("items")] + [JsonPropertyName("items"), JsonPropertyOrder(20)] public List? Items { get; set; } /// @@ -215,28 +199,28 @@ public partial class CalculateRatesResponseBody /// /// usps_first_class_mail /// - [JsonPropertyName("service_code")] + [JsonPropertyName("service_code"), JsonPropertyOrder(22)] public string? ServiceCode { get; set; } /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from")] + [JsonPropertyName("ship_from"), JsonPropertyOrder(23)] public ShippingAddress? ShipFrom { get; set; } /// /// The recipient's mailing address /// /// The recipient's mailing address - [JsonPropertyName("ship_to")] + [JsonPropertyName("ship_to"), JsonPropertyOrder(24)] public ShippingAddressTo? ShipTo { get; set; } /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("shipment_number")] + [JsonPropertyName("shipment_number"), JsonPropertyOrder(25)] public string? ShipmentNumber { get; set; } /// @@ -246,13 +230,13 @@ public partial class CalculateRatesResponseBody /// /// se-28529731 /// - [JsonPropertyName("shipping_rule_id")] + [JsonPropertyName("shipping_rule_id"), JsonPropertyOrder(26)] public string? ShippingRuleId { get; set; } /// /// Gets or Sets TaxIdentifiers /// - [JsonPropertyName("tax_identifiers")] + [JsonPropertyName("tax_identifiers"), JsonPropertyOrder(27)] public List? TaxIdentifiers { get; set; } /// @@ -262,7 +246,7 @@ public partial class CalculateRatesResponseBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] + [JsonPropertyName("warehouse_id"), JsonPropertyOrder(28)] public string? WarehouseId { get; set; } diff --git a/ShipEngineSDK/Model/Carrier.cs b/ShipEngineSDK/Model/Carrier.cs index 1413a236..78ea7179 100644 --- a/ShipEngineSDK/Model/Carrier.cs +++ b/ShipEngineSDK/Model/Carrier.cs @@ -35,8 +35,8 @@ public partial class Carrier /// /// account_570827 /// - [JsonPropertyName("account_number")] - public string? AccountNumber { get; set; } + [JsonPropertyName("account_number"), JsonInclude] + public string? AccountNumber { get; private set; } /// /// Current available balance @@ -45,8 +45,8 @@ public partial class Carrier /// /// 3799.52 /// - [JsonPropertyName("balance")] - public double? Balance { get; set; } + [JsonPropertyName("balance"), JsonInclude] + public double? Balance { get; private set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. @@ -55,8 +55,8 @@ public partial class Carrier /// /// dhl_express /// - [JsonPropertyName("carrier_code")] - public string? CarrierCode { get; set; } + [JsonPropertyName("carrier_code"), JsonInclude] + public string? CarrierCode { get; private set; } /// /// A string that uniquely identifies the carrier. @@ -65,15 +65,15 @@ public partial class Carrier /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - public string? CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// The carrier is disabled by the current ShipEngine account's billing plan. /// /// The carrier is disabled by the current ShipEngine account's billing plan. - [JsonPropertyName("disabled_by_billing_plan")] - public bool? DisabledByBillingPlan { get; set; } + [JsonPropertyName("disabled_by_billing_plan"), JsonInclude] + public bool? DisabledByBillingPlan { get; private set; } /// /// Screen readable name @@ -82,15 +82,15 @@ public partial class Carrier /// /// Stamps.com /// - [JsonPropertyName("friendly_name")] - public string? FriendlyName { get; set; } + [JsonPropertyName("friendly_name"), JsonInclude] + public string? FriendlyName { get; private set; } /// /// Carrier supports multiple packages per shipment /// /// Carrier supports multiple packages per shipment - [JsonPropertyName("has_multi_package_supporting_services")] - public bool? HasMultiPackageSupportingServices { get; set; } + [JsonPropertyName("has_multi_package_supporting_services"), JsonInclude] + public bool? HasMultiPackageSupportingServices { get; private set; } /// /// Nickname given to the account when initially setting up the carrier. @@ -99,50 +99,50 @@ public partial class Carrier /// /// ShipEngine Account - Stamps.com /// - [JsonPropertyName("nickname")] - public string? Nickname { get; set; } + [JsonPropertyName("nickname"), JsonInclude] + public string? Nickname { get; private set; } /// /// A list of options that are available to that carrier /// /// A list of options that are available to that carrier - [JsonPropertyName("options")] - public List? Options { get; set; } + [JsonPropertyName("options"), JsonInclude] + public List? Options { get; private set; } /// /// A list of package types that are supported by the carrier /// /// A list of package types that are supported by the carrier - [JsonPropertyName("packages")] - public List? Packages { get; set; } + [JsonPropertyName("packages"), JsonInclude] + public List? Packages { get; private set; } /// /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation /// /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation - [JsonPropertyName("primary")] - public bool? Primary { get; set; } + [JsonPropertyName("primary"), JsonInclude] + public bool? Primary { get; private set; } /// /// Indicates whether the carrier requires funding to use its services /// /// Indicates whether the carrier requires funding to use its services - [JsonPropertyName("requires_funded_amount")] - public bool? RequiresFundedAmount { get; set; } + [JsonPropertyName("requires_funded_amount"), JsonInclude] + public bool? RequiresFundedAmount { get; private set; } /// /// A list of services that are offered by the carrier /// /// A list of services that are offered by the carrier - [JsonPropertyName("services")] - public List? Services { get; set; } + [JsonPropertyName("services"), JsonInclude] + public List? Services { get; private set; } /// /// The carrier supports adding custom label messages to an order. /// /// The carrier supports adding custom label messages to an order. - [JsonPropertyName("supports_label_messages")] - public bool? SupportsLabelMessages { get; set; } + [JsonPropertyName("supports_label_messages"), JsonInclude] + public bool? SupportsLabelMessages { get; private set; } /// diff --git a/ShipEngineSDK/Model/CarrierAdvancedOption.cs b/ShipEngineSDK/Model/CarrierAdvancedOption.cs index 85aecf6c..e6af5277 100644 --- a/ShipEngineSDK/Model/CarrierAdvancedOption.cs +++ b/ShipEngineSDK/Model/CarrierAdvancedOption.cs @@ -35,15 +35,15 @@ public partial class CarrierAdvancedOption /// /// false /// - [JsonPropertyName("default_value")] - public string? DefaultValue { get; set; } + [JsonPropertyName("default_value"), JsonInclude] + public string? DefaultValue { get; private set; } /// /// Description of option /// /// Description of option - [JsonPropertyName("description")] - public string? Description { get; set; } + [JsonPropertyName("description"), JsonInclude] + public string? Description { get; private set; } /// /// Name of advanced option @@ -52,8 +52,8 @@ public partial class CarrierAdvancedOption /// /// contains_alcohol /// - [JsonPropertyName("name")] - public string? Name { get; set; } + [JsonPropertyName("name"), JsonInclude] + public string? Name { get; private set; } /// diff --git a/ShipEngineSDK/Model/CarrierName.cs b/ShipEngineSDK/Model/CarrierName.cs index d69d9d9b..7ee91955 100644 --- a/ShipEngineSDK/Model/CarrierName.cs +++ b/ShipEngineSDK/Model/CarrierName.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(CarrierNameJsonConverter))] public class CarrierName { - private string _value; + private readonly string _value; /// /// Create a new instance of CarrierName with a predefined value. @@ -224,6 +224,12 @@ public CarrierName(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is CarrierName other && _value == other._value; } internal class CarrierNameJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/CarrierNameWithSettings.cs b/ShipEngineSDK/Model/CarrierNameWithSettings.cs index e804e283..33b47a7a 100644 --- a/ShipEngineSDK/Model/CarrierNameWithSettings.cs +++ b/ShipEngineSDK/Model/CarrierNameWithSettings.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(CarrierNameWithSettingsJsonConverter))] public class CarrierNameWithSettings { - private string _value; + private readonly string _value; /// /// Create a new instance of CarrierNameWithSettings with a predefined value. @@ -80,6 +80,12 @@ public CarrierNameWithSettings(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is CarrierNameWithSettings other && _value == other._value; } internal class CarrierNameWithSettingsJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/CollectOnDelivery.cs b/ShipEngineSDK/Model/CollectOnDelivery.cs index 90a3642d..9da6ff3c 100644 --- a/ShipEngineSDK/Model/CollectOnDelivery.cs +++ b/ShipEngineSDK/Model/CollectOnDelivery.cs @@ -29,14 +29,15 @@ public partial class CollectOnDelivery { /// - /// Gets or Sets PaymentType CLOVUS + /// Gets or Sets PaymentType /// - [JsonPropertyName("payment_type")] + [JsonPropertyName("payment_type"), JsonPropertyOrder(2)] public CollectOnDeliveryPaymentType? PaymentType { get; set; } + /// /// Gets or Sets PaymentAmount /// - [JsonPropertyName("payment_amount")] + [JsonPropertyName("payment_amount"), JsonPropertyOrder(1)] public PaymentAmount? PaymentAmount { get; set; } diff --git a/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs b/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs index 51a17df6..c0158aae 100644 --- a/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs +++ b/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(CollectOnDeliveryPaymentTypeJsonConverter))] public class CollectOnDeliveryPaymentType { - private string _value; + private readonly string _value; /// /// Create a new instance of CollectOnDeliveryPaymentType with a predefined value. @@ -80,6 +80,12 @@ public CollectOnDeliveryPaymentType(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is CollectOnDeliveryPaymentType other && _value == other._value; } internal class CollectOnDeliveryPaymentTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs b/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs index 3c788337..b2ff8076 100644 --- a/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs +++ b/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs @@ -35,8 +35,7 @@ public partial class CompareBulkRatesRequestBody : AbstractOpenAPISchema /// The rate options /// /// The rate options - [JsonPropertyName("rate_options")] - [JsonRequired] + [JsonPropertyName("rate_options"), JsonRequired, JsonPropertyOrder(1)] public required RateRequestBody RateOptions { get; set; } diff --git a/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs b/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs index ed3c9814..3da17feb 100644 --- a/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs @@ -35,24 +35,21 @@ public partial class ConnectAccessWorldwideRequestBody /// /// Stamps.com /// - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(1)] public required string Nickname { get; set; } /// /// Access Worldwide Password /// /// Access Worldwide Password - [JsonPropertyName("password")] - [JsonRequired] + [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(2)] public required string Password { get; set; } /// /// Access Worldwide Username /// /// Access Worldwide Username - [JsonPropertyName("username")] - [JsonRequired] + [JsonPropertyName("username"), JsonRequired, JsonPropertyOrder(3)] public required string Username { get; set; } diff --git a/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs b/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs index 6952f75b..6e941d48 100644 --- a/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs @@ -35,22 +35,19 @@ public partial class ConnectAmazonBuyShippingRequestBody /// /// john.doe@example.com /// - [JsonPropertyName("email")] - [JsonRequired] + [JsonPropertyName("email"), JsonRequired, JsonPropertyOrder(1)] public required string Email { get; set; } /// /// Gets or Sets MerchantSellerId /// - [JsonPropertyName("merchant_seller_id")] - [JsonRequired] + [JsonPropertyName("merchant_seller_id"), JsonRequired, JsonPropertyOrder(2)] public required string MerchantSellerId { get; set; } /// /// Gets or Sets MwsAuthToken /// - [JsonPropertyName("mws_auth_token")] - [JsonRequired] + [JsonPropertyName("mws_auth_token"), JsonRequired, JsonPropertyOrder(3)] public required string MwsAuthToken { get; set; } /// @@ -60,8 +57,7 @@ public partial class ConnectAmazonBuyShippingRequestBody /// /// Test Amazon Buy Shipping /// - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(4)] public required string Nickname { get; set; } diff --git a/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs b/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs index e1ad102e..8caf1968 100644 --- a/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs +++ b/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs @@ -32,8 +32,7 @@ public partial class ConnectAmazonShippingUk /// Amazon UK Shipping auth code. /// /// Amazon UK Shipping auth code. - [JsonPropertyName("auth_code")] - [JsonRequired] + [JsonPropertyName("auth_code"), JsonRequired, JsonPropertyOrder(1)] public required string AuthCode { get; set; } /// @@ -43,8 +42,7 @@ public partial class ConnectAmazonShippingUk /// /// Stamps.com /// - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] public required string Nickname { get; set; } diff --git a/ShipEngineSDK/Model/ConnectApcRequestBody.cs b/ShipEngineSDK/Model/ConnectApcRequestBody.cs index 2338f1de..c9826bbe 100644 --- a/ShipEngineSDK/Model/ConnectApcRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectApcRequestBody.cs @@ -35,8 +35,7 @@ public partial class ConnectApcRequestBody /// /// APC carrier account /// - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(1)] public required string Nickname { get; set; } /// @@ -46,8 +45,7 @@ public partial class ConnectApcRequestBody /// /// 12345 /// - [JsonPropertyName("password")] - [JsonRequired] + [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(2)] public required string Password { get; set; } /// @@ -57,8 +55,7 @@ public partial class ConnectApcRequestBody /// /// john_doe /// - [JsonPropertyName("username")] - [JsonRequired] + [JsonPropertyName("username"), JsonRequired, JsonPropertyOrder(3)] public required string Username { get; set; } diff --git a/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs b/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs index 4e6df419..8bd159e2 100644 --- a/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs @@ -32,24 +32,21 @@ public partial class ConnectAsendiaRequestBody /// Asendia account number /// /// Asendia account number - [JsonPropertyName("account_number")] - [JsonRequired] + [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// FTP password /// /// FTP password - [JsonPropertyName("ftp_password")] - [JsonRequired] + [JsonPropertyName("ftp_password"), JsonRequired, JsonPropertyOrder(2)] public required string FtpPassword { get; set; } /// /// FTP username /// /// FTP username - [JsonPropertyName("ftp_username")] - [JsonRequired] + [JsonPropertyName("ftp_username"), JsonRequired, JsonPropertyOrder(3)] public required string FtpUsername { get; set; } /// @@ -59,8 +56,7 @@ public partial class ConnectAsendiaRequestBody /// /// Asendia account /// - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(4)] public required string Nickname { get; set; } diff --git a/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs b/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs index 2484a496..bc27728b 100644 --- a/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs @@ -32,32 +32,28 @@ public partial class ConnectAustraliaPostRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number")] - [JsonRequired] + [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// API key /// /// API key - [JsonPropertyName("api_key")] - [JsonRequired] + [JsonPropertyName("api_key"), JsonRequired, JsonPropertyOrder(2)] public required string ApiKey { get; set; } /// /// API secret /// /// API secret - [JsonPropertyName("api_secret")] - [JsonRequired] + [JsonPropertyName("api_secret"), JsonRequired, JsonPropertyOrder(3)] public required string ApiSecret { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(4)] public required string Nickname { get; set; } diff --git a/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs b/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs index c19bee6e..7ab61a7e 100644 --- a/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs @@ -32,40 +32,35 @@ public partial class ConnectCanadaPostRequestBody /// Canada Post Account Number /// /// Canada Post Account Number - [JsonPropertyName("account_number")] - [JsonRequired] + [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Canada Post Account API Key /// /// Canada Post Account API Key - [JsonPropertyName("api_key")] - [JsonRequired] + [JsonPropertyName("api_key"), JsonRequired, JsonPropertyOrder(2)] public required string ApiKey { get; set; } /// /// Canada Post Account API Secret /// /// Canada Post Account API Secret - [JsonPropertyName("api_secret")] - [JsonRequired] + [JsonPropertyName("api_secret"), JsonRequired, JsonPropertyOrder(3)] public required string ApiSecret { get; set; } /// /// Canada Post Account Contract ID /// /// Canada Post Account Contract ID - [JsonPropertyName("contract_id")] - [JsonRequired] + [JsonPropertyName("contract_id"), JsonRequired, JsonPropertyOrder(4)] public required string ContractId { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(5)] public required string Nickname { get; set; } diff --git a/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs b/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs index 54da24cf..5bb665f4 100644 --- a/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs +++ b/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs @@ -35,8 +35,7 @@ public partial class ConnectCarrierResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [JsonRequired] + [JsonPropertyName("carrier_id"), JsonRequired, JsonPropertyOrder(1)] public required string CarrierId { get; set; } diff --git a/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs index 162b3c83..6c58f052 100644 --- a/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs @@ -29,113 +29,105 @@ public partial class ConnectDhlEcommerceRequestBody { /// - /// Gets or Sets AncillaryEndorsement CLOVUS + /// Gets or Sets AncillaryEndorsement /// - [JsonPropertyName("ancillary_endorsement")] + [JsonPropertyName("ancillary_endorsement"), JsonPropertyOrder(8)] public AncillaryServiceEndorsement? AncillaryEndorsement { get; set; } + /// /// The client id /// /// The client id - [JsonPropertyName("client_id")] - [JsonRequired] + [JsonPropertyName("client_id"), JsonRequired, JsonPropertyOrder(1)] public required string ClientId { get; set; } /// /// The distribution center /// /// The distribution center - [JsonPropertyName("distribution_center")] - [JsonRequired] + [JsonPropertyName("distribution_center"), JsonRequired, JsonPropertyOrder(2)] public required string DistributionCenter { get; set; } /// /// A nickname to help you identify this account /// /// A nickname to help you identify this account - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(3)] public required string Nickname { get; set; } /// /// The account password /// /// The account password - [JsonPropertyName("password")] - [JsonRequired] + [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(4)] public required string Password { get; set; } /// /// The pickup number /// /// The pickup number - [JsonPropertyName("pickup_number")] - [JsonRequired] + [JsonPropertyName("pickup_number"), JsonRequired, JsonPropertyOrder(5)] public required string PickupNumber { get; set; } /// /// The account username /// /// The account username - [JsonPropertyName("username")] - [JsonRequired] + [JsonPropertyName("username"), JsonRequired, JsonPropertyOrder(6)] public required string Username { get; set; } /// /// Account number /// /// Account number - [JsonPropertyName("account_number")] - [Obsolete] + [JsonPropertyName("account_number"), JsonPropertyOrder(7), Obsolete] public string? AccountNumber { get; set; } /// /// The DHL E-Commerce API key. This field is optional, but if not set you will not be able to get rates for this account. /// /// The DHL E-Commerce API key. This field is optional, but if not set you will not be able to get rates for this account. - [JsonPropertyName("api_key")] + [JsonPropertyName("api_key"), JsonPropertyOrder(9)] public string? ApiKey { get; set; } /// /// The DHL E-Commerce API secret. This field is optional, but if not set you will not be able to get rates for this account. /// /// The DHL E-Commerce API secret. This field is optional, but if not set you will not be able to get rates for this account. - [JsonPropertyName("api_secret")] + [JsonPropertyName("api_secret"), JsonPropertyOrder(10)] public string? ApiSecret { get; set; } /// /// FTP password /// /// FTP password - [JsonPropertyName("ftp_password")] - [Obsolete] + [JsonPropertyName("ftp_password"), JsonPropertyOrder(11), Obsolete] public string? FtpPassword { get; set; } /// /// FTP username /// /// FTP username - [JsonPropertyName("ftp_username")] - [Obsolete] + [JsonPropertyName("ftp_username"), JsonPropertyOrder(12), Obsolete] public string? FtpUsername { get; set; } /// /// Gets or Sets RegistrationId /// - [JsonPropertyName("registration_id")] + [JsonPropertyName("registration_id"), JsonPropertyOrder(13)] public string? RegistrationId { get; set; } /// /// Gets or Sets SoftwareName /// - [JsonPropertyName("software_name")] + [JsonPropertyName("software_name"), JsonPropertyOrder(14)] public string? SoftwareName { get; set; } /// /// Sold To field /// /// Sold To field - [JsonPropertyName("sold_to")] + [JsonPropertyName("sold_to"), JsonPropertyOrder(15)] public string? SoldTo { get; set; } diff --git a/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs index 4c9f029c..a2a8477e 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs @@ -32,16 +32,14 @@ public partial class ConnectDhlExpressAuRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number")] - [JsonRequired] + [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] public required string Nickname { get; set; } diff --git a/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs index 32b447f3..2ea1a316 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs @@ -32,16 +32,14 @@ public partial class ConnectDhlExpressCaRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number")] - [JsonRequired] + [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] public required string Nickname { get; set; } diff --git a/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs index ce0820af..9a491b30 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs @@ -32,16 +32,14 @@ public partial class ConnectDhlExpressRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number")] - [JsonRequired] + [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] public required string Nickname { get; set; } /// @@ -51,21 +49,21 @@ public partial class ConnectDhlExpressRequestBody /// /// CA /// - [JsonPropertyName("country_code")] + [JsonPropertyName("country_code"), JsonPropertyOrder(3)] public string? CountryCode { get; set; } /// /// Required if site id is provided /// /// Required if site id is provided - [JsonPropertyName("password")] + [JsonPropertyName("password"), JsonPropertyOrder(4)] public string? Password { get; set; } /// /// Required if password is provided /// /// Required if password is provided - [JsonPropertyName("site_id")] + [JsonPropertyName("site_id"), JsonPropertyOrder(5)] public string? SiteId { get; set; } diff --git a/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs index edefd45a..519e0fe1 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs @@ -32,24 +32,21 @@ public partial class ConnectDhlExpressUkRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number")] - [JsonRequired] + [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] public required string Nickname { get; set; } /// /// Password /// /// Password - [JsonPropertyName("password")] - [JsonRequired] + [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(3)] public required string Password { get; set; } /// @@ -59,8 +56,7 @@ public partial class ConnectDhlExpressUkRequestBody /// /// se-28529731 /// - [JsonPropertyName("site_id")] - [JsonRequired] + [JsonPropertyName("site_id"), JsonRequired, JsonPropertyOrder(4)] public required string SiteId { get; set; } diff --git a/ShipEngineSDK/Model/ConnectDpdRequestBody.cs b/ShipEngineSDK/Model/ConnectDpdRequestBody.cs index ae14627e..8e6b4b71 100644 --- a/ShipEngineSDK/Model/ConnectDpdRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDpdRequestBody.cs @@ -32,24 +32,21 @@ public partial class ConnectDpdRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number")] - [JsonRequired] + [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] public required string Nickname { get; set; } /// /// Password /// /// Password - [JsonPropertyName("password")] - [JsonRequired] + [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(3)] public required string Password { get; set; } diff --git a/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs b/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs index 6e52b5b1..e2821afd 100644 --- a/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs @@ -32,24 +32,21 @@ public partial class ConnectEndiciaRequestBody /// Account /// /// Account - [JsonPropertyName("account")] - [JsonRequired] + [JsonPropertyName("account"), JsonRequired, JsonPropertyOrder(1)] public required string Account { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] public required string Nickname { get; set; } /// /// Passphrase /// /// Passphrase - [JsonPropertyName("passphrase")] - [JsonRequired] + [JsonPropertyName("passphrase"), JsonRequired, JsonPropertyOrder(3)] public required string Passphrase { get; set; } diff --git a/ShipEngineSDK/Model/ConnectFedexRequestBody.cs b/ShipEngineSDK/Model/ConnectFedexRequestBody.cs index 2d5a8ff5..b165fb34 100644 --- a/ShipEngineSDK/Model/ConnectFedexRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectFedexRequestBody.cs @@ -32,40 +32,35 @@ public partial class ConnectFedexRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number")] - [JsonRequired] + [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Address /// /// Address - [JsonPropertyName("address1")] - [JsonRequired] + [JsonPropertyName("address1"), JsonRequired, JsonPropertyOrder(2)] public required string Address1 { get; set; } /// /// Boolean signaling agreement to the Fedex End User License Agreement /// /// Boolean signaling agreement to the Fedex End User License Agreement - [JsonPropertyName("agree_to_eula")] - [JsonRequired] + [JsonPropertyName("agree_to_eula"), JsonRequired, JsonPropertyOrder(3)] public required bool AgreeToEula { get; set; } /// /// The city /// /// The city - [JsonPropertyName("city")] - [JsonRequired] + [JsonPropertyName("city"), JsonRequired, JsonPropertyOrder(4)] public required string City { get; set; } /// /// Country code /// /// Country code - [JsonPropertyName("country_code")] - [JsonRequired] + [JsonPropertyName("country_code"), JsonRequired, JsonPropertyOrder(5)] public required string CountryCode { get; set; } /// @@ -75,77 +70,70 @@ public partial class ConnectFedexRequestBody /// /// john.doe@example.com /// - [JsonPropertyName("email")] - [JsonRequired] + [JsonPropertyName("email"), JsonRequired, JsonPropertyOrder(6)] public required string Email { get; set; } /// /// First name /// /// First name - [JsonPropertyName("first_name")] - [JsonRequired] + [JsonPropertyName("first_name"), JsonRequired, JsonPropertyOrder(7)] public required string FirstName { get; set; } /// /// Last name /// /// Last name - [JsonPropertyName("last_name")] - [JsonRequired] + [JsonPropertyName("last_name"), JsonRequired, JsonPropertyOrder(8)] public required string LastName { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(9)] public required string Nickname { get; set; } /// /// Phone number /// /// Phone number - [JsonPropertyName("phone")] - [JsonRequired] + [JsonPropertyName("phone"), JsonRequired, JsonPropertyOrder(10)] public required string Phone { get; set; } /// /// Postal Code /// /// Postal Code - [JsonPropertyName("postal_code")] - [JsonRequired] + [JsonPropertyName("postal_code"), JsonRequired, JsonPropertyOrder(11)] public required string PostalCode { get; set; } /// /// State /// /// State - [JsonPropertyName("state")] - [JsonRequired] + [JsonPropertyName("state"), JsonRequired, JsonPropertyOrder(12)] public required string State { get; set; } /// /// Address /// /// Address - [JsonPropertyName("address2")] + [JsonPropertyName("address2"), JsonPropertyOrder(13)] public string? Address2 { get; set; } /// /// The company /// /// The company - [JsonPropertyName("company")] + [JsonPropertyName("company"), JsonPropertyOrder(14)] public string? Company { get; set; } /// /// Meter number /// /// Meter number - [JsonPropertyName("meter_number")] + [JsonPropertyName("meter_number"), JsonPropertyOrder(15)] public string? MeterNumber { get; set; } diff --git a/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs b/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs index e45beada..a36439b6 100644 --- a/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs @@ -32,40 +32,35 @@ public partial class ConnectFedexUkRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number")] - [JsonRequired] + [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Address /// /// Address - [JsonPropertyName("address1")] - [JsonRequired] + [JsonPropertyName("address1"), JsonRequired, JsonPropertyOrder(2)] public required string Address1 { get; set; } /// /// Boolean signaling agreement to the Fedex End User License Agreement /// /// Boolean signaling agreement to the Fedex End User License Agreement - [JsonPropertyName("agree_to_eula")] - [JsonRequired] + [JsonPropertyName("agree_to_eula"), JsonRequired, JsonPropertyOrder(3)] public required bool AgreeToEula { get; set; } /// /// The city /// /// The city - [JsonPropertyName("city")] - [JsonRequired] + [JsonPropertyName("city"), JsonRequired, JsonPropertyOrder(4)] public required string City { get; set; } /// /// Country code /// /// Country code - [JsonPropertyName("country_code")] - [JsonRequired] + [JsonPropertyName("country_code"), JsonRequired, JsonPropertyOrder(5)] public required string CountryCode { get; set; } /// @@ -75,77 +70,70 @@ public partial class ConnectFedexUkRequestBody /// /// john.doe@example.com /// - [JsonPropertyName("email")] - [JsonRequired] + [JsonPropertyName("email"), JsonRequired, JsonPropertyOrder(6)] public required string Email { get; set; } /// /// First name /// /// First name - [JsonPropertyName("first_name")] - [JsonRequired] + [JsonPropertyName("first_name"), JsonRequired, JsonPropertyOrder(7)] public required string FirstName { get; set; } /// /// Last name /// /// Last name - [JsonPropertyName("last_name")] - [JsonRequired] + [JsonPropertyName("last_name"), JsonRequired, JsonPropertyOrder(8)] public required string LastName { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(9)] public required string Nickname { get; set; } /// /// Phone number /// /// Phone number - [JsonPropertyName("phone")] - [JsonRequired] + [JsonPropertyName("phone"), JsonRequired, JsonPropertyOrder(10)] public required string Phone { get; set; } /// /// Postal Code /// /// Postal Code - [JsonPropertyName("postal_code")] - [JsonRequired] + [JsonPropertyName("postal_code"), JsonRequired, JsonPropertyOrder(11)] public required string PostalCode { get; set; } /// /// State /// /// State - [JsonPropertyName("state")] - [JsonRequired] + [JsonPropertyName("state"), JsonRequired, JsonPropertyOrder(12)] public required string State { get; set; } /// /// Address /// /// Address - [JsonPropertyName("address2")] + [JsonPropertyName("address2"), JsonPropertyOrder(13)] public string? Address2 { get; set; } /// /// The company /// /// The company - [JsonPropertyName("company")] + [JsonPropertyName("company"), JsonPropertyOrder(14)] public string? Company { get; set; } /// /// Meter number /// /// Meter number - [JsonPropertyName("meter_number")] + [JsonPropertyName("meter_number"), JsonPropertyOrder(15)] public string? MeterNumber { get; set; } diff --git a/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs b/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs index 52e9704a..56679bd8 100644 --- a/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs @@ -35,31 +35,28 @@ public partial class ConnectFirstmileRequestBody /// /// se-28529731 /// - [JsonPropertyName("mailer_id")] - [JsonRequired] + [JsonPropertyName("mailer_id"), JsonRequired, JsonPropertyOrder(1)] public required string MailerId { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] public required string Nickname { get; set; } /// /// Password /// /// Password - [JsonPropertyName("password")] - [JsonRequired] + [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(3)] public required string Password { get; set; } /// /// Profile name /// /// Profile name - [JsonPropertyName("profile_name")] + [JsonPropertyName("profile_name"), JsonPropertyOrder(4)] public string? ProfileName { get; set; } diff --git a/ShipEngineSDK/Model/ConnectImexRequestBody.cs b/ShipEngineSDK/Model/ConnectImexRequestBody.cs index c8399f51..5c35bd41 100644 --- a/ShipEngineSDK/Model/ConnectImexRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectImexRequestBody.cs @@ -32,24 +32,21 @@ public partial class ConnectImexRequestBody /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(1)] public required string Nickname { get; set; } /// /// Password /// /// Password - [JsonPropertyName("password")] - [JsonRequired] + [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(2)] public required string Password { get; set; } /// /// Username /// /// Username - [JsonPropertyName("username")] - [JsonRequired] + [JsonPropertyName("username"), JsonRequired, JsonPropertyOrder(3)] public required string Username { get; set; } diff --git a/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs b/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs index 31ec8aa0..5f421097 100644 --- a/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs @@ -35,15 +35,13 @@ public partial class ConnectInsurerRequestBody /// /// john.doe@example.com /// - [JsonPropertyName("email")] - [JsonRequired] + [JsonPropertyName("email"), JsonRequired, JsonPropertyOrder(1)] public required string Email { get; set; } /// /// Gets or Sets PolicyId /// - [JsonPropertyName("policy_id")] - [JsonRequired] + [JsonPropertyName("policy_id"), JsonRequired, JsonPropertyOrder(2)] public required string PolicyId { get; set; } diff --git a/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs b/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs index 077d3dce..b06e82fb 100644 --- a/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs @@ -32,192 +32,182 @@ public partial class ConnectLasershipRequestBody /// Address /// /// Address - [JsonPropertyName("Address")] - [JsonRequired] + [JsonPropertyName("Address"), JsonRequired, JsonPropertyOrder(1)] public required string Address { get; set; } /// /// City /// /// City - [JsonPropertyName("City")] - [JsonRequired] + [JsonPropertyName("City"), JsonRequired, JsonPropertyOrder(2)] public required string City { get; set; } /// /// Customer Branch /// /// Customer Branch - [JsonPropertyName("customer_branch")] - [JsonRequired] + [JsonPropertyName("customer_branch"), JsonRequired, JsonPropertyOrder(3)] public required string CustomerBranch { get; set; } /// /// Critical Entry Time (local time) /// /// Critical Entry Time (local time) - [JsonPropertyName("lasership_critical_entry_time")] - [JsonRequired] + [JsonPropertyName("lasership_critical_entry_time"), JsonRequired, JsonPropertyOrder(4)] public required string LasershipCriticalEntryTime { get; set; } /// /// Critical Pull Time (local time) /// /// Critical Pull Time (local time) - [JsonPropertyName("lasership_critical_pull_time")] - [JsonRequired] + [JsonPropertyName("lasership_critical_pull_time"), JsonRequired, JsonPropertyOrder(5)] public required string LasershipCriticalPullTime { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(6)] public required string Nickname { get; set; } /// /// PostalCode /// /// PostalCode - [JsonPropertyName("PostalCode")] - [JsonRequired] + [JsonPropertyName("PostalCode"), JsonRequired, JsonPropertyOrder(7)] public required string PostalCode { get; set; } /// /// State /// /// State - [JsonPropertyName("State")] - [JsonRequired] + [JsonPropertyName("State"), JsonRequired, JsonPropertyOrder(8)] public required string State { get; set; } /// /// Web Service ID (WSID) /// /// Web Service ID (WSID) - [JsonPropertyName("web_services_id")] - [JsonRequired] + [JsonPropertyName("web_services_id"), JsonRequired, JsonPropertyOrder(9)] public required string WebServicesId { get; set; } /// /// Web Service Key (WSKey) /// /// Web Service Key (WSKey) - [JsonPropertyName("web_services_key")] - [JsonRequired] + [JsonPropertyName("web_services_key"), JsonRequired, JsonPropertyOrder(10)] public required string WebServicesKey { get; set; } /// /// Address2 /// /// Address2 - [JsonPropertyName("Address2")] + [JsonPropertyName("Address2"), JsonPropertyOrder(11)] public string? Address2 { get; set; } /// /// Set this to true if your shipments will always contain Alcohol /// /// Set this to true if your shipments will always contain Alcohol - [JsonPropertyName("AttrAlcohol")] + [JsonPropertyName("AttrAlcohol"), JsonPropertyOrder(12)] public bool? AttrAlcohol { get; set; } /// /// Set this to true if your shipments will always contain Controlled Substances /// /// Set this to true if your shipments will always contain Controlled Substances - [JsonPropertyName("AttrControlledSubstance")] + [JsonPropertyName("AttrControlledSubstance"), JsonPropertyOrder(13)] public bool? AttrControlledSubstance { get; set; } /// /// Set this to true if your shipments will always contain DryIce /// /// Set this to true if your shipments will always contain DryIce - [JsonPropertyName("AttrDryIce")] + [JsonPropertyName("AttrDryIce"), JsonPropertyOrder(14)] public bool? AttrDryIce { get; set; } /// /// Set this to true if your shipments will always contain Explosives /// /// Set this to true if your shipments will always contain Explosives - [JsonPropertyName("AttrExplosive")] + [JsonPropertyName("AttrExplosive"), JsonPropertyOrder(15)] public bool? AttrExplosive { get; set; } /// /// Set this to true if your shipments will always contain Hazmat /// /// Set this to true if your shipments will always contain Hazmat - [JsonPropertyName("AttrHazmat")] + [JsonPropertyName("AttrHazmat"), JsonPropertyOrder(16)] public bool? AttrHazmat { get; set; } /// /// Set this to true if your shipments will always use \"No Return To Sender\" /// /// Set this to true if your shipments will always use \"No Return To Sender\" - [JsonPropertyName("AttrNoRTS")] + [JsonPropertyName("AttrNoRTS"), JsonPropertyOrder(17)] public bool? AttrNoRTS { get; set; } /// /// Set this to true if your shipments will always be Perishable /// /// Set this to true if your shipments will always be Perishable - [JsonPropertyName("AttrPerishable")] + [JsonPropertyName("AttrPerishable"), JsonPropertyOrder(18)] public bool? AttrPerishable { get; set; } /// /// Set this to true if your shipments will always require Refrigeration /// /// Set this to true if your shipments will always require Refrigeration - [JsonPropertyName("AttrRefrigerated")] + [JsonPropertyName("AttrRefrigerated"), JsonPropertyOrder(19)] public bool? AttrRefrigerated { get; set; } /// /// Set this to true if your shipments will always require Two Persons /// /// Set this to true if your shipments will always require Two Persons - [JsonPropertyName("AttrTwoPersons")] + [JsonPropertyName("AttrTwoPersons"), JsonPropertyOrder(20)] public bool? AttrTwoPersons { get; set; } /// /// Country /// /// Country - [JsonPropertyName("country")] + [JsonPropertyName("country"), JsonPropertyOrder(21)] public string? Country { get; set; } /// /// Declare piece attributes separately for every shipment, overrides individual attribute below. /// /// Declare piece attributes separately for every shipment, overrides individual attribute below. - [JsonPropertyName("declare_piece_attributes_separately_for_every_shipment")] + [JsonPropertyName("declare_piece_attributes_separately_for_every_shipment"), JsonPropertyOrder(22)] public bool? DeclarePieceAttributesSeparatelyForEveryShipment { get; set; } /// /// Email /// /// Email - [JsonPropertyName("Email")] + [JsonPropertyName("Email"), JsonPropertyOrder(23)] public string? Email { get; set; } /// /// Facility Code /// /// Facility Code - [JsonPropertyName("facility_code")] + [JsonPropertyName("facility_code"), JsonPropertyOrder(24)] public string? FacilityCode { get; set; } /// /// Instructions /// /// Instructions - [JsonPropertyName("instructions")] + [JsonPropertyName("instructions"), JsonPropertyOrder(25)] public string? Instructions { get; set; } /// /// Phone /// /// Phone - [JsonPropertyName("Phone")] + [JsonPropertyName("Phone"), JsonPropertyOrder(26)] public string? Phone { get; set; } diff --git a/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs b/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs index dd0e3b5b..5b79e5e8 100644 --- a/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs @@ -32,30 +32,28 @@ public partial class ConnectNewgisticsRequestBody /// Induction site /// /// Induction site - [JsonPropertyName("induction_site")] - [JsonRequired] + [JsonPropertyName("induction_site"), JsonRequired, JsonPropertyOrder(1)] public required string InductionSite { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] public required string Nickname { get; set; } /// /// Mailer id /// /// Mailer id - [JsonPropertyName("mailer_id")] + [JsonPropertyName("mailer_id"), JsonPropertyOrder(3)] public int? MailerId { get; set; } /// /// Merchant id /// /// Merchant id - [JsonPropertyName("merchant_id")] + [JsonPropertyName("merchant_id"), JsonPropertyOrder(4)] public int? MerchantId { get; set; } diff --git a/ShipEngineSDK/Model/ConnectOntracRequestBody.cs b/ShipEngineSDK/Model/ConnectOntracRequestBody.cs index 980099e9..2846350b 100644 --- a/ShipEngineSDK/Model/ConnectOntracRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectOntracRequestBody.cs @@ -32,24 +32,21 @@ public partial class ConnectOntracRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number")] - [JsonRequired] + [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] public required string Nickname { get; set; } /// /// Password /// /// Password - [JsonPropertyName("password")] - [JsonRequired] + [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(3)] public required string Password { get; set; } diff --git a/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs b/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs index 8f6c5fec..29772f2a 100644 --- a/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs @@ -32,24 +32,21 @@ public partial class ConnectPurolatorRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number")] - [JsonRequired] + [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Activation key /// /// Activation key - [JsonPropertyName("activation_key")] - [JsonRequired] + [JsonPropertyName("activation_key"), JsonRequired, JsonPropertyOrder(2)] public required string ActivationKey { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(3)] public required string Nickname { get; set; } diff --git a/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs b/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs index 15b376c5..b96c6a9a 100644 --- a/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs @@ -32,47 +32,42 @@ public partial class ConnectRoyalMailRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number")] - [JsonRequired] + [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// City /// /// City - [JsonPropertyName("city")] - [JsonRequired] + [JsonPropertyName("city"), JsonRequired, JsonPropertyOrder(2)] public required string City { get; set; } /// /// Contact name /// /// Contact name - [JsonPropertyName("contact_name")] - [JsonRequired] + [JsonPropertyName("contact_name"), JsonRequired, JsonPropertyOrder(3)] public required string ContactName { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(4)] public required string Nickname { get; set; } /// /// Postal code /// /// Postal code - [JsonPropertyName("postal_code")] - [JsonRequired] + [JsonPropertyName("postal_code"), JsonRequired, JsonPropertyOrder(5)] public required string PostalCode { get; set; } /// /// Company name /// /// Company name - [JsonPropertyName("company_name")] + [JsonPropertyName("company_name"), JsonPropertyOrder(6)] public string? CompanyName { get; set; } /// @@ -82,7 +77,7 @@ public partial class ConnectRoyalMailRequestBody /// /// john.doe@example.com /// - [JsonPropertyName("email")] + [JsonPropertyName("email"), JsonPropertyOrder(7)] public string? Email { get; set; } /// @@ -92,35 +87,35 @@ public partial class ConnectRoyalMailRequestBody /// /// john.doe@example.com /// - [JsonPropertyName("oba_email")] + [JsonPropertyName("oba_email"), JsonPropertyOrder(8)] public string? ObaEmail { get; set; } /// /// Phone /// /// Phone - [JsonPropertyName("phone")] + [JsonPropertyName("phone"), JsonPropertyOrder(9)] public string? Phone { get; set; } /// /// Street line1 /// /// Street line1 - [JsonPropertyName("street_line1")] + [JsonPropertyName("street_line1"), JsonPropertyOrder(10)] public string? StreetLine1 { get; set; } /// /// Street line2 /// /// Street line2 - [JsonPropertyName("street_line2")] + [JsonPropertyName("street_line2"), JsonPropertyOrder(11)] public string? StreetLine2 { get; set; } /// /// Street line3 /// /// Street line3 - [JsonPropertyName("street_line3")] + [JsonPropertyName("street_line3"), JsonPropertyOrder(12)] public string? StreetLine3 { get; set; } diff --git a/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs b/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs index 6b507250..79fc7e5b 100644 --- a/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs @@ -32,24 +32,21 @@ public partial class ConnectRrDonnelleyRequestBody /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(1)] public required string Nickname { get; set; } /// /// Password /// /// Password - [JsonPropertyName("password")] - [JsonRequired] + [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(2)] public required string Password { get; set; } /// /// Username /// /// Username - [JsonPropertyName("username")] - [JsonRequired] + [JsonPropertyName("username"), JsonRequired, JsonPropertyOrder(3)] public required string Username { get; set; } diff --git a/ShipEngineSDK/Model/ConnectSekoRequestBody.cs b/ShipEngineSDK/Model/ConnectSekoRequestBody.cs index eaeeec9a..58cfedf2 100644 --- a/ShipEngineSDK/Model/ConnectSekoRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectSekoRequestBody.cs @@ -32,16 +32,14 @@ public partial class ConnectSekoRequestBody /// Seko Account Access Key /// /// Seko Account Access Key - [JsonPropertyName("access_key")] - [JsonRequired] + [JsonPropertyName("access_key"), JsonRequired, JsonPropertyOrder(1)] public required string AccessKey { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] public required string Nickname { get; set; } diff --git a/ShipEngineSDK/Model/ConnectSendleRequestBody.cs b/ShipEngineSDK/Model/ConnectSendleRequestBody.cs index 398ffa35..00449944 100644 --- a/ShipEngineSDK/Model/ConnectSendleRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectSendleRequestBody.cs @@ -32,16 +32,14 @@ public partial class ConnectSendleRequestBody /// API key /// /// API key - [JsonPropertyName("api_key")] - [JsonRequired] + [JsonPropertyName("api_key"), JsonRequired, JsonPropertyOrder(1)] public required string ApiKey { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] public required string Nickname { get; set; } /// @@ -51,8 +49,7 @@ public partial class ConnectSendleRequestBody /// /// se-28529731 /// - [JsonPropertyName("sendle_id")] - [JsonRequired] + [JsonPropertyName("sendle_id"), JsonRequired, JsonPropertyOrder(3)] public required string SendleId { get; set; } diff --git a/ShipEngineSDK/Model/ConnectStampsRequestBody.cs b/ShipEngineSDK/Model/ConnectStampsRequestBody.cs index 57204aa8..172422c9 100644 --- a/ShipEngineSDK/Model/ConnectStampsRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectStampsRequestBody.cs @@ -32,24 +32,21 @@ public partial class ConnectStampsRequestBody /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(1)] public required string Nickname { get; set; } /// /// Password /// /// Password - [JsonPropertyName("password")] - [JsonRequired] + [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(2)] public required string Password { get; set; } /// /// Username /// /// Username - [JsonPropertyName("username")] - [JsonRequired] + [JsonPropertyName("username"), JsonRequired, JsonPropertyOrder(3)] public required string Username { get; set; } diff --git a/ShipEngineSDK/Model/ConnectUpsRequestBody.cs b/ShipEngineSDK/Model/ConnectUpsRequestBody.cs index ca9829bb..bffdc58e 100644 --- a/ShipEngineSDK/Model/ConnectUpsRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectUpsRequestBody.cs @@ -32,16 +32,14 @@ public partial class ConnectUpsRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number")] - [JsonRequired] + [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname")] - [JsonRequired] + [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] public required string Nickname { get; set; } diff --git a/ShipEngineSDK/Model/ContactDetails.cs b/ShipEngineSDK/Model/ContactDetails.cs index a9d66ae8..3fbf01c4 100644 --- a/ShipEngineSDK/Model/ContactDetails.cs +++ b/ShipEngineSDK/Model/ContactDetails.cs @@ -35,23 +35,20 @@ public partial class ContactDetails /// /// john.doe@example.com /// - [JsonPropertyName("email")] - [JsonRequired] + [JsonPropertyName("email"), JsonRequired, JsonPropertyOrder(1)] public required string Email { get; set; } /// /// Gets or Sets Name /// - [JsonPropertyName("name")] - [JsonRequired] + [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(2)] public required string Name { get; set; } /// /// Phone number associated /// /// Phone number associated - [JsonPropertyName("phone")] - [JsonRequired] + [JsonPropertyName("phone"), JsonRequired, JsonPropertyOrder(3)] public required string Phone { get; set; } diff --git a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs index cc9e777a..d6fe4c04 100644 --- a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs @@ -89,13 +89,11 @@ public override bool CanConvert(Type typeToConvert) => /// - /// The image type CLOVUS + /// The image type /// /// The image type - [JsonPropertyName("image_content_type")] - [JsonRequired] - public required ImageContentTypeEnum ImageContentType { get; set; } = new(); - + [JsonPropertyName("image_content_type"), JsonRequired, JsonPropertyOrder(1)] + public required ImageContentTypeEnum ImageContentType { get; set; } /// /// A base64 encoded string representation of the image. @@ -104,8 +102,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg== /// - [JsonPropertyName("image_data")] - [JsonRequired] + [JsonPropertyName("image_data"), JsonRequired, JsonPropertyOrder(2)] public required string ImageData { get; set; } /// @@ -115,8 +112,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// My logo /// - [JsonPropertyName("name")] - [JsonRequired] + [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(3)] public required string Name { get; set; } /// @@ -126,8 +122,8 @@ public override bool CanConvert(Type typeToConvert) => /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// Indicates whether this image is set as default. @@ -136,7 +132,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// false /// - [JsonPropertyName("is_default")] + [JsonPropertyName("is_default"), JsonPropertyOrder(5)] public bool? IsDefault { get; set; } /// @@ -146,8 +142,8 @@ public override bool CanConvert(Type typeToConvert) => /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id")] - public string? LabelImageId { get; set; } + [JsonPropertyName("label_image_id"), JsonInclude] + public string? LabelImageId { get; private set; } /// /// The date and time that the image was modified in ShipEngine. @@ -156,8 +152,8 @@ public override bool CanConvert(Type typeToConvert) => /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("modified_at")] - public DateTimeOffset? ModifiedAt { get; set; } + [JsonPropertyName("modified_at"), JsonInclude] + public DateTimeOffset? ModifiedAt { get; private set; } /// diff --git a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs index 242f45f8..a69a8cbe 100644 --- a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs +++ b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs @@ -35,7 +35,7 @@ public partial class CreateAndProcessBatchRequestBody /// /// This is my batch /// - [JsonPropertyName("batch_notes")] + [JsonPropertyName("batch_notes"), JsonPropertyOrder(1)] public string? BatchNotes { get; set; } /// @@ -45,27 +45,27 @@ public partial class CreateAndProcessBatchRequestBody /// /// se-28529731 /// - [JsonPropertyName("external_batch_id")] + [JsonPropertyName("external_batch_id"), JsonPropertyOrder(2)] public string? ExternalBatchId { get; set; } /// /// Gets or Sets ProcessLabels /// - [JsonPropertyName("process_labels")] + [JsonPropertyName("process_labels"), JsonPropertyOrder(3)] public CreateAndProcessBatchRequestBodyProcessLabels? ProcessLabels { get; set; } /// /// Array of rate IDs used in the batch /// /// Array of rate IDs used in the batch - [JsonPropertyName("rate_ids")] + [JsonPropertyName("rate_ids"), JsonPropertyOrder(4)] public List? RateIds { get; set; } /// /// Array of shipment IDs used in the batch /// /// Array of shipment IDs used in the batch - [JsonPropertyName("shipment_ids")] + [JsonPropertyName("shipment_ids"), JsonPropertyOrder(5)] public List? ShipmentIds { get; set; } diff --git a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs index 06fece9b..e0961fb6 100644 --- a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs +++ b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs @@ -29,26 +29,29 @@ public partial class CreateAndProcessBatchRequestBodyProcessLabels { /// - /// The display format that the label should be shown in. CLOVUS + /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(2)] public DisplayScheme? DisplayScheme { get; set; } + /// - /// Gets or Sets LabelFormat CLOVUS + /// Gets or Sets LabelFormat /// - [JsonPropertyName("label_format")] + [JsonPropertyName("label_format"), JsonPropertyOrder(3)] public LabelFormat? LabelFormat { get; set; } + /// - /// Gets or Sets LabelLayout CLOVUS + /// Gets or Sets LabelLayout /// - [JsonPropertyName("label_layout")] + [JsonPropertyName("label_layout"), JsonPropertyOrder(4)] public LabelLayout? LabelLayout { get; set; } + /// /// When 'true', the batch will be enqueued for processing /// /// When 'true', the batch will be enqueued for processing - [JsonPropertyName("create_batch_and_process_labels")] + [JsonPropertyName("create_batch_and_process_labels"), JsonPropertyOrder(1)] public bool? CreateBatchAndProcessLabels { get; set; } /// @@ -58,7 +61,7 @@ public partial class CreateAndProcessBatchRequestBodyProcessLabels /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("ship_date")] + [JsonPropertyName("ship_date"), JsonPropertyOrder(5)] public DateTimeOffset? ShipDate { get; set; } diff --git a/ShipEngineSDK/Model/CreateAndValidateShipment.cs b/ShipEngineSDK/Model/CreateAndValidateShipment.cs index 3c0d257e..bd0dfc6a 100644 --- a/ShipEngineSDK/Model/CreateAndValidateShipment.cs +++ b/ShipEngineSDK/Model/CreateAndValidateShipment.cs @@ -29,40 +29,44 @@ public partial class CreateAndValidateShipment { /// - /// The type of delivery confirmation that is required for this shipment. CLOVUS + /// The type of delivery confirmation that is required for this shipment. /// /// The type of delivery confirmation that is required for this shipment. - [JsonPropertyName("confirmation")] + [JsonPropertyName("confirmation"), JsonPropertyOrder(5)] public DeliveryConfirmation? Confirmation { get; set; } + /// - /// The insurance provider to use for any insured packages in the shipment. CLOVUS + /// The insurance provider to use for any insured packages in the shipment. /// /// The insurance provider to use for any insured packages in the shipment. - [JsonPropertyName("insurance_provider")] + [JsonPropertyName("insurance_provider"), JsonPropertyOrder(11)] public InsuranceProvider? InsuranceProvider { get; set; } + /// - /// Gets or Sets OrderSourceCode CLOVUS + /// Gets or Sets OrderSourceCode /// - [JsonPropertyName("order_source_code")] + [JsonPropertyName("order_source_code"), JsonPropertyOrder(15)] public OrderSourceName? OrderSourceCode { get; set; } + /// - /// The current status of the shipment CLOVUS + /// The current status of the shipment /// /// The current status of the shipment - [JsonPropertyName("shipment_status")] - public ShipmentStatus? ShipmentStatus { get; set; } + [JsonPropertyName("shipment_status"), JsonInclude] + public ShipmentStatus? ShipmentStatus { get; private set; } + /// /// The address validation /// /// The address validation - [JsonPropertyName("address_validation")] + [JsonPropertyName("address_validation"), JsonPropertyOrder(1)] public AddressValidationResult? AddressValidation { get; set; } /// /// Advanced shipment options. These are entirely optional. /// /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options")] + [JsonPropertyName("advanced_options"), JsonPropertyOrder(2)] public AdvancedShipmentOptions? AdvancedOptions { get; set; } /// @@ -72,7 +76,7 @@ public partial class CreateAndValidateShipment /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] + [JsonPropertyName("carrier_id"), JsonPropertyOrder(3)] public string? CarrierId { get; set; } /// @@ -82,7 +86,7 @@ public partial class CreateAndValidateShipment /// /// retail /// - [JsonPropertyName("comparison_rate_type")] + [JsonPropertyName("comparison_rate_type"), JsonPropertyOrder(4)] public string? ComparisonRateType { get; set; } /// @@ -92,50 +96,49 @@ public partial class CreateAndValidateShipment /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// Customs information. This is usually only needed for international shipments. /// /// Customs information. This is usually only needed for international shipments. - [JsonPropertyName("customs")] + [JsonPropertyName("customs"), JsonPropertyOrder(7)] public InternationalShipmentOptions? Customs { get; set; } /// /// An array of errors that occurred while creating shipment. /// /// An array of errors that occurred while creating shipment. - [JsonPropertyName("errors")] - [Obsolete] - public List? Errors { get; set; } + [JsonPropertyName("errors"), JsonInclude, Obsolete] + public List? Errors { get; private set; } /// /// ID that the Order Source assigned /// /// ID that the Order Source assigned - [JsonPropertyName("external_order_id")] + [JsonPropertyName("external_order_id"), JsonPropertyOrder(9)] public string? ExternalOrderId { get; set; } /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("external_shipment_id")] + [JsonPropertyName("external_shipment_id"), JsonPropertyOrder(10)] public string? ExternalShipmentId { get; set; } /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. - [JsonPropertyName("is_return")] + [JsonPropertyName("is_return"), JsonPropertyOrder(12)] public bool? IsReturn { get; set; } /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - [JsonPropertyName("items")] + [JsonPropertyName("items"), JsonPropertyOrder(13)] public List? Items { get; set; } /// @@ -145,21 +148,21 @@ public partial class CreateAndValidateShipment /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("modified_at")] - public DateTimeOffset? ModifiedAt { get; set; } + [JsonPropertyName("modified_at"), JsonInclude] + public DateTimeOffset? ModifiedAt { get; private set; } /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] + [JsonPropertyName("packages"), JsonPropertyOrder(16)] public List? Packages { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. /// /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to")] + [JsonPropertyName("return_to"), JsonPropertyOrder(17)] public ShippingAddress? ReturnTo { get; set; } /// @@ -169,7 +172,7 @@ public partial class CreateAndValidateShipment /// /// usps_first_class_mail /// - [JsonPropertyName("service_code")] + [JsonPropertyName("service_code"), JsonPropertyOrder(18)] public string? ServiceCode { get; set; } /// @@ -179,21 +182,21 @@ public partial class CreateAndValidateShipment /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date")] + [JsonPropertyName("ship_date"), JsonPropertyOrder(19)] public DateTimeOffset? ShipDate { get; set; } /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from")] + [JsonPropertyName("ship_from"), JsonPropertyOrder(20)] public ShippingAddress? ShipFrom { get; set; } /// /// The recipient's mailing address /// /// The recipient's mailing address - [JsonPropertyName("ship_to")] + [JsonPropertyName("ship_to"), JsonPropertyOrder(21)] public ShippingAddressTo? ShipTo { get; set; } /// @@ -203,14 +206,14 @@ public partial class CreateAndValidateShipment /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string? ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private set; } /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("shipment_number")] + [JsonPropertyName("shipment_number"), JsonPropertyOrder(23)] public string? ShipmentNumber { get; set; } /// @@ -220,28 +223,28 @@ public partial class CreateAndValidateShipment /// /// se-28529731 /// - [JsonPropertyName("shipping_rule_id")] + [JsonPropertyName("shipping_rule_id"), JsonPropertyOrder(25)] public string? ShippingRuleId { get; set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. - [JsonPropertyName("tags")] - public List? Tags { get; set; } + [JsonPropertyName("tags"), JsonInclude] + public List? Tags { get; private set; } /// /// Gets or Sets TaxIdentifiers /// - [JsonPropertyName("tax_identifiers")] + [JsonPropertyName("tax_identifiers"), JsonPropertyOrder(27)] public List? TaxIdentifiers { get; set; } /// /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment - [JsonPropertyName("total_weight")] - public Weight? TotalWeight { get; set; } + [JsonPropertyName("total_weight"), JsonInclude] + public Weight? TotalWeight { get; private set; } /// /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. @@ -250,7 +253,7 @@ public partial class CreateAndValidateShipment /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] + [JsonPropertyName("warehouse_id"), JsonPropertyOrder(29)] public string? WarehouseId { get; set; } diff --git a/ShipEngineSDK/Model/CreateBatchRequestBody.cs b/ShipEngineSDK/Model/CreateBatchRequestBody.cs index 205afa55..0cfe5907 100644 --- a/ShipEngineSDK/Model/CreateBatchRequestBody.cs +++ b/ShipEngineSDK/Model/CreateBatchRequestBody.cs @@ -35,7 +35,7 @@ public partial class CreateBatchRequestBody /// /// This is my batch /// - [JsonPropertyName("batch_notes")] + [JsonPropertyName("batch_notes"), JsonPropertyOrder(1)] public string? BatchNotes { get; set; } /// @@ -45,21 +45,21 @@ public partial class CreateBatchRequestBody /// /// se-28529731 /// - [JsonPropertyName("external_batch_id")] + [JsonPropertyName("external_batch_id"), JsonPropertyOrder(2)] public string? ExternalBatchId { get; set; } /// /// Array of rate IDs used in the batch /// /// Array of rate IDs used in the batch - [JsonPropertyName("rate_ids")] + [JsonPropertyName("rate_ids"), JsonPropertyOrder(3)] public List? RateIds { get; set; } /// /// Array of shipment IDs used in the batch /// /// Array of shipment IDs used in the batch - [JsonPropertyName("shipment_ids")] + [JsonPropertyName("shipment_ids"), JsonPropertyOrder(4)] public List? ShipmentIds { get; set; } diff --git a/ShipEngineSDK/Model/CreateBatchResponseBody.cs b/ShipEngineSDK/Model/CreateBatchResponseBody.cs index b6b479b9..c0d27b15 100644 --- a/ShipEngineSDK/Model/CreateBatchResponseBody.cs +++ b/ShipEngineSDK/Model/CreateBatchResponseBody.cs @@ -29,37 +29,30 @@ public partial class CreateBatchResponseBody { /// - /// Gets or Sets LabelFormat CLOVUS + /// Gets or Sets LabelFormat /// - [JsonPropertyName("label_format")] - [JsonRequired] - public required LabelFormat LabelFormat { get; set; } = new(); - + [JsonPropertyName("label_format"), JsonInclude] + public LabelFormat? LabelFormat { get; private set; } /// - /// label layout CLOVUS + /// label layout /// /// label layout - [JsonPropertyName("label_layout")] - [JsonRequired] - public required LabelLayout LabelLayout { get; set; } = new(); - + [JsonPropertyName("label_layout"), JsonInclude] + public LabelLayout? LabelLayout { get; private set; } /// - /// Gets or Sets Status CLOVUS + /// Gets or Sets Status /// - [JsonPropertyName("status")] - [JsonRequired] - public required BatchStatus Status { get; set; } = new(); - + [JsonPropertyName("status"), JsonInclude] + public BatchStatus? Status { get; private set; } /// /// Link to batch errors endpoint /// /// Link to batch errors endpoint - [JsonPropertyName("batch_errors_url")] - [JsonRequired] - public required OptionalLink BatchErrorsUrl { get; set; } + [JsonPropertyName("batch_errors_url"), JsonInclude] + public OptionalLink? BatchErrorsUrl { get; private set; } /// /// A string that uniquely identifies the batch @@ -68,32 +61,28 @@ public partial class CreateBatchResponseBody /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - [JsonRequired] - public required string BatchId { get; set; } + [JsonPropertyName("batch_id"), JsonInclude] + public string? BatchId { get; private set; } /// /// Link to batch labels query /// /// Link to batch labels query - [JsonPropertyName("batch_labels_url")] - [JsonRequired] + [JsonPropertyName("batch_labels_url"), JsonRequired, JsonPropertyOrder(3)] public required OptionalLink BatchLabelsUrl { get; set; } /// /// The batch number. /// /// The batch number. - [JsonPropertyName("batch_number")] - [JsonRequired] - public required string BatchNumber { get; set; } + [JsonPropertyName("batch_number"), JsonInclude] + public string? BatchNumber { get; private set; } /// /// The batch shipments endpoint /// /// The batch shipments endpoint - [JsonPropertyName("batch_shipments_url")] - [JsonRequired] + [JsonPropertyName("batch_shipments_url"), JsonRequired, JsonPropertyOrder(5)] public required OptionalLink BatchShipmentsUrl { get; set; } /// @@ -103,9 +92,8 @@ public partial class CreateBatchResponseBody /// /// 1 /// - [JsonPropertyName("completed")] - [JsonRequired] - public required int Completed { get; set; } + [JsonPropertyName("completed"), JsonInclude] + public int? Completed { get; private set; } /// /// The total of errors, warnings, and completed properties @@ -114,9 +102,8 @@ public partial class CreateBatchResponseBody /// /// 2 /// - [JsonPropertyName("count")] - [JsonRequired] - public required int Count { get; set; } + [JsonPropertyName("count"), JsonInclude] + public int? Count { get; private set; } /// /// The date and time the batch was created in ShipEngine @@ -125,9 +112,8 @@ public partial class CreateBatchResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - [JsonRequired] - public required DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// The number of errors that occurred while generating the batch @@ -136,17 +122,15 @@ public partial class CreateBatchResponseBody /// /// 2 /// - [JsonPropertyName("errors")] - [JsonRequired] - public required int Errors { get; set; } + [JsonPropertyName("errors"), JsonInclude] + public int? Errors { get; private set; } /// /// The form download for any customs that are needed /// /// The form download for any customs that are needed - [JsonPropertyName("form_download")] - [JsonRequired] - public required OptionalLink FormDownload { get; set; } + [JsonPropertyName("form_download"), JsonInclude] + public OptionalLink? FormDownload { get; private set; } /// /// The number of forms for customs that are available for download @@ -155,33 +139,29 @@ public partial class CreateBatchResponseBody /// /// 3 /// - [JsonPropertyName("forms")] - [JsonRequired] - public required int Forms { get; set; } + [JsonPropertyName("forms"), JsonInclude] + public int? Forms { get; private set; } /// /// The label download for the batch /// /// The label download for the batch - [JsonPropertyName("label_download")] - [JsonRequired] - public required LabelDownload LabelDownload { get; set; } + [JsonPropertyName("label_download"), JsonInclude] + public LabelDownload? LabelDownload { get; private set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - [JsonRequired] - public required PaperlessDownload PaperlessDownload { get; set; } + [JsonPropertyName("paperless_download"), JsonInclude] + public PaperlessDownload? PaperlessDownload { get; private set; } /// /// The errors associated with the failed API call /// /// The errors associated with the failed API call - [JsonPropertyName("process_errors")] - [JsonRequired] - public required List ProcessErrors { get; set; } + [JsonPropertyName("process_errors"), JsonInclude] + public List? ProcessErrors { get; private set; } /// /// The number of warnings that occurred while generating the batch @@ -190,9 +170,8 @@ public partial class CreateBatchResponseBody /// /// 1 /// - [JsonPropertyName("warnings")] - [JsonRequired] - public required int Warnings { get; set; } + [JsonPropertyName("warnings"), JsonInclude] + public int? Warnings { get; private set; } /// /// Custom notes you can add for each created batch @@ -201,17 +180,15 @@ public partial class CreateBatchResponseBody /// /// Batch for morning shipment /// - [JsonPropertyName("batch_notes")] - [JsonRequired] - public required string BatchNotes { get; set; } + [JsonPropertyName("batch_notes"), JsonInclude] + public string? BatchNotes { get; private set; } /// /// A string that uniquely identifies the external batch /// /// A string that uniquely identifies the external batch - [JsonPropertyName("external_batch_id")] - [JsonRequired] - public required string ExternalBatchId { get; set; } + [JsonPropertyName("external_batch_id"), JsonInclude] + public string? ExternalBatchId { get; private set; } /// /// The date and time the batch was processed in ShipEngine @@ -220,9 +197,8 @@ public partial class CreateBatchResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("processed_at")] - [JsonRequired] - public required DateTimeOffset ProcessedAt { get; set; } + [JsonPropertyName("processed_at"), JsonInclude] + public DateTimeOffset? ProcessedAt { get; private set; } /// diff --git a/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs b/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs index a7b18813..e252fdd4 100644 --- a/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs @@ -29,32 +29,37 @@ public partial class CreateLabelFromRateRequestBody { /// - /// The display format that the label should be shown in. CLOVUS + /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(1)] public DisplayScheme? DisplayScheme { get; set; } + /// - /// Gets or Sets LabelDownloadType CLOVUS + /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type")] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(2)] public LabelDownloadType? LabelDownloadType { get; set; } + /// - /// Gets or Sets LabelFormat CLOVUS + /// Gets or Sets LabelFormat /// - [JsonPropertyName("label_format")] + [JsonPropertyName("label_format"), JsonPropertyOrder(3)] public LabelFormat? LabelFormat { get; set; } + /// - /// Gets or Sets LabelLayout CLOVUS + /// Gets or Sets LabelLayout /// - [JsonPropertyName("label_layout")] + [JsonPropertyName("label_layout"), JsonPropertyOrder(4)] public LabelLayout? LabelLayout { get; set; } + /// - /// Gets or Sets ValidateAddress CLOVUS + /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address")] + [JsonPropertyName("validate_address"), JsonPropertyOrder(5)] public ValidateAddress? ValidateAddress { get; set; } + /// /// Returns the string presentation of the object /// diff --git a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs index 2087f798..588c39e6 100644 --- a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs @@ -29,56 +29,64 @@ public partial class CreateLabelFromRateResponseBody { /// - /// The label charge event. CLOVUS + /// The label charge event. /// /// The label charge event. - [JsonPropertyName("charge_event")] + [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] public LabelChargeEvent? ChargeEvent { get; set; } + /// - /// The display format that the label should be shown in. CLOVUS + /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(7)] public DisplayScheme? DisplayScheme { get; set; } + /// - /// Gets or Sets LabelDownloadType CLOVUS + /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type")] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(14)] 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. CLOVUS + /// 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")] + [JsonPropertyName("label_format"), JsonPropertyOrder(15)] public LabelFormat? LabelFormat { 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. CLOVUS + /// 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")] + [JsonPropertyName("label_layout"), JsonPropertyOrder(18)] public LabelLayout? LabelLayout { get; set; } + /// - /// Gets or Sets Status CLOVUS + /// Gets or Sets Status /// - [JsonPropertyName("status")] - public LabelStatus? Status { get; set; } + [JsonPropertyName("status"), JsonInclude] + public LabelStatus? Status { get; private set; } + /// - /// The current status of the package, such as `in_transit` or `delivered` CLOVUS + /// The current status of the package, such as `in_transit` or `delivered` /// /// The current status of the package, such as `in_transit` or `delivered` - [JsonPropertyName("tracking_status")] - public TrackingStatus? TrackingStatus { get; set; } + [JsonPropertyName("tracking_status"), JsonInclude] + public TrackingStatus? TrackingStatus { get; private set; } + /// - /// Gets or Sets ValidateAddress CLOVUS + /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address")] + [JsonPropertyName("validate_address"), JsonPropertyOrder(36)] public ValidateAddress? ValidateAddress { get; set; } + /// /// Additional information some carriers may provide by which to identify a given label in their system. /// /// Additional information some carriers may provide by which to identify a given label in their system. - [JsonPropertyName("alternative_identifiers")] - public List? AlternativeIdentifiers { get; set; } + [JsonPropertyName("alternative_identifiers"), JsonInclude] + public List? AlternativeIdentifiers { get; private set; } /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. @@ -87,8 +95,8 @@ public partial class CreateLabelFromRateResponseBody /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - public string? BatchId { get; set; } + [JsonPropertyName("batch_id"), JsonInclude] + public string? BatchId { get; private set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. @@ -97,8 +105,8 @@ public partial class CreateLabelFromRateResponseBody /// /// dhl_express /// - [JsonPropertyName("carrier_code")] - public string? CarrierCode { get; set; } + [JsonPropertyName("carrier_code"), JsonInclude] + public string? CarrierCode { get; private set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label @@ -107,8 +115,8 @@ public partial class CreateLabelFromRateResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - public string? CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// The date and time that the label was created in ShipEngine. @@ -117,49 +125,49 @@ public partial class CreateLabelFromRateResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private 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. /// /// 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. - [JsonPropertyName("form_download")] - public Link? FormDownload { get; set; } + [JsonPropertyName("form_download"), JsonInclude] + public Link? FormDownload { get; private set; } /// /// 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. /// /// 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. - [JsonPropertyName("insurance_claim")] - public Link? InsuranceClaim { get; set; } + [JsonPropertyName("insurance_claim"), JsonInclude] + public Link? InsuranceClaim { get; private set; } /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. - [JsonPropertyName("insurance_cost")] - public MonetaryValue? InsuranceCost { get; set; } + [JsonPropertyName("insurance_cost"), JsonInclude] + public MonetaryValue? InsuranceCost { get; private set; } /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. - [JsonPropertyName("is_international")] - public bool? IsInternational { get; set; } + [JsonPropertyName("is_international"), JsonInclude] + public bool? IsInternational { get; private set; } /// /// 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")] + [JsonPropertyName("is_return_label"), JsonPropertyOrder(12)] public bool? IsReturnLabel { get; set; } /// /// Gets or Sets LabelDownload /// - [JsonPropertyName("label_download")] - public LabelDownload? LabelDownload { get; set; } + [JsonPropertyName("label_download"), JsonInclude] + public LabelDownload? LabelDownload { get; private set; } /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. @@ -168,8 +176,8 @@ public partial class CreateLabelFromRateResponseBody /// /// se-28529731 /// - [JsonPropertyName("label_id")] - public string? LabelId { get; set; } + [JsonPropertyName("label_id"), JsonInclude] + public string? LabelId { get; private set; } /// /// The label image resource that was used to create a custom label image. @@ -178,7 +186,7 @@ public partial class CreateLabelFromRateResponseBody /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id")] + [JsonPropertyName("label_image_id"), JsonPropertyOrder(17)] public string? LabelImageId { get; set; } /// @@ -188,7 +196,7 @@ public partial class CreateLabelFromRateResponseBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id")] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19)] public string? OutboundLabelId { get; set; } /// @@ -198,35 +206,35 @@ public partial class CreateLabelFromRateResponseBody /// /// small_flat_rate_box /// - [JsonPropertyName("package_code")] - public string? PackageCode { get; set; } + [JsonPropertyName("package_code"), JsonInclude] + public string? PackageCode { get; private set; } /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - public List? Packages { get; set; } + [JsonPropertyName("packages"), JsonInclude] + public List? Packages { get; private set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - public PaperlessDownload? PaperlessDownload { get; set; } + [JsonPropertyName("paperless_download"), JsonInclude] + public PaperlessDownload? PaperlessDownload { get; private set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue? RequestedComparisonAmount { get; set; } + [JsonPropertyName("requested_comparison_amount"), JsonInclude] + public MonetaryValue? RequestedComparisonAmount { get; private set; } /// /// 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")] + [JsonPropertyName("rma_number"), JsonPropertyOrder(24)] public string? RmaNumber { get; set; } /// @@ -236,8 +244,8 @@ public partial class CreateLabelFromRateResponseBody /// /// usps_first_class_mail /// - [JsonPropertyName("service_code")] - public string? ServiceCode { get; set; } + [JsonPropertyName("service_code"), JsonInclude] + public string? ServiceCode { get; private set; } /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -246,22 +254,22 @@ public partial class CreateLabelFromRateResponseBody /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date")] - public DateTimeOffset? ShipDate { get; set; } + [JsonPropertyName("ship_date"), JsonInclude] + public DateTimeOffset? ShipDate { get; private set; } /// /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment")] + [JsonPropertyName("shipment"), JsonPropertyOrder(27)] public Shipment? Shipment { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - [JsonPropertyName("shipment_cost")] - public MonetaryValue? ShipmentCost { get; set; } + [JsonPropertyName("shipment_cost"), JsonInclude] + public MonetaryValue? ShipmentCost { get; private set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) @@ -270,23 +278,22 @@ public partial class CreateLabelFromRateResponseBody /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string? ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private 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")] - [Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(31), Obsolete] public bool? TestLabel { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. - [JsonPropertyName("trackable")] - public bool? Trackable { get; set; } + [JsonPropertyName("trackable"), JsonInclude] + public bool? Trackable { get; private set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. @@ -295,8 +302,8 @@ public partial class CreateLabelFromRateResponseBody /// /// 782758401696 /// - [JsonPropertyName("tracking_number")] - public string? TrackingNumber { get; set; } + [JsonPropertyName("tracking_number"), JsonInclude] + public string? TrackingNumber { get; private set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. @@ -305,15 +312,15 @@ public partial class CreateLabelFromRateResponseBody /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// - [JsonPropertyName("tracking_url")] - public string? TrackingUrl { get; set; } + [JsonPropertyName("tracking_url"), JsonInclude] + public string? TrackingUrl { get; private set; } /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) - [JsonPropertyName("voided")] - public bool? Voided { get; set; } + [JsonPropertyName("voided"), JsonInclude] + public bool? Voided { get; private set; } /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided @@ -322,8 +329,8 @@ public partial class CreateLabelFromRateResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("voided_at")] - public DateTimeOffset? VoidedAt { get; set; } + [JsonPropertyName("voided_at"), JsonInclude] + public DateTimeOffset? VoidedAt { get; private set; } /// diff --git a/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs b/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs index 31a161d0..05ee8297 100644 --- a/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs @@ -29,32 +29,37 @@ public partial class CreateLabelFromShipmentRequestBody { /// - /// The display format that the label should be shown in. CLOVUS + /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(1)] public DisplayScheme? DisplayScheme { get; set; } + /// - /// Gets or Sets LabelDownloadType CLOVUS + /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type")] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(2)] public LabelDownloadType? LabelDownloadType { get; set; } + /// - /// Gets or Sets LabelFormat CLOVUS + /// Gets or Sets LabelFormat /// - [JsonPropertyName("label_format")] + [JsonPropertyName("label_format"), JsonPropertyOrder(3)] public LabelFormat? LabelFormat { get; set; } + /// - /// Gets or Sets LabelLayout CLOVUS + /// Gets or Sets LabelLayout /// - [JsonPropertyName("label_layout")] + [JsonPropertyName("label_layout"), JsonPropertyOrder(4)] public LabelLayout? LabelLayout { get; set; } + /// - /// Gets or Sets ValidateAddress CLOVUS + /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address")] + [JsonPropertyName("validate_address"), JsonPropertyOrder(5)] public ValidateAddress? ValidateAddress { get; set; } + /// /// Returns the string presentation of the object /// diff --git a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs index 5df4d081..6ad86de5 100644 --- a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs @@ -29,56 +29,64 @@ public partial class CreateLabelFromShipmentResponseBody { /// - /// The label charge event. CLOVUS + /// The label charge event. /// /// The label charge event. - [JsonPropertyName("charge_event")] + [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] public LabelChargeEvent? ChargeEvent { get; set; } + /// - /// The display format that the label should be shown in. CLOVUS + /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(7)] public DisplayScheme? DisplayScheme { get; set; } + /// - /// Gets or Sets LabelDownloadType CLOVUS + /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type")] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(14)] 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. CLOVUS + /// 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")] + [JsonPropertyName("label_format"), JsonPropertyOrder(15)] public LabelFormat? LabelFormat { 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. CLOVUS + /// 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")] + [JsonPropertyName("label_layout"), JsonPropertyOrder(18)] public LabelLayout? LabelLayout { get; set; } + /// - /// Gets or Sets Status CLOVUS + /// Gets or Sets Status /// - [JsonPropertyName("status")] - public LabelStatus? Status { get; set; } + [JsonPropertyName("status"), JsonInclude] + public LabelStatus? Status { get; private set; } + /// - /// The current status of the package, such as `in_transit` or `delivered` CLOVUS + /// The current status of the package, such as `in_transit` or `delivered` /// /// The current status of the package, such as `in_transit` or `delivered` - [JsonPropertyName("tracking_status")] - public TrackingStatus? TrackingStatus { get; set; } + [JsonPropertyName("tracking_status"), JsonInclude] + public TrackingStatus? TrackingStatus { get; private set; } + /// - /// Gets or Sets ValidateAddress CLOVUS + /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address")] + [JsonPropertyName("validate_address"), JsonPropertyOrder(36)] public ValidateAddress? ValidateAddress { get; set; } + /// /// Additional information some carriers may provide by which to identify a given label in their system. /// /// Additional information some carriers may provide by which to identify a given label in their system. - [JsonPropertyName("alternative_identifiers")] - public List? AlternativeIdentifiers { get; set; } + [JsonPropertyName("alternative_identifiers"), JsonInclude] + public List? AlternativeIdentifiers { get; private set; } /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. @@ -87,8 +95,8 @@ public partial class CreateLabelFromShipmentResponseBody /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - public string? BatchId { get; set; } + [JsonPropertyName("batch_id"), JsonInclude] + public string? BatchId { get; private set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. @@ -97,8 +105,8 @@ public partial class CreateLabelFromShipmentResponseBody /// /// dhl_express /// - [JsonPropertyName("carrier_code")] - public string? CarrierCode { get; set; } + [JsonPropertyName("carrier_code"), JsonInclude] + public string? CarrierCode { get; private set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label @@ -107,8 +115,8 @@ public partial class CreateLabelFromShipmentResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - public string? CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// The date and time that the label was created in ShipEngine. @@ -117,49 +125,49 @@ public partial class CreateLabelFromShipmentResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private 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. /// /// 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. - [JsonPropertyName("form_download")] - public Link? FormDownload { get; set; } + [JsonPropertyName("form_download"), JsonInclude] + public Link? FormDownload { get; private set; } /// /// 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. /// /// 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. - [JsonPropertyName("insurance_claim")] - public Link? InsuranceClaim { get; set; } + [JsonPropertyName("insurance_claim"), JsonInclude] + public Link? InsuranceClaim { get; private set; } /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. - [JsonPropertyName("insurance_cost")] - public MonetaryValue? InsuranceCost { get; set; } + [JsonPropertyName("insurance_cost"), JsonInclude] + public MonetaryValue? InsuranceCost { get; private set; } /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. - [JsonPropertyName("is_international")] - public bool? IsInternational { get; set; } + [JsonPropertyName("is_international"), JsonInclude] + public bool? IsInternational { get; private set; } /// /// 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")] + [JsonPropertyName("is_return_label"), JsonPropertyOrder(12)] public bool? IsReturnLabel { get; set; } /// /// Gets or Sets LabelDownload /// - [JsonPropertyName("label_download")] - public LabelDownload? LabelDownload { get; set; } + [JsonPropertyName("label_download"), JsonInclude] + public LabelDownload? LabelDownload { get; private set; } /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. @@ -168,8 +176,8 @@ public partial class CreateLabelFromShipmentResponseBody /// /// se-28529731 /// - [JsonPropertyName("label_id")] - public string? LabelId { get; set; } + [JsonPropertyName("label_id"), JsonInclude] + public string? LabelId { get; private set; } /// /// The label image resource that was used to create a custom label image. @@ -178,7 +186,7 @@ public partial class CreateLabelFromShipmentResponseBody /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id")] + [JsonPropertyName("label_image_id"), JsonPropertyOrder(17)] public string? LabelImageId { get; set; } /// @@ -188,7 +196,7 @@ public partial class CreateLabelFromShipmentResponseBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id")] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19)] public string? OutboundLabelId { get; set; } /// @@ -198,35 +206,35 @@ public partial class CreateLabelFromShipmentResponseBody /// /// small_flat_rate_box /// - [JsonPropertyName("package_code")] - public string? PackageCode { get; set; } + [JsonPropertyName("package_code"), JsonInclude] + public string? PackageCode { get; private set; } /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - public List? Packages { get; set; } + [JsonPropertyName("packages"), JsonInclude] + public List? Packages { get; private set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - public PaperlessDownload? PaperlessDownload { get; set; } + [JsonPropertyName("paperless_download"), JsonInclude] + public PaperlessDownload? PaperlessDownload { get; private set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue? RequestedComparisonAmount { get; set; } + [JsonPropertyName("requested_comparison_amount"), JsonInclude] + public MonetaryValue? RequestedComparisonAmount { get; private set; } /// /// 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")] + [JsonPropertyName("rma_number"), JsonPropertyOrder(24)] public string? RmaNumber { get; set; } /// @@ -236,8 +244,8 @@ public partial class CreateLabelFromShipmentResponseBody /// /// usps_first_class_mail /// - [JsonPropertyName("service_code")] - public string? ServiceCode { get; set; } + [JsonPropertyName("service_code"), JsonInclude] + public string? ServiceCode { get; private set; } /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -246,22 +254,22 @@ public partial class CreateLabelFromShipmentResponseBody /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date")] - public DateTimeOffset? ShipDate { get; set; } + [JsonPropertyName("ship_date"), JsonInclude] + public DateTimeOffset? ShipDate { get; private set; } /// /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment")] + [JsonPropertyName("shipment"), JsonPropertyOrder(27)] public Shipment? Shipment { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - [JsonPropertyName("shipment_cost")] - public MonetaryValue? ShipmentCost { get; set; } + [JsonPropertyName("shipment_cost"), JsonInclude] + public MonetaryValue? ShipmentCost { get; private set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) @@ -270,23 +278,22 @@ public partial class CreateLabelFromShipmentResponseBody /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string? ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private 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")] - [Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(31), Obsolete] public bool? TestLabel { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. - [JsonPropertyName("trackable")] - public bool? Trackable { get; set; } + [JsonPropertyName("trackable"), JsonInclude] + public bool? Trackable { get; private set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. @@ -295,8 +302,8 @@ public partial class CreateLabelFromShipmentResponseBody /// /// 782758401696 /// - [JsonPropertyName("tracking_number")] - public string? TrackingNumber { get; set; } + [JsonPropertyName("tracking_number"), JsonInclude] + public string? TrackingNumber { get; private set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. @@ -305,15 +312,15 @@ public partial class CreateLabelFromShipmentResponseBody /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// - [JsonPropertyName("tracking_url")] - public string? TrackingUrl { get; set; } + [JsonPropertyName("tracking_url"), JsonInclude] + public string? TrackingUrl { get; private set; } /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) - [JsonPropertyName("voided")] - public bool? Voided { get; set; } + [JsonPropertyName("voided"), JsonInclude] + public bool? Voided { get; private set; } /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided @@ -322,8 +329,8 @@ public partial class CreateLabelFromShipmentResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("voided_at")] - public DateTimeOffset? VoidedAt { get; set; } + [JsonPropertyName("voided_at"), JsonInclude] + public DateTimeOffset? VoidedAt { get; private set; } /// diff --git a/ShipEngineSDK/Model/CreateLabelRequestBody.cs b/ShipEngineSDK/Model/CreateLabelRequestBody.cs index f26ef2d9..5f532363 100644 --- a/ShipEngineSDK/Model/CreateLabelRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelRequestBody.cs @@ -29,64 +29,71 @@ public partial class CreateLabelRequestBody { /// - /// The label charge event. CLOVUS + /// The label charge event. /// /// The label charge event. - [JsonPropertyName("charge_event")] + [JsonPropertyName("charge_event"), JsonPropertyOrder(6)] public LabelChargeEvent? ChargeEvent { get; set; } + /// - /// The display format that the label should be shown in. CLOVUS + /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(8)] public DisplayScheme? DisplayScheme { get; set; } + /// - /// Gets or Sets LabelDownloadType CLOVUS + /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type")] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(15)] 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. CLOVUS + /// 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")] + [JsonPropertyName("label_format"), JsonPropertyOrder(16)] public LabelFormat? LabelFormat { 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. CLOVUS + /// 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")] + [JsonPropertyName("label_layout"), JsonPropertyOrder(19)] public LabelLayout? LabelLayout { get; set; } + /// - /// Gets or Sets Status CLOVUS + /// Gets or Sets Status /// - [JsonPropertyName("status")] - public LabelStatus? Status { get; set; } + [JsonPropertyName("status"), JsonInclude] + public LabelStatus? Status { get; private set; } + /// - /// The current status of the package, such as `in_transit` or `delivered` CLOVUS + /// The current status of the package, such as `in_transit` or `delivered` /// /// The current status of the package, such as `in_transit` or `delivered` - [JsonPropertyName("tracking_status")] - public TrackingStatus? TrackingStatus { get; set; } + [JsonPropertyName("tracking_status"), JsonInclude] + public TrackingStatus? TrackingStatus { get; private set; } + /// - /// Gets or Sets ValidateAddress CLOVUS + /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address")] + [JsonPropertyName("validate_address"), JsonPropertyOrder(38)] public ValidateAddress? ValidateAddress { get; set; } + /// /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment")] - [JsonRequired] + [JsonPropertyName("shipment"), JsonRequired, JsonPropertyOrder(1)] public required Shipment Shipment { get; set; } /// /// Additional information some carriers may provide by which to identify a given label in their system. /// /// Additional information some carriers may provide by which to identify a given label in their system. - [JsonPropertyName("alternative_identifiers")] - public List? AlternativeIdentifiers { get; set; } + [JsonPropertyName("alternative_identifiers"), JsonInclude] + public List? AlternativeIdentifiers { get; private set; } /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. @@ -95,8 +102,8 @@ public partial class CreateLabelRequestBody /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - public string? BatchId { get; set; } + [JsonPropertyName("batch_id"), JsonInclude] + public string? BatchId { get; private set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. @@ -105,8 +112,8 @@ public partial class CreateLabelRequestBody /// /// dhl_express /// - [JsonPropertyName("carrier_code")] - public string? CarrierCode { get; set; } + [JsonPropertyName("carrier_code"), JsonInclude] + public string? CarrierCode { get; private set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label @@ -115,8 +122,8 @@ public partial class CreateLabelRequestBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - public string? CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// The date and time that the label was created in ShipEngine. @@ -125,49 +132,49 @@ public partial class CreateLabelRequestBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private 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. /// /// 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. - [JsonPropertyName("form_download")] - public Link? FormDownload { get; set; } + [JsonPropertyName("form_download"), JsonInclude] + public Link? FormDownload { get; private set; } /// /// 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. /// /// 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. - [JsonPropertyName("insurance_claim")] - public Link? InsuranceClaim { get; set; } + [JsonPropertyName("insurance_claim"), JsonInclude] + public Link? InsuranceClaim { get; private set; } /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. - [JsonPropertyName("insurance_cost")] - public MonetaryValue? InsuranceCost { get; set; } + [JsonPropertyName("insurance_cost"), JsonInclude] + public MonetaryValue? InsuranceCost { get; private set; } /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. - [JsonPropertyName("is_international")] - public bool? IsInternational { get; set; } + [JsonPropertyName("is_international"), JsonInclude] + public bool? IsInternational { get; private set; } /// /// 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")] + [JsonPropertyName("is_return_label"), JsonPropertyOrder(13)] public bool? IsReturnLabel { get; set; } /// /// Gets or Sets LabelDownload /// - [JsonPropertyName("label_download")] - public LabelDownload? LabelDownload { get; set; } + [JsonPropertyName("label_download"), JsonInclude] + public LabelDownload? LabelDownload { get; private set; } /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. @@ -176,8 +183,8 @@ public partial class CreateLabelRequestBody /// /// se-28529731 /// - [JsonPropertyName("label_id")] - public string? LabelId { get; set; } + [JsonPropertyName("label_id"), JsonInclude] + public string? LabelId { get; private set; } /// /// The label image resource that was used to create a custom label image. @@ -186,7 +193,7 @@ public partial class CreateLabelRequestBody /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id")] + [JsonPropertyName("label_image_id"), JsonPropertyOrder(18)] public string? LabelImageId { get; set; } /// @@ -196,7 +203,7 @@ public partial class CreateLabelRequestBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id")] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(20)] public string? OutboundLabelId { get; set; } /// @@ -206,35 +213,35 @@ public partial class CreateLabelRequestBody /// /// small_flat_rate_box /// - [JsonPropertyName("package_code")] - public string? PackageCode { get; set; } + [JsonPropertyName("package_code"), JsonInclude] + public string? PackageCode { get; private set; } /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - public List? Packages { get; set; } + [JsonPropertyName("packages"), JsonInclude] + public List? Packages { get; private set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - public PaperlessDownload? PaperlessDownload { get; set; } + [JsonPropertyName("paperless_download"), JsonInclude] + public PaperlessDownload? PaperlessDownload { get; private set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue? RequestedComparisonAmount { get; set; } + [JsonPropertyName("requested_comparison_amount"), JsonInclude] + public MonetaryValue? RequestedComparisonAmount { get; private set; } /// /// 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")] + [JsonPropertyName("rma_number"), JsonPropertyOrder(25)] public string? RmaNumber { get; set; } /// @@ -244,8 +251,8 @@ public partial class CreateLabelRequestBody /// /// usps_first_class_mail /// - [JsonPropertyName("service_code")] - public string? ServiceCode { get; set; } + [JsonPropertyName("service_code"), JsonInclude] + public string? ServiceCode { get; private set; } /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -254,8 +261,8 @@ public partial class CreateLabelRequestBody /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date")] - public DateTimeOffset? ShipDate { get; set; } + [JsonPropertyName("ship_date"), JsonInclude] + public DateTimeOffset? ShipDate { get; private set; } /// /// A unique identifier for a carrier drop off point where a merchant plans to deliver packages. This will take precedence over a shipment's ship from address. @@ -264,7 +271,7 @@ public partial class CreateLabelRequestBody /// /// 614940 /// - [JsonPropertyName("ship_from_service_point_id")] + [JsonPropertyName("ship_from_service_point_id"), JsonPropertyOrder(28)] public string? ShipFromServicePointId { get; set; } /// @@ -274,15 +281,15 @@ public partial class CreateLabelRequestBody /// /// 614940 /// - [JsonPropertyName("ship_to_service_point_id")] + [JsonPropertyName("ship_to_service_point_id"), JsonPropertyOrder(29)] public string? ShipToServicePointId { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - [JsonPropertyName("shipment_cost")] - public MonetaryValue? ShipmentCost { get; set; } + [JsonPropertyName("shipment_cost"), JsonInclude] + public MonetaryValue? ShipmentCost { get; private set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) @@ -291,23 +298,22 @@ public partial class CreateLabelRequestBody /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string? ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private 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")] - [Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(33), Obsolete] public bool? TestLabel { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. - [JsonPropertyName("trackable")] - public bool? Trackable { get; set; } + [JsonPropertyName("trackable"), JsonInclude] + public bool? Trackable { get; private set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. @@ -316,8 +322,8 @@ public partial class CreateLabelRequestBody /// /// 782758401696 /// - [JsonPropertyName("tracking_number")] - public string? TrackingNumber { get; set; } + [JsonPropertyName("tracking_number"), JsonInclude] + public string? TrackingNumber { get; private set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. @@ -326,15 +332,15 @@ public partial class CreateLabelRequestBody /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// - [JsonPropertyName("tracking_url")] - public string? TrackingUrl { get; set; } + [JsonPropertyName("tracking_url"), JsonInclude] + public string? TrackingUrl { get; private set; } /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) - [JsonPropertyName("voided")] - public bool? Voided { get; set; } + [JsonPropertyName("voided"), JsonInclude] + public bool? Voided { get; private set; } /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided @@ -343,8 +349,8 @@ public partial class CreateLabelRequestBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("voided_at")] - public DateTimeOffset? VoidedAt { get; set; } + [JsonPropertyName("voided_at"), JsonInclude] + public DateTimeOffset? VoidedAt { get; private set; } /// diff --git a/ShipEngineSDK/Model/CreateLabelResponseBody.cs b/ShipEngineSDK/Model/CreateLabelResponseBody.cs index 6230bcbb..a8063aaf 100644 --- a/ShipEngineSDK/Model/CreateLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelResponseBody.cs @@ -29,68 +29,58 @@ public partial class CreateLabelResponseBody { /// - /// The label charge event. CLOVUS + /// The label charge event. /// /// The label charge event. - [JsonPropertyName("charge_event")] - [JsonRequired] - public required LabelChargeEvent ChargeEvent { get; set; } = new(); - + [JsonPropertyName("charge_event"), JsonRequired, JsonPropertyOrder(4)] + public required LabelChargeEvent ChargeEvent { get; set; } /// - /// The display format that the label should be shown in. CLOVUS + /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] - [JsonRequired] - public required DisplayScheme DisplayScheme { get; set; } = new(); - + [JsonPropertyName("display_scheme"), JsonRequired, JsonPropertyOrder(6)] + public required DisplayScheme DisplayScheme { 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. CLOVUS + /// 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")] - [JsonRequired] - public required LabelFormat LabelFormat { get; set; } = new(); - + [JsonPropertyName("label_format"), JsonRequired, JsonPropertyOrder(11)] + public required LabelFormat LabelFormat { 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. CLOVUS + /// 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")] - [JsonRequired] - public required LabelLayout LabelLayout { get; set; } = new(); - + [JsonPropertyName("label_layout"), JsonRequired, JsonPropertyOrder(13)] + public required LabelLayout LabelLayout { get; set; } /// - /// Gets or Sets Status CLOVUS + /// Gets or Sets Status /// - [JsonPropertyName("status")] - [JsonRequired] - public required LabelStatus Status { get; set; } = new(); - + [JsonPropertyName("status"), JsonInclude] + public LabelStatus? Status { get; private set; } /// - /// The current status of the package, such as `in_transit` or `delivered` CLOVUS + /// The current status of the package, such as `in_transit` or `delivered` /// /// The current status of the package, such as `in_transit` or `delivered` - [JsonPropertyName("tracking_status")] - [JsonRequired] - public required TrackingStatus TrackingStatus { get; set; } = new(); - + [JsonPropertyName("tracking_status"), JsonInclude] + public TrackingStatus? TrackingStatus { get; private set; } /// - /// Gets or Sets LabelDownloadType CLOVUS + /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type")] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(28)] public LabelDownloadType? LabelDownloadType { get; set; } + /// - /// Gets or Sets ValidateAddress CLOVUS + /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address")] + [JsonPropertyName("validate_address"), JsonPropertyOrder(37)] public ValidateAddress? ValidateAddress { get; set; } + /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// @@ -98,9 +88,8 @@ public partial class CreateLabelResponseBody /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - [JsonRequired] - public required string BatchId { get; set; } + [JsonPropertyName("batch_id"), JsonInclude] + public string? BatchId { get; private set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. @@ -109,9 +98,8 @@ public partial class CreateLabelResponseBody /// /// dhl_express /// - [JsonPropertyName("carrier_code")] - [JsonRequired] - public required string CarrierCode { get; set; } + [JsonPropertyName("carrier_code"), JsonInclude] + public string? CarrierCode { get; private set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label @@ -120,9 +108,8 @@ public partial class CreateLabelResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [JsonRequired] - public required string CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// The date and time that the label was created in ShipEngine. @@ -131,40 +118,35 @@ public partial class CreateLabelResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - [JsonRequired] - public required DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. - [JsonPropertyName("insurance_cost")] - [JsonRequired] - public required MonetaryValue InsuranceCost { get; set; } + [JsonPropertyName("insurance_cost"), JsonInclude] + public MonetaryValue? InsuranceCost { get; private set; } /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. - [JsonPropertyName("is_international")] - [JsonRequired] - public required bool IsInternational { get; set; } + [JsonPropertyName("is_international"), JsonInclude] + public bool? IsInternational { get; private set; } /// /// 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")] - [JsonRequired] + [JsonPropertyName("is_return_label"), JsonRequired, JsonPropertyOrder(9)] public required bool IsReturnLabel { get; set; } /// /// Gets or Sets LabelDownload /// - [JsonPropertyName("label_download")] - [JsonRequired] - public required LabelDownload LabelDownload { get; set; } + [JsonPropertyName("label_download"), JsonInclude] + public LabelDownload? LabelDownload { get; private set; } /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. @@ -173,9 +155,8 @@ public partial class CreateLabelResponseBody /// /// se-28529731 /// - [JsonPropertyName("label_id")] - [JsonRequired] - public required string LabelId { get; set; } + [JsonPropertyName("label_id"), JsonInclude] + public string? LabelId { get; private set; } /// /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. @@ -184,17 +165,15 @@ public partial class CreateLabelResponseBody /// /// small_flat_rate_box /// - [JsonPropertyName("package_code")] - [JsonRequired] - public required string PackageCode { get; set; } + [JsonPropertyName("package_code"), JsonInclude] + public string? PackageCode { get; private set; } /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - [JsonRequired] - public required List Packages { get; set; } + [JsonPropertyName("packages"), JsonInclude] + public List? Packages { get; private set; } /// /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. @@ -203,9 +182,8 @@ public partial class CreateLabelResponseBody /// /// usps_first_class_mail /// - [JsonPropertyName("service_code")] - [JsonRequired] - public required string ServiceCode { get; set; } + [JsonPropertyName("service_code"), JsonInclude] + public string? ServiceCode { get; private set; } /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -214,17 +192,15 @@ public partial class CreateLabelResponseBody /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date")] - [JsonRequired] - public required DateTimeOffset ShipDate { get; set; } + [JsonPropertyName("ship_date"), JsonInclude] + public DateTimeOffset? ShipDate { get; private set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - [JsonPropertyName("shipment_cost")] - [JsonRequired] - public required MonetaryValue ShipmentCost { get; set; } + [JsonPropertyName("shipment_cost"), JsonInclude] + public MonetaryValue? ShipmentCost { get; private set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) @@ -233,17 +209,15 @@ public partial class CreateLabelResponseBody /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - [JsonRequired] - public required string ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. - [JsonPropertyName("trackable")] - [JsonRequired] - public required bool Trackable { get; set; } + [JsonPropertyName("trackable"), JsonInclude] + public bool? Trackable { get; private set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. @@ -252,40 +226,36 @@ public partial class CreateLabelResponseBody /// /// 782758401696 /// - [JsonPropertyName("tracking_number")] - [JsonRequired] - public required string TrackingNumber { get; set; } + [JsonPropertyName("tracking_number"), JsonInclude] + public string? TrackingNumber { get; private set; } /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) - [JsonPropertyName("voided")] - [JsonRequired] - public required bool Voided { get; set; } + [JsonPropertyName("voided"), JsonInclude] + public bool? Voided { get; private set; } /// /// Additional information some carriers may provide by which to identify a given label in their system. /// /// Additional information some carriers may provide by which to identify a given label in their system. - [JsonPropertyName("alternative_identifiers")] - public List? AlternativeIdentifiers { get; set; } + [JsonPropertyName("alternative_identifiers"), JsonInclude] + public List? AlternativeIdentifiers { get; private 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. /// /// 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. - [JsonPropertyName("form_download")] - [JsonRequired] - public required Link FormDownload { get; set; } + [JsonPropertyName("form_download"), JsonInclude] + public Link? FormDownload { get; private set; } /// /// 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. /// /// 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. - [JsonPropertyName("insurance_claim")] - [JsonRequired] - public required Link InsuranceClaim { get; set; } + [JsonPropertyName("insurance_claim"), JsonInclude] + public Link? InsuranceClaim { get; private set; } /// /// The label image resource that was used to create a custom label image. @@ -294,8 +264,7 @@ public partial class CreateLabelResponseBody /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id")] - [JsonRequired] + [JsonPropertyName("label_image_id"), JsonRequired, JsonPropertyOrder(29)] public required string LabelImageId { get; set; } /// @@ -305,45 +274,42 @@ public partial class CreateLabelResponseBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id")] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(30)] public string? OutboundLabelId { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - [JsonRequired] - public required PaperlessDownload PaperlessDownload { get; set; } + [JsonPropertyName("paperless_download"), JsonInclude] + public PaperlessDownload? PaperlessDownload { get; private set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue? RequestedComparisonAmount { get; set; } + [JsonPropertyName("requested_comparison_amount"), JsonInclude] + public MonetaryValue? RequestedComparisonAmount { get; private set; } /// /// 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")] - [JsonRequired] + [JsonPropertyName("rma_number"), JsonRequired, JsonPropertyOrder(33)] public required string RmaNumber { get; set; } /// /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment")] + [JsonPropertyName("shipment"), JsonPropertyOrder(34)] 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")] - [Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(35), Obsolete] public bool? TestLabel { get; set; } /// @@ -353,8 +319,8 @@ public partial class CreateLabelResponseBody /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// - [JsonPropertyName("tracking_url")] - public string? TrackingUrl { get; set; } + [JsonPropertyName("tracking_url"), JsonInclude] + public string? TrackingUrl { get; private set; } /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided @@ -363,9 +329,8 @@ public partial class CreateLabelResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("voided_at")] - [JsonRequired] - public required DateTimeOffset VoidedAt { get; set; } + [JsonPropertyName("voided_at"), JsonInclude] + public DateTimeOffset? VoidedAt { get; private set; } /// diff --git a/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs b/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs index 9c128188..68178c63 100644 --- a/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs +++ b/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs @@ -35,8 +35,7 @@ public partial class CreateManifestByObjectRequestBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [JsonRequired] + [JsonPropertyName("carrier_id"), JsonRequired, JsonPropertyOrder(1)] public required string CarrierId { get; set; } /// @@ -46,8 +45,7 @@ public partial class CreateManifestByObjectRequestBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("ship_date")] - [JsonRequired] + [JsonPropertyName("ship_date"), JsonRequired, JsonPropertyOrder(2)] public required DateTimeOffset ShipDate { get; set; } /// @@ -57,22 +55,21 @@ public partial class CreateManifestByObjectRequestBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] - [JsonRequired] + [JsonPropertyName("warehouse_id"), JsonRequired, JsonPropertyOrder(3)] public required string WarehouseId { get; set; } /// /// The list of label ids to exclude from the manifest /// /// The list of label ids to exclude from the manifest - [JsonPropertyName("excluded_label_ids")] + [JsonPropertyName("excluded_label_ids"), JsonPropertyOrder(4)] public List? ExcludedLabelIds { get; set; } /// /// The list of label ids to include for the manifest /// /// The list of label ids to include for the manifest - [JsonPropertyName("label_ids")] + [JsonPropertyName("label_ids"), JsonPropertyOrder(5)] public List? LabelIds { get; set; } diff --git a/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs b/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs index 1ca43572..2658768a 100644 --- a/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs +++ b/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs @@ -32,8 +32,7 @@ public partial class CreateManifestLabelIdsRequestBody /// The list of label ids to include in the manifest /// /// The list of label ids to include in the manifest - [JsonPropertyName("label_ids")] - [JsonRequired] + [JsonPropertyName("label_ids"), JsonRequired, JsonPropertyOrder(1)] public required List LabelIds { get; set; } diff --git a/ShipEngineSDK/Model/CreateManifestResponseBody.cs b/ShipEngineSDK/Model/CreateManifestResponseBody.cs index bc32f5eb..a56e7fd7 100644 --- a/ShipEngineSDK/Model/CreateManifestResponseBody.cs +++ b/ShipEngineSDK/Model/CreateManifestResponseBody.cs @@ -35,9 +35,7 @@ public partial class CreateManifestResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [JsonRequired] - [Obsolete] + [JsonPropertyName("carrier_id"), JsonRequired, JsonPropertyOrder(1), Obsolete] public required string CarrierId { get; set; } /// @@ -47,18 +45,15 @@ public partial class CreateManifestResponseBody /// /// 2019-07-12T13:37:39.050Z /// - [JsonPropertyName("created_at")] - [JsonRequired] - [Obsolete] + [JsonPropertyName("created_at"), JsonRequired, JsonPropertyOrder(2), Obsolete] public required DateTimeOffset CreatedAt { get; set; } /// /// The errors associated with the failed API call /// /// The errors associated with the failed API call - [JsonPropertyName("errors")] - [JsonRequired] - public required List Errors { get; set; } + [JsonPropertyName("errors"), JsonInclude] + public List? Errors { get; private set; } /// /// A string that uniquely identifies the form @@ -67,17 +62,13 @@ public partial class CreateManifestResponseBody /// /// se-28529731 /// - [JsonPropertyName("form_id")] - [JsonRequired] - [Obsolete] + [JsonPropertyName("form_id"), JsonRequired, JsonPropertyOrder(4), Obsolete] public required string FormId { get; set; } /// /// Gets or Sets ManifestDownload /// - [JsonPropertyName("manifest_download")] - [JsonRequired] - [Obsolete] + [JsonPropertyName("manifest_download"), JsonRequired, JsonPropertyOrder(5), Obsolete] public required ManifestDownload ManifestDownload { get; set; } /// @@ -87,9 +78,7 @@ public partial class CreateManifestResponseBody /// /// se-28529731 /// - [JsonPropertyName("manifest_id")] - [JsonRequired] - [Obsolete] + [JsonPropertyName("manifest_id"), JsonRequired, JsonPropertyOrder(6), Obsolete] public required string ManifestId { get; set; } /// @@ -99,8 +88,7 @@ public partial class CreateManifestResponseBody /// /// aa3d8e8e-462b-4476-9618-72db7f7b7009 /// - [JsonPropertyName("request_id")] - [JsonRequired] + [JsonPropertyName("request_id"), JsonRequired, JsonPropertyOrder(7)] public required Guid RequestId { get; set; } /// @@ -110,9 +98,7 @@ public partial class CreateManifestResponseBody /// /// 2019-07-12T13:37:39.050Z /// - [JsonPropertyName("ship_date")] - [JsonRequired] - [Obsolete] + [JsonPropertyName("ship_date"), JsonRequired, JsonPropertyOrder(8), Obsolete] public required DateTimeOffset ShipDate { get; set; } /// @@ -122,10 +108,8 @@ public partial class CreateManifestResponseBody /// /// 100 /// - [JsonPropertyName("shipments")] - [JsonRequired] - [Obsolete] - public required int Shipments { get; set; } + [JsonPropertyName("shipments"), JsonInclude, Obsolete] + public int? Shipments { get; private set; } /// /// A string that uniquely identifies the submission @@ -134,9 +118,7 @@ public partial class CreateManifestResponseBody /// /// 9475711899564878915476 /// - [JsonPropertyName("submission_id")] - [JsonRequired] - [Obsolete] + [JsonPropertyName("submission_id"), JsonRequired, JsonPropertyOrder(10), Obsolete] public required string SubmissionId { get; set; } /// @@ -146,31 +128,28 @@ public partial class CreateManifestResponseBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] - [JsonRequired] - [Obsolete] + [JsonPropertyName("warehouse_id"), JsonRequired, JsonPropertyOrder(11), Obsolete] public required string WarehouseId { get; set; } /// /// An array of the label ids used in this manifest. /// /// An array of the label ids used in this manifest. - [JsonPropertyName("label_ids")] - [Obsolete] - public List? LabelIds { get; set; } + [JsonPropertyName("label_ids"), JsonInclude, Obsolete] + public List? LabelIds { get; private set; } /// /// Resulting manifest requests with statuses /// /// Resulting manifest requests with statuses - [JsonPropertyName("manifest_requests")] + [JsonPropertyName("manifest_requests"), JsonPropertyOrder(13)] public List? ManifestRequests { get; set; } /// /// Resulting Manifests /// /// Resulting Manifests - [JsonPropertyName("manifests")] + [JsonPropertyName("manifests"), JsonPropertyOrder(14)] public List? Manifests { get; set; } diff --git a/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs b/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs index 2403b59e..c1c553e1 100644 --- a/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs +++ b/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs @@ -34,8 +34,7 @@ public partial class CreatePackageTypeRequestBody /// /// laptop_box /// - [JsonPropertyName("name")] - [JsonRequired] + [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(1)] public required string Name { get; set; } /// @@ -45,8 +44,7 @@ public partial class CreatePackageTypeRequestBody /// /// small_flat_rate_box /// - [JsonPropertyName("package_code")] - [JsonRequired] + [JsonPropertyName("package_code"), JsonRequired, JsonPropertyOrder(2)] public required string PackageCode { get; set; } /// @@ -56,14 +54,14 @@ public partial class CreatePackageTypeRequestBody /// /// Packaging for laptops /// - [JsonPropertyName("description")] + [JsonPropertyName("description"), JsonPropertyOrder(3)] public string? Description { get; set; } /// /// The custom dimensions for the package. /// /// The custom dimensions for the package. - [JsonPropertyName("dimensions")] + [JsonPropertyName("dimensions"), JsonPropertyOrder(4)] public Dimensions? Dimensions { get; set; } /// @@ -73,7 +71,7 @@ public partial class CreatePackageTypeRequestBody /// /// se-28529731 /// - [JsonPropertyName("package_id")] + [JsonPropertyName("package_id"), JsonPropertyOrder(5)] public string? PackageId { get; set; } diff --git a/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs b/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs index 4e1e6847..b75b9ff0 100644 --- a/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs +++ b/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs @@ -34,8 +34,7 @@ public partial class CreatePackageTypeResponseBody /// /// laptop_box /// - [JsonPropertyName("name")] - [JsonRequired] + [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(1)] public required string Name { get; set; } /// @@ -45,8 +44,7 @@ public partial class CreatePackageTypeResponseBody /// /// small_flat_rate_box /// - [JsonPropertyName("package_code")] - [JsonRequired] + [JsonPropertyName("package_code"), JsonRequired, JsonPropertyOrder(2)] public required string PackageCode { get; set; } /// @@ -56,14 +54,14 @@ public partial class CreatePackageTypeResponseBody /// /// Packaging for laptops /// - [JsonPropertyName("description")] + [JsonPropertyName("description"), JsonPropertyOrder(3)] public string? Description { get; set; } /// /// The custom dimensions for the package. /// /// The custom dimensions for the package. - [JsonPropertyName("dimensions")] + [JsonPropertyName("dimensions"), JsonPropertyOrder(4)] public Dimensions? Dimensions { get; set; } /// @@ -73,7 +71,7 @@ public partial class CreatePackageTypeResponseBody /// /// se-28529731 /// - [JsonPropertyName("package_id")] + [JsonPropertyName("package_id"), JsonPropertyOrder(5)] public string? PackageId { get; set; } diff --git a/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs b/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs index 21436975..f973f35d 100644 --- a/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs +++ b/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs @@ -29,34 +29,39 @@ public partial class CreateReturnLabelRequestBody { /// - /// The label charge event. CLOVUS + /// The label charge event. /// /// The label charge event. - [JsonPropertyName("charge_event")] + [JsonPropertyName("charge_event"), JsonPropertyOrder(1)] public LabelChargeEvent? ChargeEvent { get; set; } + /// - /// The display format that the label should be shown in. CLOVUS + /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(2)] public DisplayScheme? DisplayScheme { get; set; } + /// - /// Gets or Sets LabelDownloadType CLOVUS + /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type")] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(3)] 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. CLOVUS + /// 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")] + [JsonPropertyName("label_format"), JsonPropertyOrder(4)] public LabelFormat? LabelFormat { 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. CLOVUS + /// 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")] + [JsonPropertyName("label_layout"), JsonPropertyOrder(6)] public LabelLayout? LabelLayout { get; set; } + /// /// The label image resource that was used to create a custom label image. /// @@ -64,7 +69,7 @@ public partial class CreateReturnLabelRequestBody /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id")] + [JsonPropertyName("label_image_id"), JsonPropertyOrder(5)] public string? LabelImageId { get; set; } diff --git a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs index 84bfb2c1..bd3d49fb 100644 --- a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs @@ -29,56 +29,64 @@ public partial class CreateReturnLabelResponseBody { /// - /// The label charge event. CLOVUS + /// The label charge event. /// /// The label charge event. - [JsonPropertyName("charge_event")] + [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] public LabelChargeEvent? ChargeEvent { get; set; } + /// - /// The display format that the label should be shown in. CLOVUS + /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(7)] public DisplayScheme? DisplayScheme { get; set; } + /// - /// Gets or Sets LabelDownloadType CLOVUS + /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type")] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(14)] 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. CLOVUS + /// 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")] + [JsonPropertyName("label_format"), JsonPropertyOrder(15)] public LabelFormat? LabelFormat { 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. CLOVUS + /// 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")] + [JsonPropertyName("label_layout"), JsonPropertyOrder(18)] public LabelLayout? LabelLayout { get; set; } + /// - /// Gets or Sets Status CLOVUS + /// Gets or Sets Status /// - [JsonPropertyName("status")] - public LabelStatus? Status { get; set; } + [JsonPropertyName("status"), JsonInclude] + public LabelStatus? Status { get; private set; } + /// - /// The current status of the package, such as `in_transit` or `delivered` CLOVUS + /// The current status of the package, such as `in_transit` or `delivered` /// /// The current status of the package, such as `in_transit` or `delivered` - [JsonPropertyName("tracking_status")] - public TrackingStatus? TrackingStatus { get; set; } + [JsonPropertyName("tracking_status"), JsonInclude] + public TrackingStatus? TrackingStatus { get; private set; } + /// - /// Gets or Sets ValidateAddress CLOVUS + /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address")] + [JsonPropertyName("validate_address"), JsonPropertyOrder(36)] public ValidateAddress? ValidateAddress { get; set; } + /// /// Additional information some carriers may provide by which to identify a given label in their system. /// /// Additional information some carriers may provide by which to identify a given label in their system. - [JsonPropertyName("alternative_identifiers")] - public List? AlternativeIdentifiers { get; set; } + [JsonPropertyName("alternative_identifiers"), JsonInclude] + public List? AlternativeIdentifiers { get; private set; } /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. @@ -87,8 +95,8 @@ public partial class CreateReturnLabelResponseBody /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - public string? BatchId { get; set; } + [JsonPropertyName("batch_id"), JsonInclude] + public string? BatchId { get; private set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. @@ -97,8 +105,8 @@ public partial class CreateReturnLabelResponseBody /// /// dhl_express /// - [JsonPropertyName("carrier_code")] - public string? CarrierCode { get; set; } + [JsonPropertyName("carrier_code"), JsonInclude] + public string? CarrierCode { get; private set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label @@ -107,8 +115,8 @@ public partial class CreateReturnLabelResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - public string? CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// The date and time that the label was created in ShipEngine. @@ -117,49 +125,49 @@ public partial class CreateReturnLabelResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private 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. /// /// 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. - [JsonPropertyName("form_download")] - public Link? FormDownload { get; set; } + [JsonPropertyName("form_download"), JsonInclude] + public Link? FormDownload { get; private set; } /// /// 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. /// /// 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. - [JsonPropertyName("insurance_claim")] - public Link? InsuranceClaim { get; set; } + [JsonPropertyName("insurance_claim"), JsonInclude] + public Link? InsuranceClaim { get; private set; } /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. - [JsonPropertyName("insurance_cost")] - public MonetaryValue? InsuranceCost { get; set; } + [JsonPropertyName("insurance_cost"), JsonInclude] + public MonetaryValue? InsuranceCost { get; private set; } /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. - [JsonPropertyName("is_international")] - public bool? IsInternational { get; set; } + [JsonPropertyName("is_international"), JsonInclude] + public bool? IsInternational { get; private set; } /// /// 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")] + [JsonPropertyName("is_return_label"), JsonPropertyOrder(12)] public bool? IsReturnLabel { get; set; } /// /// Gets or Sets LabelDownload /// - [JsonPropertyName("label_download")] - public LabelDownload? LabelDownload { get; set; } + [JsonPropertyName("label_download"), JsonInclude] + public LabelDownload? LabelDownload { get; private set; } /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. @@ -168,8 +176,8 @@ public partial class CreateReturnLabelResponseBody /// /// se-28529731 /// - [JsonPropertyName("label_id")] - public string? LabelId { get; set; } + [JsonPropertyName("label_id"), JsonInclude] + public string? LabelId { get; private set; } /// /// The label image resource that was used to create a custom label image. @@ -178,7 +186,7 @@ public partial class CreateReturnLabelResponseBody /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id")] + [JsonPropertyName("label_image_id"), JsonPropertyOrder(17)] public string? LabelImageId { get; set; } /// @@ -188,7 +196,7 @@ public partial class CreateReturnLabelResponseBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id")] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19)] public string? OutboundLabelId { get; set; } /// @@ -198,35 +206,35 @@ public partial class CreateReturnLabelResponseBody /// /// small_flat_rate_box /// - [JsonPropertyName("package_code")] - public string? PackageCode { get; set; } + [JsonPropertyName("package_code"), JsonInclude] + public string? PackageCode { get; private set; } /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - public List? Packages { get; set; } + [JsonPropertyName("packages"), JsonInclude] + public List? Packages { get; private set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - public PaperlessDownload? PaperlessDownload { get; set; } + [JsonPropertyName("paperless_download"), JsonInclude] + public PaperlessDownload? PaperlessDownload { get; private set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue? RequestedComparisonAmount { get; set; } + [JsonPropertyName("requested_comparison_amount"), JsonInclude] + public MonetaryValue? RequestedComparisonAmount { get; private set; } /// /// 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")] + [JsonPropertyName("rma_number"), JsonPropertyOrder(24)] public string? RmaNumber { get; set; } /// @@ -236,8 +244,8 @@ public partial class CreateReturnLabelResponseBody /// /// usps_first_class_mail /// - [JsonPropertyName("service_code")] - public string? ServiceCode { get; set; } + [JsonPropertyName("service_code"), JsonInclude] + public string? ServiceCode { get; private set; } /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -246,22 +254,22 @@ public partial class CreateReturnLabelResponseBody /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date")] - public DateTimeOffset? ShipDate { get; set; } + [JsonPropertyName("ship_date"), JsonInclude] + public DateTimeOffset? ShipDate { get; private set; } /// /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment")] + [JsonPropertyName("shipment"), JsonPropertyOrder(27)] public Shipment? Shipment { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - [JsonPropertyName("shipment_cost")] - public MonetaryValue? ShipmentCost { get; set; } + [JsonPropertyName("shipment_cost"), JsonInclude] + public MonetaryValue? ShipmentCost { get; private set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) @@ -270,23 +278,22 @@ public partial class CreateReturnLabelResponseBody /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string? ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private 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")] - [Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(31), Obsolete] public bool? TestLabel { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. - [JsonPropertyName("trackable")] - public bool? Trackable { get; set; } + [JsonPropertyName("trackable"), JsonInclude] + public bool? Trackable { get; private set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. @@ -295,8 +302,8 @@ public partial class CreateReturnLabelResponseBody /// /// 782758401696 /// - [JsonPropertyName("tracking_number")] - public string? TrackingNumber { get; set; } + [JsonPropertyName("tracking_number"), JsonInclude] + public string? TrackingNumber { get; private set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. @@ -305,15 +312,15 @@ public partial class CreateReturnLabelResponseBody /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// - [JsonPropertyName("tracking_url")] - public string? TrackingUrl { get; set; } + [JsonPropertyName("tracking_url"), JsonInclude] + public string? TrackingUrl { get; private set; } /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) - [JsonPropertyName("voided")] - public bool? Voided { get; set; } + [JsonPropertyName("voided"), JsonInclude] + public bool? Voided { get; private set; } /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided @@ -322,8 +329,8 @@ public partial class CreateReturnLabelResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("voided_at")] - public DateTimeOffset? VoidedAt { get; set; } + [JsonPropertyName("voided_at"), JsonInclude] + public DateTimeOffset? VoidedAt { get; private set; } /// diff --git a/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs b/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs index 11e42c0a..384eebeb 100644 --- a/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs +++ b/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs @@ -32,16 +32,15 @@ public partial class CreateShipmentResponseBodyFields /// The address validation /// /// The address validation - [JsonPropertyName("address_validation")] + [JsonPropertyName("address_validation"), JsonPropertyOrder(1)] public AddressValidationResult? AddressValidation { get; set; } /// /// An array of errors that occurred while creating shipment. /// /// An array of errors that occurred while creating shipment. - [JsonPropertyName("errors")] - [Obsolete] - public List? Errors { get; set; } + [JsonPropertyName("errors"), JsonInclude, Obsolete] + public List? Errors { get; private set; } /// diff --git a/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs b/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs index 1e9f495f..d8824e3d 100644 --- a/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs +++ b/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs @@ -32,8 +32,7 @@ public partial class CreateShipmentsRequestBody /// An array of shipments to be created. /// /// An array of shipments to be created. - [JsonPropertyName("shipments")] - [JsonRequired] + [JsonPropertyName("shipments"), JsonRequired, JsonPropertyOrder(1)] public required List Shipments { get; set; } diff --git a/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs b/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs index 8504313c..ff29860d 100644 --- a/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs +++ b/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs @@ -32,16 +32,14 @@ public partial class CreateShipmentsResponseBody /// An array of shipments that were created. /// /// An array of shipments that were created. - [JsonPropertyName("shipments")] - [JsonRequired] + [JsonPropertyName("shipments"), JsonRequired, JsonPropertyOrder(1)] public required List Shipments { get; set; } /// /// Indicates if errors occured while creating the shipments /// /// Indicates if errors occured while creating the shipments - [JsonPropertyName("has_errors")] - [JsonRequired] + [JsonPropertyName("has_errors"), JsonRequired, JsonPropertyOrder(2)] public required bool HasErrors { get; set; } diff --git a/ShipEngineSDK/Model/CreateTagResponseBody.cs b/ShipEngineSDK/Model/CreateTagResponseBody.cs index f758b98a..43047f4e 100644 --- a/ShipEngineSDK/Model/CreateTagResponseBody.cs +++ b/ShipEngineSDK/Model/CreateTagResponseBody.cs @@ -35,8 +35,7 @@ public partial class CreateTagResponseBody /// /// Fragile /// - [JsonPropertyName("name")] - [JsonRequired] + [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(1)] public required string Name { get; set; } diff --git a/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs b/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs index 9297d7db..3755a0f8 100644 --- a/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs +++ b/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs @@ -35,16 +35,14 @@ public partial class CreateWarehouseRequestBody /// /// Zero Cool HQ /// - [JsonPropertyName("name")] - [JsonRequired] + [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(1)] public required string Name { get; set; } /// /// The origin address of the warehouse /// /// The origin address of the warehouse - [JsonPropertyName("origin_address")] - [JsonRequired] + [JsonPropertyName("origin_address"), JsonRequired, JsonPropertyOrder(2)] public required Address OriginAddress { get; set; } /// @@ -54,21 +52,21 @@ public partial class CreateWarehouseRequestBody /// /// 2019-06-25T18:12:35.583Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// Designates which single warehouse is the default on the account /// /// Designates which single warehouse is the default on the account - [JsonPropertyName("is_default")] + [JsonPropertyName("is_default"), JsonPropertyOrder(4)] public bool? IsDefault { get; set; } /// /// The return address associated with the warehouse /// /// The return address associated with the warehouse - [JsonPropertyName("return_address")] + [JsonPropertyName("return_address"), JsonPropertyOrder(5)] public Address? ReturnAddress { get; set; } /// @@ -78,8 +76,8 @@ public partial class CreateWarehouseRequestBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] - public string? WarehouseId { get; set; } + [JsonPropertyName("warehouse_id"), JsonInclude] + public string? WarehouseId { get; private set; } /// diff --git a/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs b/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs index 971a50f9..245caf67 100644 --- a/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs +++ b/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs @@ -35,9 +35,8 @@ public partial class CreateWarehouseResponseBody /// /// 2019-06-25T18:12:35.583Z /// - [JsonPropertyName("created_at")] - [JsonRequired] - public required DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// Name of the warehouse @@ -46,24 +45,21 @@ public partial class CreateWarehouseResponseBody /// /// Zero Cool HQ /// - [JsonPropertyName("name")] - [JsonRequired] + [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(2)] public required string Name { get; set; } /// /// The origin address of the warehouse /// /// The origin address of the warehouse - [JsonPropertyName("origin_address")] - [JsonRequired] + [JsonPropertyName("origin_address"), JsonRequired, JsonPropertyOrder(3)] public required Address OriginAddress { get; set; } /// /// The return address associated with the warehouse /// /// The return address associated with the warehouse - [JsonPropertyName("return_address")] - [JsonRequired] + [JsonPropertyName("return_address"), JsonRequired, JsonPropertyOrder(4)] public required Address ReturnAddress { get; set; } /// @@ -73,15 +69,14 @@ public partial class CreateWarehouseResponseBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] - [JsonRequired] - public required string WarehouseId { get; set; } + [JsonPropertyName("warehouse_id"), JsonInclude] + public string? WarehouseId { get; private set; } /// /// Designates which single warehouse is the default on the account /// /// Designates which single warehouse is the default on the account - [JsonPropertyName("is_default")] + [JsonPropertyName("is_default"), JsonPropertyOrder(6)] public bool? IsDefault { get; set; } diff --git a/ShipEngineSDK/Model/CreateWebhookRequestBody.cs b/ShipEngineSDK/Model/CreateWebhookRequestBody.cs index 39a49813..0d50d616 100644 --- a/ShipEngineSDK/Model/CreateWebhookRequestBody.cs +++ b/ShipEngineSDK/Model/CreateWebhookRequestBody.cs @@ -29,12 +29,10 @@ public partial class CreateWebhookRequestBody { /// - /// Gets or Sets Event CLOVUS + /// Gets or Sets Event /// - [JsonPropertyName("event")] - [JsonRequired] - public required WebhookEvent Event { get; set; } = new(); - + [JsonPropertyName("event"), JsonRequired, JsonPropertyOrder(1)] + public required WebhookEvent Event { get; set; } /// /// The url that the webhook sends the request to @@ -43,15 +41,14 @@ public partial class CreateWebhookRequestBody /// /// http://api.shipengine.com/v1/labels/se-28529731 /// - [JsonPropertyName("url")] - [JsonRequired] + [JsonPropertyName("url"), JsonRequired, JsonPropertyOrder(2)] public required string Url { get; set; } /// /// Array of custom webhook headers /// /// Array of custom webhook headers - [JsonPropertyName("headers")] + [JsonPropertyName("headers"), JsonPropertyOrder(3)] public List? Headers { get; set; } diff --git a/ShipEngineSDK/Model/CreateWebhookResponseBody.cs b/ShipEngineSDK/Model/CreateWebhookResponseBody.cs index 9ce0e612..fdaaff7a 100644 --- a/ShipEngineSDK/Model/CreateWebhookResponseBody.cs +++ b/ShipEngineSDK/Model/CreateWebhookResponseBody.cs @@ -29,12 +29,10 @@ public partial class CreateWebhookResponseBody { /// - /// Gets or Sets Event CLOVUS + /// Gets or Sets Event /// - [JsonPropertyName("event")] - [JsonRequired] - public required WebhookEvent Event { get; set; } = new(); - + [JsonPropertyName("event"), JsonRequired, JsonPropertyOrder(1)] + public required WebhookEvent Event { get; set; } /// /// The url that the webhook sends the request to @@ -43,8 +41,7 @@ public partial class CreateWebhookResponseBody /// /// http://api.shipengine.com/v1/labels/se-28529731 /// - [JsonPropertyName("url")] - [JsonRequired] + [JsonPropertyName("url"), JsonRequired, JsonPropertyOrder(2)] public required string Url { get; set; } /// @@ -54,15 +51,14 @@ public partial class CreateWebhookResponseBody /// /// se-28529731 /// - [JsonPropertyName("webhook_id")] - [JsonRequired] - public required string WebhookId { get; set; } + [JsonPropertyName("webhook_id"), JsonInclude] + public string? WebhookId { get; private set; } /// /// Array of custom webhook headers /// /// Array of custom webhook headers - [JsonPropertyName("headers")] + [JsonPropertyName("headers"), JsonPropertyOrder(4)] public List? Headers { get; set; } diff --git a/ShipEngineSDK/Model/CustomsItem.cs b/ShipEngineSDK/Model/CustomsItem.cs index 0d2ac99f..4e6ac0b3 100644 --- a/ShipEngineSDK/Model/CustomsItem.cs +++ b/ShipEngineSDK/Model/CustomsItem.cs @@ -35,9 +35,8 @@ public partial class CustomsItem /// /// se-28529731 /// - [JsonPropertyName("customs_item_id")] - [JsonRequired] - public required string CustomsItemId { get; set; } + [JsonPropertyName("customs_item_id"), JsonInclude] + public string? CustomsItemId { get; private set; } /// /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated @@ -46,14 +45,14 @@ public partial class CustomsItem /// /// CA /// - [JsonPropertyName("country_of_origin")] + [JsonPropertyName("country_of_origin"), JsonPropertyOrder(2)] public string? CountryOfOrigin { get; set; } /// /// A description of the item /// /// A description of the item - [JsonPropertyName("description")] + [JsonPropertyName("description"), JsonPropertyOrder(3)] public string? Description { get; set; } /// @@ -63,55 +62,55 @@ public partial class CustomsItem /// /// 3926.1 /// - [JsonPropertyName("harmonized_tariff_code")] + [JsonPropertyName("harmonized_tariff_code"), JsonPropertyOrder(4)] public string? HarmonizedTariffCode { get; set; } /// /// The quantity of this item in the shipment. /// /// The quantity of this item in the shipment. - [JsonPropertyName("quantity")] + [JsonPropertyName("quantity"), JsonPropertyOrder(5)] public int? Quantity { get; set; } /// /// The SKU (Stock Keeping Unit) of the customs item /// /// The SKU (Stock Keeping Unit) of the customs item - [JsonPropertyName("sku")] + [JsonPropertyName("sku"), JsonPropertyOrder(6)] public string? Sku { get; set; } /// /// Description of the Custom Item's SKU /// /// Description of the Custom Item's SKU - [JsonPropertyName("sku_description")] + [JsonPropertyName("sku_description"), JsonPropertyOrder(7)] public string? SkuDescription { get; set; } /// /// Gets or Sets UnitOfMeasure /// - [JsonPropertyName("unit_of_measure")] + [JsonPropertyName("unit_of_measure"), JsonPropertyOrder(8)] public string? UnitOfMeasure { get; set; } /// /// The monetary amount, in the specified currency. /// /// The monetary amount, in the specified currency. - [JsonPropertyName("value")] + [JsonPropertyName("value"), JsonPropertyOrder(9)] public double? Value { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("value_currency")] + [JsonPropertyName("value_currency"), JsonPropertyOrder(10)] public string? ValueCurrency { get; set; } /// /// The item weight /// /// The item weight - [JsonPropertyName("weight")] + [JsonPropertyName("weight"), JsonPropertyOrder(11)] public Weight? Weight { get; set; } diff --git a/ShipEngineSDK/Model/DangerousAmount.cs b/ShipEngineSDK/Model/DangerousAmount.cs index d81ac2a2..2e0ce79a 100644 --- a/ShipEngineSDK/Model/DangerousAmount.cs +++ b/ShipEngineSDK/Model/DangerousAmount.cs @@ -32,14 +32,14 @@ public partial class DangerousAmount /// The amount of dangerous goods. /// /// The amount of dangerous goods. - [JsonPropertyName("amount")] + [JsonPropertyName("amount"), JsonPropertyOrder(1)] public double? Amount { get; set; } /// /// The unit of dangerous goods. /// /// The unit of dangerous goods. - [JsonPropertyName("unit")] + [JsonPropertyName("unit"), JsonPropertyOrder(2)] public string? Unit { get; set; } diff --git a/ShipEngineSDK/Model/DangerousGoods.cs b/ShipEngineSDK/Model/DangerousGoods.cs index bf2e5e7d..fc6c0d5c 100644 --- a/ShipEngineSDK/Model/DangerousGoods.cs +++ b/ShipEngineSDK/Model/DangerousGoods.cs @@ -29,79 +29,83 @@ public partial class DangerousGoods { /// - /// Gets or Sets PackagingGroup CLOVUS + /// Gets or Sets PackagingGroup /// - [JsonPropertyName("packaging_group")] + [JsonPropertyName("packaging_group"), JsonPropertyOrder(4)] public PackagingGroup? PackagingGroup { get; set; } + /// - /// Gets or Sets PackagingInstructionSection CLOVUS + /// Gets or Sets PackagingInstructionSection /// - [JsonPropertyName("packaging_instruction_section")] + [JsonPropertyName("packaging_instruction_section"), JsonPropertyOrder(6)] public PackagingInstructionSection? PackagingInstructionSection { get; set; } + /// - /// Gets or Sets RegulationLevel CLOVUS + /// Gets or Sets RegulationLevel /// - [JsonPropertyName("regulation_level")] + [JsonPropertyName("regulation_level"), JsonPropertyOrder(13)] public RegulationLevel? RegulationLevel { get; set; } + /// - /// Gets or Sets TransportMean CLOVUS + /// Gets or Sets TransportMean /// - [JsonPropertyName("transport_mean")] + [JsonPropertyName("transport_mean"), JsonPropertyOrder(18)] public TransportMean? TransportMean { get; set; } + /// /// Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier /// /// Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier - [JsonPropertyName("additional_description")] + [JsonPropertyName("additional_description"), JsonPropertyOrder(1)] public string? AdditionalDescription { get; set; } /// /// This model represents the amount of the dangerous goods. /// /// This model represents the amount of the dangerous goods. - [JsonPropertyName("dangerous_amount")] + [JsonPropertyName("dangerous_amount"), JsonPropertyOrder(2)] public DangerousAmount? DangerousAmount { get; set; } /// /// UN number to identify the dangerous goods. /// /// UN number to identify the dangerous goods. - [JsonPropertyName("id_number")] + [JsonPropertyName("id_number"), JsonPropertyOrder(3)] public string? IdNumber { get; set; } /// /// The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container. /// /// The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container. - [JsonPropertyName("packaging_instruction")] + [JsonPropertyName("packaging_instruction"), JsonPropertyOrder(5)] public string? PackagingInstruction { get; set; } /// /// The type of exterior packaging used to contain the dangerous good. /// /// The type of exterior packaging used to contain the dangerous good. - [JsonPropertyName("packaging_type")] + [JsonPropertyName("packaging_type"), JsonPropertyOrder(7)] public string? PackagingType { get; set; } /// /// Dangerous goods product class based on regulation. /// /// Dangerous goods product class based on regulation. - [JsonPropertyName("product_class")] + [JsonPropertyName("product_class"), JsonPropertyOrder(8)] public string? ProductClass { get; set; } /// /// A secondary of product class for substances presenting more than one particular hazard /// /// A secondary of product class for substances presenting more than one particular hazard - [JsonPropertyName("product_class_subsidiary")] + [JsonPropertyName("product_class_subsidiary"), JsonPropertyOrder(9)] public string? ProductClassSubsidiary { get; set; } /// /// Quantity of dangerous goods. /// /// Quantity of dangerous goods. - [JsonPropertyName("quantity")] + [JsonPropertyName("quantity"), JsonPropertyOrder(10)] public int? Quantity { get; set; } /// @@ -111,14 +115,14 @@ public partial class DangerousGoods /// /// false /// - [JsonPropertyName("radioactive")] + [JsonPropertyName("radioactive"), JsonPropertyOrder(11)] public bool? Radioactive { get; set; } /// /// Name of the regulatory authority. /// /// Name of the regulatory authority. - [JsonPropertyName("regulation_authority")] + [JsonPropertyName("regulation_authority"), JsonPropertyOrder(12)] public string? RegulationAuthority { get; set; } /// @@ -128,35 +132,35 @@ public partial class DangerousGoods /// /// false /// - [JsonPropertyName("reportable_quantity")] + [JsonPropertyName("reportable_quantity"), JsonPropertyOrder(14)] public bool? ReportableQuantity { get; set; } /// /// Trade description of the dangerous goods. /// /// Trade description of the dangerous goods. - [JsonPropertyName("shipping_name")] + [JsonPropertyName("shipping_name"), JsonPropertyOrder(15)] public string? ShippingName { get; set; } /// /// Recognized Technical or chemical name of dangerous goods. /// /// Recognized Technical or chemical name of dangerous goods. - [JsonPropertyName("technical_name")] + [JsonPropertyName("technical_name"), JsonPropertyOrder(16)] public string? TechnicalName { get; set; } /// /// Transport category assign to dangerous goods for the transport purpose. /// /// Transport category assign to dangerous goods for the transport purpose. - [JsonPropertyName("transport_category")] + [JsonPropertyName("transport_category"), JsonPropertyOrder(17)] public string? TransportCategory { get; set; } /// /// Defines which types of tunnels the shipment is allowed to go through /// /// Defines which types of tunnels the shipment is allowed to go through - [JsonPropertyName("tunnel_code")] + [JsonPropertyName("tunnel_code"), JsonPropertyOrder(19)] public string? TunnelCode { get; set; } diff --git a/ShipEngineSDK/Model/DefaultLabelLayout.cs b/ShipEngineSDK/Model/DefaultLabelLayout.cs index c980735d..da2e059d 100644 --- a/ShipEngineSDK/Model/DefaultLabelLayout.cs +++ b/ShipEngineSDK/Model/DefaultLabelLayout.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(DefaultLabelLayoutJsonConverter))] public class DefaultLabelLayout { - private string _value; + private readonly string _value; /// /// Create a new instance of DefaultLabelLayout with a predefined value. @@ -68,6 +68,12 @@ public DefaultLabelLayout(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is DefaultLabelLayout other && _value == other._value; } internal class DefaultLabelLayoutJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs b/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs index 0156170b..05d88b01 100644 --- a/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs +++ b/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs @@ -32,9 +32,8 @@ public partial class DeletePickupByIdResponseBody /// The errors associated with the failed API call /// /// The errors associated with the failed API call - [JsonPropertyName("errors")] - [JsonRequired] - public required List Errors { get; set; } + [JsonPropertyName("errors"), JsonInclude] + public List? Errors { get; private set; } /// /// Pickup Resource ID @@ -43,8 +42,7 @@ public partial class DeletePickupByIdResponseBody /// /// pik_3YcKU5zdtJuCqoeNwyqqbW /// - [JsonPropertyName("pickup_id")] - [JsonRequired] + [JsonPropertyName("pickup_id"), JsonRequired, JsonPropertyOrder(2)] public required string PickupId { get; set; } /// @@ -54,8 +52,7 @@ public partial class DeletePickupByIdResponseBody /// /// aa3d8e8e-462b-4476-9618-72db7f7b7009 /// - [JsonPropertyName("request_id")] - [JsonRequired] + [JsonPropertyName("request_id"), JsonRequired, JsonPropertyOrder(3)] public required Guid RequestId { get; set; } diff --git a/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs b/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs index 8e63b7a1..53a5a06f 100644 --- a/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs +++ b/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs @@ -35,8 +35,7 @@ public partial class DeleteScheduledPickupResponseBody /// /// pik_3YcKU5zdtJuCqoeNwyqqbW /// - [JsonPropertyName("pickup_id")] - [JsonRequired] + [JsonPropertyName("pickup_id"), JsonRequired, JsonPropertyOrder(1)] public required string PickupId { get; set; } diff --git a/ShipEngineSDK/Model/DeliveryConfirmation.cs b/ShipEngineSDK/Model/DeliveryConfirmation.cs index e7a0fbb1..2d6a370b 100644 --- a/ShipEngineSDK/Model/DeliveryConfirmation.cs +++ b/ShipEngineSDK/Model/DeliveryConfirmation.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(DeliveryConfirmationJsonConverter))] public class DeliveryConfirmation { - private string _value; + private readonly string _value; /// /// Create a new instance of DeliveryConfirmation with a predefined value. @@ -98,6 +98,12 @@ public DeliveryConfirmation(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is DeliveryConfirmation other && _value == other._value; } internal class DeliveryConfirmationJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/DeprecatedManifest.cs b/ShipEngineSDK/Model/DeprecatedManifest.cs index fa2cd827..d73e5240 100644 --- a/ShipEngineSDK/Model/DeprecatedManifest.cs +++ b/ShipEngineSDK/Model/DeprecatedManifest.cs @@ -35,8 +35,7 @@ public partial class DeprecatedManifest /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [Obsolete] + [JsonPropertyName("carrier_id"), JsonPropertyOrder(1), Obsolete] public string? CarrierId { get; set; } /// @@ -46,8 +45,7 @@ public partial class DeprecatedManifest /// /// 2019-07-12T13:37:39.050Z /// - [JsonPropertyName("created_at")] - [Obsolete] + [JsonPropertyName("created_at"), JsonPropertyOrder(2), Obsolete] public DateTimeOffset? CreatedAt { get; set; } /// @@ -57,23 +55,20 @@ public partial class DeprecatedManifest /// /// se-28529731 /// - [JsonPropertyName("form_id")] - [Obsolete] + [JsonPropertyName("form_id"), JsonPropertyOrder(3), Obsolete] public string? FormId { get; set; } /// /// An array of the label ids used in this manifest. /// /// An array of the label ids used in this manifest. - [JsonPropertyName("label_ids")] - [Obsolete] - public List? LabelIds { get; set; } + [JsonPropertyName("label_ids"), JsonInclude, Obsolete] + public List? LabelIds { get; private set; } /// /// Gets or Sets ManifestDownload /// - [JsonPropertyName("manifest_download")] - [Obsolete] + [JsonPropertyName("manifest_download"), JsonPropertyOrder(5), Obsolete] public ManifestDownload? ManifestDownload { get; set; } /// @@ -83,8 +78,7 @@ public partial class DeprecatedManifest /// /// se-28529731 /// - [JsonPropertyName("manifest_id")] - [Obsolete] + [JsonPropertyName("manifest_id"), JsonPropertyOrder(6), Obsolete] public string? ManifestId { get; set; } /// @@ -94,8 +88,7 @@ public partial class DeprecatedManifest /// /// 2019-07-12T13:37:39.050Z /// - [JsonPropertyName("ship_date")] - [Obsolete] + [JsonPropertyName("ship_date"), JsonPropertyOrder(7), Obsolete] public DateTimeOffset? ShipDate { get; set; } /// @@ -105,9 +98,8 @@ public partial class DeprecatedManifest /// /// 100 /// - [JsonPropertyName("shipments")] - [Obsolete] - public int? Shipments { get; set; } + [JsonPropertyName("shipments"), JsonInclude, Obsolete] + public int? Shipments { get; private set; } /// /// A string that uniquely identifies the submission @@ -116,8 +108,7 @@ public partial class DeprecatedManifest /// /// 9475711899564878915476 /// - [JsonPropertyName("submission_id")] - [Obsolete] + [JsonPropertyName("submission_id"), JsonPropertyOrder(9), Obsolete] public string? SubmissionId { get; set; } /// @@ -127,8 +118,7 @@ public partial class DeprecatedManifest /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] - [Obsolete] + [JsonPropertyName("warehouse_id"), JsonPropertyOrder(10), Obsolete] public string? WarehouseId { get; set; } diff --git a/ShipEngineSDK/Model/DhlExpressAccountSettings.cs b/ShipEngineSDK/Model/DhlExpressAccountSettings.cs index 92e6cb5f..30124d28 100644 --- a/ShipEngineSDK/Model/DhlExpressAccountSettings.cs +++ b/ShipEngineSDK/Model/DhlExpressAccountSettings.cs @@ -32,21 +32,21 @@ public partial class DhlExpressAccountSettings /// Indicates if this is primary account /// /// Indicates if this is primary account - [JsonPropertyName("is_primary_account")] + [JsonPropertyName("is_primary_account"), JsonPropertyOrder(1)] public bool? IsPrimaryAccount { get; set; } /// /// Account nickname /// /// Account nickname - [JsonPropertyName("nickname")] + [JsonPropertyName("nickname"), JsonPropertyOrder(2)] public string? Nickname { get; set; } /// /// Indicates if the account number should be hidden on the archive documentation /// /// Indicates if the account number should be hidden on the archive documentation - [JsonPropertyName("should_hide_account_number_on_archive_doc")] + [JsonPropertyName("should_hide_account_number_on_archive_doc"), JsonPropertyOrder(3)] public bool? ShouldHideAccountNumberOnArchiveDoc { get; set; } diff --git a/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs b/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs index 6d278de5..8f21712f 100644 --- a/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs @@ -32,21 +32,21 @@ public partial class DhlExpressSettingsResponseBody /// Indicates if this is primary account /// /// Indicates if this is primary account - [JsonPropertyName("is_primary_account")] + [JsonPropertyName("is_primary_account"), JsonPropertyOrder(1)] public bool? IsPrimaryAccount { get; set; } /// /// Account nickname /// /// Account nickname - [JsonPropertyName("nickname")] + [JsonPropertyName("nickname"), JsonPropertyOrder(2)] public string? Nickname { get; set; } /// /// Indicates if the account number should be hidden on the archive documentation /// /// Indicates if the account number should be hidden on the archive documentation - [JsonPropertyName("should_hide_account_number_on_archive_doc")] + [JsonPropertyName("should_hide_account_number_on_archive_doc"), JsonPropertyOrder(3)] public bool? ShouldHideAccountNumberOnArchiveDoc { get; set; } diff --git a/ShipEngineSDK/Model/DimensionUnit.cs b/ShipEngineSDK/Model/DimensionUnit.cs index 0621116c..d66f3a5a 100644 --- a/ShipEngineSDK/Model/DimensionUnit.cs +++ b/ShipEngineSDK/Model/DimensionUnit.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(DimensionUnitJsonConverter))] public class DimensionUnit { - private string _value; + private readonly string _value; /// /// Create a new instance of DimensionUnit with a predefined value. @@ -68,6 +68,12 @@ public DimensionUnit(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is DimensionUnit other && _value == other._value; } internal class DimensionUnitJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/Dimensions.cs b/ShipEngineSDK/Model/Dimensions.cs index 476675a7..127b8ec2 100644 --- a/ShipEngineSDK/Model/Dimensions.cs +++ b/ShipEngineSDK/Model/Dimensions.cs @@ -29,35 +29,30 @@ public partial class Dimensions { /// - /// Gets or Sets Unit CLOVUS + /// Gets or Sets Unit /// - [JsonPropertyName("unit")] - [JsonRequired] - public required DimensionUnit Unit { get; set; } = new(); - + [JsonPropertyName("unit"), JsonRequired, JsonPropertyOrder(1)] + public required DimensionUnit Unit { get; set; } /// /// The height of the package, in the specified unit /// /// The height of the package, in the specified unit - [JsonPropertyName("height")] - [JsonRequired] + [JsonPropertyName("height"), JsonRequired, JsonPropertyOrder(2)] public required double Height { get; set; } /// /// The length of the package, in the specified unit /// /// The length of the package, in the specified unit - [JsonPropertyName("length")] - [JsonRequired] + [JsonPropertyName("length"), JsonRequired, JsonPropertyOrder(3)] public required double Length { get; set; } /// /// The width of the package, in the specified unit /// /// The width of the package, in the specified unit - [JsonPropertyName("width")] - [JsonRequired] + [JsonPropertyName("width"), JsonRequired, JsonPropertyOrder(4)] public required double Width { get; set; } diff --git a/ShipEngineSDK/Model/DisplayScheme.cs b/ShipEngineSDK/Model/DisplayScheme.cs index 03430cdd..530b2623 100644 --- a/ShipEngineSDK/Model/DisplayScheme.cs +++ b/ShipEngineSDK/Model/DisplayScheme.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(DisplaySchemeJsonConverter))] public class DisplayScheme { - private string _value; + private readonly string _value; /// /// Create a new instance of DisplayScheme with a predefined value. @@ -86,6 +86,12 @@ public DisplayScheme(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is DisplayScheme other && _value == other._value; } internal class DisplaySchemeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/Error.cs b/ShipEngineSDK/Model/Error.cs index 8972ca57..9049604e 100644 --- a/ShipEngineSDK/Model/Error.cs +++ b/ShipEngineSDK/Model/Error.cs @@ -29,28 +29,22 @@ public partial class Error { /// - /// Gets or Sets ErrorCode CLOVUS + /// Gets or Sets ErrorCode /// - [JsonPropertyName("error_code")] - [JsonRequired] - public required ErrorCode ErrorCode { get; set; } = new(); - + [JsonPropertyName("error_code"), JsonRequired, JsonPropertyOrder(1)] + public required ErrorCode ErrorCode { get; set; } /// - /// Gets or Sets ErrorSource CLOVUS + /// Gets or Sets ErrorSource /// - [JsonPropertyName("error_source")] - [JsonRequired] - public required ErrorSource ErrorSource { get; set; } = new(); - + [JsonPropertyName("error_source"), JsonRequired, JsonPropertyOrder(2)] + public required ErrorSource ErrorSource { get; set; } /// - /// Gets or Sets ErrorType CLOVUS + /// Gets or Sets ErrorType /// - [JsonPropertyName("error_type")] - [JsonRequired] - public required ErrorType ErrorType { get; set; } = new(); - + [JsonPropertyName("error_type"), JsonRequired, JsonPropertyOrder(3)] + public required ErrorType ErrorType { get; set; } /// /// An error message associated with the failed API call @@ -59,9 +53,8 @@ public partial class Error /// /// Body of request cannot be null. /// - [JsonPropertyName("message")] - [JsonRequired] - public required string Message { get; set; } + [JsonPropertyName("message"), JsonInclude] + public string? Message { get; private set; } /// diff --git a/ShipEngineSDK/Model/ErrorCode.cs b/ShipEngineSDK/Model/ErrorCode.cs index 11eb6b7d..617686f6 100644 --- a/ShipEngineSDK/Model/ErrorCode.cs +++ b/ShipEngineSDK/Model/ErrorCode.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(ErrorCodeJsonConverter))] public class ErrorCode { - private string _value; + private readonly string _value; /// /// Create a new instance of ErrorCode with a predefined value. @@ -314,6 +314,12 @@ public ErrorCode(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is ErrorCode other && _value == other._value; } internal class ErrorCodeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/ErrorResponseBody.cs b/ShipEngineSDK/Model/ErrorResponseBody.cs index 82eba960..9bd8903f 100644 --- a/ShipEngineSDK/Model/ErrorResponseBody.cs +++ b/ShipEngineSDK/Model/ErrorResponseBody.cs @@ -32,9 +32,8 @@ public partial class ErrorResponseBody /// The errors associated with the failed API call /// /// The errors associated with the failed API call - [JsonPropertyName("errors")] - [JsonRequired] - public required List Errors { get; set; } + [JsonPropertyName("errors"), JsonInclude] + public List? Errors { get; private set; } /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur @@ -43,8 +42,7 @@ public partial class ErrorResponseBody /// /// aa3d8e8e-462b-4476-9618-72db7f7b7009 /// - [JsonPropertyName("request_id")] - [JsonRequired] + [JsonPropertyName("request_id"), JsonRequired, JsonPropertyOrder(2)] public required Guid RequestId { get; set; } diff --git a/ShipEngineSDK/Model/ErrorSource.cs b/ShipEngineSDK/Model/ErrorSource.cs index bc611c3a..aaac9d4d 100644 --- a/ShipEngineSDK/Model/ErrorSource.cs +++ b/ShipEngineSDK/Model/ErrorSource.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(ErrorSourceJsonConverter))] public class ErrorSource { - private string _value; + private readonly string _value; /// /// Create a new instance of ErrorSource with a predefined value. @@ -74,6 +74,12 @@ public ErrorSource(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is ErrorSource other && _value == other._value; } internal class ErrorSourceJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/ErrorType.cs b/ShipEngineSDK/Model/ErrorType.cs index 247c0db7..b288f7fb 100644 --- a/ShipEngineSDK/Model/ErrorType.cs +++ b/ShipEngineSDK/Model/ErrorType.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(ErrorTypeJsonConverter))] public class ErrorType { - private string _value; + private readonly string _value; /// /// Create a new instance of ErrorType with a predefined value. @@ -92,6 +92,12 @@ public ErrorType(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is ErrorType other && _value == other._value; } internal class ErrorTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs b/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs index 4e801c82..c3a4ac89 100644 --- a/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs +++ b/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs @@ -32,9 +32,8 @@ public partial class ErrorWithLabelIdResponseBody /// The errors associated with the failed API call /// /// The errors associated with the failed API call - [JsonPropertyName("errors")] - [JsonRequired] - public required List Errors { get; set; } + [JsonPropertyName("errors"), JsonInclude] + public List? Errors { get; private set; } /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur @@ -43,8 +42,7 @@ public partial class ErrorWithLabelIdResponseBody /// /// aa3d8e8e-462b-4476-9618-72db7f7b7009 /// - [JsonPropertyName("request_id")] - [JsonRequired] + [JsonPropertyName("request_id"), JsonRequired, JsonPropertyOrder(2)] public required Guid RequestId { get; set; } diff --git a/ShipEngineSDK/Model/EstimateRatesRequestBody.cs b/ShipEngineSDK/Model/EstimateRatesRequestBody.cs index 08a769ec..4d3acd53 100644 --- a/ShipEngineSDK/Model/EstimateRatesRequestBody.cs +++ b/ShipEngineSDK/Model/EstimateRatesRequestBody.cs @@ -34,12 +34,12 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// Gets or Sets AddressResidentialIndicator /// - [JsonPropertyName("address_residential_indicator")] + [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(11)] public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } /// /// Gets or Sets Confirmation /// - [JsonPropertyName("confirmation")] + [JsonPropertyName("confirmation"), JsonPropertyOrder(12)] public DeliveryConfirmation? Confirmation { get; set; } /// /// from postal code @@ -48,8 +48,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// Austin /// - [JsonPropertyName("from_city_locality")] - [JsonRequired] + [JsonPropertyName("from_city_locality"), JsonRequired, JsonPropertyOrder(1)] public required string FromCityLocality { get; set; } /// @@ -59,8 +58,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// CA /// - [JsonPropertyName("from_country_code")] - [JsonRequired] + [JsonPropertyName("from_country_code"), JsonRequired, JsonPropertyOrder(2)] public required string FromCountryCode { get; set; } /// @@ -70,8 +68,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// 78756-3717 /// - [JsonPropertyName("from_postal_code")] - [JsonRequired] + [JsonPropertyName("from_postal_code"), JsonRequired, JsonPropertyOrder(3)] public required string FromPostalCode { get; set; } /// @@ -81,8 +78,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// Austin /// - [JsonPropertyName("from_state_province")] - [JsonRequired] + [JsonPropertyName("from_state_province"), JsonRequired, JsonPropertyOrder(4)] public required string FromStateProvince { get; set; } /// @@ -92,8 +88,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("ship_date")] - [JsonRequired] + [JsonPropertyName("ship_date"), JsonRequired, JsonPropertyOrder(5)] public required DateTimeOffset ShipDate { get; set; } /// @@ -103,8 +98,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// Austin /// - [JsonPropertyName("to_city_locality")] - [JsonRequired] + [JsonPropertyName("to_city_locality"), JsonRequired, JsonPropertyOrder(6)] public required string ToCityLocality { get; set; } /// @@ -114,8 +108,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// CA /// - [JsonPropertyName("to_country_code")] - [JsonRequired] + [JsonPropertyName("to_country_code"), JsonRequired, JsonPropertyOrder(7)] public required string ToCountryCode { get; set; } /// @@ -125,8 +118,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// 78756-3717 /// - [JsonPropertyName("to_postal_code")] - [JsonRequired] + [JsonPropertyName("to_postal_code"), JsonRequired, JsonPropertyOrder(8)] public required string ToPostalCode { get; set; } /// @@ -136,23 +128,21 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// Houston /// - [JsonPropertyName("to_state_province")] - [JsonRequired] + [JsonPropertyName("to_state_province"), JsonRequired, JsonPropertyOrder(9)] public required string ToStateProvince { get; set; } /// /// The weight of the package /// /// The weight of the package - [JsonPropertyName("weight")] - [JsonRequired] + [JsonPropertyName("weight"), JsonRequired, JsonPropertyOrder(10)] public required Weight Weight { get; set; } /// /// The dimensions of the package /// /// The dimensions of the package - [JsonPropertyName("dimensions")] + [JsonPropertyName("dimensions"), JsonPropertyOrder(13)] public Dimensions? Dimensions { get; set; } diff --git a/ShipEngineSDK/Model/FedexAccountSettings.cs b/ShipEngineSDK/Model/FedexAccountSettings.cs index ec7e6caf..57a3ecbf 100644 --- a/ShipEngineSDK/Model/FedexAccountSettings.cs +++ b/ShipEngineSDK/Model/FedexAccountSettings.cs @@ -29,43 +29,46 @@ public partial class FedexAccountSettings { /// - /// Gets or Sets PickupType CLOVUS + /// Gets or Sets PickupType /// - [JsonPropertyName("pickup_type")] + [JsonPropertyName("pickup_type"), JsonPropertyOrder(4)] public FedexPickupType? PickupType { get; set; } + /// - /// Gets or Sets SmartPostEndorsement CLOVUS + /// Gets or Sets SmartPostEndorsement /// - [JsonPropertyName("smart_post_endorsement")] + [JsonPropertyName("smart_post_endorsement"), JsonPropertyOrder(6)] public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } + /// - /// Gets or Sets SmartPostHub CLOVUS + /// Gets or Sets SmartPostHub /// - [JsonPropertyName("smart_post_hub")] + [JsonPropertyName("smart_post_hub"), JsonPropertyOrder(7)] public SmartPostHub? SmartPostHub { get; set; } + /// /// Gets or Sets IsPrimaryAccount /// - [JsonPropertyName("is_primary_account")] + [JsonPropertyName("is_primary_account"), JsonPropertyOrder(1)] public bool? IsPrimaryAccount { get; set; } /// /// Gets or Sets LetterheadImage /// - [JsonPropertyName("letterhead_image")] + [JsonPropertyName("letterhead_image"), JsonPropertyOrder(2)] public string? LetterheadImage { get; set; } /// /// Account nickname /// /// Account nickname - [JsonPropertyName("nickname")] + [JsonPropertyName("nickname"), JsonPropertyOrder(3)] public string? Nickname { get; set; } /// /// Gets or Sets SignatureImage /// - [JsonPropertyName("signature_image")] + [JsonPropertyName("signature_image"), JsonPropertyOrder(5)] public string? SignatureImage { get; set; } diff --git a/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs b/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs index a4179a67..8074e060 100644 --- a/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs @@ -29,43 +29,46 @@ public partial class FedexAccountSettingsRequestBody { /// - /// Gets or Sets PickupType CLOVUS + /// Gets or Sets PickupType /// - [JsonPropertyName("pickup_type")] + [JsonPropertyName("pickup_type"), JsonPropertyOrder(4)] public FedexPickupType? PickupType { get; set; } + /// - /// Gets or Sets SmartPostEndorsement CLOVUS + /// Gets or Sets SmartPostEndorsement /// - [JsonPropertyName("smart_post_endorsement")] + [JsonPropertyName("smart_post_endorsement"), JsonPropertyOrder(6)] public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } + /// - /// Gets or Sets SmartPostHub CLOVUS + /// Gets or Sets SmartPostHub /// - [JsonPropertyName("smart_post_hub")] + [JsonPropertyName("smart_post_hub"), JsonPropertyOrder(7)] public SmartPostHub? SmartPostHub { get; set; } + /// /// Gets or Sets IsPrimaryAccount /// - [JsonPropertyName("is_primary_account")] + [JsonPropertyName("is_primary_account"), JsonPropertyOrder(1)] public bool? IsPrimaryAccount { get; set; } /// /// Gets or Sets LetterheadImage /// - [JsonPropertyName("letterhead_image")] + [JsonPropertyName("letterhead_image"), JsonPropertyOrder(2)] public string? LetterheadImage { get; set; } /// /// Account nickname /// /// Account nickname - [JsonPropertyName("nickname")] + [JsonPropertyName("nickname"), JsonPropertyOrder(3)] public string? Nickname { get; set; } /// /// Gets or Sets SignatureImage /// - [JsonPropertyName("signature_image")] + [JsonPropertyName("signature_image"), JsonPropertyOrder(5)] public string? SignatureImage { get; set; } diff --git a/ShipEngineSDK/Model/FedexPickupType.cs b/ShipEngineSDK/Model/FedexPickupType.cs index a1670140..7ab3fa51 100644 --- a/ShipEngineSDK/Model/FedexPickupType.cs +++ b/ShipEngineSDK/Model/FedexPickupType.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(FedexPickupTypeJsonConverter))] public class FedexPickupType { - private string _value; + private readonly string _value; /// /// Create a new instance of FedexPickupType with a predefined value. @@ -92,6 +92,12 @@ public FedexPickupType(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is FedexPickupType other && _value == other._value; } internal class FedexPickupTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/FedexSettingsResponseBody.cs b/ShipEngineSDK/Model/FedexSettingsResponseBody.cs index e6c217e0..e5f2c6d8 100644 --- a/ShipEngineSDK/Model/FedexSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/FedexSettingsResponseBody.cs @@ -29,43 +29,46 @@ public partial class FedexSettingsResponseBody { /// - /// Gets or Sets PickupType CLOVUS + /// Gets or Sets PickupType /// - [JsonPropertyName("pickup_type")] + [JsonPropertyName("pickup_type"), JsonPropertyOrder(4)] public FedexPickupType? PickupType { get; set; } + /// - /// Gets or Sets SmartPostEndorsement CLOVUS + /// Gets or Sets SmartPostEndorsement /// - [JsonPropertyName("smart_post_endorsement")] + [JsonPropertyName("smart_post_endorsement"), JsonPropertyOrder(6)] public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } + /// - /// Gets or Sets SmartPostHub CLOVUS + /// Gets or Sets SmartPostHub /// - [JsonPropertyName("smart_post_hub")] + [JsonPropertyName("smart_post_hub"), JsonPropertyOrder(7)] public SmartPostHub? SmartPostHub { get; set; } + /// /// Gets or Sets IsPrimaryAccount /// - [JsonPropertyName("is_primary_account")] + [JsonPropertyName("is_primary_account"), JsonPropertyOrder(1)] public bool? IsPrimaryAccount { get; set; } /// /// Gets or Sets LetterheadImage /// - [JsonPropertyName("letterhead_image")] + [JsonPropertyName("letterhead_image"), JsonPropertyOrder(2)] public string? LetterheadImage { get; set; } /// /// Account nickname /// /// Account nickname - [JsonPropertyName("nickname")] + [JsonPropertyName("nickname"), JsonPropertyOrder(3)] public string? Nickname { get; set; } /// /// Gets or Sets SignatureImage /// - [JsonPropertyName("signature_image")] + [JsonPropertyName("signature_image"), JsonPropertyOrder(5)] public string? SignatureImage { get; set; } diff --git a/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs b/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs index 7d56506c..fbafd504 100644 --- a/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs +++ b/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs @@ -89,11 +89,12 @@ public override bool CanConvert(Type typeToConvert) => /// - /// The image type CLOVUS + /// The image type /// /// The image type - [JsonPropertyName("image_content_type")] + [JsonPropertyName("image_content_type"), JsonPropertyOrder(2)] public ImageContentTypeEnum? ImageContentType { get; set; } + /// /// The date and time that the image was created in ShipEngine. /// @@ -101,8 +102,8 @@ public override bool CanConvert(Type typeToConvert) => /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// A base64 encoded string representation of the image. @@ -111,7 +112,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg== /// - [JsonPropertyName("image_data")] + [JsonPropertyName("image_data"), JsonPropertyOrder(3)] public string? ImageData { get; set; } /// @@ -121,7 +122,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// false /// - [JsonPropertyName("is_default")] + [JsonPropertyName("is_default"), JsonPropertyOrder(4)] public bool? IsDefault { get; set; } /// @@ -131,8 +132,8 @@ public override bool CanConvert(Type typeToConvert) => /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id")] - public string? LabelImageId { get; set; } + [JsonPropertyName("label_image_id"), JsonInclude] + public string? LabelImageId { get; private set; } /// /// The date and time that the image was modified in ShipEngine. @@ -141,8 +142,8 @@ public override bool CanConvert(Type typeToConvert) => /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("modified_at")] - public DateTimeOffset? ModifiedAt { get; set; } + [JsonPropertyName("modified_at"), JsonInclude] + public DateTimeOffset? ModifiedAt { get; private set; } /// /// A human readable name for the image. @@ -151,7 +152,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// My logo /// - [JsonPropertyName("name")] + [JsonPropertyName("name"), JsonPropertyOrder(7)] public string? Name { get; set; } diff --git a/ShipEngineSDK/Model/GetAccountSettingsResponseBody.cs b/ShipEngineSDK/Model/GetAccountSettingsResponseBody.cs index d646b5d2..a7075f7d 100644 --- a/ShipEngineSDK/Model/GetAccountSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/GetAccountSettingsResponseBody.cs @@ -29,11 +29,12 @@ public partial class GetAccountSettingsResponseBody { /// - /// Gets or Sets DefaultLabelLayout CLOVUS + /// Gets or Sets DefaultLabelLayout /// - [JsonPropertyName("default_label_layout")] + [JsonPropertyName("default_label_layout"), JsonPropertyOrder(1)] public DefaultLabelLayout? DefaultLabelLayout { get; set; } + /// /// Returns the string presentation of the object /// diff --git a/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs b/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs index 0971f961..1c973793 100644 --- a/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs @@ -29,37 +29,30 @@ public partial class GetBatchByExternalIdResponseBody { /// - /// Gets or Sets LabelFormat CLOVUS + /// Gets or Sets LabelFormat /// - [JsonPropertyName("label_format")] - [JsonRequired] - public required LabelFormat LabelFormat { get; set; } = new(); - + [JsonPropertyName("label_format"), JsonInclude] + public LabelFormat? LabelFormat { get; private set; } /// - /// label layout CLOVUS + /// label layout /// /// label layout - [JsonPropertyName("label_layout")] - [JsonRequired] - public required LabelLayout LabelLayout { get; set; } = new(); - + [JsonPropertyName("label_layout"), JsonInclude] + public LabelLayout? LabelLayout { get; private set; } /// - /// Gets or Sets Status CLOVUS + /// Gets or Sets Status /// - [JsonPropertyName("status")] - [JsonRequired] - public required BatchStatus Status { get; set; } = new(); - + [JsonPropertyName("status"), JsonInclude] + public BatchStatus? Status { get; private set; } /// /// Link to batch errors endpoint /// /// Link to batch errors endpoint - [JsonPropertyName("batch_errors_url")] - [JsonRequired] - public required OptionalLink BatchErrorsUrl { get; set; } + [JsonPropertyName("batch_errors_url"), JsonInclude] + public OptionalLink? BatchErrorsUrl { get; private set; } /// /// A string that uniquely identifies the batch @@ -68,32 +61,28 @@ public partial class GetBatchByExternalIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - [JsonRequired] - public required string BatchId { get; set; } + [JsonPropertyName("batch_id"), JsonInclude] + public string? BatchId { get; private set; } /// /// Link to batch labels query /// /// Link to batch labels query - [JsonPropertyName("batch_labels_url")] - [JsonRequired] + [JsonPropertyName("batch_labels_url"), JsonRequired, JsonPropertyOrder(3)] public required OptionalLink BatchLabelsUrl { get; set; } /// /// The batch number. /// /// The batch number. - [JsonPropertyName("batch_number")] - [JsonRequired] - public required string BatchNumber { get; set; } + [JsonPropertyName("batch_number"), JsonInclude] + public string? BatchNumber { get; private set; } /// /// The batch shipments endpoint /// /// The batch shipments endpoint - [JsonPropertyName("batch_shipments_url")] - [JsonRequired] + [JsonPropertyName("batch_shipments_url"), JsonRequired, JsonPropertyOrder(5)] public required OptionalLink BatchShipmentsUrl { get; set; } /// @@ -103,9 +92,8 @@ public partial class GetBatchByExternalIdResponseBody /// /// 1 /// - [JsonPropertyName("completed")] - [JsonRequired] - public required int Completed { get; set; } + [JsonPropertyName("completed"), JsonInclude] + public int? Completed { get; private set; } /// /// The total of errors, warnings, and completed properties @@ -114,9 +102,8 @@ public partial class GetBatchByExternalIdResponseBody /// /// 2 /// - [JsonPropertyName("count")] - [JsonRequired] - public required int Count { get; set; } + [JsonPropertyName("count"), JsonInclude] + public int? Count { get; private set; } /// /// The date and time the batch was created in ShipEngine @@ -125,9 +112,8 @@ public partial class GetBatchByExternalIdResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - [JsonRequired] - public required DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// The number of errors that occurred while generating the batch @@ -136,17 +122,15 @@ public partial class GetBatchByExternalIdResponseBody /// /// 2 /// - [JsonPropertyName("errors")] - [JsonRequired] - public required int Errors { get; set; } + [JsonPropertyName("errors"), JsonInclude] + public int? Errors { get; private set; } /// /// The form download for any customs that are needed /// /// The form download for any customs that are needed - [JsonPropertyName("form_download")] - [JsonRequired] - public required OptionalLink FormDownload { get; set; } + [JsonPropertyName("form_download"), JsonInclude] + public OptionalLink? FormDownload { get; private set; } /// /// The number of forms for customs that are available for download @@ -155,33 +139,29 @@ public partial class GetBatchByExternalIdResponseBody /// /// 3 /// - [JsonPropertyName("forms")] - [JsonRequired] - public required int Forms { get; set; } + [JsonPropertyName("forms"), JsonInclude] + public int? Forms { get; private set; } /// /// The label download for the batch /// /// The label download for the batch - [JsonPropertyName("label_download")] - [JsonRequired] - public required LabelDownload LabelDownload { get; set; } + [JsonPropertyName("label_download"), JsonInclude] + public LabelDownload? LabelDownload { get; private set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - [JsonRequired] - public required PaperlessDownload PaperlessDownload { get; set; } + [JsonPropertyName("paperless_download"), JsonInclude] + public PaperlessDownload? PaperlessDownload { get; private set; } /// /// The errors associated with the failed API call /// /// The errors associated with the failed API call - [JsonPropertyName("process_errors")] - [JsonRequired] - public required List ProcessErrors { get; set; } + [JsonPropertyName("process_errors"), JsonInclude] + public List? ProcessErrors { get; private set; } /// /// The number of warnings that occurred while generating the batch @@ -190,9 +170,8 @@ public partial class GetBatchByExternalIdResponseBody /// /// 1 /// - [JsonPropertyName("warnings")] - [JsonRequired] - public required int Warnings { get; set; } + [JsonPropertyName("warnings"), JsonInclude] + public int? Warnings { get; private set; } /// /// Custom notes you can add for each created batch @@ -201,17 +180,15 @@ public partial class GetBatchByExternalIdResponseBody /// /// Batch for morning shipment /// - [JsonPropertyName("batch_notes")] - [JsonRequired] - public required string BatchNotes { get; set; } + [JsonPropertyName("batch_notes"), JsonInclude] + public string? BatchNotes { get; private set; } /// /// A string that uniquely identifies the external batch /// /// A string that uniquely identifies the external batch - [JsonPropertyName("external_batch_id")] - [JsonRequired] - public required string ExternalBatchId { get; set; } + [JsonPropertyName("external_batch_id"), JsonInclude] + public string? ExternalBatchId { get; private set; } /// /// The date and time the batch was processed in ShipEngine @@ -220,9 +197,8 @@ public partial class GetBatchByExternalIdResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("processed_at")] - [JsonRequired] - public required DateTimeOffset ProcessedAt { get; set; } + [JsonPropertyName("processed_at"), JsonInclude] + public DateTimeOffset? ProcessedAt { get; private set; } /// diff --git a/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs b/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs index b24c57e5..2d63c6da 100644 --- a/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs @@ -29,37 +29,30 @@ public partial class GetBatchByIdResponseBody { /// - /// Gets or Sets LabelFormat CLOVUS + /// Gets or Sets LabelFormat /// - [JsonPropertyName("label_format")] - [JsonRequired] - public required LabelFormat LabelFormat { get; set; } = new(); - + [JsonPropertyName("label_format"), JsonInclude] + public LabelFormat? LabelFormat { get; private set; } /// - /// label layout CLOVUS + /// label layout /// /// label layout - [JsonPropertyName("label_layout")] - [JsonRequired] - public required LabelLayout LabelLayout { get; set; } = new(); - + [JsonPropertyName("label_layout"), JsonInclude] + public LabelLayout? LabelLayout { get; private set; } /// - /// Gets or Sets Status CLOVUS + /// Gets or Sets Status /// - [JsonPropertyName("status")] - [JsonRequired] - public required BatchStatus Status { get; set; } = new(); - + [JsonPropertyName("status"), JsonInclude] + public BatchStatus? Status { get; private set; } /// /// Link to batch errors endpoint /// /// Link to batch errors endpoint - [JsonPropertyName("batch_errors_url")] - [JsonRequired] - public required OptionalLink BatchErrorsUrl { get; set; } + [JsonPropertyName("batch_errors_url"), JsonInclude] + public OptionalLink? BatchErrorsUrl { get; private set; } /// /// A string that uniquely identifies the batch @@ -68,32 +61,28 @@ public partial class GetBatchByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - [JsonRequired] - public required string BatchId { get; set; } + [JsonPropertyName("batch_id"), JsonInclude] + public string? BatchId { get; private set; } /// /// Link to batch labels query /// /// Link to batch labels query - [JsonPropertyName("batch_labels_url")] - [JsonRequired] + [JsonPropertyName("batch_labels_url"), JsonRequired, JsonPropertyOrder(3)] public required OptionalLink BatchLabelsUrl { get; set; } /// /// The batch number. /// /// The batch number. - [JsonPropertyName("batch_number")] - [JsonRequired] - public required string BatchNumber { get; set; } + [JsonPropertyName("batch_number"), JsonInclude] + public string? BatchNumber { get; private set; } /// /// The batch shipments endpoint /// /// The batch shipments endpoint - [JsonPropertyName("batch_shipments_url")] - [JsonRequired] + [JsonPropertyName("batch_shipments_url"), JsonRequired, JsonPropertyOrder(5)] public required OptionalLink BatchShipmentsUrl { get; set; } /// @@ -103,9 +92,8 @@ public partial class GetBatchByIdResponseBody /// /// 1 /// - [JsonPropertyName("completed")] - [JsonRequired] - public required int Completed { get; set; } + [JsonPropertyName("completed"), JsonInclude] + public int? Completed { get; private set; } /// /// The total of errors, warnings, and completed properties @@ -114,9 +102,8 @@ public partial class GetBatchByIdResponseBody /// /// 2 /// - [JsonPropertyName("count")] - [JsonRequired] - public required int Count { get; set; } + [JsonPropertyName("count"), JsonInclude] + public int? Count { get; private set; } /// /// The date and time the batch was created in ShipEngine @@ -125,9 +112,8 @@ public partial class GetBatchByIdResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - [JsonRequired] - public required DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// The number of errors that occurred while generating the batch @@ -136,17 +122,15 @@ public partial class GetBatchByIdResponseBody /// /// 2 /// - [JsonPropertyName("errors")] - [JsonRequired] - public required int Errors { get; set; } + [JsonPropertyName("errors"), JsonInclude] + public int? Errors { get; private set; } /// /// The form download for any customs that are needed /// /// The form download for any customs that are needed - [JsonPropertyName("form_download")] - [JsonRequired] - public required OptionalLink FormDownload { get; set; } + [JsonPropertyName("form_download"), JsonInclude] + public OptionalLink? FormDownload { get; private set; } /// /// The number of forms for customs that are available for download @@ -155,33 +139,29 @@ public partial class GetBatchByIdResponseBody /// /// 3 /// - [JsonPropertyName("forms")] - [JsonRequired] - public required int Forms { get; set; } + [JsonPropertyName("forms"), JsonInclude] + public int? Forms { get; private set; } /// /// The label download for the batch /// /// The label download for the batch - [JsonPropertyName("label_download")] - [JsonRequired] - public required LabelDownload LabelDownload { get; set; } + [JsonPropertyName("label_download"), JsonInclude] + public LabelDownload? LabelDownload { get; private set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - [JsonRequired] - public required PaperlessDownload PaperlessDownload { get; set; } + [JsonPropertyName("paperless_download"), JsonInclude] + public PaperlessDownload? PaperlessDownload { get; private set; } /// /// The errors associated with the failed API call /// /// The errors associated with the failed API call - [JsonPropertyName("process_errors")] - [JsonRequired] - public required List ProcessErrors { get; set; } + [JsonPropertyName("process_errors"), JsonInclude] + public List? ProcessErrors { get; private set; } /// /// The number of warnings that occurred while generating the batch @@ -190,9 +170,8 @@ public partial class GetBatchByIdResponseBody /// /// 1 /// - [JsonPropertyName("warnings")] - [JsonRequired] - public required int Warnings { get; set; } + [JsonPropertyName("warnings"), JsonInclude] + public int? Warnings { get; private set; } /// /// Custom notes you can add for each created batch @@ -201,17 +180,15 @@ public partial class GetBatchByIdResponseBody /// /// Batch for morning shipment /// - [JsonPropertyName("batch_notes")] - [JsonRequired] - public required string BatchNotes { get; set; } + [JsonPropertyName("batch_notes"), JsonInclude] + public string? BatchNotes { get; private set; } /// /// A string that uniquely identifies the external batch /// /// A string that uniquely identifies the external batch - [JsonPropertyName("external_batch_id")] - [JsonRequired] - public required string ExternalBatchId { get; set; } + [JsonPropertyName("external_batch_id"), JsonInclude] + public string? ExternalBatchId { get; private set; } /// /// The date and time the batch was processed in ShipEngine @@ -220,9 +197,8 @@ public partial class GetBatchByIdResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("processed_at")] - [JsonRequired] - public required DateTimeOffset ProcessedAt { get; set; } + [JsonPropertyName("processed_at"), JsonInclude] + public DateTimeOffset? ProcessedAt { get; private set; } /// diff --git a/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs b/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs index f6532fbb..c2421eac 100644 --- a/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs @@ -35,8 +35,8 @@ public partial class GetCarrierByIdResponseBody /// /// account_570827 /// - [JsonPropertyName("account_number")] - public string? AccountNumber { get; set; } + [JsonPropertyName("account_number"), JsonInclude] + public string? AccountNumber { get; private set; } /// /// Current available balance @@ -45,8 +45,8 @@ public partial class GetCarrierByIdResponseBody /// /// 3799.52 /// - [JsonPropertyName("balance")] - public double? Balance { get; set; } + [JsonPropertyName("balance"), JsonInclude] + public double? Balance { get; private set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. @@ -55,8 +55,8 @@ public partial class GetCarrierByIdResponseBody /// /// dhl_express /// - [JsonPropertyName("carrier_code")] - public string? CarrierCode { get; set; } + [JsonPropertyName("carrier_code"), JsonInclude] + public string? CarrierCode { get; private set; } /// /// A string that uniquely identifies the carrier. @@ -65,15 +65,15 @@ public partial class GetCarrierByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - public string? CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// The carrier is disabled by the current ShipEngine account's billing plan. /// /// The carrier is disabled by the current ShipEngine account's billing plan. - [JsonPropertyName("disabled_by_billing_plan")] - public bool? DisabledByBillingPlan { get; set; } + [JsonPropertyName("disabled_by_billing_plan"), JsonInclude] + public bool? DisabledByBillingPlan { get; private set; } /// /// Screen readable name @@ -82,15 +82,15 @@ public partial class GetCarrierByIdResponseBody /// /// Stamps.com /// - [JsonPropertyName("friendly_name")] - public string? FriendlyName { get; set; } + [JsonPropertyName("friendly_name"), JsonInclude] + public string? FriendlyName { get; private set; } /// /// Carrier supports multiple packages per shipment /// /// Carrier supports multiple packages per shipment - [JsonPropertyName("has_multi_package_supporting_services")] - public bool? HasMultiPackageSupportingServices { get; set; } + [JsonPropertyName("has_multi_package_supporting_services"), JsonInclude] + public bool? HasMultiPackageSupportingServices { get; private set; } /// /// Nickname given to the account when initially setting up the carrier. @@ -99,50 +99,50 @@ public partial class GetCarrierByIdResponseBody /// /// ShipEngine Account - Stamps.com /// - [JsonPropertyName("nickname")] - public string? Nickname { get; set; } + [JsonPropertyName("nickname"), JsonInclude] + public string? Nickname { get; private set; } /// /// A list of options that are available to that carrier /// /// A list of options that are available to that carrier - [JsonPropertyName("options")] - public List? Options { get; set; } + [JsonPropertyName("options"), JsonInclude] + public List? Options { get; private set; } /// /// A list of package types that are supported by the carrier /// /// A list of package types that are supported by the carrier - [JsonPropertyName("packages")] - public List? Packages { get; set; } + [JsonPropertyName("packages"), JsonInclude] + public List? Packages { get; private set; } /// /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation /// /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation - [JsonPropertyName("primary")] - public bool? Primary { get; set; } + [JsonPropertyName("primary"), JsonInclude] + public bool? Primary { get; private set; } /// /// Indicates whether the carrier requires funding to use its services /// /// Indicates whether the carrier requires funding to use its services - [JsonPropertyName("requires_funded_amount")] - public bool? RequiresFundedAmount { get; set; } + [JsonPropertyName("requires_funded_amount"), JsonInclude] + public bool? RequiresFundedAmount { get; private set; } /// /// A list of services that are offered by the carrier /// /// A list of services that are offered by the carrier - [JsonPropertyName("services")] - public List? Services { get; set; } + [JsonPropertyName("services"), JsonInclude] + public List? Services { get; private set; } /// /// The carrier supports adding custom label messages to an order. /// /// The carrier supports adding custom label messages to an order. - [JsonPropertyName("supports_label_messages")] - public bool? SupportsLabelMessages { get; set; } + [JsonPropertyName("supports_label_messages"), JsonInclude] + public bool? SupportsLabelMessages { get; private set; } /// diff --git a/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs b/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs index 42b00199..a7d0be52 100644 --- a/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs @@ -32,8 +32,8 @@ public partial class GetCarrierOptionsResponseBody /// AN array of carrier options /// /// AN array of carrier options - [JsonPropertyName("options")] - public List? Options { get; set; } + [JsonPropertyName("options"), JsonInclude] + public List? Options { get; private set; } /// diff --git a/ShipEngineSDK/Model/GetCarriersResponseBody.cs b/ShipEngineSDK/Model/GetCarriersResponseBody.cs index b9d12ebc..a6e57556 100644 --- a/ShipEngineSDK/Model/GetCarriersResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarriersResponseBody.cs @@ -32,17 +32,15 @@ public partial class GetCarriersResponseBody /// The carrier response body /// /// The carrier response body - [JsonPropertyName("carriers")] - [JsonRequired] - public required List Carriers { get; set; } + [JsonPropertyName("carriers"), JsonInclude] + public List? Carriers { get; private set; } /// /// The errors associated with the failed API call /// /// The errors associated with the failed API call - [JsonPropertyName("errors")] - [JsonRequired] - public required List Errors { get; set; } + [JsonPropertyName("errors"), JsonInclude] + public List? Errors { get; private set; } /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur @@ -51,8 +49,7 @@ public partial class GetCarriersResponseBody /// /// aa3d8e8e-462b-4476-9618-72db7f7b7009 /// - [JsonPropertyName("request_id")] - [JsonRequired] + [JsonPropertyName("request_id"), JsonRequired, JsonPropertyOrder(3)] public required Guid RequestId { get; set; } diff --git a/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs b/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs index 18212203..7e3aeb17 100644 --- a/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs +++ b/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs @@ -32,16 +32,14 @@ public partial class GetInsuranceBalanceResponseBody /// The monetary amount, in the specified currency. /// /// The monetary amount, in the specified currency. - [JsonPropertyName("amount")] - [JsonRequired] + [JsonPropertyName("amount"), JsonRequired, JsonPropertyOrder(1)] public required double Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("currency")] - [JsonRequired] + [JsonPropertyName("currency"), JsonRequired, JsonPropertyOrder(2)] public required string Currency { get; set; } diff --git a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs index 070f724d..c4c035e9 100644 --- a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs @@ -29,56 +29,64 @@ public partial class GetLabelByExternalShipmentIdResponseBody { /// - /// The label charge event. CLOVUS + /// The label charge event. /// /// The label charge event. - [JsonPropertyName("charge_event")] + [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] public LabelChargeEvent? ChargeEvent { get; set; } + /// - /// The display format that the label should be shown in. CLOVUS + /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(7)] public DisplayScheme? DisplayScheme { get; set; } + /// - /// Gets or Sets LabelDownloadType CLOVUS + /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type")] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(14)] 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. CLOVUS + /// 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")] + [JsonPropertyName("label_format"), JsonPropertyOrder(15)] public LabelFormat? LabelFormat { 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. CLOVUS + /// 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")] + [JsonPropertyName("label_layout"), JsonPropertyOrder(18)] public LabelLayout? LabelLayout { get; set; } + /// - /// Gets or Sets Status CLOVUS + /// Gets or Sets Status /// - [JsonPropertyName("status")] - public LabelStatus? Status { get; set; } + [JsonPropertyName("status"), JsonInclude] + public LabelStatus? Status { get; private set; } + /// - /// The current status of the package, such as `in_transit` or `delivered` CLOVUS + /// The current status of the package, such as `in_transit` or `delivered` /// /// The current status of the package, such as `in_transit` or `delivered` - [JsonPropertyName("tracking_status")] - public TrackingStatus? TrackingStatus { get; set; } + [JsonPropertyName("tracking_status"), JsonInclude] + public TrackingStatus? TrackingStatus { get; private set; } + /// - /// Gets or Sets ValidateAddress CLOVUS + /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address")] + [JsonPropertyName("validate_address"), JsonPropertyOrder(36)] public ValidateAddress? ValidateAddress { get; set; } + /// /// Additional information some carriers may provide by which to identify a given label in their system. /// /// Additional information some carriers may provide by which to identify a given label in their system. - [JsonPropertyName("alternative_identifiers")] - public List? AlternativeIdentifiers { get; set; } + [JsonPropertyName("alternative_identifiers"), JsonInclude] + public List? AlternativeIdentifiers { get; private set; } /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. @@ -87,8 +95,8 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - public string? BatchId { get; set; } + [JsonPropertyName("batch_id"), JsonInclude] + public string? BatchId { get; private set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. @@ -97,8 +105,8 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// dhl_express /// - [JsonPropertyName("carrier_code")] - public string? CarrierCode { get; set; } + [JsonPropertyName("carrier_code"), JsonInclude] + public string? CarrierCode { get; private set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label @@ -107,8 +115,8 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - public string? CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// The date and time that the label was created in ShipEngine. @@ -117,49 +125,49 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private 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. /// /// 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. - [JsonPropertyName("form_download")] - public Link? FormDownload { get; set; } + [JsonPropertyName("form_download"), JsonInclude] + public Link? FormDownload { get; private set; } /// /// 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. /// /// 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. - [JsonPropertyName("insurance_claim")] - public Link? InsuranceClaim { get; set; } + [JsonPropertyName("insurance_claim"), JsonInclude] + public Link? InsuranceClaim { get; private set; } /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. - [JsonPropertyName("insurance_cost")] - public MonetaryValue? InsuranceCost { get; set; } + [JsonPropertyName("insurance_cost"), JsonInclude] + public MonetaryValue? InsuranceCost { get; private set; } /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. - [JsonPropertyName("is_international")] - public bool? IsInternational { get; set; } + [JsonPropertyName("is_international"), JsonInclude] + public bool? IsInternational { get; private set; } /// /// 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")] + [JsonPropertyName("is_return_label"), JsonPropertyOrder(12)] public bool? IsReturnLabel { get; set; } /// /// Gets or Sets LabelDownload /// - [JsonPropertyName("label_download")] - public LabelDownload? LabelDownload { get; set; } + [JsonPropertyName("label_download"), JsonInclude] + public LabelDownload? LabelDownload { get; private set; } /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. @@ -168,8 +176,8 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("label_id")] - public string? LabelId { get; set; } + [JsonPropertyName("label_id"), JsonInclude] + public string? LabelId { get; private set; } /// /// The label image resource that was used to create a custom label image. @@ -178,7 +186,7 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id")] + [JsonPropertyName("label_image_id"), JsonPropertyOrder(17)] public string? LabelImageId { get; set; } /// @@ -188,7 +196,7 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id")] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19)] public string? OutboundLabelId { get; set; } /// @@ -198,35 +206,35 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// small_flat_rate_box /// - [JsonPropertyName("package_code")] - public string? PackageCode { get; set; } + [JsonPropertyName("package_code"), JsonInclude] + public string? PackageCode { get; private set; } /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - public List? Packages { get; set; } + [JsonPropertyName("packages"), JsonInclude] + public List? Packages { get; private set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - public PaperlessDownload? PaperlessDownload { get; set; } + [JsonPropertyName("paperless_download"), JsonInclude] + public PaperlessDownload? PaperlessDownload { get; private set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue? RequestedComparisonAmount { get; set; } + [JsonPropertyName("requested_comparison_amount"), JsonInclude] + public MonetaryValue? RequestedComparisonAmount { get; private set; } /// /// 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")] + [JsonPropertyName("rma_number"), JsonPropertyOrder(24)] public string? RmaNumber { get; set; } /// @@ -236,8 +244,8 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// usps_first_class_mail /// - [JsonPropertyName("service_code")] - public string? ServiceCode { get; set; } + [JsonPropertyName("service_code"), JsonInclude] + public string? ServiceCode { get; private set; } /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -246,22 +254,22 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date")] - public DateTimeOffset? ShipDate { get; set; } + [JsonPropertyName("ship_date"), JsonInclude] + public DateTimeOffset? ShipDate { get; private set; } /// /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment")] + [JsonPropertyName("shipment"), JsonPropertyOrder(27)] public Shipment? Shipment { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - [JsonPropertyName("shipment_cost")] - public MonetaryValue? ShipmentCost { get; set; } + [JsonPropertyName("shipment_cost"), JsonInclude] + public MonetaryValue? ShipmentCost { get; private set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) @@ -270,23 +278,22 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string? ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private 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")] - [Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(31), Obsolete] public bool? TestLabel { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. - [JsonPropertyName("trackable")] - public bool? Trackable { get; set; } + [JsonPropertyName("trackable"), JsonInclude] + public bool? Trackable { get; private set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. @@ -295,8 +302,8 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// 782758401696 /// - [JsonPropertyName("tracking_number")] - public string? TrackingNumber { get; set; } + [JsonPropertyName("tracking_number"), JsonInclude] + public string? TrackingNumber { get; private set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. @@ -305,15 +312,15 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// - [JsonPropertyName("tracking_url")] - public string? TrackingUrl { get; set; } + [JsonPropertyName("tracking_url"), JsonInclude] + public string? TrackingUrl { get; private set; } /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) - [JsonPropertyName("voided")] - public bool? Voided { get; set; } + [JsonPropertyName("voided"), JsonInclude] + public bool? Voided { get; private set; } /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided @@ -322,8 +329,8 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("voided_at")] - public DateTimeOffset? VoidedAt { get; set; } + [JsonPropertyName("voided_at"), JsonInclude] + public DateTimeOffset? VoidedAt { get; private set; } /// diff --git a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs index b704b444..d82505af 100644 --- a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs @@ -29,56 +29,64 @@ public partial class GetLabelByIdResponseBody { /// - /// The label charge event. CLOVUS + /// The label charge event. /// /// The label charge event. - [JsonPropertyName("charge_event")] + [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] public LabelChargeEvent? ChargeEvent { get; set; } + /// - /// The display format that the label should be shown in. CLOVUS + /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(7)] public DisplayScheme? DisplayScheme { get; set; } + /// - /// Gets or Sets LabelDownloadType CLOVUS + /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type")] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(14)] 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. CLOVUS + /// 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")] + [JsonPropertyName("label_format"), JsonPropertyOrder(15)] public LabelFormat? LabelFormat { 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. CLOVUS + /// 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")] + [JsonPropertyName("label_layout"), JsonPropertyOrder(18)] public LabelLayout? LabelLayout { get; set; } + /// - /// Gets or Sets Status CLOVUS + /// Gets or Sets Status /// - [JsonPropertyName("status")] - public LabelStatus? Status { get; set; } + [JsonPropertyName("status"), JsonInclude] + public LabelStatus? Status { get; private set; } + /// - /// The current status of the package, such as `in_transit` or `delivered` CLOVUS + /// The current status of the package, such as `in_transit` or `delivered` /// /// The current status of the package, such as `in_transit` or `delivered` - [JsonPropertyName("tracking_status")] - public TrackingStatus? TrackingStatus { get; set; } + [JsonPropertyName("tracking_status"), JsonInclude] + public TrackingStatus? TrackingStatus { get; private set; } + /// - /// Gets or Sets ValidateAddress CLOVUS + /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address")] + [JsonPropertyName("validate_address"), JsonPropertyOrder(36)] public ValidateAddress? ValidateAddress { get; set; } + /// /// Additional information some carriers may provide by which to identify a given label in their system. /// /// Additional information some carriers may provide by which to identify a given label in their system. - [JsonPropertyName("alternative_identifiers")] - public List? AlternativeIdentifiers { get; set; } + [JsonPropertyName("alternative_identifiers"), JsonInclude] + public List? AlternativeIdentifiers { get; private set; } /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. @@ -87,8 +95,8 @@ public partial class GetLabelByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - public string? BatchId { get; set; } + [JsonPropertyName("batch_id"), JsonInclude] + public string? BatchId { get; private set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. @@ -97,8 +105,8 @@ public partial class GetLabelByIdResponseBody /// /// dhl_express /// - [JsonPropertyName("carrier_code")] - public string? CarrierCode { get; set; } + [JsonPropertyName("carrier_code"), JsonInclude] + public string? CarrierCode { get; private set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label @@ -107,8 +115,8 @@ public partial class GetLabelByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - public string? CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// The date and time that the label was created in ShipEngine. @@ -117,49 +125,49 @@ public partial class GetLabelByIdResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private 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. /// /// 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. - [JsonPropertyName("form_download")] - public Link? FormDownload { get; set; } + [JsonPropertyName("form_download"), JsonInclude] + public Link? FormDownload { get; private set; } /// /// 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. /// /// 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. - [JsonPropertyName("insurance_claim")] - public Link? InsuranceClaim { get; set; } + [JsonPropertyName("insurance_claim"), JsonInclude] + public Link? InsuranceClaim { get; private set; } /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. - [JsonPropertyName("insurance_cost")] - public MonetaryValue? InsuranceCost { get; set; } + [JsonPropertyName("insurance_cost"), JsonInclude] + public MonetaryValue? InsuranceCost { get; private set; } /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. - [JsonPropertyName("is_international")] - public bool? IsInternational { get; set; } + [JsonPropertyName("is_international"), JsonInclude] + public bool? IsInternational { get; private set; } /// /// 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")] + [JsonPropertyName("is_return_label"), JsonPropertyOrder(12)] public bool? IsReturnLabel { get; set; } /// /// Gets or Sets LabelDownload /// - [JsonPropertyName("label_download")] - public LabelDownload? LabelDownload { get; set; } + [JsonPropertyName("label_download"), JsonInclude] + public LabelDownload? LabelDownload { get; private set; } /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. @@ -168,8 +176,8 @@ public partial class GetLabelByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("label_id")] - public string? LabelId { get; set; } + [JsonPropertyName("label_id"), JsonInclude] + public string? LabelId { get; private set; } /// /// The label image resource that was used to create a custom label image. @@ -178,7 +186,7 @@ public partial class GetLabelByIdResponseBody /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id")] + [JsonPropertyName("label_image_id"), JsonPropertyOrder(17)] public string? LabelImageId { get; set; } /// @@ -188,7 +196,7 @@ public partial class GetLabelByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id")] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19)] public string? OutboundLabelId { get; set; } /// @@ -198,35 +206,35 @@ public partial class GetLabelByIdResponseBody /// /// small_flat_rate_box /// - [JsonPropertyName("package_code")] - public string? PackageCode { get; set; } + [JsonPropertyName("package_code"), JsonInclude] + public string? PackageCode { get; private set; } /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - public List? Packages { get; set; } + [JsonPropertyName("packages"), JsonInclude] + public List? Packages { get; private set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - public PaperlessDownload? PaperlessDownload { get; set; } + [JsonPropertyName("paperless_download"), JsonInclude] + public PaperlessDownload? PaperlessDownload { get; private set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue? RequestedComparisonAmount { get; set; } + [JsonPropertyName("requested_comparison_amount"), JsonInclude] + public MonetaryValue? RequestedComparisonAmount { get; private set; } /// /// 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")] + [JsonPropertyName("rma_number"), JsonPropertyOrder(24)] public string? RmaNumber { get; set; } /// @@ -236,8 +244,8 @@ public partial class GetLabelByIdResponseBody /// /// usps_first_class_mail /// - [JsonPropertyName("service_code")] - public string? ServiceCode { get; set; } + [JsonPropertyName("service_code"), JsonInclude] + public string? ServiceCode { get; private set; } /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -246,22 +254,22 @@ public partial class GetLabelByIdResponseBody /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date")] - public DateTimeOffset? ShipDate { get; set; } + [JsonPropertyName("ship_date"), JsonInclude] + public DateTimeOffset? ShipDate { get; private set; } /// /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment")] + [JsonPropertyName("shipment"), JsonPropertyOrder(27)] public Shipment? Shipment { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - [JsonPropertyName("shipment_cost")] - public MonetaryValue? ShipmentCost { get; set; } + [JsonPropertyName("shipment_cost"), JsonInclude] + public MonetaryValue? ShipmentCost { get; private set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) @@ -270,23 +278,22 @@ public partial class GetLabelByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string? ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private 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")] - [Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(31), Obsolete] public bool? TestLabel { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. - [JsonPropertyName("trackable")] - public bool? Trackable { get; set; } + [JsonPropertyName("trackable"), JsonInclude] + public bool? Trackable { get; private set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. @@ -295,8 +302,8 @@ public partial class GetLabelByIdResponseBody /// /// 782758401696 /// - [JsonPropertyName("tracking_number")] - public string? TrackingNumber { get; set; } + [JsonPropertyName("tracking_number"), JsonInclude] + public string? TrackingNumber { get; private set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. @@ -305,15 +312,15 @@ public partial class GetLabelByIdResponseBody /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// - [JsonPropertyName("tracking_url")] - public string? TrackingUrl { get; set; } + [JsonPropertyName("tracking_url"), JsonInclude] + public string? TrackingUrl { get; private set; } /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) - [JsonPropertyName("voided")] - public bool? Voided { get; set; } + [JsonPropertyName("voided"), JsonInclude] + public bool? Voided { get; private set; } /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided @@ -322,8 +329,8 @@ public partial class GetLabelByIdResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("voided_at")] - public DateTimeOffset? VoidedAt { get; set; } + [JsonPropertyName("voided_at"), JsonInclude] + public DateTimeOffset? VoidedAt { get; private set; } /// diff --git a/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs b/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs index 907f58e7..69aead5b 100644 --- a/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs @@ -35,9 +35,8 @@ public partial class GetManifestByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [JsonRequired] - public required string CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// The date-time that the manifest was created @@ -46,9 +45,8 @@ public partial class GetManifestByIdResponseBody /// /// 2019-07-12T13:37:39.050Z /// - [JsonPropertyName("created_at")] - [JsonRequired] - public required DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// A string that uniquely identifies the form @@ -57,24 +55,21 @@ public partial class GetManifestByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("form_id")] - [JsonRequired] - public required string FormId { get; set; } + [JsonPropertyName("form_id"), JsonInclude] + public string? FormId { get; private set; } /// /// An array of the label ids used in this manifest. /// /// An array of the label ids used in this manifest. - [JsonPropertyName("label_ids")] - [JsonRequired] - public required List LabelIds { get; set; } + [JsonPropertyName("label_ids"), JsonInclude] + public List? LabelIds { get; private set; } /// /// Gets or Sets ManifestDownload /// - [JsonPropertyName("manifest_download")] - [JsonRequired] - public required ManifestDownload ManifestDownload { get; set; } + [JsonPropertyName("manifest_download"), JsonInclude] + public ManifestDownload? ManifestDownload { get; private set; } /// /// A string that uniquely identifies the manifest @@ -83,9 +78,8 @@ public partial class GetManifestByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("manifest_id")] - [JsonRequired] - public required string ManifestId { get; set; } + [JsonPropertyName("manifest_id"), JsonInclude] + public string? ManifestId { get; private set; } /// /// The date-time that the manifests shipments will be picked up @@ -94,9 +88,8 @@ public partial class GetManifestByIdResponseBody /// /// 2019-07-12T13:37:39.050Z /// - [JsonPropertyName("ship_date")] - [JsonRequired] - public required DateTimeOffset ShipDate { get; set; } + [JsonPropertyName("ship_date"), JsonInclude] + public DateTimeOffset? ShipDate { get; private set; } /// /// The number of shipments that are included in this manifest @@ -105,9 +98,8 @@ public partial class GetManifestByIdResponseBody /// /// 100 /// - [JsonPropertyName("shipments")] - [JsonRequired] - public required int Shipments { get; set; } + [JsonPropertyName("shipments"), JsonInclude] + public int? Shipments { get; private set; } /// /// A string that uniquely identifies the submission @@ -116,9 +108,8 @@ public partial class GetManifestByIdResponseBody /// /// 9475711899564878915476 /// - [JsonPropertyName("submission_id")] - [JsonRequired] - public required string SubmissionId { get; set; } + [JsonPropertyName("submission_id"), JsonInclude] + public string? SubmissionId { get; private set; } /// /// A string that uniquely identifies the warehouse @@ -127,9 +118,8 @@ public partial class GetManifestByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] - [JsonRequired] - public required string WarehouseId { get; set; } + [JsonPropertyName("warehouse_id"), JsonInclude] + public string? WarehouseId { get; private set; } /// diff --git a/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs b/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs index 3bc0879a..e04a44ed 100644 --- a/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs @@ -34,8 +34,7 @@ public partial class GetPackageTypeByIdResponseBody /// /// laptop_box /// - [JsonPropertyName("name")] - [JsonRequired] + [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(1)] public required string Name { get; set; } /// @@ -45,8 +44,7 @@ public partial class GetPackageTypeByIdResponseBody /// /// small_flat_rate_box /// - [JsonPropertyName("package_code")] - [JsonRequired] + [JsonPropertyName("package_code"), JsonRequired, JsonPropertyOrder(2)] public required string PackageCode { get; set; } /// @@ -56,14 +54,14 @@ public partial class GetPackageTypeByIdResponseBody /// /// Packaging for laptops /// - [JsonPropertyName("description")] + [JsonPropertyName("description"), JsonPropertyOrder(3)] public string? Description { get; set; } /// /// The custom dimensions for the package. /// /// The custom dimensions for the package. - [JsonPropertyName("dimensions")] + [JsonPropertyName("dimensions"), JsonPropertyOrder(4)] public Dimensions? Dimensions { get; set; } /// @@ -73,7 +71,7 @@ public partial class GetPackageTypeByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("package_id")] + [JsonPropertyName("package_id"), JsonPropertyOrder(5)] public string? PackageId { get; set; } diff --git a/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs b/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs index 67fbf790..6ab9fd39 100644 --- a/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs @@ -35,15 +35,13 @@ public partial class GetPickupByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [JsonRequired] - public required string CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// Gets or Sets ContactDetails /// - [JsonPropertyName("contact_details")] - [JsonRequired] + [JsonPropertyName("contact_details"), JsonRequired, JsonPropertyOrder(2)] public required ContactDetails ContactDetails { get; set; } /// @@ -53,32 +51,28 @@ public partial class GetPickupByIdResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - [JsonRequired] - public required DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// The errors associated with the failed API call /// /// The errors associated with the failed API call - [JsonPropertyName("errors")] - [JsonRequired] - public required List Errors { get; set; } + [JsonPropertyName("errors"), JsonInclude] + public List? Errors { get; private set; } /// /// Label IDs that will be included in the pickup request /// /// Label IDs that will be included in the pickup request - [JsonPropertyName("label_ids")] - [JsonRequired] + [JsonPropertyName("label_ids"), JsonRequired, JsonPropertyOrder(5)] public required List LabelIds { get; set; } /// /// Gets or Sets PickupAddress /// - [JsonPropertyName("pickup_address")] - [JsonRequired] - public required Address PickupAddress { get; set; } + [JsonPropertyName("pickup_address"), JsonInclude] + public Address? PickupAddress { get; private set; } /// /// Pickup Resource ID @@ -87,15 +81,13 @@ public partial class GetPickupByIdResponseBody /// /// pik_3YcKU5zdtJuCqoeNwyqqbW /// - [JsonPropertyName("pickup_id")] - [JsonRequired] - public required string PickupId { get; set; } + [JsonPropertyName("pickup_id"), JsonInclude] + public string? PickupId { get; private set; } /// /// Gets or Sets PickupWindow /// - [JsonPropertyName("pickup_window")] - [JsonRequired] + [JsonPropertyName("pickup_window"), JsonRequired, JsonPropertyOrder(8)] public required PickupWindow PickupWindow { get; set; } /// @@ -105,8 +97,7 @@ public partial class GetPickupByIdResponseBody /// /// aa3d8e8e-462b-4476-9618-72db7f7b7009 /// - [JsonPropertyName("request_id")] - [JsonRequired] + [JsonPropertyName("request_id"), JsonRequired, JsonPropertyOrder(9)] public required Guid RequestId { get; set; } /// @@ -116,9 +107,8 @@ public partial class GetPickupByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] - [JsonRequired] - public required string WarehouseId { get; set; } + [JsonPropertyName("warehouse_id"), JsonInclude] + public string? WarehouseId { get; private set; } /// /// The date and time that the pickup was cancelled in ShipEngine. @@ -127,8 +117,8 @@ public partial class GetPickupByIdResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("cancelled_at")] - public DateTimeOffset? CancelledAt { get; set; } + [JsonPropertyName("cancelled_at"), JsonInclude] + public DateTimeOffset? CancelledAt { get; private set; } /// /// The carrier confirmation number for the scheduled pickup. @@ -137,23 +127,22 @@ public partial class GetPickupByIdResponseBody /// /// 292513CL4A3 /// - [JsonPropertyName("confirmation_number")] - [JsonRequired] - public required string ConfirmationNumber { get; set; } + [JsonPropertyName("confirmation_number"), JsonInclude] + public string? ConfirmationNumber { get; private set; } /// /// Used by some carriers to give special instructions for a package pickup /// /// Used by some carriers to give special instructions for a package pickup - [JsonPropertyName("pickup_notes")] + [JsonPropertyName("pickup_notes"), JsonPropertyOrder(13)] public string? PickupNotes { get; set; } /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. - [JsonPropertyName("pickup_windows")] - public List? PickupWindows { get; set; } + [JsonPropertyName("pickup_windows"), JsonInclude] + public List? PickupWindows { get; private set; } /// diff --git a/ShipEngineSDK/Model/GetPickupsResponseBody.cs b/ShipEngineSDK/Model/GetPickupsResponseBody.cs index 0414437b..e33ba7c4 100644 --- a/ShipEngineSDK/Model/GetPickupsResponseBody.cs +++ b/ShipEngineSDK/Model/GetPickupsResponseBody.cs @@ -32,17 +32,15 @@ public partial class GetPickupsResponseBody /// The errors associated with the failed API call /// /// The errors associated with the failed API call - [JsonPropertyName("errors")] - [JsonRequired] - public required List Errors { get; set; } + [JsonPropertyName("errors"), JsonInclude] + public List? Errors { get; private set; } /// /// Helpful links to other pages of results /// /// Helpful links to other pages of results - [JsonPropertyName("links")] - [JsonRequired] - public required PaginationLink Links { get; set; } + [JsonPropertyName("links"), JsonInclude] + public PaginationLink? Links { get; private set; } /// /// Current page of the list pickups results @@ -51,9 +49,8 @@ public partial class GetPickupsResponseBody /// /// 3 /// - [JsonPropertyName("page")] - [JsonRequired] - public required int Page { get; set; } + [JsonPropertyName("page"), JsonInclude] + public int? Page { get; private set; } /// /// Total number of pages for list pickups results @@ -62,16 +59,14 @@ public partial class GetPickupsResponseBody /// /// 4 /// - [JsonPropertyName("pages")] - [JsonRequired] - public required int Pages { get; set; } + [JsonPropertyName("pages"), JsonInclude] + public int? Pages { get; private set; } /// /// An array of pickups associated with the user's account. /// /// An array of pickups associated with the user's account. - [JsonPropertyName("pickups")] - [JsonRequired] + [JsonPropertyName("pickups"), JsonRequired, JsonPropertyOrder(5)] public required List Pickups { get; set; } /// @@ -81,8 +76,7 @@ public partial class GetPickupsResponseBody /// /// aa3d8e8e-462b-4476-9618-72db7f7b7009 /// - [JsonPropertyName("request_id")] - [JsonRequired] + [JsonPropertyName("request_id"), JsonRequired, JsonPropertyOrder(6)] public required Guid RequestId { get; set; } /// @@ -92,9 +86,8 @@ public partial class GetPickupsResponseBody /// /// 3 /// - [JsonPropertyName("total")] - [JsonRequired] - public required long Total { get; set; } + [JsonPropertyName("total"), JsonInclude] + public long? Total { get; private set; } /// diff --git a/ShipEngineSDK/Model/GetRateByIdResponseBody.cs b/ShipEngineSDK/Model/GetRateByIdResponseBody.cs index dc88b2a9..8452ee64 100644 --- a/ShipEngineSDK/Model/GetRateByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetRateByIdResponseBody.cs @@ -29,36 +29,30 @@ public partial class GetRateByIdResponseBody { /// - /// Gets or Sets RateType CLOVUS + /// Gets or Sets RateType /// - [JsonPropertyName("rate_type")] - [JsonRequired] - public required RateType RateType { get; set; } = new(); - + [JsonPropertyName("rate_type"), JsonInclude] + public RateType? RateType { get; private set; } /// - /// Gets or Sets ValidationStatus CLOVUS + /// Gets or Sets ValidationStatus /// - [JsonPropertyName("validation_status")] - [JsonRequired] - public required ValidationStatus ValidationStatus { get; set; } = new(); - + [JsonPropertyName("validation_status"), JsonInclude] + public ValidationStatus? ValidationStatus { get; private set; } /// /// carrier code /// /// carrier code - [JsonPropertyName("carrier_code")] - [JsonRequired] - public required string CarrierCode { get; set; } + [JsonPropertyName("carrier_code"), JsonInclude] + public string? CarrierCode { get; private set; } /// /// carrier friendly name /// /// carrier friendly name - [JsonPropertyName("carrier_friendly_name")] - [JsonRequired] - public required string CarrierFriendlyName { get; set; } + [JsonPropertyName("carrier_friendly_name"), JsonInclude] + public string? CarrierFriendlyName { get; private set; } /// /// A string that uniquely identifies the carrier @@ -67,65 +61,57 @@ public partial class GetRateByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [JsonRequired] - public required string CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// carrier nickname /// /// carrier nickname - [JsonPropertyName("carrier_nickname")] - [JsonRequired] - public required string CarrierNickname { get; set; } + [JsonPropertyName("carrier_nickname"), JsonInclude] + public string? CarrierNickname { get; private set; } /// /// The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price. /// /// The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price. - [JsonPropertyName("confirmation_amount")] - [JsonRequired] - public required MonetaryValue ConfirmationAmount { get; set; } + [JsonPropertyName("confirmation_amount"), JsonInclude] + public MonetaryValue? ConfirmationAmount { get; private set; } /// /// The error messages /// /// The error messages - [JsonPropertyName("error_messages")] - [JsonRequired] - public required List ErrorMessages { get; set; } + [JsonPropertyName("error_messages"), JsonInclude] + public List? ErrorMessages { get; private set; } /// /// Indicates if the rate is guaranteed. /// /// Indicates if the rate is guaranteed. - [JsonPropertyName("guaranteed_service")] - [JsonRequired] - public required bool GuaranteedService { get; set; } + [JsonPropertyName("guaranteed_service"), JsonInclude] + public bool? GuaranteedService { get; private set; } /// /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. /// /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. - [JsonPropertyName("insurance_amount")] - [JsonRequired] - public required MonetaryValue InsuranceAmount { get; set; } + [JsonPropertyName("insurance_amount"), JsonInclude] + public MonetaryValue? InsuranceAmount { get; private set; } /// /// Indicates if the rates been negotiated /// /// Indicates if the rates been negotiated - [JsonPropertyName("negotiated_rate")] - [JsonRequired] - public required bool NegotiatedRate { get; set; } + [JsonPropertyName("negotiated_rate"), JsonInclude] + public bool? NegotiatedRate { get; private set; } /// /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. /// /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. - [JsonPropertyName("other_amount")] - [JsonRequired] - public required MonetaryValue OtherAmount { get; set; } + [JsonPropertyName("other_amount"), JsonInclude] + public MonetaryValue? OtherAmount { get; private set; } /// /// A string that uniquely identifies the rate @@ -134,56 +120,50 @@ public partial class GetRateByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("rate_id")] - [JsonRequired] - public required string RateId { get; set; } + [JsonPropertyName("rate_id"), JsonInclude] + public string? RateId { get; private set; } /// /// service code for the rate /// /// service code for the rate - [JsonPropertyName("service_code")] - [JsonRequired] - public required string ServiceCode { get; set; } + [JsonPropertyName("service_code"), JsonInclude] + public string? ServiceCode { get; private set; } /// /// service type /// /// service type - [JsonPropertyName("service_type")] - [JsonRequired] - public required string ServiceType { get; set; } + [JsonPropertyName("service_type"), JsonInclude] + public string? ServiceType { get; private set; } /// /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. /// /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. - [JsonPropertyName("shipping_amount")] - [JsonRequired] - public required MonetaryValue ShippingAmount { get; set; } + [JsonPropertyName("shipping_amount"), JsonInclude] + public MonetaryValue? ShippingAmount { get; private set; } /// /// Indicates if rate is trackable /// /// Indicates if rate is trackable - [JsonPropertyName("trackable")] - [JsonRequired] - public required bool Trackable { get; set; } + [JsonPropertyName("trackable"), JsonInclude] + public bool? Trackable { get; private set; } /// /// The warning messages /// /// The warning messages - [JsonPropertyName("warning_messages")] - [JsonRequired] - public required List WarningMessages { get; set; } + [JsonPropertyName("warning_messages"), JsonInclude] + public List? WarningMessages { get; private set; } /// /// The carrier delivery days /// /// The carrier delivery days - [JsonPropertyName("carrier_delivery_days")] - public string? CarrierDeliveryDays { get; set; } + [JsonPropertyName("carrier_delivery_days"), JsonInclude] + public string? CarrierDeliveryDays { get; private set; } /// /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday @@ -192,8 +172,8 @@ public partial class GetRateByIdResponseBody /// /// 5 /// - [JsonPropertyName("delivery_days")] - public int? DeliveryDays { get; set; } + [JsonPropertyName("delivery_days"), JsonInclude] + public int? DeliveryDays { get; private set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. @@ -202,8 +182,8 @@ public partial class GetRateByIdResponseBody /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("estimated_delivery_date")] - public DateTimeOffset? EstimatedDeliveryDate { get; set; } + [JsonPropertyName("estimated_delivery_date"), JsonInclude] + public DateTimeOffset? EstimatedDeliveryDate { get; private set; } /// /// package type that this rate was estimated for @@ -212,30 +192,29 @@ public partial class GetRateByIdResponseBody /// /// package /// - [JsonPropertyName("package_type")] - [JsonRequired] - public required string PackageType { get; set; } + [JsonPropertyName("package_type"), JsonInclude] + public string? PackageType { get; private set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue? RequestedComparisonAmount { get; set; } + [JsonPropertyName("requested_comparison_amount"), JsonInclude] + public MonetaryValue? RequestedComparisonAmount { get; private set; } /// /// ship date /// /// ship date - [JsonPropertyName("ship_date")] - public DateTimeOffset? ShipDate { get; set; } + [JsonPropertyName("ship_date"), JsonInclude] + public DateTimeOffset? ShipDate { get; private set; } /// /// Tariff and additional taxes associated with an international shipment. /// /// Tariff and additional taxes associated with an international shipment. - [JsonPropertyName("tax_amount")] - public MonetaryValue? TaxAmount { get; set; } + [JsonPropertyName("tax_amount"), JsonInclude] + public MonetaryValue? TaxAmount { get; private set; } /// /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location @@ -244,9 +223,8 @@ public partial class GetRateByIdResponseBody /// /// 6 /// - [JsonPropertyName("zone")] - [JsonRequired] - public required int Zone { get; set; } + [JsonPropertyName("zone"), JsonInclude] + public int? Zone { get; private set; } /// diff --git a/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs b/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs index 75511c3a..1e7274de 100644 --- a/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs @@ -31,7 +31,7 @@ public partial class GetServicePointByIdResponseBody /// /// Gets or Sets ServicePoint /// - [JsonPropertyName("service_point")] + [JsonPropertyName("service_point"), JsonPropertyOrder(1)] public GetServicePointByIdResponseBodyServicePoint? ServicePoint { get; set; } diff --git a/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs b/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs index dace42f3..1154162c 100644 --- a/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs +++ b/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs @@ -166,11 +166,12 @@ public override bool CanConvert(Type typeToConvert) => /// - /// Service point type CLOVUS + /// Service point type /// /// Service point type - [JsonPropertyName("type")] + [JsonPropertyName("type"), JsonPropertyOrder(15)] public TypeEnum? Type { get; set; } + /// /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. /// @@ -178,7 +179,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// PLACE DU CANADA /// - [JsonPropertyName("address_line1")] + [JsonPropertyName("address_line1"), JsonPropertyOrder(1)] public string? AddressLine1 { get; set; } /// @@ -188,7 +189,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// dhl_express /// - [JsonPropertyName("carrier_code")] + [JsonPropertyName("carrier_code"), JsonPropertyOrder(2)] public string? CarrierCode { get; set; } /// @@ -198,7 +199,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// TRUN /// - [JsonPropertyName("city_locality")] + [JsonPropertyName("city_locality"), JsonPropertyOrder(3)] public string? CityLocality { get; set; } /// @@ -208,7 +209,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// My fancy company name /// - [JsonPropertyName("company_name")] + [JsonPropertyName("company_name"), JsonPropertyOrder(4)] public string? CompanyName { get; set; } /// @@ -218,20 +219,20 @@ public override bool CanConvert(Type typeToConvert) => /// /// CA /// - [JsonPropertyName("country_code")] + [JsonPropertyName("country_code"), JsonPropertyOrder(5)] public string? CountryCode { get; set; } /// /// Service features /// /// Service features - [JsonPropertyName("features")] + [JsonPropertyName("features"), JsonPropertyOrder(6)] public List? Features { get; set; } /// /// Gets or Sets HoursOfOperation /// - [JsonPropertyName("hours_of_operation")] + [JsonPropertyName("hours_of_operation"), JsonPropertyOrder(7)] public ListServicePointsResponseBodyServicePointsInnerHoursOfOperation? HoursOfOperation { get; set; } /// @@ -241,7 +242,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// 48.842608 /// - [JsonPropertyName("lat")] + [JsonPropertyName("lat"), JsonPropertyOrder(8)] public double? Lat { get; set; } /// @@ -251,7 +252,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// 0.032875 /// - [JsonPropertyName("long")] + [JsonPropertyName("long"), JsonPropertyOrder(9)] public double? Long { get; set; } /// @@ -261,7 +262,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// 555-555-5555 /// - [JsonPropertyName("phone_number")] + [JsonPropertyName("phone_number"), JsonPropertyOrder(10)] public string? PhoneNumber { get; set; } /// @@ -271,13 +272,13 @@ public override bool CanConvert(Type typeToConvert) => /// /// 78756-3717 /// - [JsonPropertyName("postal_code")] + [JsonPropertyName("postal_code"), JsonPropertyOrder(11)] public string? PostalCode { get; set; } /// /// Gets or Sets ServiceCodes /// - [JsonPropertyName("service_codes")] + [JsonPropertyName("service_codes"), JsonPropertyOrder(12)] public List? ServiceCodes { get; set; } /// @@ -287,7 +288,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// 614940 /// - [JsonPropertyName("service_point_id")] + [JsonPropertyName("service_point_id"), JsonPropertyOrder(13)] public string? ServicePointId { get; set; } /// @@ -297,7 +298,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// TRUN /// - [JsonPropertyName("state_province")] + [JsonPropertyName("state_province"), JsonPropertyOrder(14)] public string? StateProvince { get; set; } diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBody.cs b/ShipEngineSDK/Model/GetServicePointsRequestBody.cs index 1e2d14b4..1bb2c0d1 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBody.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBody.cs @@ -32,14 +32,13 @@ public partial class GetServicePointsRequestBody /// An array of shipping service providers and service codes /// /// An array of shipping service providers and service codes - [JsonPropertyName("providers")] - [JsonRequired] + [JsonPropertyName("providers"), JsonRequired, JsonPropertyOrder(1)] public required List Providers { get; set; } /// /// Gets or Sets Address /// - [JsonPropertyName("address")] + [JsonPropertyName("address"), JsonPropertyOrder(2)] public GetServicePointsRequestBodyAddress? Address { get; set; } /// @@ -49,7 +48,7 @@ public partial class GetServicePointsRequestBody /// /// 177A Bleecker Street New York /// - [JsonPropertyName("address_query")] + [JsonPropertyName("address_query"), JsonPropertyOrder(3)] public string? AddressQuery { get; set; } /// @@ -59,7 +58,7 @@ public partial class GetServicePointsRequestBody /// /// 48.874518928233094 /// - [JsonPropertyName("lat")] + [JsonPropertyName("lat"), JsonPropertyOrder(4)] public double? Lat { get; set; } /// @@ -69,7 +68,7 @@ public partial class GetServicePointsRequestBody /// /// 2.3591775711639404 /// - [JsonPropertyName("long")] + [JsonPropertyName("long"), JsonPropertyOrder(5)] public double? Long { get; set; } /// @@ -79,7 +78,7 @@ public partial class GetServicePointsRequestBody /// /// 25 /// - [JsonPropertyName("max_results")] + [JsonPropertyName("max_results"), JsonPropertyOrder(6)] public int? MaxResults { get; set; } /// @@ -89,13 +88,13 @@ public partial class GetServicePointsRequestBody /// /// 500 /// - [JsonPropertyName("radius")] + [JsonPropertyName("radius"), JsonPropertyOrder(7)] public int? Radius { get; set; } /// /// Gets or Sets Shipment /// - [JsonPropertyName("shipment")] + [JsonPropertyName("shipment"), JsonPropertyOrder(8)] public GetServicePointsRequestBodyShipment? Shipment { get; set; } diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs index c20f623e..72c4c928 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs @@ -35,8 +35,7 @@ public partial class GetServicePointsRequestBodyAddress /// /// CA /// - [JsonPropertyName("country_code")] - [JsonRequired] + [JsonPropertyName("country_code"), JsonRequired, JsonPropertyOrder(1)] public required string CountryCode { get; set; } /// @@ -46,26 +45,26 @@ public partial class GetServicePointsRequestBodyAddress /// /// 1999 Bishop Grandin Blvd. /// - [JsonPropertyName("address_line1")] + [JsonPropertyName("address_line1"), JsonPropertyOrder(2)] public string? AddressLine1 { get; set; } /// /// Gets or Sets AddressLine2 /// - [JsonPropertyName("address_line2")] + [JsonPropertyName("address_line2"), JsonPropertyOrder(3)] public string? AddressLine2 { get; set; } /// /// Gets or Sets AddressLine3 /// - [JsonPropertyName("address_line3")] + [JsonPropertyName("address_line3"), JsonPropertyOrder(4)] public string? AddressLine3 { get; set; } /// /// The name of the city or locality /// /// The name of the city or locality - [JsonPropertyName("city_locality")] + [JsonPropertyName("city_locality"), JsonPropertyOrder(5)] public string? CityLocality { get; set; } /// @@ -75,14 +74,14 @@ public partial class GetServicePointsRequestBodyAddress /// /// 78756-3717 /// - [JsonPropertyName("postal_code")] + [JsonPropertyName("postal_code"), JsonPropertyOrder(6)] public string? PostalCode { get; set; } /// /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. /// /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. - [JsonPropertyName("state_province")] + [JsonPropertyName("state_province"), JsonPropertyOrder(7)] public string? StateProvince { get; set; } diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs index 71e4f2c7..6d4fcb55 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs @@ -35,13 +35,13 @@ public partial class GetServicePointsRequestBodyProvidersInner /// /// se-123456 /// - [JsonPropertyName("carrier_id")] + [JsonPropertyName("carrier_id"), JsonPropertyOrder(1)] public string? CarrierId { get; set; } /// /// Gets or Sets ServiceCode /// - [JsonPropertyName("service_code")] + [JsonPropertyName("service_code"), JsonPropertyOrder(2)] public List? ServiceCode { get; set; } diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs index e85bf1d1..9b218119 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs @@ -32,7 +32,7 @@ public partial class GetServicePointsRequestBodyShipment /// Shipment total weight /// /// Shipment total weight - [JsonPropertyName("total_weight")] + [JsonPropertyName("total_weight"), JsonPropertyOrder(1)] public Weight? TotalWeight { get; set; } diff --git a/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs b/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs index b69008e9..e37abe8e 100644 --- a/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs @@ -29,43 +29,37 @@ public partial class GetShipmentByExternalIdResponseBody { /// - /// The type of delivery confirmation that is required for this shipment. CLOVUS + /// The type of delivery confirmation that is required for this shipment. /// /// The type of delivery confirmation that is required for this shipment. - [JsonPropertyName("confirmation")] - [JsonRequired] - public required DeliveryConfirmation Confirmation { get; set; } = new(); - + [JsonPropertyName("confirmation"), JsonRequired, JsonPropertyOrder(3)] + public required DeliveryConfirmation Confirmation { get; set; } /// - /// The insurance provider to use for any insured packages in the shipment. CLOVUS + /// The insurance provider to use for any insured packages in the shipment. /// /// The insurance provider to use for any insured packages in the shipment. - [JsonPropertyName("insurance_provider")] - [JsonRequired] - public required InsuranceProvider InsuranceProvider { get; set; } = new(); - + [JsonPropertyName("insurance_provider"), JsonRequired, JsonPropertyOrder(5)] + public required InsuranceProvider InsuranceProvider { get; set; } /// - /// The current status of the shipment CLOVUS + /// The current status of the shipment /// /// The current status of the shipment - [JsonPropertyName("shipment_status")] - [JsonRequired] - public required ShipmentStatus ShipmentStatus { get; set; } = new(); - + [JsonPropertyName("shipment_status"), JsonInclude] + public ShipmentStatus? ShipmentStatus { get; private set; } /// - /// Gets or Sets OrderSourceCode CLOVUS + /// Gets or Sets OrderSourceCode /// - [JsonPropertyName("order_source_code")] + [JsonPropertyName("order_source_code"), JsonPropertyOrder(23)] public OrderSourceName? OrderSourceCode { get; set; } + /// /// Advanced shipment options. These are entirely optional. /// /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options")] - [JsonRequired] + [JsonPropertyName("advanced_options"), JsonRequired, JsonPropertyOrder(1)] public required AdvancedShipmentOptions AdvancedOptions { get; set; } /// @@ -75,8 +69,7 @@ public partial class GetShipmentByExternalIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [JsonRequired] + [JsonPropertyName("carrier_id"), JsonRequired, JsonPropertyOrder(2)] public required string CarrierId { get; set; } /// @@ -86,9 +79,8 @@ public partial class GetShipmentByExternalIdResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - [JsonRequired] - public required DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// The date and time that the shipment was created or last modified. @@ -97,24 +89,21 @@ public partial class GetShipmentByExternalIdResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("modified_at")] - [JsonRequired] - public required DateTimeOffset ModifiedAt { get; set; } + [JsonPropertyName("modified_at"), JsonInclude] + public DateTimeOffset? ModifiedAt { get; private set; } /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - [JsonRequired] + [JsonPropertyName("packages"), JsonRequired, JsonPropertyOrder(7)] public required List Packages { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. /// /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to")] - [JsonRequired] + [JsonPropertyName("return_to"), JsonRequired, JsonPropertyOrder(8)] public required ShippingAddress ReturnTo { get; set; } /// @@ -124,8 +113,7 @@ public partial class GetShipmentByExternalIdResponseBody /// /// usps_first_class_mail /// - [JsonPropertyName("service_code")] - [JsonRequired] + [JsonPropertyName("service_code"), JsonRequired, JsonPropertyOrder(9)] public required string ServiceCode { get; set; } /// @@ -135,24 +123,21 @@ public partial class GetShipmentByExternalIdResponseBody /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date")] - [JsonRequired] + [JsonPropertyName("ship_date"), JsonRequired, JsonPropertyOrder(10)] public required DateTimeOffset ShipDate { get; set; } /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from")] - [JsonRequired] + [JsonPropertyName("ship_from"), JsonRequired, JsonPropertyOrder(11)] public required ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address /// /// The recipient's mailing address - [JsonPropertyName("ship_to")] - [JsonRequired] + [JsonPropertyName("ship_to"), JsonRequired, JsonPropertyOrder(12)] public required ShippingAddressTo ShipTo { get; set; } /// @@ -162,25 +147,22 @@ public partial class GetShipmentByExternalIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - [JsonRequired] - public required string ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. - [JsonPropertyName("tags")] - [JsonRequired] - public required List Tags { get; set; } + [JsonPropertyName("tags"), JsonInclude] + public List? Tags { get; private set; } /// /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment - [JsonPropertyName("total_weight")] - [JsonRequired] - public required Weight TotalWeight { get; set; } + [JsonPropertyName("total_weight"), JsonInclude] + public Weight? TotalWeight { get; private set; } /// /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. @@ -189,50 +171,49 @@ public partial class GetShipmentByExternalIdResponseBody /// /// retail /// - [JsonPropertyName("comparison_rate_type")] + [JsonPropertyName("comparison_rate_type"), JsonPropertyOrder(17)] public string? ComparisonRateType { get; set; } /// /// Customs information. This is usually only needed for international shipments. /// /// Customs information. This is usually only needed for international shipments. - [JsonPropertyName("customs")] - [JsonRequired] + [JsonPropertyName("customs"), JsonRequired, JsonPropertyOrder(18)] public required InternationalShipmentOptions Customs { get; set; } /// /// ID that the Order Source assigned /// /// ID that the Order Source assigned - [JsonPropertyName("external_order_id")] + [JsonPropertyName("external_order_id"), JsonPropertyOrder(19)] public string? ExternalOrderId { get; set; } /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("external_shipment_id")] + [JsonPropertyName("external_shipment_id"), JsonPropertyOrder(20)] public string? ExternalShipmentId { get; set; } /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. - [JsonPropertyName("is_return")] + [JsonPropertyName("is_return"), JsonPropertyOrder(21)] public bool? IsReturn { get; set; } /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - [JsonPropertyName("items")] + [JsonPropertyName("items"), JsonPropertyOrder(22)] public List? Items { get; set; } /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("shipment_number")] + [JsonPropertyName("shipment_number"), JsonPropertyOrder(24)] public string? ShipmentNumber { get; set; } /// @@ -242,13 +223,13 @@ public partial class GetShipmentByExternalIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("shipping_rule_id")] + [JsonPropertyName("shipping_rule_id"), JsonPropertyOrder(25)] public string? ShippingRuleId { get; set; } /// /// Gets or Sets TaxIdentifiers /// - [JsonPropertyName("tax_identifiers")] + [JsonPropertyName("tax_identifiers"), JsonPropertyOrder(26)] public List? TaxIdentifiers { get; set; } /// @@ -258,8 +239,7 @@ public partial class GetShipmentByExternalIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] - [JsonRequired] + [JsonPropertyName("warehouse_id"), JsonRequired, JsonPropertyOrder(27)] public required string WarehouseId { get; set; } diff --git a/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs b/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs index bba40672..a94a29fe 100644 --- a/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs @@ -29,43 +29,37 @@ public partial class GetShipmentByIdResponseBody { /// - /// The type of delivery confirmation that is required for this shipment. CLOVUS + /// The type of delivery confirmation that is required for this shipment. /// /// The type of delivery confirmation that is required for this shipment. - [JsonPropertyName("confirmation")] - [JsonRequired] - public required DeliveryConfirmation Confirmation { get; set; } = new(); - + [JsonPropertyName("confirmation"), JsonRequired, JsonPropertyOrder(3)] + public required DeliveryConfirmation Confirmation { get; set; } /// - /// The insurance provider to use for any insured packages in the shipment. CLOVUS + /// The insurance provider to use for any insured packages in the shipment. /// /// The insurance provider to use for any insured packages in the shipment. - [JsonPropertyName("insurance_provider")] - [JsonRequired] - public required InsuranceProvider InsuranceProvider { get; set; } = new(); - + [JsonPropertyName("insurance_provider"), JsonRequired, JsonPropertyOrder(5)] + public required InsuranceProvider InsuranceProvider { get; set; } /// - /// The current status of the shipment CLOVUS + /// The current status of the shipment /// /// The current status of the shipment - [JsonPropertyName("shipment_status")] - [JsonRequired] - public required ShipmentStatus ShipmentStatus { get; set; } = new(); - + [JsonPropertyName("shipment_status"), JsonInclude] + public ShipmentStatus? ShipmentStatus { get; private set; } /// - /// Gets or Sets OrderSourceCode CLOVUS + /// Gets or Sets OrderSourceCode /// - [JsonPropertyName("order_source_code")] + [JsonPropertyName("order_source_code"), JsonPropertyOrder(23)] public OrderSourceName? OrderSourceCode { get; set; } + /// /// Advanced shipment options. These are entirely optional. /// /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options")] - [JsonRequired] + [JsonPropertyName("advanced_options"), JsonRequired, JsonPropertyOrder(1)] public required AdvancedShipmentOptions AdvancedOptions { get; set; } /// @@ -75,8 +69,7 @@ public partial class GetShipmentByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [JsonRequired] + [JsonPropertyName("carrier_id"), JsonRequired, JsonPropertyOrder(2)] public required string CarrierId { get; set; } /// @@ -86,9 +79,8 @@ public partial class GetShipmentByIdResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - [JsonRequired] - public required DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// The date and time that the shipment was created or last modified. @@ -97,24 +89,21 @@ public partial class GetShipmentByIdResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("modified_at")] - [JsonRequired] - public required DateTimeOffset ModifiedAt { get; set; } + [JsonPropertyName("modified_at"), JsonInclude] + public DateTimeOffset? ModifiedAt { get; private set; } /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - [JsonRequired] + [JsonPropertyName("packages"), JsonRequired, JsonPropertyOrder(7)] public required List Packages { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. /// /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to")] - [JsonRequired] + [JsonPropertyName("return_to"), JsonRequired, JsonPropertyOrder(8)] public required ShippingAddress ReturnTo { get; set; } /// @@ -124,8 +113,7 @@ public partial class GetShipmentByIdResponseBody /// /// usps_first_class_mail /// - [JsonPropertyName("service_code")] - [JsonRequired] + [JsonPropertyName("service_code"), JsonRequired, JsonPropertyOrder(9)] public required string ServiceCode { get; set; } /// @@ -135,24 +123,21 @@ public partial class GetShipmentByIdResponseBody /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date")] - [JsonRequired] + [JsonPropertyName("ship_date"), JsonRequired, JsonPropertyOrder(10)] public required DateTimeOffset ShipDate { get; set; } /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from")] - [JsonRequired] + [JsonPropertyName("ship_from"), JsonRequired, JsonPropertyOrder(11)] public required ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address /// /// The recipient's mailing address - [JsonPropertyName("ship_to")] - [JsonRequired] + [JsonPropertyName("ship_to"), JsonRequired, JsonPropertyOrder(12)] public required ShippingAddressTo ShipTo { get; set; } /// @@ -162,25 +147,22 @@ public partial class GetShipmentByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - [JsonRequired] - public required string ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. - [JsonPropertyName("tags")] - [JsonRequired] - public required List Tags { get; set; } + [JsonPropertyName("tags"), JsonInclude] + public List? Tags { get; private set; } /// /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment - [JsonPropertyName("total_weight")] - [JsonRequired] - public required Weight TotalWeight { get; set; } + [JsonPropertyName("total_weight"), JsonInclude] + public Weight? TotalWeight { get; private set; } /// /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. @@ -189,50 +171,49 @@ public partial class GetShipmentByIdResponseBody /// /// retail /// - [JsonPropertyName("comparison_rate_type")] + [JsonPropertyName("comparison_rate_type"), JsonPropertyOrder(17)] public string? ComparisonRateType { get; set; } /// /// Customs information. This is usually only needed for international shipments. /// /// Customs information. This is usually only needed for international shipments. - [JsonPropertyName("customs")] - [JsonRequired] + [JsonPropertyName("customs"), JsonRequired, JsonPropertyOrder(18)] public required InternationalShipmentOptions Customs { get; set; } /// /// ID that the Order Source assigned /// /// ID that the Order Source assigned - [JsonPropertyName("external_order_id")] + [JsonPropertyName("external_order_id"), JsonPropertyOrder(19)] public string? ExternalOrderId { get; set; } /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("external_shipment_id")] + [JsonPropertyName("external_shipment_id"), JsonPropertyOrder(20)] public string? ExternalShipmentId { get; set; } /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. - [JsonPropertyName("is_return")] + [JsonPropertyName("is_return"), JsonPropertyOrder(21)] public bool? IsReturn { get; set; } /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - [JsonPropertyName("items")] + [JsonPropertyName("items"), JsonPropertyOrder(22)] public List? Items { get; set; } /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("shipment_number")] + [JsonPropertyName("shipment_number"), JsonPropertyOrder(24)] public string? ShipmentNumber { get; set; } /// @@ -242,13 +223,13 @@ public partial class GetShipmentByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("shipping_rule_id")] + [JsonPropertyName("shipping_rule_id"), JsonPropertyOrder(25)] public string? ShippingRuleId { get; set; } /// /// Gets or Sets TaxIdentifiers /// - [JsonPropertyName("tax_identifiers")] + [JsonPropertyName("tax_identifiers"), JsonPropertyOrder(26)] public List? TaxIdentifiers { get; set; } /// @@ -258,8 +239,7 @@ public partial class GetShipmentByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] - [JsonRequired] + [JsonPropertyName("warehouse_id"), JsonRequired, JsonPropertyOrder(27)] public required string WarehouseId { get; set; } diff --git a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs index 048134ea..5464d0a6 100644 --- a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs @@ -29,12 +29,10 @@ public partial class GetTrackingLogFromLabelResponseBody { /// - /// Gets or Sets StatusCode CLOVUS + /// Gets or Sets StatusCode /// - [JsonPropertyName("status_code")] - [JsonRequired] - public required StatusCode StatusCode { get; set; } = new(); - + [JsonPropertyName("status_code"), JsonRequired, JsonPropertyOrder(4)] + public required StatusCode StatusCode { get; set; } /// /// Carrier status code @@ -43,9 +41,8 @@ public partial class GetTrackingLogFromLabelResponseBody /// /// 1 /// - [JsonPropertyName("carrier_status_code")] - [JsonRequired] - public required string CarrierStatusCode { get; set; } + [JsonPropertyName("carrier_status_code"), JsonInclude] + public string? CarrierStatusCode { get; private set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -54,17 +51,15 @@ public partial class GetTrackingLogFromLabelResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("estimated_delivery_date")] - [JsonRequired] + [JsonPropertyName("estimated_delivery_date"), JsonRequired, JsonPropertyOrder(2)] public required DateTimeOffset EstimatedDeliveryDate { get; set; } /// /// The events that have occured during the lifetime of this tracking number. /// /// The events that have occured during the lifetime of this tracking number. - [JsonPropertyName("events")] - [JsonRequired] - public required List Events { get; set; } + [JsonPropertyName("events"), JsonInclude] + public List? Events { get; private set; } /// /// A tracking number for a package. The format depends on the carrier. @@ -73,8 +68,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// /// 1Z932R800392060079 /// - [JsonPropertyName("tracking_number")] - [JsonRequired] + [JsonPropertyName("tracking_number"), JsonRequired, JsonPropertyOrder(5)] public required string TrackingNumber { get; set; } /// @@ -84,7 +78,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("actual_delivery_date")] + [JsonPropertyName("actual_delivery_date"), JsonPropertyOrder(6)] public DateTimeOffset? ActualDeliveryDate { get; set; } /// @@ -94,7 +88,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// /// dhl_express /// - [JsonPropertyName("carrier_code")] + [JsonPropertyName("carrier_code"), JsonPropertyOrder(7)] public string? CarrierCode { get; set; } /// @@ -104,8 +98,8 @@ public partial class GetTrackingLogFromLabelResponseBody /// /// OT /// - [JsonPropertyName("carrier_detail_code")] - public string? CarrierDetailCode { get; set; } + [JsonPropertyName("carrier_detail_code"), JsonInclude] + public string? CarrierDetailCode { get; private set; } /// /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. @@ -114,7 +108,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] + [JsonPropertyName("carrier_id"), JsonPropertyOrder(9)] public string? CarrierId { get; set; } /// @@ -124,15 +118,15 @@ public partial class GetTrackingLogFromLabelResponseBody /// /// Your item was delivered in or at the mailbox at 9:10 am on March /// - [JsonPropertyName("carrier_status_description")] - public string? CarrierStatusDescription { get; set; } + [JsonPropertyName("carrier_status_description"), JsonInclude] + public string? CarrierStatusDescription { get; private set; } /// /// Exception description /// /// Exception description - [JsonPropertyName("exception_description")] - public string? ExceptionDescription { get; set; } + [JsonPropertyName("exception_description"), JsonInclude] + public string? ExceptionDescription { get; private set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -141,7 +135,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("ship_date")] + [JsonPropertyName("ship_date"), JsonPropertyOrder(12)] public DateTimeOffset? ShipDate { get; set; } /// @@ -151,8 +145,8 @@ public partial class GetTrackingLogFromLabelResponseBody /// /// Delivered /// - [JsonPropertyName("status_description")] - public string? StatusDescription { get; set; } + [JsonPropertyName("status_description"), JsonInclude] + public string? StatusDescription { get; private set; } /// /// Carrier Tracking Url, if available @@ -161,8 +155,8 @@ public partial class GetTrackingLogFromLabelResponseBody /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// - [JsonPropertyName("tracking_url")] - public string? TrackingUrl { get; set; } + [JsonPropertyName("tracking_url"), JsonInclude] + public string? TrackingUrl { get; private set; } /// diff --git a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs index 8946ddcb..896580a8 100644 --- a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs @@ -29,12 +29,10 @@ public partial class GetTrackingLogResponseBody { /// - /// Gets or Sets StatusCode CLOVUS + /// Gets or Sets StatusCode /// - [JsonPropertyName("status_code")] - [JsonRequired] - public required StatusCode StatusCode { get; set; } = new(); - + [JsonPropertyName("status_code"), JsonRequired, JsonPropertyOrder(7)] + public required StatusCode StatusCode { get; set; } /// /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. @@ -43,8 +41,7 @@ public partial class GetTrackingLogResponseBody /// /// dhl_express /// - [JsonPropertyName("carrier_code")] - [JsonRequired] + [JsonPropertyName("carrier_code"), JsonRequired, JsonPropertyOrder(1)] public required string CarrierCode { get; set; } /// @@ -54,9 +51,8 @@ public partial class GetTrackingLogResponseBody /// /// OT /// - [JsonPropertyName("carrier_detail_code")] - [JsonRequired] - public required string CarrierDetailCode { get; set; } + [JsonPropertyName("carrier_detail_code"), JsonInclude] + public string? CarrierDetailCode { get; private set; } /// /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. @@ -65,8 +61,7 @@ public partial class GetTrackingLogResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [JsonRequired] + [JsonPropertyName("carrier_id"), JsonRequired, JsonPropertyOrder(3)] public required string CarrierId { get; set; } /// @@ -76,9 +71,8 @@ public partial class GetTrackingLogResponseBody /// /// 1 /// - [JsonPropertyName("carrier_status_code")] - [JsonRequired] - public required string CarrierStatusCode { get; set; } + [JsonPropertyName("carrier_status_code"), JsonInclude] + public string? CarrierStatusCode { get; private set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -87,17 +81,15 @@ public partial class GetTrackingLogResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("estimated_delivery_date")] - [JsonRequired] + [JsonPropertyName("estimated_delivery_date"), JsonRequired, JsonPropertyOrder(5)] public required DateTimeOffset EstimatedDeliveryDate { get; set; } /// /// The events that have occured during the lifetime of this tracking number. /// /// The events that have occured during the lifetime of this tracking number. - [JsonPropertyName("events")] - [JsonRequired] - public required List Events { get; set; } + [JsonPropertyName("events"), JsonInclude] + public List? Events { get; private set; } /// /// A tracking number for a package. The format depends on the carrier. @@ -106,8 +98,7 @@ public partial class GetTrackingLogResponseBody /// /// 1Z932R800392060079 /// - [JsonPropertyName("tracking_number")] - [JsonRequired] + [JsonPropertyName("tracking_number"), JsonRequired, JsonPropertyOrder(8)] public required string TrackingNumber { get; set; } /// @@ -117,9 +108,8 @@ public partial class GetTrackingLogResponseBody /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// - [JsonPropertyName("tracking_url")] - [JsonRequired] - public required string TrackingUrl { get; set; } + [JsonPropertyName("tracking_url"), JsonInclude] + public string? TrackingUrl { get; private set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -128,7 +118,7 @@ public partial class GetTrackingLogResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("actual_delivery_date")] + [JsonPropertyName("actual_delivery_date"), JsonPropertyOrder(10)] public DateTimeOffset? ActualDeliveryDate { get; set; } /// @@ -138,15 +128,15 @@ public partial class GetTrackingLogResponseBody /// /// Your item was delivered in or at the mailbox at 9:10 am on March /// - [JsonPropertyName("carrier_status_description")] - public string? CarrierStatusDescription { get; set; } + [JsonPropertyName("carrier_status_description"), JsonInclude] + public string? CarrierStatusDescription { get; private set; } /// /// Exception description /// /// Exception description - [JsonPropertyName("exception_description")] - public string? ExceptionDescription { get; set; } + [JsonPropertyName("exception_description"), JsonInclude] + public string? ExceptionDescription { get; private set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -155,7 +145,7 @@ public partial class GetTrackingLogResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("ship_date")] + [JsonPropertyName("ship_date"), JsonPropertyOrder(13)] public DateTimeOffset? ShipDate { get; set; } /// @@ -165,8 +155,8 @@ public partial class GetTrackingLogResponseBody /// /// Delivered /// - [JsonPropertyName("status_description")] - public string? StatusDescription { get; set; } + [JsonPropertyName("status_description"), JsonInclude] + public string? StatusDescription { get; private set; } /// diff --git a/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs b/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs index 4d6c420f..25867a5b 100644 --- a/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs @@ -35,9 +35,8 @@ public partial class GetWarehouseByIdResponseBody /// /// 2019-06-25T18:12:35.583Z /// - [JsonPropertyName("created_at")] - [JsonRequired] - public required DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// Name of the warehouse @@ -46,24 +45,21 @@ public partial class GetWarehouseByIdResponseBody /// /// Zero Cool HQ /// - [JsonPropertyName("name")] - [JsonRequired] + [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(2)] public required string Name { get; set; } /// /// The origin address of the warehouse /// /// The origin address of the warehouse - [JsonPropertyName("origin_address")] - [JsonRequired] + [JsonPropertyName("origin_address"), JsonRequired, JsonPropertyOrder(3)] public required Address OriginAddress { get; set; } /// /// The return address associated with the warehouse /// /// The return address associated with the warehouse - [JsonPropertyName("return_address")] - [JsonRequired] + [JsonPropertyName("return_address"), JsonRequired, JsonPropertyOrder(4)] public required Address ReturnAddress { get; set; } /// @@ -73,15 +69,14 @@ public partial class GetWarehouseByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] - [JsonRequired] - public required string WarehouseId { get; set; } + [JsonPropertyName("warehouse_id"), JsonInclude] + public string? WarehouseId { get; private set; } /// /// Designates which single warehouse is the default on the account /// /// Designates which single warehouse is the default on the account - [JsonPropertyName("is_default")] + [JsonPropertyName("is_default"), JsonPropertyOrder(6)] public bool? IsDefault { get; set; } diff --git a/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs b/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs index 4bf191fd..84fc1609 100644 --- a/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs @@ -29,12 +29,10 @@ public partial class GetWebhookByIdResponseBody { /// - /// Gets or Sets Event CLOVUS + /// Gets or Sets Event /// - [JsonPropertyName("event")] - [JsonRequired] - public required WebhookEvent Event { get; set; } = new(); - + [JsonPropertyName("event"), JsonRequired, JsonPropertyOrder(1)] + public required WebhookEvent Event { get; set; } /// /// The url that the webhook sends the request to @@ -43,8 +41,7 @@ public partial class GetWebhookByIdResponseBody /// /// http://api.shipengine.com/v1/labels/se-28529731 /// - [JsonPropertyName("url")] - [JsonRequired] + [JsonPropertyName("url"), JsonRequired, JsonPropertyOrder(2)] public required string Url { get; set; } /// @@ -54,15 +51,14 @@ public partial class GetWebhookByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("webhook_id")] - [JsonRequired] - public required string WebhookId { get; set; } + [JsonPropertyName("webhook_id"), JsonInclude] + public string? WebhookId { get; private set; } /// /// Array of custom webhook headers /// /// Array of custom webhook headers - [JsonPropertyName("headers")] + [JsonPropertyName("headers"), JsonPropertyOrder(4)] public List? Headers { get; set; } diff --git a/ShipEngineSDK/Model/IdentifierType.cs b/ShipEngineSDK/Model/IdentifierType.cs index 112680da..fde76f2c 100644 --- a/ShipEngineSDK/Model/IdentifierType.cs +++ b/ShipEngineSDK/Model/IdentifierType.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(IdentifierTypeJsonConverter))] public class IdentifierType { - private string _value; + private readonly string _value; /// /// Create a new instance of IdentifierType with a predefined value. @@ -128,6 +128,12 @@ public IdentifierType(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is IdentifierType other && _value == other._value; } internal class IdentifierTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/ImporterOfRecords.cs b/ShipEngineSDK/Model/ImporterOfRecords.cs index ca6270d9..b48400f5 100644 --- a/ShipEngineSDK/Model/ImporterOfRecords.cs +++ b/ShipEngineSDK/Model/ImporterOfRecords.cs @@ -35,8 +35,7 @@ public partial class ImporterOfRecords /// /// 1999 Bishop Grandin Blvd. /// - [JsonPropertyName("address_line1")] - [JsonRequired] + [JsonPropertyName("address_line1"), JsonRequired, JsonPropertyOrder(1)] public required string AddressLine1 { get; set; } /// @@ -46,8 +45,7 @@ public partial class ImporterOfRecords /// /// Winnipeg /// - [JsonPropertyName("city_locality")] - [JsonRequired] + [JsonPropertyName("city_locality"), JsonRequired, JsonPropertyOrder(2)] public required string CityLocality { get; set; } /// @@ -57,8 +55,7 @@ public partial class ImporterOfRecords /// /// CA /// - [JsonPropertyName("country_code")] - [JsonRequired] + [JsonPropertyName("country_code"), JsonRequired, JsonPropertyOrder(3)] public required string CountryCode { get; set; } /// @@ -68,8 +65,7 @@ public partial class ImporterOfRecords /// /// John Doe /// - [JsonPropertyName("name")] - [JsonRequired] + [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(4)] public required string Name { get; set; } /// @@ -79,8 +75,7 @@ public partial class ImporterOfRecords /// /// 78756-3717 /// - [JsonPropertyName("postal_code")] - [JsonRequired] + [JsonPropertyName("postal_code"), JsonRequired, JsonPropertyOrder(5)] public required string PostalCode { get; set; } /// @@ -90,7 +85,7 @@ public partial class ImporterOfRecords /// /// Unit 408 /// - [JsonPropertyName("address_line2")] + [JsonPropertyName("address_line2"), JsonPropertyOrder(6)] public string? AddressLine2 { get; set; } /// @@ -100,7 +95,7 @@ public partial class ImporterOfRecords /// /// Building #7 /// - [JsonPropertyName("address_line3")] + [JsonPropertyName("address_line3"), JsonPropertyOrder(7)] public string? AddressLine3 { get; set; } /// @@ -110,7 +105,7 @@ public partial class ImporterOfRecords /// /// The Home Depot /// - [JsonPropertyName("company_name")] + [JsonPropertyName("company_name"), JsonPropertyOrder(8)] public string? CompanyName { get; set; } /// @@ -120,7 +115,7 @@ public partial class ImporterOfRecords /// /// example@example.com /// - [JsonPropertyName("email")] + [JsonPropertyName("email"), JsonPropertyOrder(9)] public string? Email { get; set; } /// @@ -130,7 +125,7 @@ public partial class ImporterOfRecords /// /// +1 204-253-9411 ext. 123 /// - [JsonPropertyName("phone")] + [JsonPropertyName("phone"), JsonPropertyOrder(10)] public string? Phone { get; set; } /// @@ -140,7 +135,7 @@ public partial class ImporterOfRecords /// /// Manitoba /// - [JsonPropertyName("state_province")] + [JsonPropertyName("state_province"), JsonPropertyOrder(11)] public string? StateProvince { get; set; } diff --git a/ShipEngineSDK/Model/InsuranceProvider.cs b/ShipEngineSDK/Model/InsuranceProvider.cs index 8216afe7..34b0c231 100644 --- a/ShipEngineSDK/Model/InsuranceProvider.cs +++ b/ShipEngineSDK/Model/InsuranceProvider.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(InsuranceProviderJsonConverter))] public class InsuranceProvider { - private string _value; + private readonly string _value; /// /// Create a new instance of InsuranceProvider with a predefined value. @@ -80,6 +80,12 @@ public InsuranceProvider(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is InsuranceProvider other && _value == other._value; } internal class InsuranceProviderJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/InternationalShipmentOptions.cs b/ShipEngineSDK/Model/InternationalShipmentOptions.cs index f3817ee0..151a0d85 100644 --- a/ShipEngineSDK/Model/InternationalShipmentOptions.cs +++ b/ShipEngineSDK/Model/InternationalShipmentOptions.cs @@ -29,61 +29,57 @@ public partial class InternationalShipmentOptions { /// - /// The type of contents in this shipment. This may impact import duties or customs treatment. CLOVUS + /// The type of contents in this shipment. This may impact import duties or customs treatment. /// /// The type of contents in this shipment. This may impact import duties or customs treatment. - [JsonPropertyName("contents")] - [JsonRequired] - public required PackageContents Contents { get; set; } = new(); - + [JsonPropertyName("contents"), JsonRequired, JsonPropertyOrder(1)] + public required PackageContents Contents { get; set; } /// - /// Indicates what to do if a package is unable to be delivered. CLOVUS + /// Indicates what to do if a package is unable to be delivered. /// /// Indicates what to do if a package is unable to be delivered. - [JsonPropertyName("non_delivery")] - [JsonRequired] - public required NonDelivery NonDelivery { get; set; } = new(); - + [JsonPropertyName("non_delivery"), JsonRequired, JsonPropertyOrder(2)] + public required NonDelivery NonDelivery { get; set; } /// - /// Specifies the supported terms of trade code (incoterms) CLOVUS + /// Specifies the supported terms of trade code (incoterms) /// /// Specifies the supported terms of trade code (incoterms) - [JsonPropertyName("terms_of_trade_code")] + [JsonPropertyName("terms_of_trade_code"), JsonPropertyOrder(8)] public AllowedIncoterms? TermsOfTradeCode { get; set; } + /// /// Explanation for contents (required if the `contents` is provided as `other`) /// /// Explanation for contents (required if the `contents` is provided as `other`) - [JsonPropertyName("contents_explanation")] + [JsonPropertyName("contents_explanation"), JsonPropertyOrder(3)] public string? ContentsExplanation { get; set; } /// /// Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`) /// /// Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`) - [JsonPropertyName("customs_items")] - [Obsolete] + [JsonPropertyName("customs_items"), JsonPropertyOrder(4), Obsolete] public List? CustomsItems { get; set; } /// /// Declaration statement to be placed on the commercial invoice /// /// Declaration statement to be placed on the commercial invoice - [JsonPropertyName("declaration")] + [JsonPropertyName("declaration"), JsonPropertyOrder(5)] public string? Declaration { get; set; } /// /// Gets or Sets ImporterOfRecord /// - [JsonPropertyName("importer_of_record")] + [JsonPropertyName("importer_of_record"), JsonPropertyOrder(6)] public ImporterOfRecords? ImporterOfRecord { get; set; } /// /// Gets or Sets InvoiceAdditionalDetails /// - [JsonPropertyName("invoice_additional_details")] + [JsonPropertyName("invoice_additional_details"), JsonPropertyOrder(7)] public InvoiceAdditionalDetails? InvoiceAdditionalDetails { get; set; } diff --git a/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs b/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs index 20aeba95..947441f7 100644 --- a/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs +++ b/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs @@ -32,35 +32,35 @@ public partial class InvoiceAdditionalDetails /// Discount for shipment. /// /// Discount for shipment. - [JsonPropertyName("discount")] + [JsonPropertyName("discount"), JsonPropertyOrder(1)] public MonetaryValue? Discount { get; set; } /// /// Freight Charge for shipment. /// /// Freight Charge for shipment. - [JsonPropertyName("freight_charge")] + [JsonPropertyName("freight_charge"), JsonPropertyOrder(2)] public MonetaryValue? FreightCharge { get; set; } /// /// Insurance Charge for shipment. /// /// Insurance Charge for shipment. - [JsonPropertyName("insurance_charge")] + [JsonPropertyName("insurance_charge"), JsonPropertyOrder(3)] public MonetaryValue? InsuranceCharge { get; set; } /// /// Other charge for shipment. /// /// Other charge for shipment. - [JsonPropertyName("other_charge")] + [JsonPropertyName("other_charge"), JsonPropertyOrder(4)] public MonetaryValue? OtherCharge { get; set; } /// /// Description for the other charge (if provided). /// /// Description for the other charge (if provided). - [JsonPropertyName("other_charge_description")] + [JsonPropertyName("other_charge_description"), JsonPropertyOrder(5)] public string? OtherChargeDescription { get; set; } diff --git a/ShipEngineSDK/Model/Label.cs b/ShipEngineSDK/Model/Label.cs index ca5b4c38..32605a3a 100644 --- a/ShipEngineSDK/Model/Label.cs +++ b/ShipEngineSDK/Model/Label.cs @@ -29,56 +29,64 @@ public partial class Label { /// - /// The label charge event. CLOVUS + /// The label charge event. /// /// The label charge event. - [JsonPropertyName("charge_event")] + [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] public LabelChargeEvent? ChargeEvent { get; set; } + /// - /// The display format that the label should be shown in. CLOVUS + /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(7)] public DisplayScheme? DisplayScheme { get; set; } + /// - /// Gets or Sets LabelDownloadType CLOVUS + /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type")] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(14)] 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. CLOVUS + /// 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")] + [JsonPropertyName("label_format"), JsonPropertyOrder(15)] public LabelFormat? LabelFormat { 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. CLOVUS + /// 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")] + [JsonPropertyName("label_layout"), JsonPropertyOrder(18)] public LabelLayout? LabelLayout { get; set; } + /// - /// Gets or Sets Status CLOVUS + /// Gets or Sets Status /// - [JsonPropertyName("status")] - public LabelStatus? Status { get; set; } + [JsonPropertyName("status"), JsonInclude] + public LabelStatus? Status { get; private set; } + /// - /// The current status of the package, such as `in_transit` or `delivered` CLOVUS + /// The current status of the package, such as `in_transit` or `delivered` /// /// The current status of the package, such as `in_transit` or `delivered` - [JsonPropertyName("tracking_status")] - public TrackingStatus? TrackingStatus { get; set; } + [JsonPropertyName("tracking_status"), JsonInclude] + public TrackingStatus? TrackingStatus { get; private set; } + /// - /// Gets or Sets ValidateAddress CLOVUS + /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address")] + [JsonPropertyName("validate_address"), JsonPropertyOrder(36)] public ValidateAddress? ValidateAddress { get; set; } + /// /// Additional information some carriers may provide by which to identify a given label in their system. /// /// Additional information some carriers may provide by which to identify a given label in their system. - [JsonPropertyName("alternative_identifiers")] - public List? AlternativeIdentifiers { get; set; } + [JsonPropertyName("alternative_identifiers"), JsonInclude] + public List? AlternativeIdentifiers { get; private set; } /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. @@ -87,8 +95,8 @@ public partial class Label /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - public string? BatchId { get; set; } + [JsonPropertyName("batch_id"), JsonInclude] + public string? BatchId { get; private set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. @@ -97,8 +105,8 @@ public partial class Label /// /// dhl_express /// - [JsonPropertyName("carrier_code")] - public string? CarrierCode { get; set; } + [JsonPropertyName("carrier_code"), JsonInclude] + public string? CarrierCode { get; private set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label @@ -107,8 +115,8 @@ public partial class Label /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - public string? CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// The date and time that the label was created in ShipEngine. @@ -117,49 +125,49 @@ public partial class Label /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private 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. /// /// 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. - [JsonPropertyName("form_download")] - public Link? FormDownload { get; set; } + [JsonPropertyName("form_download"), JsonInclude] + public Link? FormDownload { get; private set; } /// /// 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. /// /// 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. - [JsonPropertyName("insurance_claim")] - public Link? InsuranceClaim { get; set; } + [JsonPropertyName("insurance_claim"), JsonInclude] + public Link? InsuranceClaim { get; private set; } /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. - [JsonPropertyName("insurance_cost")] - public MonetaryValue? InsuranceCost { get; set; } + [JsonPropertyName("insurance_cost"), JsonInclude] + public MonetaryValue? InsuranceCost { get; private set; } /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. - [JsonPropertyName("is_international")] - public bool? IsInternational { get; set; } + [JsonPropertyName("is_international"), JsonInclude] + public bool? IsInternational { get; private set; } /// /// 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")] + [JsonPropertyName("is_return_label"), JsonPropertyOrder(12)] public bool? IsReturnLabel { get; set; } /// /// Gets or Sets LabelDownload /// - [JsonPropertyName("label_download")] - public LabelDownload? LabelDownload { get; set; } + [JsonPropertyName("label_download"), JsonInclude] + public LabelDownload? LabelDownload { get; private set; } /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. @@ -168,8 +176,8 @@ public partial class Label /// /// se-28529731 /// - [JsonPropertyName("label_id")] - public string? LabelId { get; set; } + [JsonPropertyName("label_id"), JsonInclude] + public string? LabelId { get; private set; } /// /// The label image resource that was used to create a custom label image. @@ -178,7 +186,7 @@ public partial class Label /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id")] + [JsonPropertyName("label_image_id"), JsonPropertyOrder(17)] public string? LabelImageId { get; set; } /// @@ -188,7 +196,7 @@ public partial class Label /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id")] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19)] public string? OutboundLabelId { get; set; } /// @@ -198,35 +206,35 @@ public partial class Label /// /// small_flat_rate_box /// - [JsonPropertyName("package_code")] - public string? PackageCode { get; set; } + [JsonPropertyName("package_code"), JsonInclude] + public string? PackageCode { get; private set; } /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - public List? Packages { get; set; } + [JsonPropertyName("packages"), JsonInclude] + public List? Packages { get; private set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - public PaperlessDownload? PaperlessDownload { get; set; } + [JsonPropertyName("paperless_download"), JsonInclude] + public PaperlessDownload? PaperlessDownload { get; private set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue? RequestedComparisonAmount { get; set; } + [JsonPropertyName("requested_comparison_amount"), JsonInclude] + public MonetaryValue? RequestedComparisonAmount { get; private set; } /// /// 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")] + [JsonPropertyName("rma_number"), JsonPropertyOrder(24)] public string? RmaNumber { get; set; } /// @@ -236,8 +244,8 @@ public partial class Label /// /// usps_first_class_mail /// - [JsonPropertyName("service_code")] - public string? ServiceCode { get; set; } + [JsonPropertyName("service_code"), JsonInclude] + public string? ServiceCode { get; private set; } /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. @@ -246,22 +254,22 @@ public partial class Label /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date")] - public DateTimeOffset? ShipDate { get; set; } + [JsonPropertyName("ship_date"), JsonInclude] + public DateTimeOffset? ShipDate { get; private set; } /// /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment")] + [JsonPropertyName("shipment"), JsonPropertyOrder(27)] public Shipment? Shipment { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - [JsonPropertyName("shipment_cost")] - public MonetaryValue? ShipmentCost { get; set; } + [JsonPropertyName("shipment_cost"), JsonInclude] + public MonetaryValue? ShipmentCost { get; private set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) @@ -270,23 +278,22 @@ public partial class Label /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string? ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private 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")] - [Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(31), Obsolete] public bool? TestLabel { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. - [JsonPropertyName("trackable")] - public bool? Trackable { get; set; } + [JsonPropertyName("trackable"), JsonInclude] + public bool? Trackable { get; private set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. @@ -295,8 +302,8 @@ public partial class Label /// /// 782758401696 /// - [JsonPropertyName("tracking_number")] - public string? TrackingNumber { get; set; } + [JsonPropertyName("tracking_number"), JsonInclude] + public string? TrackingNumber { get; private set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. @@ -305,15 +312,15 @@ public partial class Label /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// - [JsonPropertyName("tracking_url")] - public string? TrackingUrl { get; set; } + [JsonPropertyName("tracking_url"), JsonInclude] + public string? TrackingUrl { get; private set; } /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) - [JsonPropertyName("voided")] - public bool? Voided { get; set; } + [JsonPropertyName("voided"), JsonInclude] + public bool? Voided { get; private set; } /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided @@ -322,8 +329,8 @@ public partial class Label /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("voided_at")] - public DateTimeOffset? VoidedAt { get; set; } + [JsonPropertyName("voided_at"), JsonInclude] + public DateTimeOffset? VoidedAt { get; private set; } /// diff --git a/ShipEngineSDK/Model/LabelChargeEvent.cs b/ShipEngineSDK/Model/LabelChargeEvent.cs index 73f200a2..44b7cf36 100644 --- a/ShipEngineSDK/Model/LabelChargeEvent.cs +++ b/ShipEngineSDK/Model/LabelChargeEvent.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(LabelChargeEventJsonConverter))] public class LabelChargeEvent { - private string _value; + private readonly string _value; /// /// Create a new instance of LabelChargeEvent with a predefined value. @@ -74,6 +74,12 @@ public LabelChargeEvent(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is LabelChargeEvent other && _value == other._value; } internal class LabelChargeEventJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/LabelDownload.cs b/ShipEngineSDK/Model/LabelDownload.cs index f4aae4c6..545614b4 100644 --- a/ShipEngineSDK/Model/LabelDownload.cs +++ b/ShipEngineSDK/Model/LabelDownload.cs @@ -35,7 +35,7 @@ public partial class LabelDownload /// /// http://api.shipengine.com/v1/labels/se-28529731 /// - [JsonPropertyName("href")] + [JsonPropertyName("href"), JsonPropertyOrder(1)] public string? Href { get; set; } /// @@ -45,7 +45,7 @@ public partial class LabelDownload /// /// http://api.shipengine.com/v1/labels/se-28529731 /// - [JsonPropertyName("pdf")] + [JsonPropertyName("pdf"), JsonPropertyOrder(2)] public string? Pdf { get; set; } /// @@ -55,7 +55,7 @@ public partial class LabelDownload /// /// http://api.shipengine.com/v1/labels/se-28529731 /// - [JsonPropertyName("png")] + [JsonPropertyName("png"), JsonPropertyOrder(3)] public string? Png { get; set; } /// @@ -65,7 +65,7 @@ public partial class LabelDownload /// /// http://api.shipengine.com/v1/labels/se-28529731 /// - [JsonPropertyName("zpl")] + [JsonPropertyName("zpl"), JsonPropertyOrder(4)] public string? Zpl { get; set; } diff --git a/ShipEngineSDK/Model/LabelDownloadType.cs b/ShipEngineSDK/Model/LabelDownloadType.cs index 6fb6d4ec..64cb6e2a 100644 --- a/ShipEngineSDK/Model/LabelDownloadType.cs +++ b/ShipEngineSDK/Model/LabelDownloadType.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(LabelDownloadTypeJsonConverter))] public class LabelDownloadType { - private string _value; + private readonly string _value; /// /// Create a new instance of LabelDownloadType with a predefined value. @@ -68,6 +68,12 @@ public LabelDownloadType(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is LabelDownloadType other && _value == other._value; } internal class LabelDownloadTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/LabelFormat.cs b/ShipEngineSDK/Model/LabelFormat.cs index 3bc597ca..3e8f6a79 100644 --- a/ShipEngineSDK/Model/LabelFormat.cs +++ b/ShipEngineSDK/Model/LabelFormat.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(LabelFormatJsonConverter))] public class LabelFormat { - private string _value; + private readonly string _value; /// /// Create a new instance of LabelFormat with a predefined value. @@ -74,6 +74,12 @@ public LabelFormat(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is LabelFormat other && _value == other._value; } internal class LabelFormatJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/LabelLayout.cs b/ShipEngineSDK/Model/LabelLayout.cs index faddea8c..93ff6f7f 100644 --- a/ShipEngineSDK/Model/LabelLayout.cs +++ b/ShipEngineSDK/Model/LabelLayout.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(LabelLayoutJsonConverter))] public class LabelLayout { - private string _value; + private readonly string _value; /// /// Create a new instance of LabelLayout with a predefined value. @@ -68,6 +68,12 @@ public LabelLayout(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is LabelLayout other && _value == other._value; } internal class LabelLayoutJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/LabelMessages.cs b/ShipEngineSDK/Model/LabelMessages.cs index 48793a3e..82ed5e80 100644 --- a/ShipEngineSDK/Model/LabelMessages.cs +++ b/ShipEngineSDK/Model/LabelMessages.cs @@ -32,24 +32,21 @@ public partial class LabelMessages /// The first line of the custom label message. Some carriers may prefix this line with something like \"REF\", \"Reference\", \"Trx Ref No.\", etc. /// /// The first line of the custom label message. Some carriers may prefix this line with something like \"REF\", \"Reference\", \"Trx Ref No.\", etc. - [JsonPropertyName("reference1")] - [JsonRequired] + [JsonPropertyName("reference1"), JsonRequired, JsonPropertyOrder(1)] public required string Reference1 { get; set; } /// /// The second line of the custom label message. Some carriers may prefix this line with something like \"INV\", \"Reference 2\", \"Trx Ref No.\", etc. /// /// The second line of the custom label message. Some carriers may prefix this line with something like \"INV\", \"Reference 2\", \"Trx Ref No.\", etc. - [JsonPropertyName("reference2")] - [JsonRequired] + [JsonPropertyName("reference2"), JsonRequired, JsonPropertyOrder(2)] public required string Reference2 { get; set; } /// /// The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc. /// /// The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc. - [JsonPropertyName("reference3")] - [JsonRequired] + [JsonPropertyName("reference3"), JsonRequired, JsonPropertyOrder(3)] public required string Reference3 { get; set; } diff --git a/ShipEngineSDK/Model/LabelPackagesInner.cs b/ShipEngineSDK/Model/LabelPackagesInner.cs index 61a31bbd..03d62717 100644 --- a/ShipEngineSDK/Model/LabelPackagesInner.cs +++ b/ShipEngineSDK/Model/LabelPackagesInner.cs @@ -32,16 +32,15 @@ public partial class LabelPackagesInner /// The package weight /// /// The package weight - [JsonPropertyName("weight")] - [JsonRequired] + [JsonPropertyName("weight"), JsonRequired, JsonPropertyOrder(1)] public required Weight Weight { get; set; } /// /// Alternative identifiers associated with this package. /// /// Alternative identifiers associated with this package. - [JsonPropertyName("alternative_identifiers")] - public List? AlternativeIdentifiers { get; set; } + [JsonPropertyName("alternative_identifiers"), JsonInclude] + public List? AlternativeIdentifiers { get; private set; } /// /// A short description of the package content. Required for shipments moving to, from, and through Mexico. @@ -50,48 +49,48 @@ public partial class LabelPackagesInner /// /// Hand knitted wool socks /// - [JsonPropertyName("content_description")] + [JsonPropertyName("content_description"), JsonPropertyOrder(3)] public string? ContentDescription { get; set; } /// /// The package dimensions /// /// The package dimensions - [JsonPropertyName("dimensions")] + [JsonPropertyName("dimensions"), JsonPropertyOrder(4)] public Dimensions? Dimensions { get; set; } /// /// An external package id. /// /// An external package id. - [JsonPropertyName("external_package_id")] + [JsonPropertyName("external_package_id"), JsonPropertyOrder(5)] public string? ExternalPackageId { get; set; } /// /// The form download for any customs that are needed /// /// The form download for any customs that are needed - [JsonPropertyName("form_download")] - public OptionalLink? FormDownload { get; set; } + [JsonPropertyName("form_download"), JsonInclude] + public OptionalLink? FormDownload { get; private set; } /// /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. /// /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. - [JsonPropertyName("insured_value")] + [JsonPropertyName("insured_value"), JsonPropertyOrder(7)] public MonetaryValue? InsuredValue { get; set; } /// /// The label download for the package /// /// The label download for the package - [JsonPropertyName("label_download")] - public LabelDownload? LabelDownload { get; set; } + [JsonPropertyName("label_download"), JsonInclude] + public LabelDownload? LabelDownload { get; private set; } /// /// Gets or Sets LabelMessages /// - [JsonPropertyName("label_messages")] + [JsonPropertyName("label_messages"), JsonPropertyOrder(9)] public LabelMessages? LabelMessages { get; set; } /// @@ -101,7 +100,7 @@ public partial class LabelPackagesInner /// /// small_flat_rate_box /// - [JsonPropertyName("package_code")] + [JsonPropertyName("package_code"), JsonPropertyOrder(10)] public string? PackageCode { get; set; } /// @@ -111,29 +110,29 @@ public partial class LabelPackagesInner /// /// se-28529731 /// - [JsonPropertyName("package_id")] + [JsonPropertyName("package_id"), JsonPropertyOrder(11)] public string? PackageId { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - public PaperlessDownload? PaperlessDownload { get; set; } + [JsonPropertyName("paperless_download"), JsonInclude] + public PaperlessDownload? PaperlessDownload { get; private set; } /// /// Details about products inside packages (Information provided would be used on custom documentation) /// /// Details about products inside packages (Information provided would be used on custom documentation) - [JsonPropertyName("products")] + [JsonPropertyName("products"), JsonPropertyOrder(13)] public List? Products { get; set; } /// /// Package sequence /// /// Package sequence - [JsonPropertyName("sequence")] - public int? Sequence { get; set; } + [JsonPropertyName("sequence"), JsonInclude] + public int? Sequence { get; private set; } /// /// The tracking number for the package. The format depends on the carrier. @@ -142,8 +141,8 @@ public partial class LabelPackagesInner /// /// 1Z932R800392060079 /// - [JsonPropertyName("tracking_number")] - public string? TrackingNumber { get; set; } + [JsonPropertyName("tracking_number"), JsonInclude] + public string? TrackingNumber { get; private set; } /// diff --git a/ShipEngineSDK/Model/LabelStatus.cs b/ShipEngineSDK/Model/LabelStatus.cs index 29d0aff1..f6034537 100644 --- a/ShipEngineSDK/Model/LabelStatus.cs +++ b/ShipEngineSDK/Model/LabelStatus.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(LabelStatusJsonConverter))] public class LabelStatus { - private string _value; + private readonly string _value; /// /// Create a new instance of LabelStatus with a predefined value. @@ -80,6 +80,12 @@ public LabelStatus(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is LabelStatus other && _value == other._value; } internal class LabelStatusJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/Link.cs b/ShipEngineSDK/Model/Link.cs index d32bc67c..64821b7d 100644 --- a/ShipEngineSDK/Model/Link.cs +++ b/ShipEngineSDK/Model/Link.cs @@ -35,15 +35,14 @@ public partial class Link /// /// http://api.shipengine.com/v1/labels/se-28529731 /// - [JsonPropertyName("href")] - [JsonRequired] + [JsonPropertyName("href"), JsonRequired, JsonPropertyOrder(1)] public required string Href { get; set; } /// /// The type of resource, or the type of relationship to the parent resource /// /// The type of resource, or the type of relationship to the parent resource - [JsonPropertyName("type")] + [JsonPropertyName("type"), JsonPropertyOrder(2)] public string? Type { get; set; } diff --git a/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs b/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs index 84369533..0e87903d 100644 --- a/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs +++ b/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs @@ -40,8 +40,8 @@ public class ListAccountImagesResponseBodyItem /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id")] - public string? LabelImageId { get; set; } + [JsonPropertyName("label_image_id"), JsonInclude] + public string? LabelImageId { get; private set; } /// /// A human readable name for the image. @@ -50,7 +50,7 @@ public class ListAccountImagesResponseBodyItem /// /// My logo /// - [JsonPropertyName("name")] + [JsonPropertyName("name"), JsonPropertyOrder(2)] public string? Name { get; set; } /// @@ -60,14 +60,14 @@ public class ListAccountImagesResponseBodyItem /// /// false /// - [JsonPropertyName("is_default")] + [JsonPropertyName("is_default"), JsonPropertyOrder(3)] public bool? IsDefault { get; set; } /// /// The file type of the image. /// /// The file type of the image. - [JsonPropertyName("image_content_type")] + [JsonPropertyName("image_content_type"), JsonPropertyOrder(4)] public string? ImageContentType { get; set; } /// @@ -77,7 +77,7 @@ public class ListAccountImagesResponseBodyItem /// /// iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg== /// - [JsonPropertyName("image_data")] + [JsonPropertyName("image_data"), JsonPropertyOrder(5)] public string? ImageData { get; set; } /// @@ -87,8 +87,8 @@ public class ListAccountImagesResponseBodyItem /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// The date and time that the image was modified in ShipEngine. @@ -97,23 +97,21 @@ public class ListAccountImagesResponseBodyItem /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("modified_at")] - public DateTimeOffset? ModifiedAt { get; set; } + [JsonPropertyName("modified_at"), JsonInclude] + public DateTimeOffset? ModifiedAt { get; private set; } } /// /// Image List /// /// Image List - [JsonPropertyName("images")] - [JsonRequired] - public required List Images { get; set; } + [JsonPropertyName("images"), JsonInclude] + public List? Images { get; private set; } /// /// Gets or Sets Links /// - [JsonPropertyName("links")] - [JsonRequired] + [JsonPropertyName("links"), JsonRequired, JsonPropertyOrder(2)] public required PaginationLink Links { get; set; } /// @@ -123,8 +121,7 @@ public class ListAccountImagesResponseBodyItem /// /// 1 /// - [JsonPropertyName("page")] - [JsonRequired] + [JsonPropertyName("page"), JsonRequired, JsonPropertyOrder(3)] public required int Page { get; set; } /// @@ -134,8 +131,7 @@ public class ListAccountImagesResponseBodyItem /// /// 4 /// - [JsonPropertyName("pages")] - [JsonRequired] + [JsonPropertyName("pages"), JsonRequired, JsonPropertyOrder(4)] public required int Pages { get; set; } /// @@ -145,8 +141,7 @@ public class ListAccountImagesResponseBodyItem /// /// 2750 /// - [JsonPropertyName("total")] - [JsonRequired] + [JsonPropertyName("total"), JsonRequired, JsonPropertyOrder(5)] public required int Total { get; set; } diff --git a/ShipEngineSDK/Model/ListAccountSettingsBody.cs b/ShipEngineSDK/Model/ListAccountSettingsBody.cs index c03f4ae8..021e4854 100644 --- a/ShipEngineSDK/Model/ListAccountSettingsBody.cs +++ b/ShipEngineSDK/Model/ListAccountSettingsBody.cs @@ -29,11 +29,12 @@ public partial class ListAccountSettingsBody { /// - /// Gets or Sets DefaultLabelLayout CLOVUS + /// Gets or Sets DefaultLabelLayout /// - [JsonPropertyName("default_label_layout")] + [JsonPropertyName("default_label_layout"), JsonPropertyOrder(1)] public DefaultLabelLayout? DefaultLabelLayout { get; set; } + /// /// Returns the string presentation of the object /// diff --git a/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs b/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs index cfd6529c..fa68b4ca 100644 --- a/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs +++ b/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs @@ -40,8 +40,8 @@ public class ListAccountSettingsImagesResponseBodyItem /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id")] - public string? LabelImageId { get; set; } + [JsonPropertyName("label_image_id"), JsonInclude] + public string? LabelImageId { get; private set; } /// /// A human readable name for the image. @@ -50,7 +50,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// /// My logo /// - [JsonPropertyName("name")] + [JsonPropertyName("name"), JsonPropertyOrder(2)] public string? Name { get; set; } /// @@ -60,14 +60,14 @@ public class ListAccountSettingsImagesResponseBodyItem /// /// false /// - [JsonPropertyName("is_default")] + [JsonPropertyName("is_default"), JsonPropertyOrder(3)] public bool? IsDefault { get; set; } /// /// The file type of the image. /// /// The file type of the image. - [JsonPropertyName("image_content_type")] + [JsonPropertyName("image_content_type"), JsonPropertyOrder(4)] public string? ImageContentType { get; set; } /// @@ -77,7 +77,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// /// iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg== /// - [JsonPropertyName("image_data")] + [JsonPropertyName("image_data"), JsonPropertyOrder(5)] public string? ImageData { get; set; } /// @@ -87,8 +87,8 @@ public class ListAccountSettingsImagesResponseBodyItem /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// The date and time that the image was modified in ShipEngine. @@ -97,23 +97,21 @@ public class ListAccountSettingsImagesResponseBodyItem /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("modified_at")] - public DateTimeOffset? ModifiedAt { get; set; } + [JsonPropertyName("modified_at"), JsonInclude] + public DateTimeOffset? ModifiedAt { get; private set; } } /// /// Image List /// /// Image List - [JsonPropertyName("images")] - [JsonRequired] - public required List Images { get; set; } + [JsonPropertyName("images"), JsonInclude] + public List? Images { get; private set; } /// /// Gets or Sets Links /// - [JsonPropertyName("links")] - [JsonRequired] + [JsonPropertyName("links"), JsonRequired, JsonPropertyOrder(2)] public required PaginationLink Links { get; set; } /// @@ -123,8 +121,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// /// 1 /// - [JsonPropertyName("page")] - [JsonRequired] + [JsonPropertyName("page"), JsonRequired, JsonPropertyOrder(3)] public required int Page { get; set; } /// @@ -134,8 +131,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// /// 4 /// - [JsonPropertyName("pages")] - [JsonRequired] + [JsonPropertyName("pages"), JsonRequired, JsonPropertyOrder(4)] public required int Pages { get; set; } /// @@ -145,8 +141,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// /// 2750 /// - [JsonPropertyName("total")] - [JsonRequired] + [JsonPropertyName("total"), JsonRequired, JsonPropertyOrder(5)] public required int Total { get; set; } diff --git a/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs b/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs index b6a9596b..ad86ccdb 100644 --- a/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs +++ b/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs @@ -32,16 +32,14 @@ public partial class ListBatchErrorsResponseBody /// The errors currently associated with the batch /// /// The errors currently associated with the batch - [JsonPropertyName("errors")] - [JsonRequired] - public required List Errors { get; set; } + [JsonPropertyName("errors"), JsonInclude] + public List? Errors { get; private set; } /// /// Gets or Sets Links /// - [JsonPropertyName("links")] - [JsonRequired] - public required PaginationLink Links { get; set; } + [JsonPropertyName("links"), JsonInclude] + public PaginationLink? Links { get; private set; } /// diff --git a/ShipEngineSDK/Model/ListBatchesResponseBody.cs b/ShipEngineSDK/Model/ListBatchesResponseBody.cs index 71388935..76ca5edb 100644 --- a/ShipEngineSDK/Model/ListBatchesResponseBody.cs +++ b/ShipEngineSDK/Model/ListBatchesResponseBody.cs @@ -32,16 +32,14 @@ public partial class ListBatchesResponseBody /// Batch List /// /// Batch List - [JsonPropertyName("batches")] - [JsonRequired] - public required List Batches { get; set; } + [JsonPropertyName("batches"), JsonInclude] + public List? Batches { get; private set; } /// /// Gets or Sets Links /// - [JsonPropertyName("links")] - [JsonRequired] - public required PaginationLink Links { get; set; } + [JsonPropertyName("links"), JsonInclude] + public PaginationLink? Links { get; private set; } /// /// The page that is currently being read @@ -50,9 +48,8 @@ public partial class ListBatchesResponseBody /// /// 1 /// - [JsonPropertyName("page")] - [JsonRequired] - public required int Page { get; set; } + [JsonPropertyName("page"), JsonInclude] + public int? Page { get; private set; } /// /// The total number of batch pages the API call returned @@ -61,9 +58,8 @@ public partial class ListBatchesResponseBody /// /// 10 /// - [JsonPropertyName("pages")] - [JsonRequired] - public required int Pages { get; set; } + [JsonPropertyName("pages"), JsonInclude] + public int? Pages { get; private set; } /// /// The total number of batches the API call returned @@ -72,9 +68,8 @@ public partial class ListBatchesResponseBody /// /// 10 /// - [JsonPropertyName("total")] - [JsonRequired] - public required long Total { get; set; } + [JsonPropertyName("total"), JsonInclude] + public long? Total { get; private set; } /// diff --git a/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs b/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs index 89237479..60cb70a2 100644 --- a/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs +++ b/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs @@ -32,8 +32,8 @@ public partial class ListCarrierPackageTypesResponseBody /// An array of custom package types /// /// An array of custom package types - [JsonPropertyName("packages")] - public List? Packages { get; set; } + [JsonPropertyName("packages"), JsonInclude] + public List? Packages { get; private set; } /// diff --git a/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs b/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs index 49be1c8b..e286f4ea 100644 --- a/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs +++ b/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs @@ -32,8 +32,8 @@ public partial class ListCarrierServicesResponseBody /// An array of services associated with the carrier /// /// An array of services associated with the carrier - [JsonPropertyName("services")] - public List? Services { get; set; } + [JsonPropertyName("services"), JsonInclude] + public List? Services { get; private set; } /// diff --git a/ShipEngineSDK/Model/ListCarriersResponseBody.cs b/ShipEngineSDK/Model/ListCarriersResponseBody.cs index 90b02e82..747f3ca7 100644 --- a/ShipEngineSDK/Model/ListCarriersResponseBody.cs +++ b/ShipEngineSDK/Model/ListCarriersResponseBody.cs @@ -32,9 +32,8 @@ public partial class ListCarriersResponseBody /// The carrier response body /// /// The carrier response body - [JsonPropertyName("carriers")] - [JsonRequired] - public required List Carriers { get; set; } + [JsonPropertyName("carriers"), JsonInclude] + public List? Carriers { get; private set; } /// diff --git a/ShipEngineSDK/Model/ListLabelsResponseBody.cs b/ShipEngineSDK/Model/ListLabelsResponseBody.cs index 1bb5a45f..07fae5d6 100644 --- a/ShipEngineSDK/Model/ListLabelsResponseBody.cs +++ b/ShipEngineSDK/Model/ListLabelsResponseBody.cs @@ -40,14 +40,14 @@ public class ListLabelsResponseBodyItem /// /// se-28529731 /// - [JsonPropertyName("label_id")] - public string? LabelId { get; set; } + [JsonPropertyName("label_id"), JsonInclude] + public string? LabelId { get; private set; } /// /// Gets or Sets Status /// - [JsonPropertyName("status")] - public LabelStatus? Status { get; set; } + [JsonPropertyName("status"), JsonInclude] + public LabelStatus? Status { get; private set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) @@ -56,14 +56,14 @@ public class ListLabelsResponseBodyItem /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string? ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private set; } /// /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment")] + [JsonPropertyName("shipment"), JsonPropertyOrder(4)] public Shipment? Shipment { get; set; } /// @@ -73,8 +73,8 @@ public class ListLabelsResponseBodyItem /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date")] - public DateTimeOffset? ShipDate { get; set; } + [JsonPropertyName("ship_date"), JsonInclude] + public DateTimeOffset? ShipDate { get; private set; } /// /// The date and time that the label was created in ShipEngine. @@ -83,29 +83,29 @@ public class ListLabelsResponseBodyItem /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - [JsonPropertyName("shipment_cost")] - public MonetaryValue? ShipmentCost { get; set; } + [JsonPropertyName("shipment_cost"), JsonInclude] + public MonetaryValue? ShipmentCost { get; private set; } /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. - [JsonPropertyName("insurance_cost")] - public MonetaryValue? InsuranceCost { get; set; } + [JsonPropertyName("insurance_cost"), JsonInclude] + public MonetaryValue? InsuranceCost { get; private set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue? RequestedComparisonAmount { get; set; } + [JsonPropertyName("requested_comparison_amount"), JsonInclude] + public MonetaryValue? RequestedComparisonAmount { get; private set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. @@ -114,29 +114,29 @@ public class ListLabelsResponseBodyItem /// /// 782758401696 /// - [JsonPropertyName("tracking_number")] - public string? TrackingNumber { get; set; } + [JsonPropertyName("tracking_number"), JsonInclude] + public string? TrackingNumber { get; private set; } /// /// 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")] + [JsonPropertyName("is_return_label"), JsonPropertyOrder(11)] public bool? IsReturnLabel { get; set; } /// /// 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")] + [JsonPropertyName("rma_number"), JsonPropertyOrder(12)] public string? RmaNumber { get; set; } /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. - [JsonPropertyName("is_international")] - public bool? IsInternational { get; set; } + [JsonPropertyName("is_international"), JsonInclude] + public bool? IsInternational { get; private set; } /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. @@ -145,8 +145,8 @@ public class ListLabelsResponseBodyItem /// /// se-28529731 /// - [JsonPropertyName("batch_id")] - public string? BatchId { get; set; } + [JsonPropertyName("batch_id"), JsonInclude] + public string? BatchId { get; private set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label @@ -155,14 +155,14 @@ public class ListLabelsResponseBodyItem /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - public string? CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// The label charge event. /// /// The label charge event. - [JsonPropertyName("charge_event")] + [JsonPropertyName("charge_event"), JsonPropertyOrder(16)] public LabelChargeEvent? ChargeEvent { get; set; } /// @@ -172,7 +172,7 @@ public class ListLabelsResponseBodyItem /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id")] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(17)] public string? OutboundLabelId { get; set; } /// @@ -182,15 +182,14 @@ public class ListLabelsResponseBodyItem /// /// usps_first_class_mail /// - [JsonPropertyName("service_code")] - public string? ServiceCode { get; set; } + [JsonPropertyName("service_code"), JsonInclude] + public string? ServiceCode { get; private 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")] - [Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(19), Obsolete] public bool? TestLabel { get; set; } /// @@ -200,21 +199,21 @@ public class ListLabelsResponseBodyItem /// /// small_flat_rate_box /// - [JsonPropertyName("package_code")] - public string? PackageCode { get; set; } + [JsonPropertyName("package_code"), JsonInclude] + public string? PackageCode { get; private set; } /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address")] + [JsonPropertyName("validate_address"), JsonPropertyOrder(21)] public ValidateAddress? ValidateAddress { get; set; } /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) - [JsonPropertyName("voided")] - public bool? Voided { get; set; } + [JsonPropertyName("voided"), JsonInclude] + public bool? Voided { get; private set; } /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided @@ -223,42 +222,42 @@ public class ListLabelsResponseBodyItem /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("voided_at")] - public DateTimeOffset? VoidedAt { get; set; } + [JsonPropertyName("voided_at"), JsonInclude] + public DateTimeOffset? VoidedAt { get; private set; } /// /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type")] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(24)] 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")] + [JsonPropertyName("label_format"), JsonPropertyOrder(25)] public LabelFormat? LabelFormat { get; set; } /// /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(26)] public DisplayScheme? DisplayScheme { 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")] + [JsonPropertyName("label_layout"), JsonPropertyOrder(27)] public LabelLayout? LabelLayout { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. - [JsonPropertyName("trackable")] - public bool? Trackable { get; set; } + [JsonPropertyName("trackable"), JsonInclude] + public bool? Trackable { get; private set; } /// /// The label image resource that was used to create a custom label image. @@ -267,7 +266,7 @@ public class ListLabelsResponseBodyItem /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id")] + [JsonPropertyName("label_image_id"), JsonPropertyOrder(29)] public string? LabelImageId { get; set; } /// @@ -277,56 +276,56 @@ public class ListLabelsResponseBodyItem /// /// dhl_express /// - [JsonPropertyName("carrier_code")] - public string? CarrierCode { get; set; } + [JsonPropertyName("carrier_code"), JsonInclude] + public string? CarrierCode { get; private set; } /// /// The current status of the package, such as `in_transit` or `delivered` /// /// The current status of the package, such as `in_transit` or `delivered` - [JsonPropertyName("tracking_status")] - public TrackingStatus? TrackingStatus { get; set; } + [JsonPropertyName("tracking_status"), JsonInclude] + public TrackingStatus? TrackingStatus { get; private set; } /// /// Gets or Sets LabelDownload /// - [JsonPropertyName("label_download")] - public LabelDownload? LabelDownload { get; set; } + [JsonPropertyName("label_download"), JsonInclude] + public LabelDownload? LabelDownload { get; private 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. /// /// 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. - [JsonPropertyName("form_download")] - public Link? FormDownload { get; set; } + [JsonPropertyName("form_download"), JsonInclude] + public Link? FormDownload { get; private set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - public PaperlessDownload? PaperlessDownload { get; set; } + [JsonPropertyName("paperless_download"), JsonInclude] + public PaperlessDownload? PaperlessDownload { get; private set; } /// /// 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. /// /// 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. - [JsonPropertyName("insurance_claim")] - public Link? InsuranceClaim { get; set; } + [JsonPropertyName("insurance_claim"), JsonInclude] + public Link? InsuranceClaim { get; private set; } /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - public List? Packages { get; set; } + [JsonPropertyName("packages"), JsonInclude] + public List? Packages { get; private set; } /// /// Additional information some carriers may provide by which to identify a given label in their system. /// /// Additional information some carriers may provide by which to identify a given label in their system. - [JsonPropertyName("alternative_identifiers")] - public List? AlternativeIdentifiers { get; set; } + [JsonPropertyName("alternative_identifiers"), JsonInclude] + public List? AlternativeIdentifiers { get; private set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. @@ -335,23 +334,21 @@ public class ListLabelsResponseBodyItem /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// - [JsonPropertyName("tracking_url")] - public string? TrackingUrl { get; set; } + [JsonPropertyName("tracking_url"), JsonInclude] + public string? TrackingUrl { get; private set; } } /// /// The labels that matched the query criteria. If no matching labels were found, then this array is empty; otherwise, it contains one page of results. The last page of results may have fewer labels than the `page_size`. /// /// The labels that matched the query criteria. If no matching labels were found, then this array is empty; otherwise, it contains one page of results. The last page of results may have fewer labels than the `page_size`. - [JsonPropertyName("labels")] - [JsonRequired] + [JsonPropertyName("labels"), JsonRequired, JsonPropertyOrder(1)] public required List Labels { get; set; } /// /// Gets or Sets Links /// - [JsonPropertyName("links")] - [JsonRequired] + [JsonPropertyName("links"), JsonRequired, JsonPropertyOrder(2)] public required PaginationLink Links { get; set; } /// @@ -361,8 +358,7 @@ public class ListLabelsResponseBodyItem /// /// 1 /// - [JsonPropertyName("page")] - [JsonRequired] + [JsonPropertyName("page"), JsonRequired, JsonPropertyOrder(3)] public required int Page { get; set; } /// @@ -372,8 +368,7 @@ public class ListLabelsResponseBodyItem /// /// 4 /// - [JsonPropertyName("pages")] - [JsonRequired] + [JsonPropertyName("pages"), JsonRequired, JsonPropertyOrder(4)] public required int Pages { get; set; } /// @@ -383,8 +378,7 @@ public class ListLabelsResponseBodyItem /// /// 2750 /// - [JsonPropertyName("total")] - [JsonRequired] + [JsonPropertyName("total"), JsonRequired, JsonPropertyOrder(5)] public required int Total { get; set; } diff --git a/ShipEngineSDK/Model/ListManifestsResponseBody.cs b/ShipEngineSDK/Model/ListManifestsResponseBody.cs index 12dc94ee..0b07315f 100644 --- a/ShipEngineSDK/Model/ListManifestsResponseBody.cs +++ b/ShipEngineSDK/Model/ListManifestsResponseBody.cs @@ -32,17 +32,15 @@ public partial class ListManifestsResponseBody /// Helpful links to other pages of results /// /// Helpful links to other pages of results - [JsonPropertyName("links")] - [JsonRequired] - public required PaginationLink Links { get; set; } + [JsonPropertyName("links"), JsonInclude] + public PaginationLink? Links { get; private set; } /// /// The list of available manifests /// /// The list of available manifests - [JsonPropertyName("manifests")] - [JsonRequired] - public required List Manifests { get; set; } + [JsonPropertyName("manifests"), JsonInclude] + public List? Manifests { get; private set; } /// /// Current page of the list manifests results @@ -51,9 +49,8 @@ public partial class ListManifestsResponseBody /// /// 3 /// - [JsonPropertyName("page")] - [JsonRequired] - public required int Page { get; set; } + [JsonPropertyName("page"), JsonInclude] + public int? Page { get; private set; } /// /// Total number of pages for list manifests results @@ -62,9 +59,8 @@ public partial class ListManifestsResponseBody /// /// 4 /// - [JsonPropertyName("pages")] - [JsonRequired] - public required int Pages { get; set; } + [JsonPropertyName("pages"), JsonInclude] + public int? Pages { get; private set; } /// /// The total number of manifests returned @@ -73,9 +69,8 @@ public partial class ListManifestsResponseBody /// /// 3 /// - [JsonPropertyName("total")] - [JsonRequired] - public required long Total { get; set; } + [JsonPropertyName("total"), JsonInclude] + public long? Total { get; private set; } /// diff --git a/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs b/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs index 500f2d46..f0ba7b8b 100644 --- a/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs +++ b/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs @@ -32,8 +32,8 @@ public partial class ListPackageTypesResponseBody /// An array of custom package types /// /// An array of custom package types - [JsonPropertyName("packages")] - public List? Packages { get; set; } + [JsonPropertyName("packages"), JsonInclude] + public List? Packages { get; private set; } /// diff --git a/ShipEngineSDK/Model/ListPickupResponseBody.cs b/ShipEngineSDK/Model/ListPickupResponseBody.cs index ee25122f..5abc367f 100644 --- a/ShipEngineSDK/Model/ListPickupResponseBody.cs +++ b/ShipEngineSDK/Model/ListPickupResponseBody.cs @@ -32,9 +32,8 @@ public partial class ListPickupResponseBody /// Helpful links to other pages of results /// /// Helpful links to other pages of results - [JsonPropertyName("links")] - [JsonRequired] - public required PaginationLink Links { get; set; } + [JsonPropertyName("links"), JsonInclude] + public PaginationLink? Links { get; private set; } /// /// Current page of the list pickups results @@ -43,9 +42,8 @@ public partial class ListPickupResponseBody /// /// 3 /// - [JsonPropertyName("page")] - [JsonRequired] - public required int Page { get; set; } + [JsonPropertyName("page"), JsonInclude] + public int? Page { get; private set; } /// /// Total number of pages for list pickups results @@ -54,16 +52,14 @@ public partial class ListPickupResponseBody /// /// 4 /// - [JsonPropertyName("pages")] - [JsonRequired] - public required int Pages { get; set; } + [JsonPropertyName("pages"), JsonInclude] + public int? Pages { get; private set; } /// /// An array of pickups associated with the user's account. /// /// An array of pickups associated with the user's account. - [JsonPropertyName("pickups")] - [JsonRequired] + [JsonPropertyName("pickups"), JsonRequired, JsonPropertyOrder(4)] public required List Pickups { get; set; } /// @@ -73,9 +69,8 @@ public partial class ListPickupResponseBody /// /// 3 /// - [JsonPropertyName("total")] - [JsonRequired] - public required long Total { get; set; } + [JsonPropertyName("total"), JsonInclude] + public long? Total { get; private set; } /// diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBody.cs b/ShipEngineSDK/Model/ListServicePointsResponseBody.cs index 5436d416..4c70af02 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBody.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBody.cs @@ -32,8 +32,8 @@ public partial class ListServicePointsResponseBody /// The errors associated with the failed API call /// /// The errors associated with the failed API call - [JsonPropertyName("errors")] - public List? Errors { get; set; } + [JsonPropertyName("errors"), JsonInclude] + public List? Errors { get; private set; } /// /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html @@ -42,7 +42,7 @@ public partial class ListServicePointsResponseBody /// /// 48.842608 /// - [JsonPropertyName("lat")] + [JsonPropertyName("lat"), JsonPropertyOrder(2)] public double? Lat { get; set; } /// @@ -52,13 +52,13 @@ public partial class ListServicePointsResponseBody /// /// 0.032875 /// - [JsonPropertyName("long")] + [JsonPropertyName("long"), JsonPropertyOrder(3)] public double? Long { get; set; } /// /// Gets or Sets ServicePoints /// - [JsonPropertyName("service_points")] + [JsonPropertyName("service_points"), JsonPropertyOrder(4)] public List? ServicePoints { get; set; } diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs index f6f0b8d1..c5496278 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs @@ -166,11 +166,12 @@ public override bool CanConvert(Type typeToConvert) => /// - /// Service point type CLOVUS + /// Service point type /// /// Service point type - [JsonPropertyName("type")] + [JsonPropertyName("type"), JsonPropertyOrder(16)] public TypeEnum? Type { get; set; } + /// /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. /// @@ -178,7 +179,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// PLACE DU CANADA /// - [JsonPropertyName("address_line1")] + [JsonPropertyName("address_line1"), JsonPropertyOrder(1)] public string? AddressLine1 { get; set; } /// @@ -188,7 +189,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// dhl_express /// - [JsonPropertyName("carrier_code")] + [JsonPropertyName("carrier_code"), JsonPropertyOrder(2)] public string? CarrierCode { get; set; } /// @@ -198,7 +199,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// TRUN /// - [JsonPropertyName("city_locality")] + [JsonPropertyName("city_locality"), JsonPropertyOrder(3)] public string? CityLocality { get; set; } /// @@ -208,7 +209,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// My fancy company name /// - [JsonPropertyName("company_name")] + [JsonPropertyName("company_name"), JsonPropertyOrder(4)] public string? CompanyName { get; set; } /// @@ -218,7 +219,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// CA /// - [JsonPropertyName("country_code")] + [JsonPropertyName("country_code"), JsonPropertyOrder(5)] public string? CountryCode { get; set; } /// @@ -228,20 +229,20 @@ public override bool CanConvert(Type typeToConvert) => /// /// 728.9959308847579 /// - [JsonPropertyName("distance_in_meters")] + [JsonPropertyName("distance_in_meters"), JsonPropertyOrder(6)] public double? DistanceInMeters { get; set; } /// /// Service features /// /// Service features - [JsonPropertyName("features")] + [JsonPropertyName("features"), JsonPropertyOrder(7)] public List? Features { get; set; } /// /// Gets or Sets HoursOfOperation /// - [JsonPropertyName("hours_of_operation")] + [JsonPropertyName("hours_of_operation"), JsonPropertyOrder(8)] public ListServicePointsResponseBodyServicePointsInnerHoursOfOperation? HoursOfOperation { get; set; } /// @@ -251,7 +252,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// 48.842608 /// - [JsonPropertyName("lat")] + [JsonPropertyName("lat"), JsonPropertyOrder(9)] public double? Lat { get; set; } /// @@ -261,7 +262,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// 0.032875 /// - [JsonPropertyName("long")] + [JsonPropertyName("long"), JsonPropertyOrder(10)] public double? Long { get; set; } /// @@ -271,7 +272,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// 555-555-5555 /// - [JsonPropertyName("phone_number")] + [JsonPropertyName("phone_number"), JsonPropertyOrder(11)] public string? PhoneNumber { get; set; } /// @@ -281,13 +282,13 @@ public override bool CanConvert(Type typeToConvert) => /// /// 78756-3717 /// - [JsonPropertyName("postal_code")] + [JsonPropertyName("postal_code"), JsonPropertyOrder(12)] public string? PostalCode { get; set; } /// /// Gets or Sets ServiceCodes /// - [JsonPropertyName("service_codes")] + [JsonPropertyName("service_codes"), JsonPropertyOrder(13)] public List? ServiceCodes { get; set; } /// @@ -297,7 +298,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// 614940 /// - [JsonPropertyName("service_point_id")] + [JsonPropertyName("service_point_id"), JsonPropertyOrder(14)] public string? ServicePointId { get; set; } /// @@ -307,7 +308,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// TRUN /// - [JsonPropertyName("state_province")] + [JsonPropertyName("state_province"), JsonPropertyOrder(15)] public string? StateProvince { get; set; } diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs index 35b9e37b..64d5d90c 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs @@ -31,43 +31,43 @@ public partial class ListServicePointsResponseBodyServicePointsInnerHoursOfOpera /// /// Gets or Sets Friday /// - [JsonPropertyName("friday")] + [JsonPropertyName("friday"), JsonPropertyOrder(1)] public List? Friday { get; set; } /// /// Gets or Sets Monday /// - [JsonPropertyName("monday")] + [JsonPropertyName("monday"), JsonPropertyOrder(2)] public List? Monday { get; set; } /// /// Gets or Sets Saturday /// - [JsonPropertyName("saturday")] + [JsonPropertyName("saturday"), JsonPropertyOrder(3)] public List? Saturday { get; set; } /// /// Gets or Sets Sunday /// - [JsonPropertyName("sunday")] + [JsonPropertyName("sunday"), JsonPropertyOrder(4)] public List? Sunday { get; set; } /// /// Gets or Sets Thursday /// - [JsonPropertyName("thursday")] + [JsonPropertyName("thursday"), JsonPropertyOrder(5)] public List? Thursday { get; set; } /// /// Gets or Sets Tuesday /// - [JsonPropertyName("tuesday")] + [JsonPropertyName("tuesday"), JsonPropertyOrder(6)] public List? Tuesday { get; set; } /// /// Gets or Sets Wednesday /// - [JsonPropertyName("wednesday")] + [JsonPropertyName("wednesday"), JsonPropertyOrder(7)] public List? Wednesday { get; set; } diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs index d010d589..ee44adc8 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs @@ -35,7 +35,7 @@ public partial class ListServicePointsResponseBodyServicePointsInnerHoursOfOpera /// /// 12:00 /// - [JsonPropertyName("close")] + [JsonPropertyName("close"), JsonPropertyOrder(1)] public string? Close { get; set; } /// @@ -45,7 +45,7 @@ public partial class ListServicePointsResponseBodyServicePointsInnerHoursOfOpera /// /// 09:15 /// - [JsonPropertyName("open")] + [JsonPropertyName("open"), JsonPropertyOrder(2)] public string? Open { get; set; } diff --git a/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs b/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs index 3c1a7793..7b723f6f 100644 --- a/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs +++ b/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs @@ -29,12 +29,10 @@ public partial class ListShipmentRatesResponseBody { /// - /// Gets or Sets Status CLOVUS + /// Gets or Sets Status /// - [JsonPropertyName("status")] - [JsonRequired] - public required RateResponseStatus Status { get; set; } = new(); - + [JsonPropertyName("status"), JsonInclude] + public RateResponseStatus? Status { get; private set; } /// /// When the rate was created @@ -43,24 +41,21 @@ public partial class ListShipmentRatesResponseBody /// /// se-28529731 /// - [JsonPropertyName("created_at")] - [JsonRequired] + [JsonPropertyName("created_at"), JsonRequired, JsonPropertyOrder(1)] public required string CreatedAt { get; set; } /// /// Gets or Sets Errors /// - [JsonPropertyName("errors")] - [JsonRequired] + [JsonPropertyName("errors"), JsonRequired, JsonPropertyOrder(2)] public required List Errors { get; set; } /// /// An array of invalid shipment rates /// /// An array of invalid shipment rates - [JsonPropertyName("invalid_rates")] - [JsonRequired] - public required List InvalidRates { get; set; } + [JsonPropertyName("invalid_rates"), JsonInclude] + public List? InvalidRates { get; private set; } /// /// A string that uniquely identifies the rate request @@ -69,17 +64,15 @@ public partial class ListShipmentRatesResponseBody /// /// se-28529731 /// - [JsonPropertyName("rate_request_id")] - [JsonRequired] - public required string RateRequestId { get; set; } + [JsonPropertyName("rate_request_id"), JsonInclude] + public string? RateRequestId { get; private set; } /// /// An array of shipment rates /// /// An array of shipment rates - [JsonPropertyName("rates")] - [JsonRequired] - public required List Rates { get; set; } + [JsonPropertyName("rates"), JsonInclude] + public List? Rates { get; private set; } /// /// A string that uniquely identifies the shipment @@ -88,9 +81,8 @@ public partial class ListShipmentRatesResponseBody /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - [JsonRequired] - public required string ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private set; } /// diff --git a/ShipEngineSDK/Model/ListShipmentsResponseBody.cs b/ShipEngineSDK/Model/ListShipmentsResponseBody.cs index 3102024f..4f35dc48 100644 --- a/ShipEngineSDK/Model/ListShipmentsResponseBody.cs +++ b/ShipEngineSDK/Model/ListShipmentsResponseBody.cs @@ -31,31 +31,27 @@ public partial class ListShipmentsResponseBody /// /// Gets or Sets Links /// - [JsonPropertyName("links")] - [JsonRequired] - public required PaginationLink Links { get; set; } + [JsonPropertyName("links"), JsonInclude] + public PaginationLink? Links { get; private set; } /// /// Gets or Sets Page /// - [JsonPropertyName("page")] - [JsonRequired] - public required int Page { get; set; } + [JsonPropertyName("page"), JsonInclude] + public int? Page { get; private set; } /// /// Gets or Sets Pages /// - [JsonPropertyName("pages")] - [JsonRequired] - public required int Pages { get; set; } + [JsonPropertyName("pages"), JsonInclude] + public int? Pages { get; private set; } /// /// The list of shipments returned by the api call /// /// The list of shipments returned by the api call - [JsonPropertyName("shipments")] - [JsonRequired] - public required List Shipments { get; set; } + [JsonPropertyName("shipments"), JsonInclude] + public List? Shipments { get; private set; } /// /// Total number of shipments returned by the api call @@ -64,9 +60,8 @@ public partial class ListShipmentsResponseBody /// /// 1990 /// - [JsonPropertyName("total")] - [JsonRequired] - public required long Total { get; set; } + [JsonPropertyName("total"), JsonInclude] + public long? Total { get; private set; } /// diff --git a/ShipEngineSDK/Model/ListTagsResponseBody.cs b/ShipEngineSDK/Model/ListTagsResponseBody.cs index 0057d51e..298cc80e 100644 --- a/ShipEngineSDK/Model/ListTagsResponseBody.cs +++ b/ShipEngineSDK/Model/ListTagsResponseBody.cs @@ -32,7 +32,7 @@ public partial class ListTagsResponseBody /// The array of tags returned by the API call /// /// The array of tags returned by the API call - [JsonPropertyName("tags")] + [JsonPropertyName("tags"), JsonPropertyOrder(1)] public List? Tags { get; set; } diff --git a/ShipEngineSDK/Model/ListWarehousesResponseBody.cs b/ShipEngineSDK/Model/ListWarehousesResponseBody.cs index 773176a9..95cd2d4e 100644 --- a/ShipEngineSDK/Model/ListWarehousesResponseBody.cs +++ b/ShipEngineSDK/Model/ListWarehousesResponseBody.cs @@ -32,9 +32,8 @@ public partial class ListWarehousesResponseBody /// The array of warehouses returned by the API call /// /// The array of warehouses returned by the API call - [JsonPropertyName("warehouses")] - [JsonRequired] - public required List Warehouses { get; set; } + [JsonPropertyName("warehouses"), JsonInclude] + public List? Warehouses { get; private set; } /// diff --git a/ShipEngineSDK/Model/Manifest.cs b/ShipEngineSDK/Model/Manifest.cs index de145fd1..037e7d7e 100644 --- a/ShipEngineSDK/Model/Manifest.cs +++ b/ShipEngineSDK/Model/Manifest.cs @@ -35,8 +35,8 @@ public partial class Manifest /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - public string? CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// The date-time that the manifest was created @@ -45,8 +45,8 @@ public partial class Manifest /// /// 2019-07-12T13:37:39.050Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// A string that uniquely identifies the form @@ -55,21 +55,21 @@ public partial class Manifest /// /// se-28529731 /// - [JsonPropertyName("form_id")] - public string? FormId { get; set; } + [JsonPropertyName("form_id"), JsonInclude] + public string? FormId { get; private set; } /// /// An array of the label ids used in this manifest. /// /// An array of the label ids used in this manifest. - [JsonPropertyName("label_ids")] - public List? LabelIds { get; set; } + [JsonPropertyName("label_ids"), JsonInclude] + public List? LabelIds { get; private set; } /// /// Gets or Sets ManifestDownload /// - [JsonPropertyName("manifest_download")] - public ManifestDownload? ManifestDownload { get; set; } + [JsonPropertyName("manifest_download"), JsonInclude] + public ManifestDownload? ManifestDownload { get; private set; } /// /// A string that uniquely identifies the manifest @@ -78,8 +78,8 @@ public partial class Manifest /// /// se-28529731 /// - [JsonPropertyName("manifest_id")] - public string? ManifestId { get; set; } + [JsonPropertyName("manifest_id"), JsonInclude] + public string? ManifestId { get; private set; } /// /// The date-time that the manifests shipments will be picked up @@ -88,8 +88,8 @@ public partial class Manifest /// /// 2019-07-12T13:37:39.050Z /// - [JsonPropertyName("ship_date")] - public DateTimeOffset? ShipDate { get; set; } + [JsonPropertyName("ship_date"), JsonInclude] + public DateTimeOffset? ShipDate { get; private set; } /// /// The number of shipments that are included in this manifest @@ -98,8 +98,8 @@ public partial class Manifest /// /// 100 /// - [JsonPropertyName("shipments")] - public int? Shipments { get; set; } + [JsonPropertyName("shipments"), JsonInclude] + public int? Shipments { get; private set; } /// /// A string that uniquely identifies the submission @@ -108,8 +108,8 @@ public partial class Manifest /// /// 9475711899564878915476 /// - [JsonPropertyName("submission_id")] - public string? SubmissionId { get; set; } + [JsonPropertyName("submission_id"), JsonInclude] + public string? SubmissionId { get; private set; } /// /// A string that uniquely identifies the warehouse @@ -118,8 +118,8 @@ public partial class Manifest /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] - public string? WarehouseId { get; set; } + [JsonPropertyName("warehouse_id"), JsonInclude] + public string? WarehouseId { get; private set; } /// diff --git a/ShipEngineSDK/Model/ManifestDownload.cs b/ShipEngineSDK/Model/ManifestDownload.cs index a816af8e..ee9f6c9b 100644 --- a/ShipEngineSDK/Model/ManifestDownload.cs +++ b/ShipEngineSDK/Model/ManifestDownload.cs @@ -35,7 +35,7 @@ public partial class ManifestDownload /// /// http://api.shipengine.com/v1/labels/se-28529731 /// - [JsonPropertyName("href")] + [JsonPropertyName("href"), JsonPropertyOrder(1)] public string? Href { get; set; } diff --git a/ShipEngineSDK/Model/ManifestRequest.cs b/ShipEngineSDK/Model/ManifestRequest.cs index 7739a3c5..29ff0675 100644 --- a/ShipEngineSDK/Model/ManifestRequest.cs +++ b/ShipEngineSDK/Model/ManifestRequest.cs @@ -29,10 +29,11 @@ public partial class ManifestRequest { /// - /// Gets or Sets Status CLOVUS + /// Gets or Sets Status /// - [JsonPropertyName("status")] + [JsonPropertyName("status"), JsonPropertyOrder(2)] public ManifestRequestStatus? Status { get; set; } + /// /// A string that uniquely identifies a manifest request /// @@ -40,8 +41,8 @@ public partial class ManifestRequest /// /// se-28529731 /// - [JsonPropertyName("manifest_request_id")] - public string? ManifestRequestId { get; set; } + [JsonPropertyName("manifest_request_id"), JsonInclude] + public string? ManifestRequestId { get; private set; } /// diff --git a/ShipEngineSDK/Model/ManifestRequestStatus.cs b/ShipEngineSDK/Model/ManifestRequestStatus.cs index 57401bd0..cb5516ec 100644 --- a/ShipEngineSDK/Model/ManifestRequestStatus.cs +++ b/ShipEngineSDK/Model/ManifestRequestStatus.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(ManifestRequestStatusJsonConverter))] public class ManifestRequestStatus { - private string _value; + private readonly string _value; /// /// Create a new instance of ManifestRequestStatus with a predefined value. @@ -68,6 +68,12 @@ public ManifestRequestStatus(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is ManifestRequestStatus other && _value == other._value; } internal class ManifestRequestStatusJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/Manifests.cs b/ShipEngineSDK/Model/Manifests.cs index b284052e..08a947be 100644 --- a/ShipEngineSDK/Model/Manifests.cs +++ b/ShipEngineSDK/Model/Manifests.cs @@ -32,7 +32,7 @@ public partial class Manifests /// Resulting Manifests /// /// Resulting Manifests - [JsonPropertyName("manifests")] + [JsonPropertyName("manifests"), JsonPropertyOrder(1)] public List? VarManifests { get; set; } diff --git a/ShipEngineSDK/Model/ManifestsRequests.cs b/ShipEngineSDK/Model/ManifestsRequests.cs index 33551ae7..5f62f111 100644 --- a/ShipEngineSDK/Model/ManifestsRequests.cs +++ b/ShipEngineSDK/Model/ManifestsRequests.cs @@ -32,7 +32,7 @@ public partial class ManifestsRequests /// Resulting manifest requests with statuses /// /// Resulting manifest requests with statuses - [JsonPropertyName("manifest_requests")] + [JsonPropertyName("manifest_requests"), JsonPropertyOrder(1)] public List? ManifestRequests { get; set; } diff --git a/ShipEngineSDK/Model/ModifyBatch.cs b/ShipEngineSDK/Model/ModifyBatch.cs index aeffeddb..90c5b92e 100644 --- a/ShipEngineSDK/Model/ModifyBatch.cs +++ b/ShipEngineSDK/Model/ModifyBatch.cs @@ -32,14 +32,14 @@ public partial class ModifyBatch /// Array of Rate IDs to be modifed on the batch /// /// Array of Rate IDs to be modifed on the batch - [JsonPropertyName("rate_ids")] + [JsonPropertyName("rate_ids"), JsonPropertyOrder(1)] public List? RateIds { get; set; } /// /// The Shipment Ids to be modified on the batch /// /// The Shipment Ids to be modified on the batch - [JsonPropertyName("shipment_ids")] + [JsonPropertyName("shipment_ids"), JsonPropertyOrder(2)] public List? ShipmentIds { get; set; } diff --git a/ShipEngineSDK/Model/MonetaryValue.cs b/ShipEngineSDK/Model/MonetaryValue.cs index c3db1332..dd5f5f42 100644 --- a/ShipEngineSDK/Model/MonetaryValue.cs +++ b/ShipEngineSDK/Model/MonetaryValue.cs @@ -32,16 +32,14 @@ public partial class MonetaryValue /// The monetary amount, in the specified currency. /// /// The monetary amount, in the specified currency. - [JsonPropertyName("amount")] - [JsonRequired] + [JsonPropertyName("amount"), JsonRequired, JsonPropertyOrder(1)] public required double Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("currency")] - [JsonRequired] + [JsonPropertyName("currency"), JsonRequired, JsonPropertyOrder(2)] public required string Currency { get; set; } diff --git a/ShipEngineSDK/Model/NonDelivery.cs b/ShipEngineSDK/Model/NonDelivery.cs index ae9e5ad4..7b3eb3cd 100644 --- a/ShipEngineSDK/Model/NonDelivery.cs +++ b/ShipEngineSDK/Model/NonDelivery.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(NonDeliveryJsonConverter))] public class NonDelivery { - private string _value; + private readonly string _value; /// /// Create a new instance of NonDelivery with a predefined value. @@ -68,6 +68,12 @@ public NonDelivery(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is NonDelivery other && _value == other._value; } internal class NonDeliveryJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/OptionalLink.cs b/ShipEngineSDK/Model/OptionalLink.cs index f67ae5ba..4d83bf5b 100644 --- a/ShipEngineSDK/Model/OptionalLink.cs +++ b/ShipEngineSDK/Model/OptionalLink.cs @@ -35,14 +35,14 @@ public partial class OptionalLink /// /// http://api.shipengine.com/v1/labels/se-28529731 /// - [JsonPropertyName("href")] + [JsonPropertyName("href"), JsonPropertyOrder(1)] public string? Href { get; set; } /// /// The type of resource, or the type of relationship to the parent resource /// /// The type of resource, or the type of relationship to the parent resource - [JsonPropertyName("type")] + [JsonPropertyName("type"), JsonPropertyOrder(2)] public string? Type { get; set; } diff --git a/ShipEngineSDK/Model/OrderSourceName.cs b/ShipEngineSDK/Model/OrderSourceName.cs index c0c75f72..1b6c3b0d 100644 --- a/ShipEngineSDK/Model/OrderSourceName.cs +++ b/ShipEngineSDK/Model/OrderSourceName.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(OrderSourceNameJsonConverter))] public class OrderSourceName { - private string _value; + private readonly string _value; /// /// Create a new instance of OrderSourceName with a predefined value. @@ -176,6 +176,12 @@ public OrderSourceName(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is OrderSourceName other && _value == other._value; } internal class OrderSourceNameJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/OriginType.cs b/ShipEngineSDK/Model/OriginType.cs index 927e0c2a..28f526af 100644 --- a/ShipEngineSDK/Model/OriginType.cs +++ b/ShipEngineSDK/Model/OriginType.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(OriginTypeJsonConverter))] public class OriginType { - private string _value; + private readonly string _value; /// /// Create a new instance of OriginType with a predefined value. @@ -68,6 +68,12 @@ public OriginType(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is OriginType other && _value == other._value; } internal class OriginTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/Package.cs b/ShipEngineSDK/Model/Package.cs index 392188b9..b1cbf48e 100644 --- a/ShipEngineSDK/Model/Package.cs +++ b/ShipEngineSDK/Model/Package.cs @@ -32,8 +32,7 @@ public partial class Package /// The package weight /// /// The package weight - [JsonPropertyName("weight")] - [JsonRequired] + [JsonPropertyName("weight"), JsonRequired, JsonPropertyOrder(1)] public required Weight Weight { get; set; } /// @@ -43,48 +42,48 @@ public partial class Package /// /// Hand knitted wool socks /// - [JsonPropertyName("content_description")] + [JsonPropertyName("content_description"), JsonPropertyOrder(2)] public string? ContentDescription { get; set; } /// /// The package dimensions /// /// The package dimensions - [JsonPropertyName("dimensions")] + [JsonPropertyName("dimensions"), JsonPropertyOrder(3)] public Dimensions? Dimensions { get; set; } /// /// An external package id. /// /// An external package id. - [JsonPropertyName("external_package_id")] + [JsonPropertyName("external_package_id"), JsonPropertyOrder(4)] public string? ExternalPackageId { get; set; } /// /// The form download for any customs that are needed /// /// The form download for any customs that are needed - [JsonPropertyName("form_download")] - public OptionalLink? FormDownload { get; set; } + [JsonPropertyName("form_download"), JsonInclude] + public OptionalLink? FormDownload { get; private set; } /// /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. /// /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. - [JsonPropertyName("insured_value")] + [JsonPropertyName("insured_value"), JsonPropertyOrder(6)] public MonetaryValue? InsuredValue { get; set; } /// /// The label download for the package /// /// The label download for the package - [JsonPropertyName("label_download")] - public LabelDownload? LabelDownload { get; set; } + [JsonPropertyName("label_download"), JsonInclude] + public LabelDownload? LabelDownload { get; private set; } /// /// Gets or Sets LabelMessages /// - [JsonPropertyName("label_messages")] + [JsonPropertyName("label_messages"), JsonPropertyOrder(8)] public LabelMessages? LabelMessages { get; set; } /// @@ -94,7 +93,7 @@ public partial class Package /// /// small_flat_rate_box /// - [JsonPropertyName("package_code")] + [JsonPropertyName("package_code"), JsonPropertyOrder(9)] public string? PackageCode { get; set; } /// @@ -104,29 +103,29 @@ public partial class Package /// /// se-28529731 /// - [JsonPropertyName("package_id")] + [JsonPropertyName("package_id"), JsonPropertyOrder(10)] public string? PackageId { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - [JsonPropertyName("paperless_download")] - public PaperlessDownload? PaperlessDownload { get; set; } + [JsonPropertyName("paperless_download"), JsonInclude] + public PaperlessDownload? PaperlessDownload { get; private set; } /// /// Details about products inside packages (Information provided would be used on custom documentation) /// /// Details about products inside packages (Information provided would be used on custom documentation) - [JsonPropertyName("products")] + [JsonPropertyName("products"), JsonPropertyOrder(12)] public List? Products { get; set; } /// /// Package sequence /// /// Package sequence - [JsonPropertyName("sequence")] - public int? Sequence { get; set; } + [JsonPropertyName("sequence"), JsonInclude] + public int? Sequence { get; private set; } /// /// The tracking number for the package. The format depends on the carrier. @@ -135,8 +134,8 @@ public partial class Package /// /// 1Z932R800392060079 /// - [JsonPropertyName("tracking_number")] - public string? TrackingNumber { get; set; } + [JsonPropertyName("tracking_number"), JsonInclude] + public string? TrackingNumber { get; private set; } /// diff --git a/ShipEngineSDK/Model/PackageContents.cs b/ShipEngineSDK/Model/PackageContents.cs index 9be7aa4c..c60226ad 100644 --- a/ShipEngineSDK/Model/PackageContents.cs +++ b/ShipEngineSDK/Model/PackageContents.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(PackageContentsJsonConverter))] public class PackageContents { - private string _value; + private readonly string _value; /// /// Create a new instance of PackageContents with a predefined value. @@ -92,6 +92,12 @@ public PackageContents(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is PackageContents other && _value == other._value; } internal class PackageContentsJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/PackageType.cs b/ShipEngineSDK/Model/PackageType.cs index facef2b2..12897308 100644 --- a/ShipEngineSDK/Model/PackageType.cs +++ b/ShipEngineSDK/Model/PackageType.cs @@ -34,8 +34,7 @@ public partial class PackageType /// /// laptop_box /// - [JsonPropertyName("name")] - [JsonRequired] + [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(1)] public required string Name { get; set; } /// @@ -45,8 +44,7 @@ public partial class PackageType /// /// small_flat_rate_box /// - [JsonPropertyName("package_code")] - [JsonRequired] + [JsonPropertyName("package_code"), JsonRequired, JsonPropertyOrder(2)] public required string PackageCode { get; set; } /// @@ -56,14 +54,14 @@ public partial class PackageType /// /// Packaging for laptops /// - [JsonPropertyName("description")] + [JsonPropertyName("description"), JsonPropertyOrder(3)] public string? Description { get; set; } /// /// The custom dimensions for the package. /// /// The custom dimensions for the package. - [JsonPropertyName("dimensions")] + [JsonPropertyName("dimensions"), JsonPropertyOrder(4)] public Dimensions? Dimensions { get; set; } /// @@ -73,7 +71,7 @@ public partial class PackageType /// /// se-28529731 /// - [JsonPropertyName("package_id")] + [JsonPropertyName("package_id"), JsonPropertyOrder(5)] public string? PackageId { get; set; } diff --git a/ShipEngineSDK/Model/PackagingGroup.cs b/ShipEngineSDK/Model/PackagingGroup.cs index 3aca99c5..c5d441d9 100644 --- a/ShipEngineSDK/Model/PackagingGroup.cs +++ b/ShipEngineSDK/Model/PackagingGroup.cs @@ -28,7 +28,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(PackagingGroupJsonConverter))] public class PackagingGroup { - private string _value; + private readonly string _value; /// /// Create a new instance of PackagingGroup with a predefined value. @@ -73,6 +73,12 @@ public PackagingGroup(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is PackagingGroup other && _value == other._value; } internal class PackagingGroupJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/PackagingInstructionSection.cs b/ShipEngineSDK/Model/PackagingInstructionSection.cs index a56d1260..deae3798 100644 --- a/ShipEngineSDK/Model/PackagingInstructionSection.cs +++ b/ShipEngineSDK/Model/PackagingInstructionSection.cs @@ -28,7 +28,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(PackagingInstructionSectionJsonConverter))] public class PackagingInstructionSection { - private string _value; + private readonly string _value; /// /// Create a new instance of PackagingInstructionSection with a predefined value. @@ -79,6 +79,12 @@ public PackagingInstructionSection(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is PackagingInstructionSection other && _value == other._value; } internal class PackagingInstructionSectionJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/PagedListResponseBody.cs b/ShipEngineSDK/Model/PagedListResponseBody.cs index 8c2ec0fb..a3359a19 100644 --- a/ShipEngineSDK/Model/PagedListResponseBody.cs +++ b/ShipEngineSDK/Model/PagedListResponseBody.cs @@ -31,8 +31,7 @@ public partial class PagedListResponseBody /// /// Gets or Sets Links /// - [JsonPropertyName("links")] - [JsonRequired] + [JsonPropertyName("links"), JsonRequired, JsonPropertyOrder(1)] public required PaginationLink Links { get; set; } /// @@ -42,8 +41,7 @@ public partial class PagedListResponseBody /// /// 1 /// - [JsonPropertyName("page")] - [JsonRequired] + [JsonPropertyName("page"), JsonRequired, JsonPropertyOrder(2)] public required int Page { get; set; } /// @@ -53,8 +51,7 @@ public partial class PagedListResponseBody /// /// 4 /// - [JsonPropertyName("pages")] - [JsonRequired] + [JsonPropertyName("pages"), JsonRequired, JsonPropertyOrder(3)] public required int Pages { get; set; } /// @@ -64,8 +61,7 @@ public partial class PagedListResponseBody /// /// 2750 /// - [JsonPropertyName("total")] - [JsonRequired] + [JsonPropertyName("total"), JsonRequired, JsonPropertyOrder(4)] public required int Total { get; set; } /// diff --git a/ShipEngineSDK/Model/PaginationLink.cs b/ShipEngineSDK/Model/PaginationLink.cs index e5f5f1e7..481902f7 100644 --- a/ShipEngineSDK/Model/PaginationLink.cs +++ b/ShipEngineSDK/Model/PaginationLink.cs @@ -32,32 +32,28 @@ public partial class PaginationLink /// The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items. /// /// The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items. - [JsonPropertyName("first")] - [JsonRequired] + [JsonPropertyName("first"), JsonRequired, JsonPropertyOrder(1)] public required Link First { get; set; } /// /// The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items. /// /// The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items. - [JsonPropertyName("last")] - [JsonRequired] + [JsonPropertyName("last"), JsonRequired, JsonPropertyOrder(2)] public required Link Last { get; set; } /// /// The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`. /// /// The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`. - [JsonPropertyName("next")] - [JsonRequired] + [JsonPropertyName("next"), JsonRequired, JsonPropertyOrder(3)] public required OptionalLink Next { get; set; } /// /// The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater. /// /// The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater. - [JsonPropertyName("prev")] - [JsonRequired] + [JsonPropertyName("prev"), JsonRequired, JsonPropertyOrder(4)] public required OptionalLink Prev { get; set; } diff --git a/ShipEngineSDK/Model/PaperlessDownload.cs b/ShipEngineSDK/Model/PaperlessDownload.cs index 680e3dae..7a26c980 100644 --- a/ShipEngineSDK/Model/PaperlessDownload.cs +++ b/ShipEngineSDK/Model/PaperlessDownload.cs @@ -32,7 +32,7 @@ public partial class PaperlessDownload /// The handoff code for the paperless download. /// /// The handoff code for the paperless download. - [JsonPropertyName("handoff_code")] + [JsonPropertyName("handoff_code"), JsonPropertyOrder(1)] public string? HandoffCode { get; set; } /// @@ -42,14 +42,14 @@ public partial class PaperlessDownload /// /// http://api.shipengine.com/v1/labels/se-28529731 /// - [JsonPropertyName("href")] + [JsonPropertyName("href"), JsonPropertyOrder(2)] public string? Href { get; set; } /// /// The instructions for the paperless download. /// /// The instructions for the paperless download. - [JsonPropertyName("instructions")] + [JsonPropertyName("instructions"), JsonPropertyOrder(3)] public string? Instructions { get; set; } diff --git a/ShipEngineSDK/Model/ParseAddressRequestBody.cs b/ShipEngineSDK/Model/ParseAddressRequestBody.cs index 02324685..b4a74fc7 100644 --- a/ShipEngineSDK/Model/ParseAddressRequestBody.cs +++ b/ShipEngineSDK/Model/ParseAddressRequestBody.cs @@ -35,15 +35,14 @@ public partial class ParseAddressRequestBody /// /// Margie McMiller at 3800 North Lamar suite 200 in austin, tx. The zip code there is 78652. /// - [JsonPropertyName("text")] - [JsonRequired] + [JsonPropertyName("text"), JsonRequired, JsonPropertyOrder(1)] public required string Text { get; set; } /// /// You can optionally provide any already-known address 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. /// /// You can optionally provide any already-known address 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. - [JsonPropertyName("address")] + [JsonPropertyName("address"), JsonPropertyOrder(2)] public PartialAddress? Address { get; set; } diff --git a/ShipEngineSDK/Model/ParseAddressResponseBody.cs b/ShipEngineSDK/Model/ParseAddressResponseBody.cs index 61af77e4..268c163a 100644 --- a/ShipEngineSDK/Model/ParseAddressResponseBody.cs +++ b/ShipEngineSDK/Model/ParseAddressResponseBody.cs @@ -32,24 +32,21 @@ public partial class ParseAddressResponseBody /// The parsed address. This address may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The address-recognition API does not currently perform any validation of the parsed address, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the address is correct. /// /// The parsed address. This address may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The address-recognition API does not currently perform any validation of the parsed address, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the address is correct. - [JsonPropertyName("address")] - [JsonRequired] + [JsonPropertyName("address"), JsonRequired, JsonPropertyOrder(1)] public required PartialAddress Address { get; set; } /// /// All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, or an address line. Each entity includes the original text and the parsed value. /// /// All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, or an address line. Each entity includes the original text and the parsed value. - [JsonPropertyName("entities")] - [JsonRequired] + [JsonPropertyName("entities"), JsonRequired, JsonPropertyOrder(2)] public required List Entities { get; set; } /// /// A confidence score between zero and one that indicates how certain the API is that it understood the text. /// /// A confidence score between zero and one that indicates how certain the API is that it understood the text. - [JsonPropertyName("score")] - [JsonRequired] + [JsonPropertyName("score"), JsonRequired, JsonPropertyOrder(3)] public required double Score { get; set; } diff --git a/ShipEngineSDK/Model/ParseShipmentRequestBody.cs b/ShipEngineSDK/Model/ParseShipmentRequestBody.cs index 03a00f63..a69b503a 100644 --- a/ShipEngineSDK/Model/ParseShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/ParseShipmentRequestBody.cs @@ -36,15 +36,14 @@ public partial class ParseShipmentRequestBody /// I have a 4oz package that's 5x10x14in, and I need to ship it to Margie McMiller at 3800 North Lamar suite 200 in austin, tx 78652. Please send it via USPS first class and require an adult signature. It also needs to be insured for $400. /// - [JsonPropertyName("text")] - [JsonRequired] + [JsonPropertyName("text"), JsonRequired, JsonPropertyOrder(1)] public required string Text { get; set; } /// /// You can optionally provide a `shipment` object 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. /// /// You can optionally provide a `shipment` object 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. - [JsonPropertyName("shipment")] + [JsonPropertyName("shipment"), JsonPropertyOrder(2)] public PartialShipment? Shipment { get; set; } diff --git a/ShipEngineSDK/Model/ParseShipmentResponseBody.cs b/ShipEngineSDK/Model/ParseShipmentResponseBody.cs index 765a212a..2caa127a 100644 --- a/ShipEngineSDK/Model/ParseShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/ParseShipmentResponseBody.cs @@ -32,24 +32,21 @@ public partial class ParseShipmentResponseBody /// All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, a carrier name, or a package weight. Each entity includes the original text and the parsed value. /// /// All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, a carrier name, or a package weight. Each entity includes the original text and the parsed value. - [JsonPropertyName("entities")] - [JsonRequired] + [JsonPropertyName("entities"), JsonRequired, JsonPropertyOrder(1)] public required List Entities { get; set; } /// /// A confidence score between zero and one that indicates how certain the API is that it understood the text. /// /// A confidence score between zero and one that indicates how certain the API is that it understood the text. - [JsonPropertyName("score")] - [JsonRequired] + [JsonPropertyName("score"), JsonRequired, JsonPropertyOrder(2)] public required double Score { get; set; } /// /// The parsed shipment. This shipment may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The shipment-recognition API does not currently perform any validation of the parsed addresses, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the addresses are correct. /// /// The parsed shipment. This shipment may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The shipment-recognition API does not currently perform any validation of the parsed addresses, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the addresses are correct. - [JsonPropertyName("shipment")] - [JsonRequired] + [JsonPropertyName("shipment"), JsonRequired, JsonPropertyOrder(3)] public required PartialShipment Shipment { get; set; } diff --git a/ShipEngineSDK/Model/PartialAddress.cs b/ShipEngineSDK/Model/PartialAddress.cs index f63a1953..4564c50a 100644 --- a/ShipEngineSDK/Model/PartialAddress.cs +++ b/ShipEngineSDK/Model/PartialAddress.cs @@ -29,11 +29,12 @@ public partial class PartialAddress { /// - /// Indicates whether this is a residential address. CLOVUS + /// Indicates whether this is a residential address. /// /// Indicates whether this is a residential address. - [JsonPropertyName("address_residential_indicator")] + [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(4)] public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } + /// /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. /// @@ -41,7 +42,7 @@ public partial class PartialAddress /// /// 1999 Bishop Grandin Blvd. /// - [JsonPropertyName("address_line1")] + [JsonPropertyName("address_line1"), JsonPropertyOrder(1)] public string? AddressLine1 { get; set; } /// @@ -51,7 +52,7 @@ public partial class PartialAddress /// /// Unit 408 /// - [JsonPropertyName("address_line2")] + [JsonPropertyName("address_line2"), JsonPropertyOrder(2)] public string? AddressLine2 { get; set; } /// @@ -61,7 +62,7 @@ public partial class PartialAddress /// /// Building #7 /// - [JsonPropertyName("address_line3")] + [JsonPropertyName("address_line3"), JsonPropertyOrder(3)] public string? AddressLine3 { get; set; } /// @@ -71,7 +72,7 @@ public partial class PartialAddress /// /// Winnipeg /// - [JsonPropertyName("city_locality")] + [JsonPropertyName("city_locality"), JsonPropertyOrder(5)] public string? CityLocality { get; set; } /// @@ -81,7 +82,7 @@ public partial class PartialAddress /// /// The Home Depot /// - [JsonPropertyName("company_name")] + [JsonPropertyName("company_name"), JsonPropertyOrder(6)] public string? CompanyName { get; set; } /// @@ -91,7 +92,7 @@ public partial class PartialAddress /// /// CA /// - [JsonPropertyName("country_code")] + [JsonPropertyName("country_code"), JsonPropertyOrder(7)] public string? CountryCode { get; set; } /// @@ -101,7 +102,7 @@ public partial class PartialAddress /// /// example@example.com /// - [JsonPropertyName("email")] + [JsonPropertyName("email"), JsonPropertyOrder(8)] public string? Email { get; set; } /// @@ -111,7 +112,7 @@ public partial class PartialAddress /// /// John Doe /// - [JsonPropertyName("name")] + [JsonPropertyName("name"), JsonPropertyOrder(9)] public string? Name { get; set; } /// @@ -121,7 +122,7 @@ public partial class PartialAddress /// /// +1 204-253-9411 ext. 123 /// - [JsonPropertyName("phone")] + [JsonPropertyName("phone"), JsonPropertyOrder(10)] public string? Phone { get; set; } /// @@ -131,7 +132,7 @@ public partial class PartialAddress /// /// 78756-3717 /// - [JsonPropertyName("postal_code")] + [JsonPropertyName("postal_code"), JsonPropertyOrder(11)] public string? PostalCode { get; set; } /// @@ -141,7 +142,7 @@ public partial class PartialAddress /// /// Manitoba /// - [JsonPropertyName("state_province")] + [JsonPropertyName("state_province"), JsonPropertyOrder(12)] public string? StateProvince { get; set; } diff --git a/ShipEngineSDK/Model/PartialShipment.cs b/ShipEngineSDK/Model/PartialShipment.cs index 5ff03ffd..2d4af8da 100644 --- a/ShipEngineSDK/Model/PartialShipment.cs +++ b/ShipEngineSDK/Model/PartialShipment.cs @@ -29,33 +29,37 @@ public partial class PartialShipment { /// - /// The type of delivery confirmation that is required for this shipment. CLOVUS + /// The type of delivery confirmation that is required for this shipment. /// /// The type of delivery confirmation that is required for this shipment. - [JsonPropertyName("confirmation")] + [JsonPropertyName("confirmation"), JsonPropertyOrder(4)] public DeliveryConfirmation? Confirmation { get; set; } + /// - /// The insurance provider to use for any insured packages in the shipment. CLOVUS + /// The insurance provider to use for any insured packages in the shipment. /// /// The insurance provider to use for any insured packages in the shipment. - [JsonPropertyName("insurance_provider")] + [JsonPropertyName("insurance_provider"), JsonPropertyOrder(9)] public InsuranceProvider? InsuranceProvider { get; set; } + /// - /// Gets or Sets OrderSourceCode CLOVUS + /// Gets or Sets OrderSourceCode /// - [JsonPropertyName("order_source_code")] + [JsonPropertyName("order_source_code"), JsonPropertyOrder(13)] public OrderSourceName? OrderSourceCode { get; set; } + /// - /// The current status of the shipment CLOVUS + /// The current status of the shipment /// /// The current status of the shipment - [JsonPropertyName("shipment_status")] - public ShipmentStatus? ShipmentStatus { get; set; } + [JsonPropertyName("shipment_status"), JsonInclude] + public ShipmentStatus? ShipmentStatus { get; private set; } + /// /// Advanced shipment options. These are entirely optional. /// /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options")] + [JsonPropertyName("advanced_options"), JsonPropertyOrder(1)] public AdvancedShipmentOptions? AdvancedOptions { get; set; } /// @@ -65,7 +69,7 @@ public partial class PartialShipment /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] + [JsonPropertyName("carrier_id"), JsonPropertyOrder(2)] public string? CarrierId { get; set; } /// @@ -75,7 +79,7 @@ public partial class PartialShipment /// /// retail /// - [JsonPropertyName("comparison_rate_type")] + [JsonPropertyName("comparison_rate_type"), JsonPropertyOrder(3)] public string? ComparisonRateType { get; set; } /// @@ -85,42 +89,42 @@ public partial class PartialShipment /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// Customs information. This is usually only needed for international shipments. /// /// Customs information. This is usually only needed for international shipments. - [JsonPropertyName("customs")] + [JsonPropertyName("customs"), JsonPropertyOrder(6)] public InternationalShipmentOptions? Customs { get; set; } /// /// ID that the Order Source assigned /// /// ID that the Order Source assigned - [JsonPropertyName("external_order_id")] + [JsonPropertyName("external_order_id"), JsonPropertyOrder(7)] public string? ExternalOrderId { get; set; } /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("external_shipment_id")] + [JsonPropertyName("external_shipment_id"), JsonPropertyOrder(8)] public string? ExternalShipmentId { get; set; } /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. - [JsonPropertyName("is_return")] + [JsonPropertyName("is_return"), JsonPropertyOrder(10)] public bool? IsReturn { get; set; } /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - [JsonPropertyName("items")] + [JsonPropertyName("items"), JsonPropertyOrder(11)] public List? Items { get; set; } /// @@ -130,21 +134,21 @@ public partial class PartialShipment /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("modified_at")] - public DateTimeOffset? ModifiedAt { get; set; } + [JsonPropertyName("modified_at"), JsonInclude] + public DateTimeOffset? ModifiedAt { get; private set; } /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] + [JsonPropertyName("packages"), JsonPropertyOrder(14)] public List? Packages { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. /// /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to")] + [JsonPropertyName("return_to"), JsonPropertyOrder(15)] public ShippingAddress? ReturnTo { get; set; } /// @@ -154,7 +158,7 @@ public partial class PartialShipment /// /// usps_first_class_mail /// - [JsonPropertyName("service_code")] + [JsonPropertyName("service_code"), JsonPropertyOrder(16)] public string? ServiceCode { get; set; } /// @@ -164,21 +168,21 @@ public partial class PartialShipment /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date")] + [JsonPropertyName("ship_date"), JsonPropertyOrder(17)] public DateTimeOffset? ShipDate { get; set; } /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from")] + [JsonPropertyName("ship_from"), JsonPropertyOrder(18)] public ShippingAddress? ShipFrom { get; set; } /// /// The recipient's mailing address /// /// The recipient's mailing address - [JsonPropertyName("ship_to")] + [JsonPropertyName("ship_to"), JsonPropertyOrder(19)] public ShippingAddressTo? ShipTo { get; set; } /// @@ -188,14 +192,14 @@ public partial class PartialShipment /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string? ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private set; } /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("shipment_number")] + [JsonPropertyName("shipment_number"), JsonPropertyOrder(21)] public string? ShipmentNumber { get; set; } /// @@ -205,28 +209,28 @@ public partial class PartialShipment /// /// se-28529731 /// - [JsonPropertyName("shipping_rule_id")] + [JsonPropertyName("shipping_rule_id"), JsonPropertyOrder(23)] public string? ShippingRuleId { get; set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. - [JsonPropertyName("tags")] - public List? Tags { get; set; } + [JsonPropertyName("tags"), JsonInclude] + public List? Tags { get; private set; } /// /// Gets or Sets TaxIdentifiers /// - [JsonPropertyName("tax_identifiers")] + [JsonPropertyName("tax_identifiers"), JsonPropertyOrder(25)] public List? TaxIdentifiers { get; set; } /// /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment - [JsonPropertyName("total_weight")] - public Weight? TotalWeight { get; set; } + [JsonPropertyName("total_weight"), JsonInclude] + public Weight? TotalWeight { get; private set; } /// /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. @@ -235,7 +239,7 @@ public partial class PartialShipment /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] + [JsonPropertyName("warehouse_id"), JsonPropertyOrder(27)] public string? WarehouseId { get; set; } diff --git a/ShipEngineSDK/Model/PartialShippingAddress.cs b/ShipEngineSDK/Model/PartialShippingAddress.cs index 1dd0fe45..0a640f22 100644 --- a/ShipEngineSDK/Model/PartialShippingAddress.cs +++ b/ShipEngineSDK/Model/PartialShippingAddress.cs @@ -32,7 +32,7 @@ public partial class PartialShippingAddress /// Additional text about how to handle the shipment at this address. /// /// Additional text about how to handle the shipment at this address. - [JsonPropertyName("instructions")] + [JsonPropertyName("instructions"), JsonPropertyOrder(1)] public string? Instructions { get; set; } diff --git a/ShipEngineSDK/Model/PartialShippingAddressTo.cs b/ShipEngineSDK/Model/PartialShippingAddressTo.cs index e1930c82..d690754d 100644 --- a/ShipEngineSDK/Model/PartialShippingAddressTo.cs +++ b/ShipEngineSDK/Model/PartialShippingAddressTo.cs @@ -31,14 +31,14 @@ public partial class PartialShippingAddressTo /// /// Gets or Sets Geolocation /// - [JsonPropertyName("geolocation")] + [JsonPropertyName("geolocation"), JsonPropertyOrder(1)] public List? Geolocation { get; set; } /// /// Additional text about how to handle the shipment at this address. /// /// Additional text about how to handle the shipment at this address. - [JsonPropertyName("instructions")] + [JsonPropertyName("instructions"), JsonPropertyOrder(2)] public string? Instructions { get; set; } diff --git a/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs b/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs index 6417d24a..e8fd0e7e 100644 --- a/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs +++ b/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs @@ -83,14 +83,15 @@ public override bool CanConvert(Type typeToConvert) => /// - /// Enum of available type of geolocation items: - 'what3words' functionality allows to specify a location by providing 3 words that have been assign to the specific location see [link](https://what3words.com/business) for more details. CLOVUS + /// Enum of available type of geolocation items: - 'what3words' functionality allows to specify a location by providing 3 words that have been assign to the specific location see [link](https://what3words.com/business) for more details. /// /// Enum of available type of geolocation items: - 'what3words' functionality allows to specify a location by providing 3 words that have been assign to the specific location see [link](https://what3words.com/business) for more details. /// /// what3words /// - [JsonPropertyName("type")] + [JsonPropertyName("type"), JsonPropertyOrder(1)] public TypeEnum? Type { get; set; } + /// /// value of the geolocation item /// @@ -98,7 +99,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// cats.with.thumbs /// - [JsonPropertyName("value")] + [JsonPropertyName("value"), JsonPropertyOrder(2)] public string? Value { get; set; } diff --git a/ShipEngineSDK/Model/PaymentAmount.cs b/ShipEngineSDK/Model/PaymentAmount.cs index 4f804ad7..47e44438 100644 --- a/ShipEngineSDK/Model/PaymentAmount.cs +++ b/ShipEngineSDK/Model/PaymentAmount.cs @@ -31,14 +31,14 @@ public partial class PaymentAmount /// /// Gets or Sets Amount /// - [JsonPropertyName("amount")] + [JsonPropertyName("amount"), JsonPropertyOrder(1)] public double? Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("currency")] + [JsonPropertyName("currency"), JsonPropertyOrder(2)] public string? Currency { get; set; } diff --git a/ShipEngineSDK/Model/Pickup.cs b/ShipEngineSDK/Model/Pickup.cs index 395f650a..e17b8fd0 100644 --- a/ShipEngineSDK/Model/Pickup.cs +++ b/ShipEngineSDK/Model/Pickup.cs @@ -23,7 +23,7 @@ namespace ShipEngineSDK.Model; /// -/// The information necessary to schedule a package pickup +/// The information necessary to schedule a package pickup /// public partial class Pickup { @@ -35,8 +35,8 @@ public partial class Pickup /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("cancelled_at")] - public DateTimeOffset? CancelledAt { get; set; } + [JsonPropertyName("cancelled_at"), JsonInclude] + public DateTimeOffset? CancelledAt { get; private set; } /// /// The carrier_id associated with the pickup @@ -45,8 +45,8 @@ public partial class Pickup /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - public string? CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// The carrier confirmation number for the scheduled pickup. @@ -55,13 +55,13 @@ public partial class Pickup /// /// 292513CL4A3 /// - [JsonPropertyName("confirmation_number")] - public string? ConfirmationNumber { get; set; } + [JsonPropertyName("confirmation_number"), JsonInclude] + public string? ConfirmationNumber { get; private set; } /// /// Gets or Sets ContactDetails /// - [JsonPropertyName("contact_details")] + [JsonPropertyName("contact_details"), JsonPropertyOrder(4)] public ContactDetails? ContactDetails { get; set; } /// @@ -71,21 +71,21 @@ public partial class Pickup /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// Label IDs that will be included in the pickup request /// /// Label IDs that will be included in the pickup request - [JsonPropertyName("label_ids")] + [JsonPropertyName("label_ids"), JsonPropertyOrder(6)] public List? LabelIds { get; set; } /// /// Gets or Sets PickupAddress /// - [JsonPropertyName("pickup_address")] - public Address? PickupAddress { get; set; } + [JsonPropertyName("pickup_address"), JsonInclude] + public Address? PickupAddress { get; private set; } /// /// Pickup Resource ID @@ -94,28 +94,28 @@ public partial class Pickup /// /// pik_3YcKU5zdtJuCqoeNwyqqbW /// - [JsonPropertyName("pickup_id")] - public string? PickupId { get; set; } + [JsonPropertyName("pickup_id"), JsonInclude] + public string? PickupId { get; private set; } /// /// Used by some carriers to give special instructions for a package pickup /// /// Used by some carriers to give special instructions for a package pickup - [JsonPropertyName("pickup_notes")] + [JsonPropertyName("pickup_notes"), JsonPropertyOrder(9)] public string? PickupNotes { get; set; } /// /// Gets or Sets PickupWindow /// - [JsonPropertyName("pickup_window")] + [JsonPropertyName("pickup_window"), JsonPropertyOrder(10)] public PickupWindow? PickupWindow { get; set; } /// - /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. + /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. - [JsonPropertyName("pickup_windows")] - public List? PickupWindows { get; set; } + [JsonPropertyName("pickup_windows"), JsonInclude, JsonRequired] + public List? PickupWindows { get; private set; } /// /// The warehouse_id associated with the pickup @@ -124,8 +124,8 @@ public partial class Pickup /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] - public string? WarehouseId { get; set; } + [JsonPropertyName("warehouse_id"), JsonInclude] + public string? WarehouseId { get; private set; } /// diff --git a/ShipEngineSDK/Model/PickupResponseBody.cs b/ShipEngineSDK/Model/PickupResponseBody.cs index ddcf261a..3267f9d0 100644 --- a/ShipEngineSDK/Model/PickupResponseBody.cs +++ b/ShipEngineSDK/Model/PickupResponseBody.cs @@ -35,15 +35,13 @@ public partial class PickupResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [JsonRequired] - public required string CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// Gets or Sets ContactDetails /// - [JsonPropertyName("contact_details")] - [JsonRequired] + [JsonPropertyName("contact_details"), JsonRequired, JsonPropertyOrder(2)] public required ContactDetails ContactDetails { get; set; } /// @@ -53,24 +51,21 @@ public partial class PickupResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - [JsonRequired] - public required DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// Label IDs that will be included in the pickup request /// /// Label IDs that will be included in the pickup request - [JsonPropertyName("label_ids")] - [JsonRequired] + [JsonPropertyName("label_ids"), JsonRequired, JsonPropertyOrder(4)] public required List LabelIds { get; set; } /// /// Gets or Sets PickupAddress /// - [JsonPropertyName("pickup_address")] - [JsonRequired] - public required Address PickupAddress { get; set; } + [JsonPropertyName("pickup_address"), JsonInclude] + public Address? PickupAddress { get; private set; } /// /// Pickup Resource ID @@ -79,15 +74,13 @@ public partial class PickupResponseBody /// /// pik_3YcKU5zdtJuCqoeNwyqqbW /// - [JsonPropertyName("pickup_id")] - [JsonRequired] - public required string PickupId { get; set; } + [JsonPropertyName("pickup_id"), JsonInclude] + public string? PickupId { get; private set; } /// /// Gets or Sets PickupWindow /// - [JsonPropertyName("pickup_window")] - [JsonRequired] + [JsonPropertyName("pickup_window"), JsonRequired, JsonPropertyOrder(7)] public required PickupWindow PickupWindow { get; set; } /// @@ -97,9 +90,8 @@ public partial class PickupResponseBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] - [JsonRequired] - public required string WarehouseId { get; set; } + [JsonPropertyName("warehouse_id"), JsonInclude] + public string? WarehouseId { get; private set; } /// /// The date and time that the pickup was cancelled in ShipEngine. @@ -108,8 +100,8 @@ public partial class PickupResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("cancelled_at")] - public DateTimeOffset? CancelledAt { get; set; } + [JsonPropertyName("cancelled_at"), JsonInclude] + public DateTimeOffset? CancelledAt { get; private set; } /// /// The carrier confirmation number for the scheduled pickup. @@ -118,23 +110,22 @@ public partial class PickupResponseBody /// /// 292513CL4A3 /// - [JsonPropertyName("confirmation_number")] - [JsonRequired] - public required string ConfirmationNumber { get; set; } + [JsonPropertyName("confirmation_number"), JsonInclude] + public string? ConfirmationNumber { get; private set; } /// /// Used by some carriers to give special instructions for a package pickup /// /// Used by some carriers to give special instructions for a package pickup - [JsonPropertyName("pickup_notes")] + [JsonPropertyName("pickup_notes"), JsonPropertyOrder(11)] public string? PickupNotes { get; set; } /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. - [JsonPropertyName("pickup_windows")] - public List? PickupWindows { get; set; } + [JsonPropertyName("pickup_windows"), JsonInclude] + public List? PickupWindows { get; private set; } /// diff --git a/ShipEngineSDK/Model/PickupWindow.cs b/ShipEngineSDK/Model/PickupWindow.cs index ef5ef829..edec12a5 100644 --- a/ShipEngineSDK/Model/PickupWindow.cs +++ b/ShipEngineSDK/Model/PickupWindow.cs @@ -35,8 +35,7 @@ public partial class PickupWindow /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("end_at")] - [JsonRequired] + [JsonPropertyName("end_at"), JsonRequired, JsonPropertyOrder(1)] public required DateTimeOffset EndAt { get; set; } /// @@ -46,8 +45,7 @@ public partial class PickupWindow /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("start_at")] - [JsonRequired] + [JsonPropertyName("start_at"), JsonRequired, JsonPropertyOrder(2)] public required DateTimeOffset StartAt { get; set; } diff --git a/ShipEngineSDK/Model/PickupWindows.cs b/ShipEngineSDK/Model/PickupWindows.cs index d96e62e1..60a13b18 100644 --- a/ShipEngineSDK/Model/PickupWindows.cs +++ b/ShipEngineSDK/Model/PickupWindows.cs @@ -35,7 +35,7 @@ public partial class PickupWindows /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("end_at")] + [JsonPropertyName("end_at"), JsonPropertyOrder(1)] public DateTimeOffset? EndAt { get; set; } /// @@ -45,7 +45,7 @@ public partial class PickupWindows /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("start_at")] + [JsonPropertyName("start_at"), JsonPropertyOrder(2)] public DateTimeOffset? StartAt { get; set; } diff --git a/ShipEngineSDK/Model/ProcessBatchRequestBody.cs b/ShipEngineSDK/Model/ProcessBatchRequestBody.cs index 046198ed..02f67db3 100644 --- a/ShipEngineSDK/Model/ProcessBatchRequestBody.cs +++ b/ShipEngineSDK/Model/ProcessBatchRequestBody.cs @@ -29,21 +29,24 @@ public partial class ProcessBatchRequestBody { /// - /// The display format that the label should be shown in. CLOVUS + /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(1)] public DisplayScheme? DisplayScheme { get; set; } + /// - /// Gets or Sets LabelFormat CLOVUS + /// Gets or Sets LabelFormat /// - [JsonPropertyName("label_format")] + [JsonPropertyName("label_format"), JsonPropertyOrder(2)] public LabelFormat? LabelFormat { get; set; } + /// - /// Gets or Sets LabelLayout CLOVUS + /// Gets or Sets LabelLayout /// - [JsonPropertyName("label_layout")] + [JsonPropertyName("label_layout"), JsonPropertyOrder(3)] public LabelLayout? LabelLayout { get; set; } + /// /// The Ship date the batch is being processed for /// @@ -51,7 +54,7 @@ public partial class ProcessBatchRequestBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("ship_date")] + [JsonPropertyName("ship_date"), JsonPropertyOrder(4)] public DateTimeOffset? ShipDate { get; set; } diff --git a/ShipEngineSDK/Model/Products.cs b/ShipEngineSDK/Model/Products.cs index c62fed79..b4c60bff 100644 --- a/ShipEngineSDK/Model/Products.cs +++ b/ShipEngineSDK/Model/Products.cs @@ -35,21 +35,21 @@ public partial class Products /// /// CA /// - [JsonPropertyName("country_of_origin")] + [JsonPropertyName("country_of_origin"), JsonPropertyOrder(1)] public string? CountryOfOrigin { get; set; } /// /// Details about dangerous goods inside products /// /// Details about dangerous goods inside products - [JsonPropertyName("dangerous_goods")] + [JsonPropertyName("dangerous_goods"), JsonPropertyOrder(2)] public List? DangerousGoods { get; set; } /// /// A description of the item /// /// A description of the item - [JsonPropertyName("description")] + [JsonPropertyName("description"), JsonPropertyOrder(3)] public string? Description { get; set; } /// @@ -59,55 +59,55 @@ public partial class Products /// /// 3926.1 /// - [JsonPropertyName("harmonized_tariff_code")] + [JsonPropertyName("harmonized_tariff_code"), JsonPropertyOrder(4)] public string? HarmonizedTariffCode { get; set; } /// /// Manufacturers Identification code /// /// Manufacturers Identification code - [JsonPropertyName("mid_code")] + [JsonPropertyName("mid_code"), JsonPropertyOrder(5)] public string? MidCode { get; set; } /// /// link to the item on the seller website /// /// link to the item on the seller website - [JsonPropertyName("product_url")] + [JsonPropertyName("product_url"), JsonPropertyOrder(6)] public string? ProductUrl { get; set; } /// /// The quantity of this item in the shipment. /// /// The quantity of this item in the shipment. - [JsonPropertyName("quantity")] + [JsonPropertyName("quantity"), JsonPropertyOrder(7)] public int? Quantity { get; set; } /// /// The SKU (Stock Keeping Unit) of the item /// /// The SKU (Stock Keeping Unit) of the item - [JsonPropertyName("sku")] + [JsonPropertyName("sku"), JsonPropertyOrder(8)] public string? Sku { get; set; } /// /// Description of the Custom Item's SKU /// /// Description of the Custom Item's SKU - [JsonPropertyName("sku_description")] + [JsonPropertyName("sku_description"), JsonPropertyOrder(9)] public string? SkuDescription { get; set; } /// /// Gets or Sets UnitOfMeasure /// - [JsonPropertyName("unit_of_measure")] + [JsonPropertyName("unit_of_measure"), JsonPropertyOrder(10)] public string? UnitOfMeasure { get; set; } /// /// The declared value of each item /// /// The declared value of each item - [JsonPropertyName("value")] + [JsonPropertyName("value"), JsonPropertyOrder(11)] public MonetaryValue? Value { get; set; } /// @@ -117,14 +117,14 @@ public partial class Products /// /// 0.2 /// - [JsonPropertyName("vat_rate")] + [JsonPropertyName("vat_rate"), JsonPropertyOrder(12)] public double? VatRate { get; set; } /// /// The item weight /// /// The item weight - [JsonPropertyName("weight")] + [JsonPropertyName("weight"), JsonPropertyOrder(13)] public Weight? Weight { get; set; } diff --git a/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs b/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs index c3db19d0..65c0749c 100644 --- a/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs +++ b/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs @@ -29,32 +29,37 @@ public partial class PurchaseLabelWithoutShipment { /// - /// The display format that the label should be shown in. CLOVUS + /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme")] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(1)] public DisplayScheme? DisplayScheme { get; set; } + /// - /// Gets or Sets LabelDownloadType CLOVUS + /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type")] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(2)] public LabelDownloadType? LabelDownloadType { get; set; } + /// - /// Gets or Sets LabelFormat CLOVUS + /// Gets or Sets LabelFormat /// - [JsonPropertyName("label_format")] + [JsonPropertyName("label_format"), JsonPropertyOrder(3)] public LabelFormat? LabelFormat { get; set; } + /// - /// Gets or Sets LabelLayout CLOVUS + /// Gets or Sets LabelLayout /// - [JsonPropertyName("label_layout")] + [JsonPropertyName("label_layout"), JsonPropertyOrder(4)] public LabelLayout? LabelLayout { get; set; } + /// - /// Gets or Sets ValidateAddress CLOVUS + /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address")] + [JsonPropertyName("validate_address"), JsonPropertyOrder(5)] public ValidateAddress? ValidateAddress { get; set; } + /// /// Returns the string presentation of the object /// diff --git a/ShipEngineSDK/Model/Rate.cs b/ShipEngineSDK/Model/Rate.cs index 2460b66c..05013a8d 100644 --- a/ShipEngineSDK/Model/Rate.cs +++ b/ShipEngineSDK/Model/Rate.cs @@ -29,36 +29,30 @@ public partial class Rate { /// - /// Gets or Sets RateType CLOVUS + /// Gets or Sets RateType /// - [JsonPropertyName("rate_type")] - [JsonRequired] - public required RateType RateType { get; set; } = new(); - + [JsonPropertyName("rate_type"), JsonInclude] + public RateType? RateType { get; private set; } /// - /// Gets or Sets ValidationStatus CLOVUS + /// Gets or Sets ValidationStatus /// - [JsonPropertyName("validation_status")] - [JsonRequired] - public required ValidationStatus ValidationStatus { get; set; } = new(); - + [JsonPropertyName("validation_status"), JsonInclude] + public ValidationStatus? ValidationStatus { get; private set; } /// /// carrier code /// /// carrier code - [JsonPropertyName("carrier_code")] - [JsonRequired] - public required string CarrierCode { get; set; } + [JsonPropertyName("carrier_code"), JsonInclude] + public string? CarrierCode { get; private set; } /// /// carrier friendly name /// /// carrier friendly name - [JsonPropertyName("carrier_friendly_name")] - [JsonRequired] - public required string CarrierFriendlyName { get; set; } + [JsonPropertyName("carrier_friendly_name"), JsonInclude] + public string? CarrierFriendlyName { get; private set; } /// /// A string that uniquely identifies the carrier @@ -67,65 +61,57 @@ public partial class Rate /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [JsonRequired] - public required string CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// carrier nickname /// /// carrier nickname - [JsonPropertyName("carrier_nickname")] - [JsonRequired] - public required string CarrierNickname { get; set; } + [JsonPropertyName("carrier_nickname"), JsonInclude] + public string? CarrierNickname { get; private set; } /// /// The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price. /// /// The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price. - [JsonPropertyName("confirmation_amount")] - [JsonRequired] - public required MonetaryValue ConfirmationAmount { get; set; } + [JsonPropertyName("confirmation_amount"), JsonInclude] + public MonetaryValue? ConfirmationAmount { get; private set; } /// /// The error messages /// /// The error messages - [JsonPropertyName("error_messages")] - [JsonRequired] - public required List ErrorMessages { get; set; } + [JsonPropertyName("error_messages"), JsonInclude] + public List? ErrorMessages { get; private set; } /// /// Indicates if the rate is guaranteed. /// /// Indicates if the rate is guaranteed. - [JsonPropertyName("guaranteed_service")] - [JsonRequired] - public required bool GuaranteedService { get; set; } + [JsonPropertyName("guaranteed_service"), JsonInclude] + public bool? GuaranteedService { get; private set; } /// /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. /// /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. - [JsonPropertyName("insurance_amount")] - [JsonRequired] - public required MonetaryValue InsuranceAmount { get; set; } + [JsonPropertyName("insurance_amount"), JsonInclude] + public MonetaryValue? InsuranceAmount { get; private set; } /// /// Indicates if the rates been negotiated /// /// Indicates if the rates been negotiated - [JsonPropertyName("negotiated_rate")] - [JsonRequired] - public required bool NegotiatedRate { get; set; } + [JsonPropertyName("negotiated_rate"), JsonInclude] + public bool? NegotiatedRate { get; private set; } /// /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. /// /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. - [JsonPropertyName("other_amount")] - [JsonRequired] - public required MonetaryValue OtherAmount { get; set; } + [JsonPropertyName("other_amount"), JsonInclude] + public MonetaryValue? OtherAmount { get; private set; } /// /// A string that uniquely identifies the rate @@ -134,56 +120,50 @@ public partial class Rate /// /// se-28529731 /// - [JsonPropertyName("rate_id")] - [JsonRequired] - public required string RateId { get; set; } + [JsonPropertyName("rate_id"), JsonInclude] + public string? RateId { get; private set; } /// /// service code for the rate /// /// service code for the rate - [JsonPropertyName("service_code")] - [JsonRequired] - public required string ServiceCode { get; set; } + [JsonPropertyName("service_code"), JsonInclude] + public string? ServiceCode { get; private set; } /// /// service type /// /// service type - [JsonPropertyName("service_type")] - [JsonRequired] - public required string ServiceType { get; set; } + [JsonPropertyName("service_type"), JsonInclude] + public string? ServiceType { get; private set; } /// /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. /// /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. - [JsonPropertyName("shipping_amount")] - [JsonRequired] - public required MonetaryValue ShippingAmount { get; set; } + [JsonPropertyName("shipping_amount"), JsonInclude] + public MonetaryValue? ShippingAmount { get; private set; } /// /// Indicates if rate is trackable /// /// Indicates if rate is trackable - [JsonPropertyName("trackable")] - [JsonRequired] - public required bool Trackable { get; set; } + [JsonPropertyName("trackable"), JsonInclude] + public bool? Trackable { get; private set; } /// /// The warning messages /// /// The warning messages - [JsonPropertyName("warning_messages")] - [JsonRequired] - public required List WarningMessages { get; set; } + [JsonPropertyName("warning_messages"), JsonInclude] + public List? WarningMessages { get; private set; } /// /// The carrier delivery days /// /// The carrier delivery days - [JsonPropertyName("carrier_delivery_days")] - public string? CarrierDeliveryDays { get; set; } + [JsonPropertyName("carrier_delivery_days"), JsonInclude] + public string? CarrierDeliveryDays { get; private set; } /// /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday @@ -192,8 +172,8 @@ public partial class Rate /// /// 5 /// - [JsonPropertyName("delivery_days")] - public int? DeliveryDays { get; set; } + [JsonPropertyName("delivery_days"), JsonInclude] + public int? DeliveryDays { get; private set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. @@ -202,8 +182,8 @@ public partial class Rate /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("estimated_delivery_date")] - public DateTimeOffset? EstimatedDeliveryDate { get; set; } + [JsonPropertyName("estimated_delivery_date"), JsonInclude] + public DateTimeOffset? EstimatedDeliveryDate { get; private set; } /// /// package type that this rate was estimated for @@ -212,30 +192,29 @@ public partial class Rate /// /// package /// - [JsonPropertyName("package_type")] - [JsonRequired] - public required string PackageType { get; set; } + [JsonPropertyName("package_type"), JsonInclude] + public string? PackageType { get; private set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. - [JsonPropertyName("requested_comparison_amount")] - public MonetaryValue? RequestedComparisonAmount { get; set; } + [JsonPropertyName("requested_comparison_amount"), JsonInclude] + public MonetaryValue? RequestedComparisonAmount { get; private set; } /// /// ship date /// /// ship date - [JsonPropertyName("ship_date")] - public DateTimeOffset? ShipDate { get; set; } + [JsonPropertyName("ship_date"), JsonInclude] + public DateTimeOffset? ShipDate { get; private set; } /// /// Tariff and additional taxes associated with an international shipment. /// /// Tariff and additional taxes associated with an international shipment. - [JsonPropertyName("tax_amount")] - public MonetaryValue? TaxAmount { get; set; } + [JsonPropertyName("tax_amount"), JsonInclude] + public MonetaryValue? TaxAmount { get; private set; } /// /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location @@ -244,9 +223,8 @@ public partial class Rate /// /// 6 /// - [JsonPropertyName("zone")] - [JsonRequired] - public required int Zone { get; set; } + [JsonPropertyName("zone"), JsonInclude] + public int? Zone { get; private set; } /// diff --git a/ShipEngineSDK/Model/RateEstimate.cs b/ShipEngineSDK/Model/RateEstimate.cs index f680d00d..41a8ae04 100644 --- a/ShipEngineSDK/Model/RateEstimate.cs +++ b/ShipEngineSDK/Model/RateEstimate.cs @@ -29,36 +29,30 @@ public partial class RateEstimate { /// - /// Gets or Sets RateType CLOVUS + /// Gets or Sets RateType /// - [JsonPropertyName("rate_type")] - [JsonRequired] - public required RateType RateType { get; set; } = new(); - + [JsonPropertyName("rate_type"), JsonInclude] + public RateType? RateType { get; private set; } /// - /// Gets or Sets ValidationStatus CLOVUS + /// Gets or Sets ValidationStatus /// - [JsonPropertyName("validation_status")] - [JsonRequired] - public required ValidationStatus ValidationStatus { get; set; } = new(); - + [JsonPropertyName("validation_status"), JsonInclude] + public ValidationStatus? ValidationStatus { get; private set; } /// /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. /// /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. - [JsonPropertyName("carrier_code")] - [JsonRequired] - public required string CarrierCode { get; set; } + [JsonPropertyName("carrier_code"), JsonInclude] + public string? CarrierCode { get; private set; } /// /// carrier friendly name /// /// carrier friendly name - [JsonPropertyName("carrier_friendly_name")] - [JsonRequired] - public required string CarrierFriendlyName { get; set; } + [JsonPropertyName("carrier_friendly_name"), JsonInclude] + public string? CarrierFriendlyName { get; private set; } /// /// A string that uniquely identifies the carrier @@ -67,112 +61,99 @@ public partial class RateEstimate /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [JsonRequired] - public required string CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// carrier nickname /// /// carrier nickname - [JsonPropertyName("carrier_nickname")] - [JsonRequired] - public required string CarrierNickname { get; set; } + [JsonPropertyName("carrier_nickname"), JsonInclude] + public string? CarrierNickname { get; private set; } /// /// The confirmation amount /// /// The confirmation amount - [JsonPropertyName("confirmation_amount")] - [JsonRequired] - public required MonetaryValue ConfirmationAmount { get; set; } + [JsonPropertyName("confirmation_amount"), JsonInclude] + public MonetaryValue? ConfirmationAmount { get; private set; } /// /// The error messages /// /// The error messages - [JsonPropertyName("error_messages")] - [JsonRequired] - public required List ErrorMessages { get; set; } + [JsonPropertyName("error_messages"), JsonInclude] + public List? ErrorMessages { get; private set; } /// /// Indicates if the rate is guaranteed. /// /// Indicates if the rate is guaranteed. - [JsonPropertyName("guaranteed_service")] - [JsonRequired] - public required bool GuaranteedService { get; set; } + [JsonPropertyName("guaranteed_service"), JsonInclude] + public bool? GuaranteedService { get; private set; } /// /// The insurance amount /// /// The insurance amount - [JsonPropertyName("insurance_amount")] - [JsonRequired] - public required MonetaryValue InsuranceAmount { get; set; } + [JsonPropertyName("insurance_amount"), JsonInclude] + public MonetaryValue? InsuranceAmount { get; private set; } /// /// Indicates if the rates been negotiated /// /// Indicates if the rates been negotiated - [JsonPropertyName("negotiated_rate")] - [JsonRequired] - public required bool NegotiatedRate { get; set; } + [JsonPropertyName("negotiated_rate"), JsonInclude] + public bool? NegotiatedRate { get; private set; } /// /// Any other charges associated with this rate /// /// Any other charges associated with this rate - [JsonPropertyName("other_amount")] - [JsonRequired] - public required MonetaryValue OtherAmount { get; set; } + [JsonPropertyName("other_amount"), JsonInclude] + public MonetaryValue? OtherAmount { get; private set; } /// /// service code for the rate /// /// service code for the rate - [JsonPropertyName("service_code")] - [JsonRequired] - public required string ServiceCode { get; set; } + [JsonPropertyName("service_code"), JsonInclude] + public string? ServiceCode { get; private set; } /// /// service type /// /// service type - [JsonPropertyName("service_type")] - [JsonRequired] - public required string ServiceType { get; set; } + [JsonPropertyName("service_type"), JsonInclude] + public string? ServiceType { get; private set; } /// /// The shipping amount /// /// The shipping amount - [JsonPropertyName("shipping_amount")] - [JsonRequired] - public required MonetaryValue ShippingAmount { get; set; } + [JsonPropertyName("shipping_amount"), JsonInclude] + public MonetaryValue? ShippingAmount { get; private set; } /// /// Indicates if rate is trackable /// /// Indicates if rate is trackable - [JsonPropertyName("trackable")] - [JsonRequired] - public required bool Trackable { get; set; } + [JsonPropertyName("trackable"), JsonInclude] + public bool? Trackable { get; private set; } /// /// The warning messages /// /// The warning messages - [JsonPropertyName("warning_messages")] - [JsonRequired] - public required List WarningMessages { get; set; } + [JsonPropertyName("warning_messages"), JsonInclude] + public List? WarningMessages { get; private set; } /// /// The carrier delivery days /// /// The carrier delivery days - [JsonPropertyName("carrier_delivery_days")] - public string? CarrierDeliveryDays { get; set; } + [JsonPropertyName("carrier_delivery_days"), JsonInclude] + public string? CarrierDeliveryDays { get; private set; } /// /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday @@ -181,8 +162,8 @@ public partial class RateEstimate /// /// 5 /// - [JsonPropertyName("delivery_days")] - public int? DeliveryDays { get; set; } + [JsonPropertyName("delivery_days"), JsonInclude] + public int? DeliveryDays { get; private set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. @@ -191,8 +172,8 @@ public partial class RateEstimate /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("estimated_delivery_date")] - public DateTimeOffset? EstimatedDeliveryDate { get; set; } + [JsonPropertyName("estimated_delivery_date"), JsonInclude] + public DateTimeOffset? EstimatedDeliveryDate { get; private set; } /// /// package type that this rate was estimated for @@ -201,23 +182,22 @@ public partial class RateEstimate /// /// package /// - [JsonPropertyName("package_type")] - [JsonRequired] - public required string PackageType { get; set; } + [JsonPropertyName("package_type"), JsonInclude] + public string? PackageType { get; private set; } /// /// ship date /// /// ship date - [JsonPropertyName("ship_date")] - public DateTimeOffset? ShipDate { get; set; } + [JsonPropertyName("ship_date"), JsonInclude] + public DateTimeOffset? ShipDate { get; private set; } /// /// Tariff and additional taxes associated with an international shipment. /// /// Tariff and additional taxes associated with an international shipment. - [JsonPropertyName("tax_amount")] - public MonetaryValue? TaxAmount { get; set; } + [JsonPropertyName("tax_amount"), JsonInclude] + public MonetaryValue? TaxAmount { get; private set; } /// /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location @@ -226,9 +206,8 @@ public partial class RateEstimate /// /// 6 /// - [JsonPropertyName("zone")] - [JsonRequired] - public required int Zone { get; set; } + [JsonPropertyName("zone"), JsonInclude] + public int? Zone { get; private set; } /// diff --git a/ShipEngineSDK/Model/RateEstimateByCarrierId.cs b/ShipEngineSDK/Model/RateEstimateByCarrierId.cs index 6977b538..82119fd4 100644 --- a/ShipEngineSDK/Model/RateEstimateByCarrierId.cs +++ b/ShipEngineSDK/Model/RateEstimateByCarrierId.cs @@ -35,8 +35,7 @@ public partial class RateEstimateByCarrierId /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [Obsolete] + [JsonPropertyName("carrier_id"), JsonPropertyOrder(1), Obsolete] public string? CarrierId { get; set; } diff --git a/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs b/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs index 44fe6725..a2bc688c 100644 --- a/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs +++ b/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs @@ -32,7 +32,7 @@ public partial class RateEstimateByCarrierIds /// Array of Carrier Ids /// /// Array of Carrier Ids - [JsonPropertyName("carrier_ids")] + [JsonPropertyName("carrier_ids"), JsonPropertyOrder(1)] public List? CarrierIds { get; set; } diff --git a/ShipEngineSDK/Model/RateEstimateOptions.cs b/ShipEngineSDK/Model/RateEstimateOptions.cs index 23bc056d..2c82a721 100644 --- a/ShipEngineSDK/Model/RateEstimateOptions.cs +++ b/ShipEngineSDK/Model/RateEstimateOptions.cs @@ -29,20 +29,22 @@ public partial class RateEstimateOptions { /// - /// Gets or Sets AddressResidentialIndicator CLOVUS + /// Gets or Sets AddressResidentialIndicator /// - [JsonPropertyName("address_residential_indicator")] + [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(1)] public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } + /// - /// Gets or Sets Confirmation CLOVUS + /// Gets or Sets Confirmation /// - [JsonPropertyName("confirmation")] + [JsonPropertyName("confirmation"), JsonPropertyOrder(2)] public DeliveryConfirmation? Confirmation { get; set; } + /// /// The dimensions of the package /// /// The dimensions of the package - [JsonPropertyName("dimensions")] + [JsonPropertyName("dimensions"), JsonPropertyOrder(3)] public Dimensions? Dimensions { get; set; } /// @@ -52,7 +54,7 @@ public partial class RateEstimateOptions /// /// Austin /// - [JsonPropertyName("from_city_locality")] + [JsonPropertyName("from_city_locality"), JsonPropertyOrder(4)] public string? FromCityLocality { get; set; } /// @@ -62,7 +64,7 @@ public partial class RateEstimateOptions /// /// CA /// - [JsonPropertyName("from_country_code")] + [JsonPropertyName("from_country_code"), JsonPropertyOrder(5)] public string? FromCountryCode { get; set; } /// @@ -72,7 +74,7 @@ public partial class RateEstimateOptions /// /// 78756-3717 /// - [JsonPropertyName("from_postal_code")] + [JsonPropertyName("from_postal_code"), JsonPropertyOrder(6)] public string? FromPostalCode { get; set; } /// @@ -82,7 +84,7 @@ public partial class RateEstimateOptions /// /// Austin /// - [JsonPropertyName("from_state_province")] + [JsonPropertyName("from_state_province"), JsonPropertyOrder(7)] public string? FromStateProvince { get; set; } /// @@ -92,7 +94,7 @@ public partial class RateEstimateOptions /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("ship_date")] + [JsonPropertyName("ship_date"), JsonPropertyOrder(8)] public DateTimeOffset? ShipDate { get; set; } /// @@ -102,7 +104,7 @@ public partial class RateEstimateOptions /// /// Austin /// - [JsonPropertyName("to_city_locality")] + [JsonPropertyName("to_city_locality"), JsonPropertyOrder(9)] public string? ToCityLocality { get; set; } /// @@ -112,7 +114,7 @@ public partial class RateEstimateOptions /// /// CA /// - [JsonPropertyName("to_country_code")] + [JsonPropertyName("to_country_code"), JsonPropertyOrder(10)] public string? ToCountryCode { get; set; } /// @@ -122,7 +124,7 @@ public partial class RateEstimateOptions /// /// 78756-3717 /// - [JsonPropertyName("to_postal_code")] + [JsonPropertyName("to_postal_code"), JsonPropertyOrder(11)] public string? ToPostalCode { get; set; } /// @@ -132,14 +134,14 @@ public partial class RateEstimateOptions /// /// Houston /// - [JsonPropertyName("to_state_province")] + [JsonPropertyName("to_state_province"), JsonPropertyOrder(12)] public string? ToStateProvince { get; set; } /// /// The weight of the package /// /// The weight of the package - [JsonPropertyName("weight")] + [JsonPropertyName("weight"), JsonPropertyOrder(13)] public Weight? Weight { get; set; } diff --git a/ShipEngineSDK/Model/RateRequestBody.cs b/ShipEngineSDK/Model/RateRequestBody.cs index ec188f1b..3cac59dc 100644 --- a/ShipEngineSDK/Model/RateRequestBody.cs +++ b/ShipEngineSDK/Model/RateRequestBody.cs @@ -32,41 +32,40 @@ public partial class RateRequestBody /// Array of carrier ids to get rates for /// /// Array of carrier ids to get rates for - [JsonPropertyName("carrier_ids")] - [JsonRequired] + [JsonPropertyName("carrier_ids"), JsonRequired, JsonPropertyOrder(1)] public required List CarrierIds { get; set; } /// /// Calculate the duties and tariffs for cross border shipments. /// /// Calculate the duties and tariffs for cross border shipments. - [JsonPropertyName("calculate_tax_amount")] + [JsonPropertyName("calculate_tax_amount"), JsonPropertyOrder(2)] public bool? CalculateTaxAmount { get; set; } /// /// Indicate if it's a return shipment /// /// Indicate if it's a return shipment - [JsonPropertyName("is_return")] + [JsonPropertyName("is_return"), JsonPropertyOrder(3)] public bool? IsReturn { get; set; } /// /// Gets or Sets PackageTypes /// - [JsonPropertyName("package_types")] + [JsonPropertyName("package_types"), JsonPropertyOrder(4)] public List? PackageTypes { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("preferred_currency")] + [JsonPropertyName("preferred_currency"), JsonPropertyOrder(5)] public string? PreferredCurrency { get; set; } /// /// Gets or Sets ServiceCodes /// - [JsonPropertyName("service_codes")] + [JsonPropertyName("service_codes"), JsonPropertyOrder(6)] public List? ServiceCodes { get; set; } diff --git a/ShipEngineSDK/Model/RateRequestByShipmentIds.cs b/ShipEngineSDK/Model/RateRequestByShipmentIds.cs index de9f60ab..079bc712 100644 --- a/ShipEngineSDK/Model/RateRequestByShipmentIds.cs +++ b/ShipEngineSDK/Model/RateRequestByShipmentIds.cs @@ -32,8 +32,7 @@ public partial class RateRequestByShipmentIds /// The array of shipment IDs /// /// The array of shipment IDs - [JsonPropertyName("shipment_ids")] - [JsonRequired] + [JsonPropertyName("shipment_ids"), JsonRequired, JsonPropertyOrder(1)] public required List ShipmentIds { get; set; } diff --git a/ShipEngineSDK/Model/RateRequestByShipments.cs b/ShipEngineSDK/Model/RateRequestByShipments.cs index 23df6a3b..a2cc64f5 100644 --- a/ShipEngineSDK/Model/RateRequestByShipments.cs +++ b/ShipEngineSDK/Model/RateRequestByShipments.cs @@ -32,8 +32,7 @@ public partial class RateRequestByShipments /// The array of shipments to get bulk rate estimates for /// /// The array of shipments to get bulk rate estimates for - [JsonPropertyName("shipments")] - [JsonRequired] + [JsonPropertyName("shipments"), JsonRequired, JsonPropertyOrder(1)] public required List Shipments { get; set; } diff --git a/ShipEngineSDK/Model/RateRequestOptions.cs b/ShipEngineSDK/Model/RateRequestOptions.cs index f1854580..1712577a 100644 --- a/ShipEngineSDK/Model/RateRequestOptions.cs +++ b/ShipEngineSDK/Model/RateRequestOptions.cs @@ -32,7 +32,7 @@ public partial class RateRequestOptions /// The rate options /// /// The rate options - [JsonPropertyName("rate_options")] + [JsonPropertyName("rate_options"), JsonPropertyOrder(1)] public RateRequestBody? RateOptions { get; set; } diff --git a/ShipEngineSDK/Model/RateRequestRateOptions.cs b/ShipEngineSDK/Model/RateRequestRateOptions.cs index e08b7ada..d61b1853 100644 --- a/ShipEngineSDK/Model/RateRequestRateOptions.cs +++ b/ShipEngineSDK/Model/RateRequestRateOptions.cs @@ -32,7 +32,7 @@ public partial class RateRequestRateOptions /// The rate options /// /// The rate options - [JsonPropertyName("rate_options")] + [JsonPropertyName("rate_options"), JsonPropertyOrder(1)] public RateRequestBody? RateOptions { get; set; } diff --git a/ShipEngineSDK/Model/RateResponse.cs b/ShipEngineSDK/Model/RateResponse.cs index d2924353..7054595f 100644 --- a/ShipEngineSDK/Model/RateResponse.cs +++ b/ShipEngineSDK/Model/RateResponse.cs @@ -32,7 +32,7 @@ public partial class RateResponse /// The rates response /// /// The rates response - [JsonPropertyName("rate_response")] + [JsonPropertyName("rate_response"), JsonPropertyOrder(1)] public RatesInformation? VarRateResponse { get; set; } diff --git a/ShipEngineSDK/Model/RateResponseStatus.cs b/ShipEngineSDK/Model/RateResponseStatus.cs index 326a7ff1..d1a17fac 100644 --- a/ShipEngineSDK/Model/RateResponseStatus.cs +++ b/ShipEngineSDK/Model/RateResponseStatus.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(RateResponseStatusJsonConverter))] public class RateResponseStatus { - private string _value; + private readonly string _value; /// /// Create a new instance of RateResponseStatus with a predefined value. @@ -80,6 +80,12 @@ public RateResponseStatus(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is RateResponseStatus other && _value == other._value; } internal class RateResponseStatusJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/RateType.cs b/ShipEngineSDK/Model/RateType.cs index d3ee5d86..743cb036 100644 --- a/ShipEngineSDK/Model/RateType.cs +++ b/ShipEngineSDK/Model/RateType.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(RateTypeJsonConverter))] public class RateType { - private string _value; + private readonly string _value; /// /// Create a new instance of RateType with a predefined value. @@ -68,6 +68,12 @@ public RateType(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is RateType other && _value == other._value; } internal class RateTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/RatesInformation.cs b/ShipEngineSDK/Model/RatesInformation.cs index e7542ba7..484f2bf4 100644 --- a/ShipEngineSDK/Model/RatesInformation.cs +++ b/ShipEngineSDK/Model/RatesInformation.cs @@ -29,10 +29,11 @@ public partial class RatesInformation { /// - /// Gets or Sets Status CLOVUS + /// Gets or Sets Status /// - [JsonPropertyName("status")] - public RateResponseStatus? Status { get; set; } + [JsonPropertyName("status"), JsonInclude] + public RateResponseStatus? Status { get; private set; } + /// /// When the rate was created /// @@ -40,21 +41,21 @@ public partial class RatesInformation /// /// se-28529731 /// - [JsonPropertyName("created_at")] + [JsonPropertyName("created_at"), JsonPropertyOrder(1)] public string? CreatedAt { get; set; } /// /// Gets or Sets Errors /// - [JsonPropertyName("errors")] + [JsonPropertyName("errors"), JsonPropertyOrder(2)] public List? Errors { get; set; } /// /// An array of invalid shipment rates /// /// An array of invalid shipment rates - [JsonPropertyName("invalid_rates")] - public List? InvalidRates { get; set; } + [JsonPropertyName("invalid_rates"), JsonInclude] + public List? InvalidRates { get; private set; } /// /// A string that uniquely identifies the rate request @@ -63,15 +64,15 @@ public partial class RatesInformation /// /// se-28529731 /// - [JsonPropertyName("rate_request_id")] - public string? RateRequestId { get; set; } + [JsonPropertyName("rate_request_id"), JsonInclude] + public string? RateRequestId { get; private set; } /// /// An array of shipment rates /// /// An array of shipment rates - [JsonPropertyName("rates")] - public List? Rates { get; set; } + [JsonPropertyName("rates"), JsonInclude] + public List? Rates { get; private set; } /// /// A string that uniquely identifies the shipment @@ -80,8 +81,8 @@ public partial class RatesInformation /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string? ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private set; } /// diff --git a/ShipEngineSDK/Model/ReasonCode.cs b/ShipEngineSDK/Model/ReasonCode.cs index f4e5288e..7de06e38 100644 --- a/ShipEngineSDK/Model/ReasonCode.cs +++ b/ShipEngineSDK/Model/ReasonCode.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(ReasonCodeJsonConverter))] public class ReasonCode { - private string _value; + private readonly string _value; /// /// Create a new instance of ReasonCode with a predefined value. @@ -98,6 +98,12 @@ public ReasonCode(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is ReasonCode other && _value == other._value; } internal class ReasonCodeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/RecognizedEntity.cs b/ShipEngineSDK/Model/RecognizedEntity.cs index e228936b..8f341749 100644 --- a/ShipEngineSDK/Model/RecognizedEntity.cs +++ b/ShipEngineSDK/Model/RecognizedEntity.cs @@ -32,47 +32,42 @@ public partial class RecognizedEntity /// The index of the last character of this entity within the original text /// /// The index of the last character of this entity within the original text - [JsonPropertyName("end_index")] - [JsonRequired] + [JsonPropertyName("end_index"), JsonRequired, JsonPropertyOrder(1)] public required int EndIndex { get; set; } /// /// A confidence score between zero and one that indicates how certain the API is that it correctly recognized this entity /// /// A confidence score between zero and one that indicates how certain the API is that it correctly recognized this entity - [JsonPropertyName("score")] - [JsonRequired] + [JsonPropertyName("score"), JsonRequired, JsonPropertyOrder(2)] public required double Score { get; set; } /// /// The index of the first character of this entity within the original text /// /// The index of the first character of this entity within the original text - [JsonPropertyName("start_index")] - [JsonRequired] + [JsonPropertyName("start_index"), JsonRequired, JsonPropertyOrder(3)] public required int StartIndex { get; set; } /// /// The substring from the original text that was recognized as this entity /// /// The substring from the original text that was recognized as this entity - [JsonPropertyName("text")] - [JsonRequired] + [JsonPropertyName("text"), JsonRequired, JsonPropertyOrder(4)] public required string Text { get; set; } /// /// The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.) /// /// The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.) - [JsonPropertyName("type")] - [JsonRequired] + [JsonPropertyName("type"), JsonRequired, JsonPropertyOrder(5)] public required string Type { get; set; } /// /// The normalized value of the entity. Most entity results have a `value` field, which is the normalized value of the entity. For example, if the substring \"john doe\" was recognized as a \"person\" entity, then the value might be normalized to have proper capitalization (e.g. \"John Doe\"). Or if the substring \"ft worth\" was recognized as a \"city\" entity, then the value might be normalized to \"Fort Worth\". Some entities have other information in addition to, or instead of a `value`. For example, a \"dimensions\" entity will have separate fields for `length`, `width`, `height`, and `unit`. /// /// The normalized value of the entity. Most entity results have a `value` field, which is the normalized value of the entity. For example, if the substring \"john doe\" was recognized as a \"person\" entity, then the value might be normalized to have proper capitalization (e.g. \"John Doe\"). Or if the substring \"ft worth\" was recognized as a \"city\" entity, then the value might be normalized to \"Fort Worth\". Some entities have other information in addition to, or instead of a `value`. For example, a \"dimensions\" entity will have separate fields for `length`, `width`, `height`, and `unit`. - [JsonPropertyName("result")] + [JsonPropertyName("result"), JsonPropertyOrder(6)] public Dictionary? Result { get; set; } diff --git a/ShipEngineSDK/Model/Redirect.cs b/ShipEngineSDK/Model/Redirect.cs index 5f6563ed..00560d87 100644 --- a/ShipEngineSDK/Model/Redirect.cs +++ b/ShipEngineSDK/Model/Redirect.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(RedirectJsonConverter))] public class Redirect { - private string _value; + private readonly string _value; /// /// Create a new instance of Redirect with a predefined value. @@ -62,6 +62,12 @@ public Redirect(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is Redirect other && _value == other._value; } internal class RedirectJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/RegulationLevel.cs b/ShipEngineSDK/Model/RegulationLevel.cs index c303327e..0c97c939 100644 --- a/ShipEngineSDK/Model/RegulationLevel.cs +++ b/ShipEngineSDK/Model/RegulationLevel.cs @@ -28,7 +28,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(RegulationLevelJsonConverter))] public class RegulationLevel { - private string _value; + private readonly string _value; /// /// Create a new instance of RegulationLevel with a predefined value. @@ -79,6 +79,12 @@ public RegulationLevel(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is RegulationLevel other && _value == other._value; } internal class RegulationLevelJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs b/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs index ca39a749..c4021f87 100644 --- a/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs +++ b/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs @@ -32,14 +32,14 @@ public partial class RemoveFromBatchRequestBody /// Array of Rate IDs to be modifed on the batch /// /// Array of Rate IDs to be modifed on the batch - [JsonPropertyName("rate_ids")] + [JsonPropertyName("rate_ids"), JsonPropertyOrder(1)] public List? RateIds { get; set; } /// /// The Shipment Ids to be modified on the batch /// /// The Shipment Ids to be modified on the batch - [JsonPropertyName("shipment_ids")] + [JsonPropertyName("shipment_ids"), JsonPropertyOrder(2)] public List? ShipmentIds { get; set; } diff --git a/ShipEngineSDK/Model/ResponseMessage.cs b/ShipEngineSDK/Model/ResponseMessage.cs index 94c940c5..319511cd 100644 --- a/ShipEngineSDK/Model/ResponseMessage.cs +++ b/ShipEngineSDK/Model/ResponseMessage.cs @@ -29,28 +29,22 @@ public partial class ResponseMessage { /// - /// Gets or Sets Code CLOVUS + /// Gets or Sets Code /// - [JsonPropertyName("code")] - [JsonRequired] - public required AddressValidationCode Code { get; set; } = new(); - + [JsonPropertyName("code"), JsonInclude] + public AddressValidationCode? Code { get; private set; } /// - /// Gets or Sets Type CLOVUS + /// Gets or Sets Type /// - [JsonPropertyName("type")] - [JsonRequired] - public required AddressValidationMessageType Type { get; set; } = new(); - + [JsonPropertyName("type"), JsonInclude] + public AddressValidationMessageType? Type { get; private set; } /// - /// Gets or Sets DetailCode CLOVUS + /// Gets or Sets DetailCode /// - [JsonPropertyName("detail_code")] - [JsonRequired] - public required AddressValidationDetailCode DetailCode { get; set; } = new(); - + [JsonPropertyName("detail_code"), JsonRequired, JsonPropertyOrder(4)] + public required AddressValidationDetailCode DetailCode { get; set; } /// /// Message explaining the address validation error @@ -59,9 +53,8 @@ public partial class ResponseMessage /// /// Invalid Postal Code /// - [JsonPropertyName("message")] - [JsonRequired] - public required string Message { get; set; } + [JsonPropertyName("message"), JsonInclude] + public string? Message { get; private set; } /// diff --git a/ShipEngineSDK/Model/SchedulePickupRequestBody.cs b/ShipEngineSDK/Model/SchedulePickupRequestBody.cs index 34b62aa6..a99c2654 100644 --- a/ShipEngineSDK/Model/SchedulePickupRequestBody.cs +++ b/ShipEngineSDK/Model/SchedulePickupRequestBody.cs @@ -31,23 +31,20 @@ public partial class SchedulePickupRequestBody /// /// Gets or Sets ContactDetails /// - [JsonPropertyName("contact_details")] - [JsonRequired] + [JsonPropertyName("contact_details"), JsonRequired, JsonPropertyOrder(1)] public required ContactDetails ContactDetails { get; set; } /// /// Label IDs that will be included in the pickup request /// /// Label IDs that will be included in the pickup request - [JsonPropertyName("label_ids")] - [JsonRequired] + [JsonPropertyName("label_ids"), JsonRequired, JsonPropertyOrder(2)] public required List LabelIds { get; set; } /// /// Gets or Sets PickupWindow /// - [JsonPropertyName("pickup_window")] - [JsonRequired] + [JsonPropertyName("pickup_window"), JsonRequired, JsonPropertyOrder(3)] public required PickupWindow PickupWindow { get; set; } /// @@ -57,8 +54,8 @@ public partial class SchedulePickupRequestBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("cancelled_at")] - public DateTimeOffset? CancelledAt { get; set; } + [JsonPropertyName("cancelled_at"), JsonInclude] + public DateTimeOffset? CancelledAt { get; private set; } /// /// The carrier_id associated with the pickup @@ -67,8 +64,8 @@ public partial class SchedulePickupRequestBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - public string? CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// The carrier confirmation number for the scheduled pickup. @@ -77,8 +74,8 @@ public partial class SchedulePickupRequestBody /// /// 292513CL4A3 /// - [JsonPropertyName("confirmation_number")] - public string? ConfirmationNumber { get; set; } + [JsonPropertyName("confirmation_number"), JsonInclude] + public string? ConfirmationNumber { get; private set; } /// /// The date and time that the pickup was created in ShipEngine. @@ -87,14 +84,14 @@ public partial class SchedulePickupRequestBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// Gets or Sets PickupAddress /// - [JsonPropertyName("pickup_address")] - public Address? PickupAddress { get; set; } + [JsonPropertyName("pickup_address"), JsonInclude] + public Address? PickupAddress { get; private set; } /// /// Pickup Resource ID @@ -103,22 +100,22 @@ public partial class SchedulePickupRequestBody /// /// pik_3YcKU5zdtJuCqoeNwyqqbW /// - [JsonPropertyName("pickup_id")] - public string? PickupId { get; set; } + [JsonPropertyName("pickup_id"), JsonInclude] + public string? PickupId { get; private set; } /// /// Used by some carriers to give special instructions for a package pickup /// /// Used by some carriers to give special instructions for a package pickup - [JsonPropertyName("pickup_notes")] + [JsonPropertyName("pickup_notes"), JsonPropertyOrder(10)] public string? PickupNotes { get; set; } /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. - [JsonPropertyName("pickup_windows")] - public List? PickupWindows { get; set; } + [JsonPropertyName("pickup_windows"), JsonInclude] + public List? PickupWindows { get; private set; } /// /// The warehouse_id associated with the pickup @@ -127,8 +124,8 @@ public partial class SchedulePickupRequestBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] - public string? WarehouseId { get; set; } + [JsonPropertyName("warehouse_id"), JsonInclude] + public string? WarehouseId { get; private set; } /// diff --git a/ShipEngineSDK/Model/SchedulePickupResponseBody.cs b/ShipEngineSDK/Model/SchedulePickupResponseBody.cs index d008e910..c54735bb 100644 --- a/ShipEngineSDK/Model/SchedulePickupResponseBody.cs +++ b/ShipEngineSDK/Model/SchedulePickupResponseBody.cs @@ -32,9 +32,8 @@ public partial class SchedulePickupResponseBody /// The errors associated with the failed API call /// /// The errors associated with the failed API call - [JsonPropertyName("errors")] - [JsonRequired] - public required List Errors { get; set; } + [JsonPropertyName("errors"), JsonInclude] + public List? Errors { get; private set; } /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur @@ -43,8 +42,7 @@ public partial class SchedulePickupResponseBody /// /// aa3d8e8e-462b-4476-9618-72db7f7b7009 /// - [JsonPropertyName("request_id")] - [JsonRequired] + [JsonPropertyName("request_id"), JsonRequired, JsonPropertyOrder(2)] public required Guid RequestId { get; set; } /// @@ -54,8 +52,8 @@ public partial class SchedulePickupResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("cancelled_at")] - public DateTimeOffset? CancelledAt { get; set; } + [JsonPropertyName("cancelled_at"), JsonInclude] + public DateTimeOffset? CancelledAt { get; private set; } /// /// The carrier_id associated with the pickup @@ -64,8 +62,8 @@ public partial class SchedulePickupResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - public string? CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// The carrier confirmation number for the scheduled pickup. @@ -74,13 +72,13 @@ public partial class SchedulePickupResponseBody /// /// 292513CL4A3 /// - [JsonPropertyName("confirmation_number")] - public string? ConfirmationNumber { get; set; } + [JsonPropertyName("confirmation_number"), JsonInclude] + public string? ConfirmationNumber { get; private set; } /// /// Gets or Sets ContactDetails /// - [JsonPropertyName("contact_details")] + [JsonPropertyName("contact_details"), JsonPropertyOrder(6)] public ContactDetails? ContactDetails { get; set; } /// @@ -90,21 +88,21 @@ public partial class SchedulePickupResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// Label IDs that will be included in the pickup request /// /// Label IDs that will be included in the pickup request - [JsonPropertyName("label_ids")] + [JsonPropertyName("label_ids"), JsonPropertyOrder(8)] public List? LabelIds { get; set; } /// /// Gets or Sets PickupAddress /// - [JsonPropertyName("pickup_address")] - public Address? PickupAddress { get; set; } + [JsonPropertyName("pickup_address"), JsonInclude] + public Address? PickupAddress { get; private set; } /// /// Pickup Resource ID @@ -113,28 +111,28 @@ public partial class SchedulePickupResponseBody /// /// pik_3YcKU5zdtJuCqoeNwyqqbW /// - [JsonPropertyName("pickup_id")] - public string? PickupId { get; set; } + [JsonPropertyName("pickup_id"), JsonInclude] + public string? PickupId { get; private set; } /// /// Used by some carriers to give special instructions for a package pickup /// /// Used by some carriers to give special instructions for a package pickup - [JsonPropertyName("pickup_notes")] + [JsonPropertyName("pickup_notes"), JsonPropertyOrder(11)] public string? PickupNotes { get; set; } /// /// Gets or Sets PickupWindow /// - [JsonPropertyName("pickup_window")] + [JsonPropertyName("pickup_window"), JsonPropertyOrder(12)] public PickupWindow? PickupWindow { get; set; } /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. - [JsonPropertyName("pickup_windows")] - public List? PickupWindows { get; set; } + [JsonPropertyName("pickup_windows"), JsonInclude] + public List? PickupWindows { get; private set; } /// /// The warehouse_id associated with the pickup @@ -143,8 +141,8 @@ public partial class SchedulePickupResponseBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] - public string? WarehouseId { get; set; } + [JsonPropertyName("warehouse_id"), JsonInclude] + public string? WarehouseId { get; private set; } /// diff --git a/ShipEngineSDK/Model/Service.cs b/ShipEngineSDK/Model/Service.cs index c42b3afc..5c858cc4 100644 --- a/ShipEngineSDK/Model/Service.cs +++ b/ShipEngineSDK/Model/Service.cs @@ -35,7 +35,7 @@ public partial class Service /// /// se-28529731 /// - [JsonPropertyName("carrier_code")] + [JsonPropertyName("carrier_code"), JsonPropertyOrder(1)] public string? CarrierCode { get; set; } /// @@ -45,29 +45,29 @@ public partial class Service /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - public string? CarrierId { get; set; } + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; private set; } /// /// Supports domestic shipping /// /// Supports domestic shipping - [JsonPropertyName("domestic")] - public bool? Domestic { get; set; } + [JsonPropertyName("domestic"), JsonInclude] + public bool? Domestic { get; private set; } /// /// Supports international shipping. /// /// Supports international shipping. - [JsonPropertyName("international")] - public bool? International { get; set; } + [JsonPropertyName("international"), JsonInclude] + public bool? International { get; private set; } /// /// Carrier supports multiple packages per shipment /// /// Carrier supports multiple packages per shipment - [JsonPropertyName("is_multi_package_supported")] - public bool? IsMultiPackageSupported { get; set; } + [JsonPropertyName("is_multi_package_supported"), JsonInclude] + public bool? IsMultiPackageSupported { get; private set; } /// /// User friendly service name @@ -76,8 +76,8 @@ public partial class Service /// /// USPS First Class Mail /// - [JsonPropertyName("name")] - public string? Name { get; set; } + [JsonPropertyName("name"), JsonInclude] + public string? Name { get; private set; } /// /// service code @@ -86,8 +86,8 @@ public partial class Service /// /// usps_media_mail /// - [JsonPropertyName("service_code")] - public string? ServiceCode { get; set; } + [JsonPropertyName("service_code"), JsonInclude] + public string? ServiceCode { get; private set; } /// diff --git a/ShipEngineSDK/Model/Shipment.cs b/ShipEngineSDK/Model/Shipment.cs index 5daf2b3a..f289015e 100644 --- a/ShipEngineSDK/Model/Shipment.cs +++ b/ShipEngineSDK/Model/Shipment.cs @@ -29,43 +29,37 @@ public partial class Shipment { /// - /// The type of delivery confirmation that is required for this shipment. CLOVUS + /// The type of delivery confirmation that is required for this shipment. /// /// The type of delivery confirmation that is required for this shipment. - [JsonPropertyName("confirmation")] - [JsonRequired] - public required DeliveryConfirmation Confirmation { get; set; } = new(); - + [JsonPropertyName("confirmation"), JsonRequired, JsonPropertyOrder(3)] + public required DeliveryConfirmation Confirmation { get; set; } /// - /// The insurance provider to use for any insured packages in the shipment. CLOVUS + /// The insurance provider to use for any insured packages in the shipment. /// /// The insurance provider to use for any insured packages in the shipment. - [JsonPropertyName("insurance_provider")] - [JsonRequired] - public required InsuranceProvider InsuranceProvider { get; set; } = new(); - + [JsonPropertyName("insurance_provider"), JsonRequired, JsonPropertyOrder(5)] + public required InsuranceProvider InsuranceProvider { get; set; } /// - /// The current status of the shipment CLOVUS + /// The current status of the shipment /// /// The current status of the shipment - [JsonPropertyName("shipment_status")] - [JsonRequired] - public required ShipmentStatus ShipmentStatus { get; set; } = new(); - + [JsonPropertyName("shipment_status"), JsonInclude] + public ShipmentStatus? ShipmentStatus { get; private set; } /// - /// Gets or Sets OrderSourceCode CLOVUS + /// Gets or Sets OrderSourceCode /// - [JsonPropertyName("order_source_code")] + [JsonPropertyName("order_source_code"), JsonPropertyOrder(23)] public OrderSourceName? OrderSourceCode { get; set; } + /// /// Advanced shipment options. These are entirely optional. /// /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options")] - [JsonRequired] + [JsonPropertyName("advanced_options"), JsonRequired, JsonPropertyOrder(1)] public required AdvancedShipmentOptions AdvancedOptions { get; set; } /// @@ -75,8 +69,7 @@ public partial class Shipment /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [JsonRequired] + [JsonPropertyName("carrier_id"), JsonRequired, JsonPropertyOrder(2)] public required string CarrierId { get; set; } /// @@ -86,9 +79,8 @@ public partial class Shipment /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - [JsonRequired] - public required DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// The date and time that the shipment was created or last modified. @@ -97,24 +89,21 @@ public partial class Shipment /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("modified_at")] - [JsonRequired] - public required DateTimeOffset ModifiedAt { get; set; } + [JsonPropertyName("modified_at"), JsonInclude] + public DateTimeOffset? ModifiedAt { get; private set; } /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - [JsonRequired] + [JsonPropertyName("packages"), JsonRequired, JsonPropertyOrder(7)] public required List Packages { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. /// /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to")] - [JsonRequired] + [JsonPropertyName("return_to"), JsonRequired, JsonPropertyOrder(8)] public required ShippingAddress ReturnTo { get; set; } /// @@ -124,8 +113,7 @@ public partial class Shipment /// /// usps_first_class_mail /// - [JsonPropertyName("service_code")] - [JsonRequired] + [JsonPropertyName("service_code"), JsonRequired, JsonPropertyOrder(9)] public required string ServiceCode { get; set; } /// @@ -135,24 +123,21 @@ public partial class Shipment /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date")] - [JsonRequired] + [JsonPropertyName("ship_date"), JsonRequired, JsonPropertyOrder(10)] public required DateTimeOffset ShipDate { get; set; } /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from")] - [JsonRequired] + [JsonPropertyName("ship_from"), JsonRequired, JsonPropertyOrder(11)] public required ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address /// /// The recipient's mailing address - [JsonPropertyName("ship_to")] - [JsonRequired] + [JsonPropertyName("ship_to"), JsonRequired, JsonPropertyOrder(12)] public required ShippingAddressTo ShipTo { get; set; } /// @@ -162,25 +147,22 @@ public partial class Shipment /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - [JsonRequired] - public required string ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. - [JsonPropertyName("tags")] - [JsonRequired] - public required List Tags { get; set; } + [JsonPropertyName("tags"), JsonInclude] + public List? Tags { get; private set; } /// /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment - [JsonPropertyName("total_weight")] - [JsonRequired] - public required Weight TotalWeight { get; set; } + [JsonPropertyName("total_weight"), JsonInclude] + public Weight? TotalWeight { get; private set; } /// /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. @@ -189,50 +171,49 @@ public partial class Shipment /// /// retail /// - [JsonPropertyName("comparison_rate_type")] + [JsonPropertyName("comparison_rate_type"), JsonPropertyOrder(17)] public string? ComparisonRateType { get; set; } /// /// Customs information. This is usually only needed for international shipments. /// /// Customs information. This is usually only needed for international shipments. - [JsonPropertyName("customs")] - [JsonRequired] + [JsonPropertyName("customs"), JsonRequired, JsonPropertyOrder(18)] public required InternationalShipmentOptions Customs { get; set; } /// /// ID that the Order Source assigned /// /// ID that the Order Source assigned - [JsonPropertyName("external_order_id")] + [JsonPropertyName("external_order_id"), JsonPropertyOrder(19)] public string? ExternalOrderId { get; set; } /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("external_shipment_id")] + [JsonPropertyName("external_shipment_id"), JsonPropertyOrder(20)] public string? ExternalShipmentId { get; set; } /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. - [JsonPropertyName("is_return")] + [JsonPropertyName("is_return"), JsonPropertyOrder(21)] public bool? IsReturn { get; set; } /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - [JsonPropertyName("items")] + [JsonPropertyName("items"), JsonPropertyOrder(22)] public List? Items { get; set; } /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("shipment_number")] + [JsonPropertyName("shipment_number"), JsonPropertyOrder(24)] public string? ShipmentNumber { get; set; } /// @@ -242,13 +223,13 @@ public partial class Shipment /// /// se-28529731 /// - [JsonPropertyName("shipping_rule_id")] + [JsonPropertyName("shipping_rule_id"), JsonPropertyOrder(25)] public string? ShippingRuleId { get; set; } /// /// Gets or Sets TaxIdentifiers /// - [JsonPropertyName("tax_identifiers")] + [JsonPropertyName("tax_identifiers"), JsonPropertyOrder(26)] public List? TaxIdentifiers { get; set; } /// @@ -258,8 +239,7 @@ public partial class Shipment /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] - [JsonRequired] + [JsonPropertyName("warehouse_id"), JsonRequired, JsonPropertyOrder(27)] public required string WarehouseId { get; set; } diff --git a/ShipEngineSDK/Model/ShipmentIdRequest.cs b/ShipEngineSDK/Model/ShipmentIdRequest.cs index 4da6ce01..7803faf0 100644 --- a/ShipEngineSDK/Model/ShipmentIdRequest.cs +++ b/ShipEngineSDK/Model/ShipmentIdRequest.cs @@ -35,7 +35,7 @@ public partial class ShipmentIdRequest /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] + [JsonPropertyName("shipment_id"), JsonPropertyOrder(1)] public string? ShipmentId { get; set; } diff --git a/ShipEngineSDK/Model/ShipmentItem.cs b/ShipEngineSDK/Model/ShipmentItem.cs index 720b8cfb..2f1f98a3 100644 --- a/ShipEngineSDK/Model/ShipmentItem.cs +++ b/ShipEngineSDK/Model/ShipmentItem.cs @@ -29,10 +29,11 @@ public partial class ShipmentItem { /// - /// Gets or Sets OrderSourceCode CLOVUS + /// Gets or Sets OrderSourceCode /// - [JsonPropertyName("order_source_code")] + [JsonPropertyName("order_source_code"), JsonPropertyOrder(5)] public OrderSourceName? OrderSourceCode { get; set; } + /// /// Amazon Standard Identification Number /// @@ -40,56 +41,56 @@ public partial class ShipmentItem /// /// B00005N5PF /// - [JsonPropertyName("asin")] + [JsonPropertyName("asin"), JsonPropertyOrder(1)] public string? Asin { get; set; } /// /// external order id /// /// external order id - [JsonPropertyName("external_order_id")] + [JsonPropertyName("external_order_id"), JsonPropertyOrder(2)] public string? ExternalOrderId { get; set; } /// /// external order item id /// /// external order item id - [JsonPropertyName("external_order_item_id")] + [JsonPropertyName("external_order_item_id"), JsonPropertyOrder(3)] public string? ExternalOrderItemId { get; set; } /// /// item name /// /// item name - [JsonPropertyName("name")] + [JsonPropertyName("name"), JsonPropertyOrder(4)] public string? Name { get; set; } /// /// The quantity of this item included in the shipment /// /// The quantity of this item included in the shipment - [JsonPropertyName("quantity")] + [JsonPropertyName("quantity"), JsonPropertyOrder(6)] public int? Quantity { get; set; } /// /// sales order id /// /// sales order id - [JsonPropertyName("sales_order_id")] + [JsonPropertyName("sales_order_id"), JsonPropertyOrder(7)] public string? SalesOrderId { get; set; } /// /// sales order item id /// /// sales order item id - [JsonPropertyName("sales_order_item_id")] + [JsonPropertyName("sales_order_item_id"), JsonPropertyOrder(8)] public string? SalesOrderItemId { get; set; } /// /// Item Stock Keeping Unit /// /// Item Stock Keeping Unit - [JsonPropertyName("sku")] + [JsonPropertyName("sku"), JsonPropertyOrder(9)] public string? Sku { get; set; } diff --git a/ShipEngineSDK/Model/ShipmentRequest.cs b/ShipEngineSDK/Model/ShipmentRequest.cs index 186d282c..4b31a201 100644 --- a/ShipEngineSDK/Model/ShipmentRequest.cs +++ b/ShipEngineSDK/Model/ShipmentRequest.cs @@ -32,7 +32,7 @@ public partial class ShipmentRequest /// The shipment object /// /// The shipment object - [JsonPropertyName("shipment")] + [JsonPropertyName("shipment"), JsonPropertyOrder(1)] public AddressValidatingShipment? Shipment { get; set; } diff --git a/ShipEngineSDK/Model/ShipmentStatus.cs b/ShipEngineSDK/Model/ShipmentStatus.cs index 301fa15d..954476e7 100644 --- a/ShipEngineSDK/Model/ShipmentStatus.cs +++ b/ShipEngineSDK/Model/ShipmentStatus.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(ShipmentStatusJsonConverter))] public class ShipmentStatus { - private string _value; + private readonly string _value; /// /// Create a new instance of ShipmentStatus with a predefined value. @@ -80,6 +80,12 @@ public ShipmentStatus(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is ShipmentStatus other && _value == other._value; } internal class ShipmentStatusJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/ShipmentsSortBy.cs b/ShipEngineSDK/Model/ShipmentsSortBy.cs index cf184e1f..5440d5d4 100644 --- a/ShipEngineSDK/Model/ShipmentsSortBy.cs +++ b/ShipEngineSDK/Model/ShipmentsSortBy.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(ShipmentsSortByJsonConverter))] public class ShipmentsSortBy { - private string _value; + private readonly string _value; /// /// Create a new instance of ShipmentsSortBy with a predefined value. @@ -68,6 +68,12 @@ public ShipmentsSortBy(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is ShipmentsSortBy other && _value == other._value; } internal class ShipmentsSortByJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/ShippingAddress.cs b/ShipEngineSDK/Model/ShippingAddress.cs index bea1cfab..657a277e 100644 --- a/ShipEngineSDK/Model/ShippingAddress.cs +++ b/ShipEngineSDK/Model/ShippingAddress.cs @@ -29,13 +29,11 @@ public partial class ShippingAddress { /// - /// Indicates whether this is a residential address. CLOVUS + /// Indicates whether this is a residential address. /// /// Indicates whether this is a residential address. - [JsonPropertyName("address_residential_indicator")] - [JsonRequired] - public required AddressResidentialIndicator AddressResidentialIndicator { get; set; } = new(); - + [JsonPropertyName("address_residential_indicator"), JsonRequired, JsonPropertyOrder(2)] + public required AddressResidentialIndicator AddressResidentialIndicator { get; set; } /// /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. @@ -44,8 +42,7 @@ public partial class ShippingAddress /// /// 1999 Bishop Grandin Blvd. /// - [JsonPropertyName("address_line1")] - [JsonRequired] + [JsonPropertyName("address_line1"), JsonRequired, JsonPropertyOrder(1)] public required string AddressLine1 { get; set; } /// @@ -55,8 +52,7 @@ public partial class ShippingAddress /// /// Winnipeg /// - [JsonPropertyName("city_locality")] - [JsonRequired] + [JsonPropertyName("city_locality"), JsonRequired, JsonPropertyOrder(3)] public required string CityLocality { get; set; } /// @@ -66,8 +62,7 @@ public partial class ShippingAddress /// /// CA /// - [JsonPropertyName("country_code")] - [JsonRequired] + [JsonPropertyName("country_code"), JsonRequired, JsonPropertyOrder(4)] public required string CountryCode { get; set; } /// @@ -77,8 +72,7 @@ public partial class ShippingAddress /// /// John Doe /// - [JsonPropertyName("name")] - [JsonRequired] + [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(5)] public required string Name { get; set; } /// @@ -88,8 +82,7 @@ public partial class ShippingAddress /// /// +1 204-253-9411 ext. 123 /// - [JsonPropertyName("phone")] - [JsonRequired] + [JsonPropertyName("phone"), JsonRequired, JsonPropertyOrder(6)] public required string Phone { get; set; } /// @@ -99,8 +92,7 @@ public partial class ShippingAddress /// /// 78756-3717 /// - [JsonPropertyName("postal_code")] - [JsonRequired] + [JsonPropertyName("postal_code"), JsonRequired, JsonPropertyOrder(7)] public required string PostalCode { get; set; } /// @@ -110,8 +102,7 @@ public partial class ShippingAddress /// /// Manitoba /// - [JsonPropertyName("state_province")] - [JsonRequired] + [JsonPropertyName("state_province"), JsonRequired, JsonPropertyOrder(8)] public required string StateProvince { get; set; } /// @@ -121,7 +112,7 @@ public partial class ShippingAddress /// /// Unit 408 /// - [JsonPropertyName("address_line2")] + [JsonPropertyName("address_line2"), JsonPropertyOrder(9)] public string? AddressLine2 { get; set; } /// @@ -131,7 +122,7 @@ public partial class ShippingAddress /// /// Building #7 /// - [JsonPropertyName("address_line3")] + [JsonPropertyName("address_line3"), JsonPropertyOrder(10)] public string? AddressLine3 { get; set; } /// @@ -141,7 +132,7 @@ public partial class ShippingAddress /// /// The Home Depot /// - [JsonPropertyName("company_name")] + [JsonPropertyName("company_name"), JsonPropertyOrder(11)] public string? CompanyName { get; set; } /// @@ -151,14 +142,14 @@ public partial class ShippingAddress /// /// example@example.com /// - [JsonPropertyName("email")] + [JsonPropertyName("email"), JsonPropertyOrder(12)] public string? Email { get; set; } /// /// Additional text about how to handle the shipment at this address. /// /// Additional text about how to handle the shipment at this address. - [JsonPropertyName("instructions")] + [JsonPropertyName("instructions"), JsonPropertyOrder(13)] public string? Instructions { get; set; } diff --git a/ShipEngineSDK/Model/ShippingAddressTo.cs b/ShipEngineSDK/Model/ShippingAddressTo.cs index 15f138c1..9836d8c7 100644 --- a/ShipEngineSDK/Model/ShippingAddressTo.cs +++ b/ShipEngineSDK/Model/ShippingAddressTo.cs @@ -29,13 +29,11 @@ public partial class ShippingAddressTo { /// - /// Indicates whether this is a residential address. CLOVUS + /// Indicates whether this is a residential address. /// /// Indicates whether this is a residential address. - [JsonPropertyName("address_residential_indicator")] - [JsonRequired] - public required AddressResidentialIndicator AddressResidentialIndicator { get; set; } = new(); - + [JsonPropertyName("address_residential_indicator"), JsonRequired, JsonPropertyOrder(2)] + public required AddressResidentialIndicator AddressResidentialIndicator { get; set; } /// /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. @@ -44,8 +42,7 @@ public partial class ShippingAddressTo /// /// 1999 Bishop Grandin Blvd. /// - [JsonPropertyName("address_line1")] - [JsonRequired] + [JsonPropertyName("address_line1"), JsonRequired, JsonPropertyOrder(1)] public required string AddressLine1 { get; set; } /// @@ -55,8 +52,7 @@ public partial class ShippingAddressTo /// /// Winnipeg /// - [JsonPropertyName("city_locality")] - [JsonRequired] + [JsonPropertyName("city_locality"), JsonRequired, JsonPropertyOrder(3)] public required string CityLocality { get; set; } /// @@ -66,8 +62,7 @@ public partial class ShippingAddressTo /// /// CA /// - [JsonPropertyName("country_code")] - [JsonRequired] + [JsonPropertyName("country_code"), JsonRequired, JsonPropertyOrder(4)] public required string CountryCode { get; set; } /// @@ -77,8 +72,7 @@ public partial class ShippingAddressTo /// /// John Doe /// - [JsonPropertyName("name")] - [JsonRequired] + [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(5)] public required string Name { get; set; } /// @@ -88,8 +82,7 @@ public partial class ShippingAddressTo /// /// +1 204-253-9411 ext. 123 /// - [JsonPropertyName("phone")] - [JsonRequired] + [JsonPropertyName("phone"), JsonRequired, JsonPropertyOrder(6)] public required string Phone { get; set; } /// @@ -99,8 +92,7 @@ public partial class ShippingAddressTo /// /// 78756-3717 /// - [JsonPropertyName("postal_code")] - [JsonRequired] + [JsonPropertyName("postal_code"), JsonRequired, JsonPropertyOrder(7)] public required string PostalCode { get; set; } /// @@ -110,8 +102,7 @@ public partial class ShippingAddressTo /// /// Manitoba /// - [JsonPropertyName("state_province")] - [JsonRequired] + [JsonPropertyName("state_province"), JsonRequired, JsonPropertyOrder(8)] public required string StateProvince { get; set; } /// @@ -121,7 +112,7 @@ public partial class ShippingAddressTo /// /// Unit 408 /// - [JsonPropertyName("address_line2")] + [JsonPropertyName("address_line2"), JsonPropertyOrder(9)] public string? AddressLine2 { get; set; } /// @@ -131,7 +122,7 @@ public partial class ShippingAddressTo /// /// Building #7 /// - [JsonPropertyName("address_line3")] + [JsonPropertyName("address_line3"), JsonPropertyOrder(10)] public string? AddressLine3 { get; set; } /// @@ -141,7 +132,7 @@ public partial class ShippingAddressTo /// /// The Home Depot /// - [JsonPropertyName("company_name")] + [JsonPropertyName("company_name"), JsonPropertyOrder(11)] public string? CompanyName { get; set; } /// @@ -151,20 +142,20 @@ public partial class ShippingAddressTo /// /// example@example.com /// - [JsonPropertyName("email")] + [JsonPropertyName("email"), JsonPropertyOrder(12)] public string? Email { get; set; } /// /// Gets or Sets Geolocation /// - [JsonPropertyName("geolocation")] + [JsonPropertyName("geolocation"), JsonPropertyOrder(13)] public List? Geolocation { get; set; } /// /// Additional text about how to handle the shipment at this address. /// /// Additional text about how to handle the shipment at this address. - [JsonPropertyName("instructions")] + [JsonPropertyName("instructions"), JsonPropertyOrder(14)] public string? Instructions { get; set; } diff --git a/ShipEngineSDK/Model/SmartPostHub.cs b/ShipEngineSDK/Model/SmartPostHub.cs index d13f06d1..8f68aa31 100644 --- a/ShipEngineSDK/Model/SmartPostHub.cs +++ b/ShipEngineSDK/Model/SmartPostHub.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(SmartPostHubJsonConverter))] public class SmartPostHub { - private string _value; + private readonly string _value; /// /// Create a new instance of SmartPostHub with a predefined value. @@ -260,6 +260,12 @@ public SmartPostHub(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is SmartPostHub other && _value == other._value; } internal class SmartPostHubJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/SortDir.cs b/ShipEngineSDK/Model/SortDir.cs index 01eb52f0..db392f43 100644 --- a/ShipEngineSDK/Model/SortDir.cs +++ b/ShipEngineSDK/Model/SortDir.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(SortDirJsonConverter))] public class SortDir { - private string _value; + private readonly string _value; /// /// Create a new instance of SortDir with a predefined value. @@ -68,6 +68,12 @@ public SortDir(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is SortDir other && _value == other._value; } internal class SortDirJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/StatusCode.cs b/ShipEngineSDK/Model/StatusCode.cs index f41238b7..202d10d5 100644 --- a/ShipEngineSDK/Model/StatusCode.cs +++ b/ShipEngineSDK/Model/StatusCode.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(StatusCodeJsonConverter))] public class StatusCode { - private string _value; + private readonly string _value; /// /// Create a new instance of StatusCode with a predefined value. @@ -98,6 +98,12 @@ public StatusCode(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is StatusCode other && _value == other._value; } internal class StatusCodeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/Tag.cs b/ShipEngineSDK/Model/Tag.cs index 05d25deb..303e7b64 100644 --- a/ShipEngineSDK/Model/Tag.cs +++ b/ShipEngineSDK/Model/Tag.cs @@ -35,8 +35,7 @@ public partial class Tag /// /// Fragile /// - [JsonPropertyName("name")] - [JsonRequired] + [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(1)] public required string Name { get; set; } diff --git a/ShipEngineSDK/Model/TagShipmentResponseBody.cs b/ShipEngineSDK/Model/TagShipmentResponseBody.cs index cb344ed9..09421417 100644 --- a/ShipEngineSDK/Model/TagShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/TagShipmentResponseBody.cs @@ -31,8 +31,7 @@ public partial class TagShipmentResponseBody /// /// Gets or Sets Tags /// - [JsonPropertyName("tags")] - [JsonRequired] + [JsonPropertyName("tags"), JsonRequired, JsonPropertyOrder(1)] public required List Tags { get; set; } diff --git a/ShipEngineSDK/Model/TaxIdentifier.cs b/ShipEngineSDK/Model/TaxIdentifier.cs index 7be7a82c..23d78e21 100644 --- a/ShipEngineSDK/Model/TaxIdentifier.cs +++ b/ShipEngineSDK/Model/TaxIdentifier.cs @@ -29,35 +29,29 @@ public partial class TaxIdentifier { /// - /// Gets or Sets IdentifierType CLOVUS + /// Gets or Sets IdentifierType /// - [JsonPropertyName("identifier_type")] - [JsonRequired] - public required IdentifierType IdentifierType { get; set; } = new(); - + [JsonPropertyName("identifier_type"), JsonRequired, JsonPropertyOrder(1)] + public required IdentifierType IdentifierType { get; set; } /// - /// Gets or Sets TaxableEntityType CLOVUS + /// Gets or Sets TaxableEntityType /// - [JsonPropertyName("taxable_entity_type")] - [JsonRequired] - public required TaxableEntityType TaxableEntityType { get; set; } = new(); - + [JsonPropertyName("taxable_entity_type"), JsonRequired, JsonPropertyOrder(3)] + public required TaxableEntityType TaxableEntityType { get; set; } /// /// The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code. /// /// The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code. - [JsonPropertyName("issuing_authority")] - [JsonRequired] + [JsonPropertyName("issuing_authority"), JsonRequired, JsonPropertyOrder(2)] public required string IssuingAuthority { get; set; } /// /// The value of the identifier /// /// The value of the identifier - [JsonPropertyName("value")] - [JsonRequired] + [JsonPropertyName("value"), JsonRequired, JsonPropertyOrder(4)] public required string Value { get; set; } diff --git a/ShipEngineSDK/Model/TaxableEntityType.cs b/ShipEngineSDK/Model/TaxableEntityType.cs index e8969517..74dd8559 100644 --- a/ShipEngineSDK/Model/TaxableEntityType.cs +++ b/ShipEngineSDK/Model/TaxableEntityType.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(TaxableEntityTypeJsonConverter))] public class TaxableEntityType { - private string _value; + private readonly string _value; /// /// Create a new instance of TaxableEntityType with a predefined value. @@ -74,6 +74,12 @@ public TaxableEntityType(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is TaxableEntityType other && _value == other._value; } internal class TaxableEntityTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs b/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs index 6da37e3f..f8a42f28 100644 --- a/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs +++ b/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs @@ -32,14 +32,14 @@ public partial class TokensGetEphemeralTokenResponseBodyYaml /// The redirect url formatted with the requested token. /// /// The redirect url formatted with the requested token. - [JsonPropertyName("redirect_url")] + [JsonPropertyName("redirect_url"), JsonPropertyOrder(1)] public string? RedirectUrl { get; set; } /// /// The requested token that expires in 10 seconds. /// /// The requested token that expires in 10 seconds. - [JsonPropertyName("token")] + [JsonPropertyName("token"), JsonPropertyOrder(2)] public string? Token { get; set; } diff --git a/ShipEngineSDK/Model/TrackEvent.cs b/ShipEngineSDK/Model/TrackEvent.cs index 7ea6d404..325e1cc7 100644 --- a/ShipEngineSDK/Model/TrackEvent.cs +++ b/ShipEngineSDK/Model/TrackEvent.cs @@ -29,12 +29,10 @@ public partial class TrackEvent { /// - /// Gets or Sets StatusCode CLOVUS + /// Gets or Sets StatusCode /// - [JsonPropertyName("status_code")] - [JsonRequired] - public required StatusCode StatusCode { get; set; } = new(); - + [JsonPropertyName("status_code"), JsonRequired, JsonPropertyOrder(8)] + public required StatusCode StatusCode { get; set; } /// /// Carrier detail code @@ -43,9 +41,8 @@ public partial class TrackEvent /// /// OT /// - [JsonPropertyName("carrier_detail_code")] - [JsonRequired] - public required string CarrierDetailCode { get; set; } + [JsonPropertyName("carrier_detail_code"), JsonInclude] + public string? CarrierDetailCode { get; private set; } /// /// Carrier status code @@ -54,9 +51,8 @@ public partial class TrackEvent /// /// 1 /// - [JsonPropertyName("carrier_status_code")] - [JsonRequired] - public required string CarrierStatusCode { get; set; } + [JsonPropertyName("carrier_status_code"), JsonInclude] + public string? CarrierStatusCode { get; private set; } /// /// carrier status description @@ -65,9 +61,8 @@ public partial class TrackEvent /// /// Your item was delivered in or at the mailbox at 9:10 am on March /// - [JsonPropertyName("carrier_status_description")] - [JsonRequired] - public required string CarrierStatusDescription { get; set; } + [JsonPropertyName("carrier_status_description"), JsonInclude] + public string? CarrierStatusDescription { get; private set; } /// /// City locality @@ -76,9 +71,8 @@ public partial class TrackEvent /// /// AUSTIN /// - [JsonPropertyName("city_locality")] - [JsonRequired] - public required string CityLocality { get; set; } + [JsonPropertyName("city_locality"), JsonInclude] + public string? CityLocality { get; private set; } /// /// Timestamp for carrier event @@ -87,8 +81,7 @@ public partial class TrackEvent /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("occurred_at")] - [JsonRequired] + [JsonPropertyName("occurred_at"), JsonRequired, JsonPropertyOrder(5)] public required DateTimeOffset OccurredAt { get; set; } /// @@ -98,9 +91,8 @@ public partial class TrackEvent /// /// 78756 /// - [JsonPropertyName("postal_code")] - [JsonRequired] - public required string PostalCode { get; set; } + [JsonPropertyName("postal_code"), JsonInclude] + public string? PostalCode { get; private set; } /// /// State province @@ -109,9 +101,8 @@ public partial class TrackEvent /// /// TX /// - [JsonPropertyName("state_province")] - [JsonRequired] - public required string StateProvince { get; set; } + [JsonPropertyName("state_province"), JsonInclude] + public string? StateProvince { get; private set; } /// /// Event Status Description @@ -120,9 +111,8 @@ public partial class TrackEvent /// /// In Transit /// - [JsonPropertyName("status_description")] - [JsonRequired] - public required string StatusDescription { get; set; } + [JsonPropertyName("status_description"), JsonInclude] + public string? StatusDescription { get; private set; } /// /// Carrier timestamp for the event, it is assumed to be the local time of where the event occurred. @@ -131,7 +121,7 @@ public partial class TrackEvent /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("carrier_occurred_at")] + [JsonPropertyName("carrier_occurred_at"), JsonPropertyOrder(10)] public DateTimeOffset? CarrierOccurredAt { get; set; } /// @@ -141,8 +131,8 @@ public partial class TrackEvent /// /// Stamps.com /// - [JsonPropertyName("company_name")] - public string? CompanyName { get; set; } + [JsonPropertyName("company_name"), JsonInclude] + public string? CompanyName { get; private set; } /// /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) @@ -151,7 +141,7 @@ public partial class TrackEvent /// /// CA /// - [JsonPropertyName("country_code")] + [JsonPropertyName("country_code"), JsonPropertyOrder(12)] public string? CountryCode { get; set; } /// @@ -161,36 +151,36 @@ public partial class TrackEvent /// /// Delivered, In/At Mailbox /// - [JsonPropertyName("description")] - public string? Description { get; set; } + [JsonPropertyName("description"), JsonInclude] + public string? Description { get; private set; } /// /// Event Code /// /// Event Code - [JsonPropertyName("event_code")] + [JsonPropertyName("event_code"), JsonPropertyOrder(14)] public string? EventCode { get; set; } /// /// Latitude coordinate of tracking event. /// /// Latitude coordinate of tracking event. - [JsonPropertyName("latitude")] + [JsonPropertyName("latitude"), JsonPropertyOrder(15)] public double? Latitude { get; set; } /// /// Longitude coordinate of tracking event. /// /// Longitude coordinate of tracking event. - [JsonPropertyName("longitude")] + [JsonPropertyName("longitude"), JsonPropertyOrder(16)] public double? Longitude { get; set; } /// /// Signer information /// /// Signer information - [JsonPropertyName("signer")] - public string? Signer { get; set; } + [JsonPropertyName("signer"), JsonInclude] + public string? Signer { get; private set; } /// diff --git a/ShipEngineSDK/Model/TrackingInformation.cs b/ShipEngineSDK/Model/TrackingInformation.cs index 92619896..212c3610 100644 --- a/ShipEngineSDK/Model/TrackingInformation.cs +++ b/ShipEngineSDK/Model/TrackingInformation.cs @@ -29,10 +29,11 @@ public partial class TrackingInformation { /// - /// Gets or Sets StatusCode CLOVUS + /// Gets or Sets StatusCode /// - [JsonPropertyName("status_code")] + [JsonPropertyName("status_code"), JsonPropertyOrder(11)] public StatusCode? StatusCode { get; set; } + /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. /// @@ -40,7 +41,7 @@ public partial class TrackingInformation /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("actual_delivery_date")] + [JsonPropertyName("actual_delivery_date"), JsonPropertyOrder(1)] public DateTimeOffset? ActualDeliveryDate { get; set; } /// @@ -50,7 +51,7 @@ public partial class TrackingInformation /// /// dhl_express /// - [JsonPropertyName("carrier_code")] + [JsonPropertyName("carrier_code"), JsonPropertyOrder(2)] public string? CarrierCode { get; set; } /// @@ -60,8 +61,8 @@ public partial class TrackingInformation /// /// OT /// - [JsonPropertyName("carrier_detail_code")] - public string? CarrierDetailCode { get; set; } + [JsonPropertyName("carrier_detail_code"), JsonInclude] + public string? CarrierDetailCode { get; private set; } /// /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. @@ -70,7 +71,7 @@ public partial class TrackingInformation /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] + [JsonPropertyName("carrier_id"), JsonPropertyOrder(4)] public string? CarrierId { get; set; } /// @@ -80,8 +81,8 @@ public partial class TrackingInformation /// /// 1 /// - [JsonPropertyName("carrier_status_code")] - public string? CarrierStatusCode { get; set; } + [JsonPropertyName("carrier_status_code"), JsonInclude] + public string? CarrierStatusCode { get; private set; } /// /// carrier status description @@ -90,8 +91,8 @@ public partial class TrackingInformation /// /// Your item was delivered in or at the mailbox at 9:10 am on March /// - [JsonPropertyName("carrier_status_description")] - public string? CarrierStatusDescription { get; set; } + [JsonPropertyName("carrier_status_description"), JsonInclude] + public string? CarrierStatusDescription { get; private set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -100,22 +101,22 @@ public partial class TrackingInformation /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("estimated_delivery_date")] + [JsonPropertyName("estimated_delivery_date"), JsonPropertyOrder(7)] public DateTimeOffset? EstimatedDeliveryDate { get; set; } /// /// The events that have occured during the lifetime of this tracking number. /// /// The events that have occured during the lifetime of this tracking number. - [JsonPropertyName("events")] - public List? Events { get; set; } + [JsonPropertyName("events"), JsonInclude] + public List? Events { get; private set; } /// /// Exception description /// /// Exception description - [JsonPropertyName("exception_description")] - public string? ExceptionDescription { get; set; } + [JsonPropertyName("exception_description"), JsonInclude] + public string? ExceptionDescription { get; private set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -124,7 +125,7 @@ public partial class TrackingInformation /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("ship_date")] + [JsonPropertyName("ship_date"), JsonPropertyOrder(10)] public DateTimeOffset? ShipDate { get; set; } /// @@ -134,8 +135,8 @@ public partial class TrackingInformation /// /// Delivered /// - [JsonPropertyName("status_description")] - public string? StatusDescription { get; set; } + [JsonPropertyName("status_description"), JsonInclude] + public string? StatusDescription { get; private set; } /// /// A tracking number for a package. The format depends on the carrier. @@ -144,7 +145,7 @@ public partial class TrackingInformation /// /// 1Z932R800392060079 /// - [JsonPropertyName("tracking_number")] + [JsonPropertyName("tracking_number"), JsonPropertyOrder(13)] public string? TrackingNumber { get; set; } /// @@ -154,8 +155,8 @@ public partial class TrackingInformation /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// - [JsonPropertyName("tracking_url")] - public string? TrackingUrl { get; set; } + [JsonPropertyName("tracking_url"), JsonInclude] + public string? TrackingUrl { get; private set; } /// diff --git a/ShipEngineSDK/Model/TrackingStatus.cs b/ShipEngineSDK/Model/TrackingStatus.cs index 0100098d..c94ae426 100644 --- a/ShipEngineSDK/Model/TrackingStatus.cs +++ b/ShipEngineSDK/Model/TrackingStatus.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(TrackingStatusJsonConverter))] public class TrackingStatus { - private string _value; + private readonly string _value; /// /// Create a new instance of TrackingStatus with a predefined value. @@ -80,6 +80,12 @@ public TrackingStatus(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is TrackingStatus other && _value == other._value; } internal class TrackingStatusJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/TransportMean.cs b/ShipEngineSDK/Model/TransportMean.cs index 6b8d825e..16ef8045 100644 --- a/ShipEngineSDK/Model/TransportMean.cs +++ b/ShipEngineSDK/Model/TransportMean.cs @@ -28,7 +28,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(TransportMeanJsonConverter))] public class TransportMean { - private string _value; + private readonly string _value; /// /// Create a new instance of TransportMean with a predefined value. @@ -79,6 +79,12 @@ public TransportMean(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is TransportMean other && _value == other._value; } internal class TransportMeanJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs index 9d90dd87..1af066cb 100644 --- a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs @@ -89,11 +89,12 @@ public override bool CanConvert(Type typeToConvert) => /// - /// The image type CLOVUS + /// The image type /// /// The image type - [JsonPropertyName("image_content_type")] + [JsonPropertyName("image_content_type"), JsonPropertyOrder(3)] public ImageContentTypeEnum? ImageContentType { get; set; } + /// /// Indicates whether this image is set as default. /// @@ -101,8 +102,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// false /// - [JsonPropertyName("is_default")] - [JsonRequired] + [JsonPropertyName("is_default"), JsonRequired, JsonPropertyOrder(1)] public required bool IsDefault { get; set; } /// @@ -112,8 +112,8 @@ public override bool CanConvert(Type typeToConvert) => /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// A base64 encoded string representation of the image. @@ -122,7 +122,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg== /// - [JsonPropertyName("image_data")] + [JsonPropertyName("image_data"), JsonPropertyOrder(4)] public string? ImageData { get; set; } /// @@ -132,8 +132,8 @@ public override bool CanConvert(Type typeToConvert) => /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id")] - public string? LabelImageId { get; set; } + [JsonPropertyName("label_image_id"), JsonInclude] + public string? LabelImageId { get; private set; } /// /// The date and time that the image was modified in ShipEngine. @@ -142,8 +142,8 @@ public override bool CanConvert(Type typeToConvert) => /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("modified_at")] - public DateTimeOffset? ModifiedAt { get; set; } + [JsonPropertyName("modified_at"), JsonInclude] + public DateTimeOffset? ModifiedAt { get; private set; } /// /// A human readable name for the image. @@ -152,7 +152,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// My logo /// - [JsonPropertyName("name")] + [JsonPropertyName("name"), JsonPropertyOrder(7)] public string? Name { get; set; } diff --git a/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs b/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs index a673d1a9..4c1a4de7 100644 --- a/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs @@ -32,7 +32,7 @@ public partial class UpdateAmazonBuyShippingRequestBody /// Email /// /// Email - [JsonPropertyName("email")] + [JsonPropertyName("email"), JsonPropertyOrder(1)] public string? Email { get; set; } diff --git a/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs index f9106d9b..2728d564 100644 --- a/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs @@ -32,21 +32,21 @@ public partial class UpdateDhlExpressSettingsRequestBody /// Indicates if this is primary account /// /// Indicates if this is primary account - [JsonPropertyName("is_primary_account")] + [JsonPropertyName("is_primary_account"), JsonPropertyOrder(1)] public bool? IsPrimaryAccount { get; set; } /// /// Account nickname /// /// Account nickname - [JsonPropertyName("nickname")] + [JsonPropertyName("nickname"), JsonPropertyOrder(2)] public string? Nickname { get; set; } /// /// Indicates if the account number should be hidden on the archive documentation /// /// Indicates if the account number should be hidden on the archive documentation - [JsonPropertyName("should_hide_account_number_on_archive_doc")] + [JsonPropertyName("should_hide_account_number_on_archive_doc"), JsonPropertyOrder(3)] public bool? ShouldHideAccountNumberOnArchiveDoc { get; set; } diff --git a/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs index 4a3b1a2d..e69ae007 100644 --- a/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs @@ -29,43 +29,46 @@ public partial class UpdateFedexSettingsRequestBody { /// - /// Gets or Sets PickupType CLOVUS + /// Gets or Sets PickupType /// - [JsonPropertyName("pickup_type")] + [JsonPropertyName("pickup_type"), JsonPropertyOrder(4)] public FedexPickupType? PickupType { get; set; } + /// - /// Gets or Sets SmartPostEndorsement CLOVUS + /// Gets or Sets SmartPostEndorsement /// - [JsonPropertyName("smart_post_endorsement")] + [JsonPropertyName("smart_post_endorsement"), JsonPropertyOrder(6)] public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } + /// - /// Gets or Sets SmartPostHub CLOVUS + /// Gets or Sets SmartPostHub /// - [JsonPropertyName("smart_post_hub")] + [JsonPropertyName("smart_post_hub"), JsonPropertyOrder(7)] public SmartPostHub? SmartPostHub { get; set; } + /// /// Gets or Sets IsPrimaryAccount /// - [JsonPropertyName("is_primary_account")] + [JsonPropertyName("is_primary_account"), JsonPropertyOrder(1)] public bool? IsPrimaryAccount { get; set; } /// /// Gets or Sets LetterheadImage /// - [JsonPropertyName("letterhead_image")] + [JsonPropertyName("letterhead_image"), JsonPropertyOrder(2)] public string? LetterheadImage { get; set; } /// /// Account nickname /// /// Account nickname - [JsonPropertyName("nickname")] + [JsonPropertyName("nickname"), JsonPropertyOrder(3)] public string? Nickname { get; set; } /// /// Gets or Sets SignatureImage /// - [JsonPropertyName("signature_image")] + [JsonPropertyName("signature_image"), JsonPropertyOrder(5)] public string? SignatureImage { get; set; } diff --git a/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs index e6cdbc1c..b54213b5 100644 --- a/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs @@ -31,13 +31,13 @@ public partial class UpdateNewgisticsSettingsRequestBody /// /// Gets or Sets IncludeBarcodeWithOrderNumber /// - [JsonPropertyName("include_barcode_with_order_number")] + [JsonPropertyName("include_barcode_with_order_number"), JsonPropertyOrder(1)] public bool? IncludeBarcodeWithOrderNumber { get; set; } /// /// Gets or Sets ReceiveEmailOnManifestProcessing /// - [JsonPropertyName("receive_email_on_manifest_processing")] + [JsonPropertyName("receive_email_on_manifest_processing"), JsonPropertyOrder(2)] public bool? ReceiveEmailOnManifestProcessing { get; set; } diff --git a/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs b/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs index 29119ca2..7ce3c552 100644 --- a/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs +++ b/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs @@ -34,8 +34,7 @@ public partial class UpdatePackageTypeRequestBody /// /// laptop_box /// - [JsonPropertyName("name")] - [JsonRequired] + [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(1)] public required string Name { get; set; } /// @@ -45,8 +44,7 @@ public partial class UpdatePackageTypeRequestBody /// /// small_flat_rate_box /// - [JsonPropertyName("package_code")] - [JsonRequired] + [JsonPropertyName("package_code"), JsonRequired, JsonPropertyOrder(2)] public required string PackageCode { get; set; } /// @@ -56,14 +54,14 @@ public partial class UpdatePackageTypeRequestBody /// /// Packaging for laptops /// - [JsonPropertyName("description")] + [JsonPropertyName("description"), JsonPropertyOrder(3)] public string? Description { get; set; } /// /// The custom dimensions for the package. /// /// The custom dimensions for the package. - [JsonPropertyName("dimensions")] + [JsonPropertyName("dimensions"), JsonPropertyOrder(4)] public Dimensions? Dimensions { get; set; } /// @@ -73,7 +71,7 @@ public partial class UpdatePackageTypeRequestBody /// /// se-28529731 /// - [JsonPropertyName("package_id")] + [JsonPropertyName("package_id"), JsonPropertyOrder(5)] public string? PackageId { get; set; } diff --git a/ShipEngineSDK/Model/UpdateShipmentFields.cs b/ShipEngineSDK/Model/UpdateShipmentFields.cs index 86a5aa38..fdc5d727 100644 --- a/ShipEngineSDK/Model/UpdateShipmentFields.cs +++ b/ShipEngineSDK/Model/UpdateShipmentFields.cs @@ -29,11 +29,12 @@ public partial class UpdateShipmentFields { /// - /// Gets or Sets ValidateAddress CLOVUS + /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address")] + [JsonPropertyName("validate_address"), JsonPropertyOrder(1)] public ValidateAddress? ValidateAddress { get; set; } + /// /// Returns the string presentation of the object /// diff --git a/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs b/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs index 68df545e..dadbf319 100644 --- a/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs @@ -29,54 +29,57 @@ public partial class UpdateShipmentRequestBody { /// - /// The type of delivery confirmation that is required for this shipment. CLOVUS + /// The type of delivery confirmation that is required for this shipment. /// /// The type of delivery confirmation that is required for this shipment. - [JsonPropertyName("confirmation")] + [JsonPropertyName("confirmation"), JsonPropertyOrder(6)] public DeliveryConfirmation? Confirmation { get; set; } + /// - /// The insurance provider to use for any insured packages in the shipment. CLOVUS + /// The insurance provider to use for any insured packages in the shipment. /// /// The insurance provider to use for any insured packages in the shipment. - [JsonPropertyName("insurance_provider")] + [JsonPropertyName("insurance_provider"), JsonPropertyOrder(11)] public InsuranceProvider? InsuranceProvider { get; set; } + /// - /// Gets or Sets OrderSourceCode CLOVUS + /// Gets or Sets OrderSourceCode /// - [JsonPropertyName("order_source_code")] + [JsonPropertyName("order_source_code"), JsonPropertyOrder(15)] public OrderSourceName? OrderSourceCode { get; set; } + /// - /// The current status of the shipment CLOVUS + /// The current status of the shipment /// /// The current status of the shipment - [JsonPropertyName("shipment_status")] - public ShipmentStatus? ShipmentStatus { get; set; } + [JsonPropertyName("shipment_status"), JsonInclude] + public ShipmentStatus? ShipmentStatus { get; private set; } + /// - /// Gets or Sets ValidateAddress CLOVUS + /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address")] + [JsonPropertyName("validate_address"), JsonPropertyOrder(27)] public ValidateAddress? ValidateAddress { get; set; } + /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from")] - [JsonRequired] + [JsonPropertyName("ship_from"), JsonRequired, JsonPropertyOrder(1)] public required ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address /// /// The recipient's mailing address - [JsonPropertyName("ship_to")] - [JsonRequired] + [JsonPropertyName("ship_to"), JsonRequired, JsonPropertyOrder(2)] public required ShippingAddressTo ShipTo { get; set; } /// /// Advanced shipment options. These are entirely optional. /// /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options")] + [JsonPropertyName("advanced_options"), JsonPropertyOrder(3)] public AdvancedShipmentOptions? AdvancedOptions { get; set; } /// @@ -86,7 +89,7 @@ public partial class UpdateShipmentRequestBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] + [JsonPropertyName("carrier_id"), JsonPropertyOrder(4)] public string? CarrierId { get; set; } /// @@ -96,7 +99,7 @@ public partial class UpdateShipmentRequestBody /// /// retail /// - [JsonPropertyName("comparison_rate_type")] + [JsonPropertyName("comparison_rate_type"), JsonPropertyOrder(5)] public string? ComparisonRateType { get; set; } /// @@ -106,42 +109,42 @@ public partial class UpdateShipmentRequestBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// Customs information. This is usually only needed for international shipments. /// /// Customs information. This is usually only needed for international shipments. - [JsonPropertyName("customs")] + [JsonPropertyName("customs"), JsonPropertyOrder(8)] public InternationalShipmentOptions? Customs { get; set; } /// /// ID that the Order Source assigned /// /// ID that the Order Source assigned - [JsonPropertyName("external_order_id")] + [JsonPropertyName("external_order_id"), JsonPropertyOrder(9)] public string? ExternalOrderId { get; set; } /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("external_shipment_id")] + [JsonPropertyName("external_shipment_id"), JsonPropertyOrder(10)] public string? ExternalShipmentId { get; set; } /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. - [JsonPropertyName("is_return")] + [JsonPropertyName("is_return"), JsonPropertyOrder(12)] public bool? IsReturn { get; set; } /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - [JsonPropertyName("items")] + [JsonPropertyName("items"), JsonPropertyOrder(13)] public List? Items { get; set; } /// @@ -151,21 +154,21 @@ public partial class UpdateShipmentRequestBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("modified_at")] - public DateTimeOffset? ModifiedAt { get; set; } + [JsonPropertyName("modified_at"), JsonInclude] + public DateTimeOffset? ModifiedAt { get; private set; } /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] + [JsonPropertyName("packages"), JsonPropertyOrder(16)] public List? Packages { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. /// /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to")] + [JsonPropertyName("return_to"), JsonPropertyOrder(17)] public ShippingAddress? ReturnTo { get; set; } /// @@ -175,7 +178,7 @@ public partial class UpdateShipmentRequestBody /// /// usps_first_class_mail /// - [JsonPropertyName("service_code")] + [JsonPropertyName("service_code"), JsonPropertyOrder(18)] public string? ServiceCode { get; set; } /// @@ -185,7 +188,7 @@ public partial class UpdateShipmentRequestBody /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date")] + [JsonPropertyName("ship_date"), JsonPropertyOrder(19)] public DateTimeOffset? ShipDate { get; set; } /// @@ -195,14 +198,14 @@ public partial class UpdateShipmentRequestBody /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - public string? ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private set; } /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("shipment_number")] + [JsonPropertyName("shipment_number"), JsonPropertyOrder(21)] public string? ShipmentNumber { get; set; } /// @@ -212,28 +215,28 @@ public partial class UpdateShipmentRequestBody /// /// se-28529731 /// - [JsonPropertyName("shipping_rule_id")] + [JsonPropertyName("shipping_rule_id"), JsonPropertyOrder(23)] public string? ShippingRuleId { get; set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. - [JsonPropertyName("tags")] - public List? Tags { get; set; } + [JsonPropertyName("tags"), JsonInclude] + public List? Tags { get; private set; } /// /// Gets or Sets TaxIdentifiers /// - [JsonPropertyName("tax_identifiers")] + [JsonPropertyName("tax_identifiers"), JsonPropertyOrder(25)] public List? TaxIdentifiers { get; set; } /// /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment - [JsonPropertyName("total_weight")] - public Weight? TotalWeight { get; set; } + [JsonPropertyName("total_weight"), JsonInclude] + public Weight? TotalWeight { get; private set; } /// /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. @@ -242,7 +245,7 @@ public partial class UpdateShipmentRequestBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] + [JsonPropertyName("warehouse_id"), JsonPropertyOrder(28)] public string? WarehouseId { get; set; } diff --git a/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs b/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs index 1fa43b5b..433daa85 100644 --- a/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs @@ -29,51 +29,44 @@ public partial class UpdateShipmentResponseBody { /// - /// The type of delivery confirmation that is required for this shipment. CLOVUS + /// The type of delivery confirmation that is required for this shipment. /// /// The type of delivery confirmation that is required for this shipment. - [JsonPropertyName("confirmation")] - [JsonRequired] - public required DeliveryConfirmation Confirmation { get; set; } = new(); - + [JsonPropertyName("confirmation"), JsonRequired, JsonPropertyOrder(4)] + public required DeliveryConfirmation Confirmation { get; set; } /// - /// The insurance provider to use for any insured packages in the shipment. CLOVUS + /// The insurance provider to use for any insured packages in the shipment. /// /// The insurance provider to use for any insured packages in the shipment. - [JsonPropertyName("insurance_provider")] - [JsonRequired] - public required InsuranceProvider InsuranceProvider { get; set; } = new(); - + [JsonPropertyName("insurance_provider"), JsonRequired, JsonPropertyOrder(7)] + public required InsuranceProvider InsuranceProvider { get; set; } /// - /// The current status of the shipment CLOVUS + /// The current status of the shipment /// /// The current status of the shipment - [JsonPropertyName("shipment_status")] - [JsonRequired] - public required ShipmentStatus ShipmentStatus { get; set; } = new(); - + [JsonPropertyName("shipment_status"), JsonInclude] + public ShipmentStatus? ShipmentStatus { get; private set; } /// - /// Gets or Sets OrderSourceCode CLOVUS + /// Gets or Sets OrderSourceCode /// - [JsonPropertyName("order_source_code")] + [JsonPropertyName("order_source_code"), JsonPropertyOrder(25)] public OrderSourceName? OrderSourceCode { get; set; } + /// /// The address validation /// /// The address validation - [JsonPropertyName("address_validation")] - [JsonRequired] + [JsonPropertyName("address_validation"), JsonRequired, JsonPropertyOrder(1)] public required AddressValidationResult AddressValidation { get; set; } /// /// Advanced shipment options. These are entirely optional. /// /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options")] - [JsonRequired] + [JsonPropertyName("advanced_options"), JsonRequired, JsonPropertyOrder(2)] public required AdvancedShipmentOptions AdvancedOptions { get; set; } /// @@ -83,8 +76,7 @@ public partial class UpdateShipmentResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id")] - [JsonRequired] + [JsonPropertyName("carrier_id"), JsonRequired, JsonPropertyOrder(3)] public required string CarrierId { get; set; } /// @@ -94,33 +86,28 @@ public partial class UpdateShipmentResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("created_at")] - [JsonRequired] - public required DateTimeOffset CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// An array of errors that occurred while creating shipment. /// /// An array of errors that occurred while creating shipment. - [JsonPropertyName("errors")] - [JsonRequired] - [Obsolete] - public required List Errors { get; set; } + [JsonPropertyName("errors"), JsonInclude, Obsolete] + public List? Errors { get; private set; } /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages")] - [JsonRequired] + [JsonPropertyName("packages"), JsonRequired, JsonPropertyOrder(8)] public required List Packages { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. /// /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to")] - [JsonRequired] + [JsonPropertyName("return_to"), JsonRequired, JsonPropertyOrder(9)] public required ShippingAddress ReturnTo { get; set; } /// @@ -130,8 +117,7 @@ public partial class UpdateShipmentResponseBody /// /// usps_first_class_mail /// - [JsonPropertyName("service_code")] - [JsonRequired] + [JsonPropertyName("service_code"), JsonRequired, JsonPropertyOrder(10)] public required string ServiceCode { get; set; } /// @@ -141,24 +127,21 @@ public partial class UpdateShipmentResponseBody /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date")] - [JsonRequired] + [JsonPropertyName("ship_date"), JsonRequired, JsonPropertyOrder(11)] public required DateTimeOffset ShipDate { get; set; } /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from")] - [JsonRequired] + [JsonPropertyName("ship_from"), JsonRequired, JsonPropertyOrder(12)] public required ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address /// /// The recipient's mailing address - [JsonPropertyName("ship_to")] - [JsonRequired] + [JsonPropertyName("ship_to"), JsonRequired, JsonPropertyOrder(13)] public required ShippingAddressTo ShipTo { get; set; } /// @@ -168,25 +151,22 @@ public partial class UpdateShipmentResponseBody /// /// se-28529731 /// - [JsonPropertyName("shipment_id")] - [JsonRequired] - public required string ShipmentId { get; set; } + [JsonPropertyName("shipment_id"), JsonInclude] + public string? ShipmentId { get; private set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. - [JsonPropertyName("tags")] - [JsonRequired] - public required List Tags { get; set; } + [JsonPropertyName("tags"), JsonInclude] + public List? Tags { get; private set; } /// /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment - [JsonPropertyName("total_weight")] - [JsonRequired] - public required Weight TotalWeight { get; set; } + [JsonPropertyName("total_weight"), JsonInclude] + public Weight? TotalWeight { get; private set; } /// /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. @@ -195,43 +175,42 @@ public partial class UpdateShipmentResponseBody /// /// retail /// - [JsonPropertyName("comparison_rate_type")] + [JsonPropertyName("comparison_rate_type"), JsonPropertyOrder(18)] public string? ComparisonRateType { get; set; } /// /// Customs information. This is usually only needed for international shipments. /// /// Customs information. This is usually only needed for international shipments. - [JsonPropertyName("customs")] - [JsonRequired] + [JsonPropertyName("customs"), JsonRequired, JsonPropertyOrder(19)] public required InternationalShipmentOptions Customs { get; set; } /// /// ID that the Order Source assigned /// /// ID that the Order Source assigned - [JsonPropertyName("external_order_id")] + [JsonPropertyName("external_order_id"), JsonPropertyOrder(20)] public string? ExternalOrderId { get; set; } /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. /// /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("external_shipment_id")] + [JsonPropertyName("external_shipment_id"), JsonPropertyOrder(21)] public string? ExternalShipmentId { get; set; } /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. - [JsonPropertyName("is_return")] + [JsonPropertyName("is_return"), JsonPropertyOrder(22)] public bool? IsReturn { get; set; } /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources /// /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources - [JsonPropertyName("items")] + [JsonPropertyName("items"), JsonPropertyOrder(23)] public List? Items { get; set; } /// @@ -241,14 +220,14 @@ public partial class UpdateShipmentResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("modified_at")] - public DateTimeOffset? ModifiedAt { get; set; } + [JsonPropertyName("modified_at"), JsonInclude] + public DateTimeOffset? ModifiedAt { get; private set; } /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. - [JsonPropertyName("shipment_number")] + [JsonPropertyName("shipment_number"), JsonPropertyOrder(26)] public string? ShipmentNumber { get; set; } /// @@ -258,13 +237,13 @@ public partial class UpdateShipmentResponseBody /// /// se-28529731 /// - [JsonPropertyName("shipping_rule_id")] + [JsonPropertyName("shipping_rule_id"), JsonPropertyOrder(27)] public string? ShippingRuleId { get; set; } /// /// Gets or Sets TaxIdentifiers /// - [JsonPropertyName("tax_identifiers")] + [JsonPropertyName("tax_identifiers"), JsonPropertyOrder(28)] public List? TaxIdentifiers { get; set; } /// @@ -274,7 +253,7 @@ public partial class UpdateShipmentResponseBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] + [JsonPropertyName("warehouse_id"), JsonPropertyOrder(29)] public string? WarehouseId { get; set; } diff --git a/ShipEngineSDK/Model/UpdateShipmentsTags.cs b/ShipEngineSDK/Model/UpdateShipmentsTags.cs index dce0361f..d2c70b8e 100644 --- a/ShipEngineSDK/Model/UpdateShipmentsTags.cs +++ b/ShipEngineSDK/Model/UpdateShipmentsTags.cs @@ -31,7 +31,7 @@ public partial class UpdateShipmentsTags /// /// Gets or Sets ShipmentsTags /// - [JsonPropertyName("shipments_tags")] + [JsonPropertyName("shipments_tags"), JsonPropertyOrder(1)] public List? ShipmentsTags { get; set; } diff --git a/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs b/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs index 614b96ff..cfa9ca0c 100644 --- a/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs @@ -31,7 +31,7 @@ public partial class UpdateShipmentsTagsRequestBody /// /// Gets or Sets ShipmentsTags /// - [JsonPropertyName("shipments_tags")] + [JsonPropertyName("shipments_tags"), JsonPropertyOrder(1)] public List? ShipmentsTags { get; set; } diff --git a/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs b/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs index 94c1f72c..39237e3b 100644 --- a/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs +++ b/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs @@ -31,13 +31,13 @@ public partial class UpdateShipmentsTagsShipmentsTagsInner /// /// Gets or Sets ShipmentId /// - [JsonPropertyName("shipment_id")] + [JsonPropertyName("shipment_id"), JsonPropertyOrder(1)] public string? ShipmentId { get; set; } /// /// Gets or Sets Tags /// - [JsonPropertyName("tags")] + [JsonPropertyName("tags"), JsonPropertyOrder(2)] public List? Tags { get; set; } diff --git a/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs index 18ac008f..ce94b9c7 100644 --- a/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs @@ -29,83 +29,85 @@ public partial class UpdateUpsSettingsRequestBody { /// - /// Gets or Sets MailInnovationsEndorsement CLOVUS + /// Gets or Sets MailInnovationsEndorsement /// - [JsonPropertyName("mail_innovations_endorsement")] + [JsonPropertyName("mail_innovations_endorsement"), JsonPropertyOrder(5)] public AncillaryServiceEndorsement? MailInnovationsEndorsement { get; set; } + /// - /// Gets or Sets PickupType CLOVUS + /// Gets or Sets PickupType /// - [JsonPropertyName("pickup_type")] + [JsonPropertyName("pickup_type"), JsonPropertyOrder(7)] public UpsPickupType? PickupType { get; set; } + /// /// account postal code /// /// account postal code - [JsonPropertyName("account_postal_code")] + [JsonPropertyName("account_postal_code"), JsonPropertyOrder(1)] public string? AccountPostalCode { get; set; } /// /// The invoice /// /// The invoice - [JsonPropertyName("invoice")] + [JsonPropertyName("invoice"), JsonPropertyOrder(2)] public UpsInvoice? Invoice { get; set; } /// /// Indicates if this is the primary UPS account /// /// Indicates if this is the primary UPS account - [JsonPropertyName("is_primary_account")] + [JsonPropertyName("is_primary_account"), JsonPropertyOrder(3)] public bool? IsPrimaryAccount { get; set; } /// /// mail innovations cost center /// /// mail innovations cost center - [JsonPropertyName("mail_innovations_cost_center")] + [JsonPropertyName("mail_innovations_cost_center"), JsonPropertyOrder(4)] public string? MailInnovationsCostCenter { get; set; } /// /// nickname /// /// nickname - [JsonPropertyName("nickname")] + [JsonPropertyName("nickname"), JsonPropertyOrder(6)] public string? Nickname { get; set; } /// /// The use carbon neutral shipping program /// /// The use carbon neutral shipping program - [JsonPropertyName("use_carbon_neutral_shipping_program")] + [JsonPropertyName("use_carbon_neutral_shipping_program"), JsonPropertyOrder(8)] public bool? UseCarbonNeutralShippingProgram { get; set; } /// /// The use consolidation services /// /// The use consolidation services - [JsonPropertyName("use_consolidation_services")] + [JsonPropertyName("use_consolidation_services"), JsonPropertyOrder(9)] public bool? UseConsolidationServices { get; set; } /// /// The use ground freight pricing /// /// The use ground freight pricing - [JsonPropertyName("use_ground_freight_pricing")] + [JsonPropertyName("use_ground_freight_pricing"), JsonPropertyOrder(10)] public bool? UseGroundFreightPricing { get; set; } /// /// The use negotiated rates /// /// The use negotiated rates - [JsonPropertyName("use_negotiated_rates")] + [JsonPropertyName("use_negotiated_rates"), JsonPropertyOrder(11)] public bool? UseNegotiatedRates { get; set; } /// /// The use order number on mail innovations labels /// /// The use order number on mail innovations labels - [JsonPropertyName("use_order_number_on_mail_innovations_labels")] + [JsonPropertyName("use_order_number_on_mail_innovations_labels"), JsonPropertyOrder(12)] public bool? UseOrderNumberOnMailInnovationsLabels { get; set; } diff --git a/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs b/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs index 268ea7c9..593de5eb 100644 --- a/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs @@ -35,16 +35,14 @@ public partial class UpdateWarehouseRequestBody /// /// Zero Cool HQ /// - [JsonPropertyName("name")] - [JsonRequired] + [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(1)] public required string Name { get; set; } /// /// The origin address of the warehouse /// /// The origin address of the warehouse - [JsonPropertyName("origin_address")] - [JsonRequired] + [JsonPropertyName("origin_address"), JsonRequired, JsonPropertyOrder(2)] public required Address OriginAddress { get; set; } /// @@ -54,21 +52,21 @@ public partial class UpdateWarehouseRequestBody /// /// 2019-06-25T18:12:35.583Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// Designates which single warehouse is the default on the account /// /// Designates which single warehouse is the default on the account - [JsonPropertyName("is_default")] + [JsonPropertyName("is_default"), JsonPropertyOrder(4)] public bool? IsDefault { get; set; } /// /// The return address associated with the warehouse /// /// The return address associated with the warehouse - [JsonPropertyName("return_address")] + [JsonPropertyName("return_address"), JsonPropertyOrder(5)] public Address? ReturnAddress { get; set; } /// @@ -78,8 +76,8 @@ public partial class UpdateWarehouseRequestBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] - public string? WarehouseId { get; set; } + [JsonPropertyName("warehouse_id"), JsonInclude] + public string? WarehouseId { get; private set; } /// diff --git a/ShipEngineSDK/Model/UpdateWarehouseSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateWarehouseSettingsRequestBody.cs index 80991e43..f3050be2 100644 --- a/ShipEngineSDK/Model/UpdateWarehouseSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateWarehouseSettingsRequestBody.cs @@ -35,7 +35,7 @@ public partial class UpdateWarehouseSettingsRequestBody /// /// true /// - [JsonPropertyName("is_default")] + [JsonPropertyName("is_default"), JsonPropertyOrder(1)] public bool? IsDefault { get; set; } diff --git a/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs b/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs index 19ea895e..2881ecd0 100644 --- a/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs @@ -32,7 +32,7 @@ public partial class UpdateWebhookRequestBody /// Array of custom webhook headers /// /// Array of custom webhook headers - [JsonPropertyName("headers")] + [JsonPropertyName("headers"), JsonPropertyOrder(1)] public List? Headers { get; set; } /// @@ -42,7 +42,7 @@ public partial class UpdateWebhookRequestBody /// /// http://api.shipengine.com/v1/labels/se-28529731 /// - [JsonPropertyName("url")] + [JsonPropertyName("url"), JsonPropertyOrder(2)] public string? Url { get; set; } diff --git a/ShipEngineSDK/Model/UpsAccountSettings.cs b/ShipEngineSDK/Model/UpsAccountSettings.cs index 99a88a1f..5fc95ad7 100644 --- a/ShipEngineSDK/Model/UpsAccountSettings.cs +++ b/ShipEngineSDK/Model/UpsAccountSettings.cs @@ -29,83 +29,85 @@ public partial class UpsAccountSettings { /// - /// Gets or Sets MailInnovationsEndorsement CLOVUS + /// Gets or Sets MailInnovationsEndorsement /// - [JsonPropertyName("mail_innovations_endorsement")] + [JsonPropertyName("mail_innovations_endorsement"), JsonPropertyOrder(5)] public AncillaryServiceEndorsement? MailInnovationsEndorsement { get; set; } + /// - /// Gets or Sets PickupType CLOVUS + /// Gets or Sets PickupType /// - [JsonPropertyName("pickup_type")] + [JsonPropertyName("pickup_type"), JsonPropertyOrder(7)] public UpsPickupType? PickupType { get; set; } + /// /// account postal code /// /// account postal code - [JsonPropertyName("account_postal_code")] + [JsonPropertyName("account_postal_code"), JsonPropertyOrder(1)] public string? AccountPostalCode { get; set; } /// /// The invoice /// /// The invoice - [JsonPropertyName("invoice")] + [JsonPropertyName("invoice"), JsonPropertyOrder(2)] public UpsInvoice? Invoice { get; set; } /// /// Indicates if this is the primary UPS account /// /// Indicates if this is the primary UPS account - [JsonPropertyName("is_primary_account")] + [JsonPropertyName("is_primary_account"), JsonPropertyOrder(3)] public bool? IsPrimaryAccount { get; set; } /// /// mail innovations cost center /// /// mail innovations cost center - [JsonPropertyName("mail_innovations_cost_center")] + [JsonPropertyName("mail_innovations_cost_center"), JsonPropertyOrder(4)] public string? MailInnovationsCostCenter { get; set; } /// /// nickname /// /// nickname - [JsonPropertyName("nickname")] + [JsonPropertyName("nickname"), JsonPropertyOrder(6)] public string? Nickname { get; set; } /// /// The use carbon neutral shipping program /// /// The use carbon neutral shipping program - [JsonPropertyName("use_carbon_neutral_shipping_program")] + [JsonPropertyName("use_carbon_neutral_shipping_program"), JsonPropertyOrder(8)] public bool? UseCarbonNeutralShippingProgram { get; set; } /// /// The use consolidation services /// /// The use consolidation services - [JsonPropertyName("use_consolidation_services")] + [JsonPropertyName("use_consolidation_services"), JsonPropertyOrder(9)] public bool? UseConsolidationServices { get; set; } /// /// The use ground freight pricing /// /// The use ground freight pricing - [JsonPropertyName("use_ground_freight_pricing")] + [JsonPropertyName("use_ground_freight_pricing"), JsonPropertyOrder(10)] public bool? UseGroundFreightPricing { get; set; } /// /// The use negotiated rates /// /// The use negotiated rates - [JsonPropertyName("use_negotiated_rates")] + [JsonPropertyName("use_negotiated_rates"), JsonPropertyOrder(11)] public bool? UseNegotiatedRates { get; set; } /// /// The use order number on mail innovations labels /// /// The use order number on mail innovations labels - [JsonPropertyName("use_order_number_on_mail_innovations_labels")] + [JsonPropertyName("use_order_number_on_mail_innovations_labels"), JsonPropertyOrder(12)] public bool? UseOrderNumberOnMailInnovationsLabels { get; set; } diff --git a/ShipEngineSDK/Model/UpsInvoice.cs b/ShipEngineSDK/Model/UpsInvoice.cs index 19661a12..e57df158 100644 --- a/ShipEngineSDK/Model/UpsInvoice.cs +++ b/ShipEngineSDK/Model/UpsInvoice.cs @@ -35,33 +35,33 @@ public partial class UpsInvoice /// /// se-28529731 /// - [JsonPropertyName("control_id")] + [JsonPropertyName("control_id"), JsonPropertyOrder(1)] public string? ControlId { get; set; } /// /// Gets or Sets InvoiceAmount /// - [JsonPropertyName("invoice_amount")] + [JsonPropertyName("invoice_amount"), JsonPropertyOrder(2)] public double? InvoiceAmount { get; set; } /// /// Gets or Sets InvoiceCurrencyCode /// - [JsonPropertyName("invoice_currency_code")] + [JsonPropertyName("invoice_currency_code"), JsonPropertyOrder(3)] public string? InvoiceCurrencyCode { get; set; } /// /// invoice date /// /// invoice date - [JsonPropertyName("invoice_date")] + [JsonPropertyName("invoice_date"), JsonPropertyOrder(4)] public DateTimeOffset? InvoiceDate { get; set; } /// /// invoice number /// /// invoice number - [JsonPropertyName("invoice_number")] + [JsonPropertyName("invoice_number"), JsonPropertyOrder(5)] public string? InvoiceNumber { get; set; } diff --git a/ShipEngineSDK/Model/UpsPickupType.cs b/ShipEngineSDK/Model/UpsPickupType.cs index 0ffd2552..5d86becc 100644 --- a/ShipEngineSDK/Model/UpsPickupType.cs +++ b/ShipEngineSDK/Model/UpsPickupType.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(UpsPickupTypeJsonConverter))] public class UpsPickupType { - private string _value; + private readonly string _value; /// /// Create a new instance of UpsPickupType with a predefined value. @@ -74,6 +74,12 @@ public UpsPickupType(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is UpsPickupType other && _value == other._value; } internal class UpsPickupTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/UpsSettingsResponseBody.cs b/ShipEngineSDK/Model/UpsSettingsResponseBody.cs index fc8611eb..b45e290e 100644 --- a/ShipEngineSDK/Model/UpsSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/UpsSettingsResponseBody.cs @@ -29,83 +29,85 @@ public partial class UpsSettingsResponseBody { /// - /// Gets or Sets MailInnovationsEndorsement CLOVUS + /// Gets or Sets MailInnovationsEndorsement /// - [JsonPropertyName("mail_innovations_endorsement")] + [JsonPropertyName("mail_innovations_endorsement"), JsonPropertyOrder(5)] public AncillaryServiceEndorsement? MailInnovationsEndorsement { get; set; } + /// - /// Gets or Sets PickupType CLOVUS + /// Gets or Sets PickupType /// - [JsonPropertyName("pickup_type")] + [JsonPropertyName("pickup_type"), JsonPropertyOrder(7)] public UpsPickupType? PickupType { get; set; } + /// /// account postal code /// /// account postal code - [JsonPropertyName("account_postal_code")] + [JsonPropertyName("account_postal_code"), JsonPropertyOrder(1)] public string? AccountPostalCode { get; set; } /// /// The invoice /// /// The invoice - [JsonPropertyName("invoice")] + [JsonPropertyName("invoice"), JsonPropertyOrder(2)] public UpsInvoice? Invoice { get; set; } /// /// Indicates if this is the primary UPS account /// /// Indicates if this is the primary UPS account - [JsonPropertyName("is_primary_account")] + [JsonPropertyName("is_primary_account"), JsonPropertyOrder(3)] public bool? IsPrimaryAccount { get; set; } /// /// mail innovations cost center /// /// mail innovations cost center - [JsonPropertyName("mail_innovations_cost_center")] + [JsonPropertyName("mail_innovations_cost_center"), JsonPropertyOrder(4)] public string? MailInnovationsCostCenter { get; set; } /// /// nickname /// /// nickname - [JsonPropertyName("nickname")] + [JsonPropertyName("nickname"), JsonPropertyOrder(6)] public string? Nickname { get; set; } /// /// The use carbon neutral shipping program /// /// The use carbon neutral shipping program - [JsonPropertyName("use_carbon_neutral_shipping_program")] + [JsonPropertyName("use_carbon_neutral_shipping_program"), JsonPropertyOrder(8)] public bool? UseCarbonNeutralShippingProgram { get; set; } /// /// The use consolidation services /// /// The use consolidation services - [JsonPropertyName("use_consolidation_services")] + [JsonPropertyName("use_consolidation_services"), JsonPropertyOrder(9)] public bool? UseConsolidationServices { get; set; } /// /// The use ground freight pricing /// /// The use ground freight pricing - [JsonPropertyName("use_ground_freight_pricing")] + [JsonPropertyName("use_ground_freight_pricing"), JsonPropertyOrder(10)] public bool? UseGroundFreightPricing { get; set; } /// /// The use negotiated rates /// /// The use negotiated rates - [JsonPropertyName("use_negotiated_rates")] + [JsonPropertyName("use_negotiated_rates"), JsonPropertyOrder(11)] public bool? UseNegotiatedRates { get; set; } /// /// The use order number on mail innovations labels /// /// The use order number on mail innovations labels - [JsonPropertyName("use_order_number_on_mail_innovations_labels")] + [JsonPropertyName("use_order_number_on_mail_innovations_labels"), JsonPropertyOrder(12)] public bool? UseOrderNumberOnMailInnovationsLabels { get; set; } diff --git a/ShipEngineSDK/Model/ValidateAddress.cs b/ShipEngineSDK/Model/ValidateAddress.cs index 86e08df6..929cb05f 100644 --- a/ShipEngineSDK/Model/ValidateAddress.cs +++ b/ShipEngineSDK/Model/ValidateAddress.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(ValidateAddressJsonConverter))] public class ValidateAddress { - private string _value; + private readonly string _value; /// /// Create a new instance of ValidateAddress with a predefined value. @@ -74,6 +74,12 @@ public ValidateAddress(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is ValidateAddress other && _value == other._value; } internal class ValidateAddressJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/ValidateShipmentFields.cs b/ShipEngineSDK/Model/ValidateShipmentFields.cs index 63d1af98..9622de8d 100644 --- a/ShipEngineSDK/Model/ValidateShipmentFields.cs +++ b/ShipEngineSDK/Model/ValidateShipmentFields.cs @@ -29,11 +29,12 @@ public partial class ValidateShipmentFields { /// - /// Gets or Sets ValidateAddress CLOVUS + /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address")] + [JsonPropertyName("validate_address"), JsonPropertyOrder(1)] public ValidateAddress? ValidateAddress { get; set; } + /// /// Returns the string presentation of the object /// diff --git a/ShipEngineSDK/Model/ValidationStatus.cs b/ShipEngineSDK/Model/ValidationStatus.cs index a200085a..0dc17de2 100644 --- a/ShipEngineSDK/Model/ValidationStatus.cs +++ b/ShipEngineSDK/Model/ValidationStatus.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(ValidationStatusJsonConverter))] public class ValidationStatus { - private string _value; + private readonly string _value; /// /// Create a new instance of ValidationStatus with a predefined value. @@ -80,6 +80,12 @@ public ValidationStatus(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is ValidationStatus other && _value == other._value; } internal class ValidationStatusJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/VoidLabelResponseBody.cs b/ShipEngineSDK/Model/VoidLabelResponseBody.cs index 1827acc2..ea8924d8 100644 --- a/ShipEngineSDK/Model/VoidLabelResponseBody.cs +++ b/ShipEngineSDK/Model/VoidLabelResponseBody.cs @@ -29,11 +29,12 @@ public partial class VoidLabelResponseBody { /// - /// Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later. CLOVUS + /// Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later. /// /// Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later. - [JsonPropertyName("reason_code")] - public ReasonCode? ReasonCode { get; set; } + [JsonPropertyName("reason_code"), JsonInclude] + public ReasonCode? ReasonCode { get; private set; } + /// /// Indicates whether the attempt to void the label was successful /// @@ -41,9 +42,8 @@ public partial class VoidLabelResponseBody /// /// false /// - [JsonPropertyName("approved")] - [JsonRequired] - public required bool Approved { get; set; } + [JsonPropertyName("approved"), JsonInclude] + public bool? Approved { get; private set; } /// /// Gets or Sets Message @@ -51,9 +51,8 @@ public partial class VoidLabelResponseBody /// /// Unable to delete FedEx shipment. Unable to retrieve record from database. /// - [JsonPropertyName("message")] - [JsonRequired] - public required string Message { get; set; } + [JsonPropertyName("message"), JsonInclude] + public string? Message { get; private set; } /// diff --git a/ShipEngineSDK/Model/Warehouse.cs b/ShipEngineSDK/Model/Warehouse.cs index 13c1bdb2..0ddb4780 100644 --- a/ShipEngineSDK/Model/Warehouse.cs +++ b/ShipEngineSDK/Model/Warehouse.cs @@ -35,14 +35,14 @@ public partial class Warehouse /// /// 2019-06-25T18:12:35.583Z /// - [JsonPropertyName("created_at")] - public DateTimeOffset? CreatedAt { get; set; } + [JsonPropertyName("created_at"), JsonInclude] + public DateTimeOffset? CreatedAt { get; private set; } /// /// Designates which single warehouse is the default on the account /// /// Designates which single warehouse is the default on the account - [JsonPropertyName("is_default")] + [JsonPropertyName("is_default"), JsonPropertyOrder(2)] public bool? IsDefault { get; set; } /// @@ -52,21 +52,21 @@ public partial class Warehouse /// /// Zero Cool HQ /// - [JsonPropertyName("name")] + [JsonPropertyName("name"), JsonPropertyOrder(3)] public string? Name { get; set; } /// /// The origin address of the warehouse /// /// The origin address of the warehouse - [JsonPropertyName("origin_address")] + [JsonPropertyName("origin_address"), JsonPropertyOrder(4)] public Address? OriginAddress { get; set; } /// /// The return address associated with the warehouse /// /// The return address associated with the warehouse - [JsonPropertyName("return_address")] + [JsonPropertyName("return_address"), JsonPropertyOrder(5)] public Address? ReturnAddress { get; set; } /// @@ -76,8 +76,8 @@ public partial class Warehouse /// /// se-28529731 /// - [JsonPropertyName("warehouse_id")] - public string? WarehouseId { get; set; } + [JsonPropertyName("warehouse_id"), JsonInclude] + public string? WarehouseId { get; private set; } /// diff --git a/ShipEngineSDK/Model/Webhook.cs b/ShipEngineSDK/Model/Webhook.cs index 293c0442..9bdde813 100644 --- a/ShipEngineSDK/Model/Webhook.cs +++ b/ShipEngineSDK/Model/Webhook.cs @@ -29,15 +29,16 @@ public partial class Webhook { /// - /// Gets or Sets Event CLOVUS + /// Gets or Sets Event /// - [JsonPropertyName("event")] + [JsonPropertyName("event"), JsonPropertyOrder(1)] public WebhookEvent? Event { get; set; } + /// /// Array of custom webhook headers /// /// Array of custom webhook headers - [JsonPropertyName("headers")] + [JsonPropertyName("headers"), JsonPropertyOrder(2)] public List? Headers { get; set; } /// @@ -47,7 +48,7 @@ public partial class Webhook /// /// http://api.shipengine.com/v1/labels/se-28529731 /// - [JsonPropertyName("url")] + [JsonPropertyName("url"), JsonPropertyOrder(3)] public string? Url { get; set; } /// @@ -57,8 +58,8 @@ public partial class Webhook /// /// se-28529731 /// - [JsonPropertyName("webhook_id")] - public string? WebhookId { get; set; } + [JsonPropertyName("webhook_id"), JsonInclude] + public string? WebhookId { get; private set; } /// diff --git a/ShipEngineSDK/Model/WebhookEvent.cs b/ShipEngineSDK/Model/WebhookEvent.cs index 9ad63533..169b9dd2 100644 --- a/ShipEngineSDK/Model/WebhookEvent.cs +++ b/ShipEngineSDK/Model/WebhookEvent.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(WebhookEventJsonConverter))] public class WebhookEvent { - private string _value; + private readonly string _value; /// /// Create a new instance of WebhookEvent with a predefined value. @@ -98,6 +98,12 @@ public WebhookEvent(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is WebhookEvent other && _value == other._value; } internal class WebhookEventJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/WebhookHeader.cs b/ShipEngineSDK/Model/WebhookHeader.cs index 44aa0c67..f1c4750b 100644 --- a/ShipEngineSDK/Model/WebhookHeader.cs +++ b/ShipEngineSDK/Model/WebhookHeader.cs @@ -35,8 +35,7 @@ public partial class WebhookHeader /// /// custom-key /// - [JsonPropertyName("key")] - [JsonRequired] + [JsonPropertyName("key"), JsonRequired, JsonPropertyOrder(1)] public required string Key { get; set; } /// @@ -46,8 +45,7 @@ public partial class WebhookHeader /// /// custom-value /// - [JsonPropertyName("value")] - [JsonRequired] + [JsonPropertyName("value"), JsonRequired, JsonPropertyOrder(2)] public required string Value { get; set; } diff --git a/ShipEngineSDK/Model/Weight.cs b/ShipEngineSDK/Model/Weight.cs index 89696e4a..27791660 100644 --- a/ShipEngineSDK/Model/Weight.cs +++ b/ShipEngineSDK/Model/Weight.cs @@ -29,19 +29,16 @@ public partial class Weight { /// - /// Gets or Sets Unit CLOVUS + /// Gets or Sets Unit /// - [JsonPropertyName("unit")] - [JsonRequired] - public required WeightUnit Unit { get; set; } = new(); - + [JsonPropertyName("unit"), JsonRequired, JsonPropertyOrder(1)] + public required WeightUnit Unit { get; set; } /// /// The weight, in the specified unit /// /// The weight, in the specified unit - [JsonPropertyName("value")] - [JsonRequired] + [JsonPropertyName("value"), JsonRequired, JsonPropertyOrder(2)] public required double Value { get; set; } diff --git a/ShipEngineSDK/Model/WeightUnit.cs b/ShipEngineSDK/Model/WeightUnit.cs index 3c9d9055..2beb2770 100644 --- a/ShipEngineSDK/Model/WeightUnit.cs +++ b/ShipEngineSDK/Model/WeightUnit.cs @@ -29,7 +29,7 @@ namespace ShipEngineSDK.Model; [JsonConverter(typeof(WeightUnitJsonConverter))] public class WeightUnit { - private string _value; + private readonly string _value; /// /// Create a new instance of WeightUnit with a predefined value. @@ -80,6 +80,12 @@ public WeightUnit(string value) /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is WeightUnit other && _value == other._value; } internal class WeightUnitJsonConverter : JsonConverter diff --git a/ShipEngineSDK/ShipEngineClient.cs b/ShipEngineSDK/ShipEngineClient.cs index 2e6b1201..9f30ddd2 100644 --- a/ShipEngineSDK/ShipEngineClient.cs +++ b/ShipEngineSDK/ShipEngineClient.cs @@ -23,9 +23,10 @@ public class ShipEngineClient /// Options for serializing the method call params to JSON. /// A separate inline setting is used for deserializing the response /// - protected static readonly JsonSerializerOptions JsonSerializerOptions = new JsonSerializerOptions + internal static readonly JsonSerializerOptions JsonSerializerOptions = new JsonSerializerOptions { DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull, + IgnoreReadOnlyProperties = true, PropertyNamingPolicy = JsonNamingPolicy.SnakeCaseLower, PropertyNameCaseInsensitive = true, WriteIndented = true, diff --git a/generation/templates/modelEnum.mustache b/generation/templates/modelEnum.mustache index 8f62a096..bcf0e6b6 100644 --- a/generation/templates/modelEnum.mustache +++ b/generation/templates/modelEnum.mustache @@ -7,7 +7,7 @@ [JsonConverter(typeof({{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}JsonConverter))] {{>visibility}} class {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} { - private string _value; + private readonly string _value; /// /// Create a new instance of {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} with a predefined value. @@ -53,6 +53,12 @@ /// Get a string representation of the current value /// public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} other && _value == other._value; } internal class {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}JsonConverter : JsonConverter<{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}> diff --git a/generation/templates/modelGeneric.mustache b/generation/templates/modelGeneric.mustache index 3994c613..e5591a7c 100644 --- a/generation/templates/modelGeneric.mustache +++ b/generation/templates/modelGeneric.mustache @@ -33,7 +33,7 @@ {{#isEnum}} /// - /// {{description}}{{^description}}Gets or Sets {{{name}}}{{/description}} CLOVUS + /// {{description}}{{^description}}Gets or Sets {{{name}}}{{/description}} /// {{#description}} /// {{.}} @@ -43,14 +43,8 @@ /// {{.}} /// {{/example}} - [JsonPropertyName("{{baseName}}")]{{#required}} - [JsonRequired]{{/required}} - {{#deprecated}} - [Obsolete] - {{/deprecated}} - public{{#required}} required{{/required}} {{{complexType}}}{{^complexType}}{{{datatypeWithEnum}}}{{/complexType}}{{^isContainer}}{{^required}}?{{/required}}{{/isContainer}} {{name}} { get; set; }{{#required}} = new(); - - {{/required}} + {{>partial_jsonAttributes}} + public{{>partial_requiredAttribute}} {{{complexType}}}{{^complexType}}{{{datatypeWithEnum}}}{{/complexType}}{{^isContainer}}{{>partial_optional}}{{/isContainer}} {{name}} {{>partial_getSet}} {{/isEnum}} {{/vars}} @@ -74,15 +68,8 @@ /// {{.}} /// {{/example}} - [JsonPropertyName("{{baseName}}")]{{#required}} - [JsonRequired]{{/required}} - {{#isDate}} - [JsonConverter(typeof(DateJsonConverter))] - {{/isDate}} - {{#deprecated}} - [Obsolete] - {{/deprecated}} - public{{#required}} required{{/required}} {{{dataType}}}{{^required}}?{{/required}} {{name}} { get; set; } + {{>partial_jsonAttributes}} + public{{>partial_requiredAttribute}} {{{dataType}}}{{>partial_optional}} {{name}} {{>partial_getSet}} {{#-last}} } @@ -97,15 +84,8 @@ /// {{.}} /// {{/example}} - [JsonPropertyName("{{baseName}}")]{{#required}} - [JsonRequired]{{/required}} - {{#isDate}} - [JsonConverter(typeof(DateJsonConverter))] - {{/isDate}} - {{#deprecated}} - [Obsolete] - {{/deprecated}} - public{{#required}} required{{/required}} {{#items.vars}}{{#-first}}List<{{classname}}Item>{{/-first}}{{/items.vars}}{{^items.vars}}{{{dataType}}}{{/items.vars}}{{^required}}?{{/required}} {{name}} { get; set; } + {{>partial_jsonAttributes}} + public{{>partial_requiredAttribute}} {{#items.vars}}{{#-first}}List<{{classname}}Item>{{/-first}}{{/items.vars}}{{^items.vars}}{{{dataType}}}{{/items.vars}}{{>partial_optional}} {{name}} {{>partial_getSet}} {{/isEnum}} {{/isInherited}} @@ -115,7 +95,7 @@ /// Gets or Sets additional properties /// [JsonExtensionData] - public IDictionary AdditionalProperties { get; set; } = new Dictionary(); + public IDictionary AdditionalProperties {{>partial_getSet}} = new Dictionary(); {{/isAdditionalPropertiesTrue}} diff --git a/generation/templates/modelOneOf.mustache b/generation/templates/modelOneOf.mustache index 2580a153..1a531395 100644 --- a/generation/templates/modelOneOf.mustache +++ b/generation/templates/modelOneOf.mustache @@ -39,12 +39,8 @@ /// {{.}} /// {{/example}} - [JsonPropertyName("{{baseName}}")]{{#required}} - [JsonRequired]{{/required}} - {{#deprecated}} - [Obsolete] - {{/deprecated}} - public{{#required}} required{{/required}} {{{complexType}}}{{^complexType}}{{{datatypeWithEnum}}}{{/complexType}}{{^isContainer}}{{^required}}?{{/required}}{{/isContainer}} {{name}} { get; set; }{{#required}} = new(); + {{>partial_jsonAttributes}} + public{{>partial_requiredAttribute}} {{{complexType}}}{{^complexType}}{{{datatypeWithEnum}}}{{/complexType}}{{^isContainer}}{{>partial_optional}}{{/isContainer}} {{name}} {{>partial_getSet}}{{#required}} = new(); {{/required}} {{/isEnum}} @@ -62,15 +58,8 @@ /// {{.}} /// {{/example}} - [JsonPropertyName("{{baseName}}")]{{#required}} - [JsonRequired]{{/required}} - {{#isDate}} - [JsonConverter(typeof(DateJsonConverter))] - {{/isDate}} - {{#deprecated}} - [Obsolete] - {{/deprecated}} - public{{#required}} required{{/required}} {{{dataType}}}{{^required}}?{{/required}} {{name}} { get; set; } + {{>partial_jsonAttributes}} + public{{>partial_requiredAttribute}} {{{dataType}}}{{>partial_optional}} {{name}} {{>partial_getSet}} {{/isEnum}} {{/isInherited}} @@ -81,7 +70,7 @@ /// Gets or Sets additional properties /// [JsonExtensionData] - public IDictionary AdditionalProperties { get; set; } = new Dictionary(); + public IDictionary AdditionalProperties {{>partial_getSet}} = new Dictionary(); {{/isAdditionalPropertiesTrue}} diff --git a/generation/templates/partial_getSet.mustache b/generation/templates/partial_getSet.mustache new file mode 100644 index 00000000..7609e35a --- /dev/null +++ b/generation/templates/partial_getSet.mustache @@ -0,0 +1 @@ +{ get; {{#isReadOnly}}private {{/isReadOnly}}set; } \ No newline at end of file diff --git a/generation/templates/partial_jsonAttributes.mustache b/generation/templates/partial_jsonAttributes.mustache new file mode 100644 index 00000000..f7dba4f3 --- /dev/null +++ b/generation/templates/partial_jsonAttributes.mustache @@ -0,0 +1 @@ +[JsonPropertyName("{{baseName}}"){{^isReadOnly}}{{#required}}, JsonRequired{{/required}}, JsonPropertyOrder({{-index}}){{/isReadOnly}}{{#isReadOnly}}, JsonInclude{{/isReadOnly}}{{#isDate}}, JsonConverter(typeof(DateJsonConverter)){{/isDate}}{{#deprecated}}, Obsolete{{/deprecated}}] \ No newline at end of file diff --git a/generation/templates/partial_optional.mustache b/generation/templates/partial_optional.mustache new file mode 100644 index 00000000..dee66315 --- /dev/null +++ b/generation/templates/partial_optional.mustache @@ -0,0 +1 @@ +{{#isReadOnly}}?{{/isReadOnly}}{{^isReadOnly}}{{^required}}?{{/required}}{{/isReadOnly}} \ No newline at end of file diff --git a/generation/templates/partial_requiredAttribute.mustache b/generation/templates/partial_requiredAttribute.mustache new file mode 100644 index 00000000..15707f91 --- /dev/null +++ b/generation/templates/partial_requiredAttribute.mustache @@ -0,0 +1 @@ +{{^isReadOnly}}{{#required}} required{{/required}}{{/isReadOnly}} \ No newline at end of file From 0606dffdbb41a5a6678590ca5c9aaf18436d1717 Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Wed, 17 Jul 2024 17:03:08 -0500 Subject: [PATCH 11/42] Better handle reaonly and writeonly properties --- CHANGELOG.md | 10 +- ShipEngineSDK.Test/SerializationTests.cs | 12 +- ShipEngineSDK/JsonWriteOnlyAttribute.cs | 12 ++ ShipEngineSDK/Model/AccountSettings.cs | 2 +- ShipEngineSDK/Model/AccountSettingsImages.cs | 16 +-- .../Model/AddFundsToCarrierRequestBody.cs | 6 +- .../Model/AddFundsToCarrierResponseBody.cs | 2 +- .../Model/AddFundsToInsuranceRequestBody.cs | 6 +- .../Model/AddFundsToInsuranceResponseBody.cs | 6 +- ShipEngineSDK/Model/AddToBatchRequestBody.cs | 2 +- ShipEngineSDK/Model/Address.cs | 30 ++--- .../Model/AddressResidentialIndicator.cs | 5 + ShipEngineSDK/Model/AddressToValidate.cs | 24 ++-- .../Model/AddressValidatingShipment.cs | 76 +++++------ ShipEngineSDK/Model/AddressValidationCode.cs | 5 + .../Model/AddressValidationDetailCode.cs | 5 + .../Model/AddressValidationMessageType.cs | 5 + .../Model/AddressValidationResult.cs | 16 +-- .../Model/AddressValidationStatus.cs | 5 + .../Model/AdvancedShipmentOptions.cs | 28 ++-- ...cedShipmentOptionsDangerousGoodsContact.cs | 2 +- .../AdvancedShipmentOptionsFedexFreight.cs | 2 +- ShipEngineSDK/Model/AllowedIncoterms.cs | 5 + ShipEngineSDK/Model/AlternativeIdentifier.cs | 2 +- ShipEngineSDK/Model/AlternativeIdentifiers.cs | 2 +- .../Model/AncillaryServiceEndorsement.cs | 5 + ShipEngineSDK/Model/Batch.cs | 44 +++---- ShipEngineSDK/Model/BatchResponseError.cs | 2 +- ShipEngineSDK/Model/BatchStatus.cs | 5 + ShipEngineSDK/Model/BatchesSortBy.cs | 5 + ShipEngineSDK/Model/BillToParty.cs | 5 + ShipEngineSDK/Model/BulkRate.cs | 14 +- .../Model/CalculateRatesResponseBody.cs | 68 +++++----- ShipEngineSDK/Model/Carrier.cs | 2 +- ShipEngineSDK/Model/CarrierAdvancedOption.cs | 2 +- ShipEngineSDK/Model/CarrierName.cs | 5 + .../Model/CarrierNameWithSettings.cs | 5 + ShipEngineSDK/Model/CollectOnDelivery.cs | 14 +- .../Model/CollectOnDeliveryPaymentType.cs | 5 + .../Model/CompareBulkRatesRequestBody.cs | 2 +- .../ConnectAccessWorldwideRequestBody.cs | 8 +- .../ConnectAmazonBuyShippingRequestBody.cs | 10 +- .../Model/ConnectAmazonShippingUk.cs | 6 +- ShipEngineSDK/Model/ConnectApcRequestBody.cs | 8 +- .../Model/ConnectAsendiaRequestBody.cs | 10 +- .../Model/ConnectAustraliaPostRequestBody.cs | 10 +- .../Model/ConnectCanadaPostRequestBody.cs | 12 +- .../Model/ConnectCarrierResponseBody.cs | 4 +- .../Model/ConnectDhlEcommerceRequestBody.cs | 26 ++-- .../Model/ConnectDhlExpressAuRequestBody.cs | 6 +- .../Model/ConnectDhlExpressCaRequestBody.cs | 6 +- .../Model/ConnectDhlExpressRequestBody.cs | 6 +- .../Model/ConnectDhlExpressUkRequestBody.cs | 10 +- ShipEngineSDK/Model/ConnectDpdRequestBody.cs | 8 +- .../Model/ConnectEndiciaRequestBody.cs | 8 +- .../Model/ConnectFedexRequestBody.cs | 26 ++-- .../Model/ConnectFedexUkRequestBody.cs | 26 ++-- .../Model/ConnectFirstmileRequestBody.cs | 8 +- ShipEngineSDK/Model/ConnectImexRequestBody.cs | 8 +- .../Model/ConnectInsurerRequestBody.cs | 6 +- .../Model/ConnectLasershipRequestBody.cs | 22 ++-- .../Model/ConnectNewgisticsRequestBody.cs | 6 +- .../Model/ConnectOntracRequestBody.cs | 8 +- .../Model/ConnectPurolatorRequestBody.cs | 8 +- .../Model/ConnectRoyalMailRequestBody.cs | 12 +- .../Model/ConnectRrDonnelleyRequestBody.cs | 8 +- ShipEngineSDK/Model/ConnectSekoRequestBody.cs | 6 +- .../Model/ConnectSendleRequestBody.cs | 8 +- .../Model/ConnectStampsRequestBody.cs | 8 +- ShipEngineSDK/Model/ConnectUpsRequestBody.cs | 6 +- ShipEngineSDK/Model/ContactDetails.cs | 8 +- .../CreateAccountSettingsImageRequestBody.cs | 8 +- .../Model/CreateAndProcessBatchRequestBody.cs | 2 +- ...AndProcessBatchRequestBodyProcessLabels.cs | 16 +-- .../Model/CreateAndValidateShipment.cs | 56 ++++---- ShipEngineSDK/Model/CreateBatchRequestBody.cs | 2 +- .../Model/CreateBatchResponseBody.cs | 44 +++---- .../Model/CreateLabelFromRateRequestBody.cs | 2 +- .../Model/CreateLabelFromRateResponseBody.cs | 114 ++++++++--------- .../CreateLabelFromShipmentRequestBody.cs | 2 +- .../CreateLabelFromShipmentResponseBody.cs | 114 ++++++++--------- ShipEngineSDK/Model/CreateLabelRequestBody.cs | 114 ++++++++--------- .../Model/CreateLabelResponseBody.cs | 120 +++++++++--------- .../CreateManifestByObjectRequestBody.cs | 8 +- .../CreateManifestLabelIdsRequestBody.cs | 4 +- .../Model/CreateManifestResponseBody.cs | 20 +-- .../Model/CreatePackageTypeRequestBody.cs | 6 +- .../Model/CreatePackageTypeResponseBody.cs | 6 +- .../Model/CreateReturnLabelRequestBody.cs | 18 +-- .../Model/CreateReturnLabelResponseBody.cs | 114 ++++++++--------- .../Model/CreateShipmentResponseBodyFields.cs | 2 +- .../Model/CreateShipmentsRequestBody.cs | 4 +- .../Model/CreateShipmentsResponseBody.cs | 6 +- ShipEngineSDK/Model/CreateTagResponseBody.cs | 4 +- .../Model/CreateWarehouseRequestBody.cs | 6 +- .../Model/CreateWarehouseResponseBody.cs | 8 +- .../Model/CreateWebhookRequestBody.cs | 6 +- .../Model/CreateWebhookResponseBody.cs | 6 +- ShipEngineSDK/Model/CustomsItem.cs | 2 +- ShipEngineSDK/Model/DangerousAmount.cs | 2 +- ShipEngineSDK/Model/DangerousGoods.cs | 50 ++++---- ShipEngineSDK/Model/DefaultLabelLayout.cs | 5 + .../Model/DeletePickupByIdResponseBody.cs | 6 +- .../DeleteScheduledPickupResponseBody.cs | 4 +- ShipEngineSDK/Model/DeliveryConfirmation.cs | 5 + ShipEngineSDK/Model/DeprecatedManifest.cs | 2 +- .../Model/DhlExpressAccountSettings.cs | 2 +- .../Model/DhlExpressSettingsResponseBody.cs | 2 +- ShipEngineSDK/Model/DimensionUnit.cs | 5 + ShipEngineSDK/Model/Dimensions.cs | 10 +- ShipEngineSDK/Model/DisplayScheme.cs | 5 + ShipEngineSDK/Model/Error.cs | 8 +- ShipEngineSDK/Model/ErrorCode.cs | 5 + ShipEngineSDK/Model/ErrorResponseBody.cs | 4 +- ShipEngineSDK/Model/ErrorSource.cs | 5 + ShipEngineSDK/Model/ErrorType.cs | 5 + .../Model/ErrorWithLabelIdResponseBody.cs | 4 +- .../Model/EstimateRatesRequestBody.cs | 38 +++--- ShipEngineSDK/Model/FedexAccountSettings.cs | 38 +++--- .../Model/FedexAccountSettingsRequestBody.cs | 38 +++--- ShipEngineSDK/Model/FedexPickupType.cs | 5 + .../Model/FedexSettingsResponseBody.cs | 38 +++--- .../GetAccountSettingsImagesResponseBody.cs | 16 +-- .../Model/GetAccountSettingsResponseBody.cs | 2 +- .../Model/GetBatchByExternalIdResponseBody.cs | 44 +++---- .../Model/GetBatchByIdResponseBody.cs | 44 +++---- .../Model/GetCarrierByIdResponseBody.cs | 2 +- .../Model/GetCarrierOptionsResponseBody.cs | 2 +- .../Model/GetCarriersResponseBody.cs | 4 +- .../Model/GetInsuranceBalanceResponseBody.cs | 6 +- ...etLabelByExternalShipmentIdResponseBody.cs | 114 ++++++++--------- .../Model/GetLabelByIdResponseBody.cs | 114 ++++++++--------- .../Model/GetManifestByIdResponseBody.cs | 2 +- .../Model/GetPackageTypeByIdResponseBody.cs | 6 +- .../Model/GetPickupByIdResponseBody.cs | 10 +- ShipEngineSDK/Model/GetPickupsResponseBody.cs | 6 +- .../Model/GetRateByIdResponseBody.cs | 26 ++-- .../Model/GetServicePointByIdResponseBody.cs | 2 +- ...ervicePointByIdResponseBodyServicePoint.cs | 16 +-- .../Model/GetServicePointsRequestBody.cs | 4 +- .../GetServicePointsRequestBodyAddress.cs | 4 +- ...tServicePointsRequestBodyProvidersInner.cs | 2 +- .../GetServicePointsRequestBodyShipment.cs | 2 +- .../GetShipmentByExternalIdResponseBody.cs | 76 +++++------ .../Model/GetShipmentByIdResponseBody.cs | 76 +++++------ .../GetTrackingLogFromLabelResponseBody.cs | 18 +-- .../Model/GetTrackingLogResponseBody.cs | 22 ++-- .../Model/GetWarehouseByIdResponseBody.cs | 8 +- .../Model/GetWebhookByIdResponseBody.cs | 6 +- ShipEngineSDK/Model/IdentifierType.cs | 5 + ShipEngineSDK/Model/ImporterOfRecords.cs | 12 +- ShipEngineSDK/Model/InsuranceProvider.cs | 5 + .../Model/InternationalShipmentOptions.cs | 20 +-- .../Model/InvoiceAdditionalDetails.cs | 2 +- ShipEngineSDK/Model/Label.cs | 114 ++++++++--------- ShipEngineSDK/Model/LabelChargeEvent.cs | 5 + ShipEngineSDK/Model/LabelDownload.cs | 2 +- ShipEngineSDK/Model/LabelDownloadType.cs | 5 + ShipEngineSDK/Model/LabelFormat.cs | 5 + ShipEngineSDK/Model/LabelLayout.cs | 5 + ShipEngineSDK/Model/LabelMessages.cs | 8 +- ShipEngineSDK/Model/LabelPackagesInner.cs | 4 +- ShipEngineSDK/Model/LabelStatus.cs | 5 + ShipEngineSDK/Model/Link.cs | 4 +- .../Model/ListAccountImagesResponseBody.cs | 10 +- .../Model/ListAccountSettingsBody.cs | 2 +- .../ListAccountSettingsImagesResponseBody.cs | 10 +- .../Model/ListBatchErrorsResponseBody.cs | 2 +- .../Model/ListBatchesResponseBody.cs | 2 +- .../ListCarrierPackageTypesResponseBody.cs | 2 +- .../Model/ListCarrierServicesResponseBody.cs | 2 +- .../Model/ListCarriersResponseBody.cs | 2 +- ShipEngineSDK/Model/ListLabelsResponseBody.cs | 22 ++-- .../Model/ListManifestsResponseBody.cs | 2 +- .../Model/ListPackageTypesResponseBody.cs | 2 +- ShipEngineSDK/Model/ListPickupResponseBody.cs | 4 +- .../Model/ListServicePointsResponseBody.cs | 2 +- ...icePointsResponseBodyServicePointsInner.cs | 16 +-- ...eBodyServicePointsInnerHoursOfOperation.cs | 2 +- ...ePointsInnerHoursOfOperationMondayInner.cs | 2 +- .../Model/ListShipmentRatesResponseBody.cs | 18 +-- .../Model/ListShipmentsResponseBody.cs | 2 +- ShipEngineSDK/Model/ListTagsResponseBody.cs | 2 +- .../Model/ListWarehousesResponseBody.cs | 2 +- ShipEngineSDK/Model/Manifest.cs | 2 +- ShipEngineSDK/Model/ManifestDownload.cs | 2 +- ShipEngineSDK/Model/ManifestRequest.cs | 14 +- ShipEngineSDK/Model/ManifestRequestStatus.cs | 5 + ShipEngineSDK/Model/Manifests.cs | 2 +- ShipEngineSDK/Model/ManifestsRequests.cs | 2 +- ShipEngineSDK/Model/ModifyBatch.cs | 2 +- ShipEngineSDK/Model/MonetaryValue.cs | 6 +- ShipEngineSDK/Model/NonDelivery.cs | 5 + ShipEngineSDK/Model/OptionalLink.cs | 2 +- ShipEngineSDK/Model/OrderSourceName.cs | 5 + ShipEngineSDK/Model/OriginType.cs | 5 + ShipEngineSDK/Model/Package.cs | 4 +- ShipEngineSDK/Model/PackageContents.cs | 5 + ShipEngineSDK/Model/PackageType.cs | 6 +- ShipEngineSDK/Model/PackagingGroup.cs | 5 + .../Model/PackagingInstructionSection.cs | 5 + ShipEngineSDK/Model/PagedListResponseBody.cs | 10 +- ShipEngineSDK/Model/PaginationLink.cs | 10 +- ShipEngineSDK/Model/PaperlessDownload.cs | 2 +- .../Model/ParseAddressRequestBody.cs | 4 +- .../Model/ParseAddressResponseBody.cs | 8 +- .../Model/ParseShipmentRequestBody.cs | 4 +- .../Model/ParseShipmentResponseBody.cs | 8 +- ShipEngineSDK/Model/PartialAddress.cs | 16 +-- ShipEngineSDK/Model/PartialShipment.cs | 56 ++++---- ShipEngineSDK/Model/PartialShippingAddress.cs | 2 +- .../Model/PartialShippingAddressTo.cs | 2 +- ...artialShippingAddressToGeolocationInner.cs | 2 +- ShipEngineSDK/Model/PaymentAmount.cs | 2 +- ShipEngineSDK/Model/Pickup.cs | 8 +- ShipEngineSDK/Model/PickupResponseBody.cs | 8 +- ShipEngineSDK/Model/PickupWindow.cs | 6 +- ShipEngineSDK/Model/PickupWindows.cs | 2 +- .../Model/ProcessBatchRequestBody.cs | 2 +- ShipEngineSDK/Model/Products.cs | 2 +- .../Model/PurchaseLabelWithoutShipment.cs | 2 +- ShipEngineSDK/Model/Rate.cs | 26 ++-- ShipEngineSDK/Model/RateEstimate.cs | 26 ++-- .../Model/RateEstimateByCarrierId.cs | 2 +- .../Model/RateEstimateByCarrierIds.cs | 2 +- ShipEngineSDK/Model/RateEstimateOptions.cs | 2 +- ShipEngineSDK/Model/RateRequestBody.cs | 4 +- .../Model/RateRequestByShipmentIds.cs | 4 +- ShipEngineSDK/Model/RateRequestByShipments.cs | 4 +- ShipEngineSDK/Model/RateRequestOptions.cs | 2 +- ShipEngineSDK/Model/RateRequestRateOptions.cs | 2 +- ShipEngineSDK/Model/RateResponse.cs | 2 +- ShipEngineSDK/Model/RateResponseStatus.cs | 5 + ShipEngineSDK/Model/RateType.cs | 5 + ShipEngineSDK/Model/RatesInformation.cs | 14 +- ShipEngineSDK/Model/ReasonCode.cs | 5 + ShipEngineSDK/Model/RecognizedEntity.cs | 12 +- ShipEngineSDK/Model/Redirect.cs | 5 + ShipEngineSDK/Model/RegulationLevel.cs | 5 + .../Model/RemoveFromBatchRequestBody.cs | 2 +- ShipEngineSDK/Model/ResponseMessage.cs | 24 ++-- .../Model/SchedulePickupRequestBody.cs | 8 +- .../Model/SchedulePickupResponseBody.cs | 4 +- ShipEngineSDK/Model/Service.cs | 2 +- ShipEngineSDK/Model/Shipment.cs | 76 +++++------ ShipEngineSDK/Model/ShipmentIdRequest.cs | 2 +- ShipEngineSDK/Model/ShipmentItem.cs | 14 +- ShipEngineSDK/Model/ShipmentRequest.cs | 2 +- ShipEngineSDK/Model/ShipmentStatus.cs | 5 + ShipEngineSDK/Model/ShipmentsSortBy.cs | 5 + ShipEngineSDK/Model/ShippingAddress.cs | 30 ++--- ShipEngineSDK/Model/ShippingAddressTo.cs | 30 ++--- ShipEngineSDK/Model/SmartPostHub.cs | 5 + ShipEngineSDK/Model/SortDir.cs | 5 + ShipEngineSDK/Model/StatusCode.cs | 5 + ShipEngineSDK/Model/Tag.cs | 4 +- .../Model/TagShipmentResponseBody.cs | 4 +- ShipEngineSDK/Model/TaxIdentifier.cs | 20 +-- ShipEngineSDK/Model/TaxableEntityType.cs | 5 + ...TokensGetEphemeralTokenResponseBodyYaml.cs | 2 +- ShipEngineSDK/Model/TrackEvent.cs | 16 +-- ShipEngineSDK/Model/TrackingInformation.cs | 14 +- ShipEngineSDK/Model/TrackingStatus.cs | 5 + ShipEngineSDK/Model/TransportMean.cs | 5 + .../UpdateAccountSettingsImageRequestBody.cs | 18 +-- .../UpdateAmazonBuyShippingRequestBody.cs | 2 +- .../UpdateDhlExpressSettingsRequestBody.cs | 2 +- .../Model/UpdateFedexSettingsRequestBody.cs | 38 +++--- .../UpdateNewgisticsSettingsRequestBody.cs | 2 +- .../Model/UpdatePackageTypeRequestBody.cs | 6 +- ShipEngineSDK/Model/UpdateShipmentFields.cs | 2 +- .../Model/UpdateShipmentRequestBody.cs | 72 +++++------ .../Model/UpdateShipmentResponseBody.cs | 76 +++++------ ShipEngineSDK/Model/UpdateShipmentsTags.cs | 2 +- .../Model/UpdateShipmentsTagsRequestBody.cs | 2 +- .../UpdateShipmentsTagsShipmentsTagsInner.cs | 2 +- .../Model/UpdateUpsSettingsRequestBody.cs | 26 ++-- .../Model/UpdateWarehouseRequestBody.cs | 6 +- .../UpdateWarehouseSettingsRequestBody.cs | 2 +- .../Model/UpdateWebhookRequestBody.cs | 2 +- ShipEngineSDK/Model/UpsAccountSettings.cs | 26 ++-- ShipEngineSDK/Model/UpsInvoice.cs | 2 +- ShipEngineSDK/Model/UpsPickupType.cs | 5 + .../Model/UpsSettingsResponseBody.cs | 26 ++-- ShipEngineSDK/Model/ValidateAddress.cs | 5 + ShipEngineSDK/Model/ValidateShipmentFields.cs | 2 +- ShipEngineSDK/Model/ValidationStatus.cs | 5 + ShipEngineSDK/Model/VoidLabelResponseBody.cs | 16 +-- ShipEngineSDK/Model/Warehouse.cs | 2 +- ShipEngineSDK/Model/Webhook.cs | 2 +- ShipEngineSDK/Model/WebhookEvent.cs | 5 + ShipEngineSDK/Model/WebhookHeader.cs | 6 +- ShipEngineSDK/Model/Weight.cs | 6 +- ShipEngineSDK/Model/WeightUnit.cs | 5 + ShipEngineSDK/ShipEngineClient.cs | 33 ++++- ShipEngineSDK/ShipEngineSDK.csproj | 2 +- generation/templates/modelEnum.mustache | 5 + generation/templates/modelGeneric.mustache | 12 +- generation/templates/modelOneOf.mustache | 7 +- .../templates/partial_jsonAttributes.mustache | 2 +- openapitools.json | 2 +- package.json | 2 +- 302 files changed, 2113 insertions(+), 1803 deletions(-) create mode 100644 ShipEngineSDK/JsonWriteOnlyAttribute.cs diff --git a/CHANGELOG.md b/CHANGELOG.md index bbe10e5f..9a04fd5a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -169,4 +169,12 @@ Updated nuget package dependencies ## Changed -- Add more explicit nullable reference types \ No newline at end of file +- Add more explicit nullable reference types + +## 3.0.0-beta.3 + +## Changed + +- Don't require any properties for deserialization so that small API changes don't completely break consumers +- Don't try to serialize read-only properties +- Don't try to deserialize write-only properties \ No newline at end of file diff --git a/ShipEngineSDK.Test/SerializationTests.cs b/ShipEngineSDK.Test/SerializationTests.cs index e0cbec83..b4200f3c 100644 --- a/ShipEngineSDK.Test/SerializationTests.cs +++ b/ShipEngineSDK.Test/SerializationTests.cs @@ -101,16 +101,14 @@ public void WhenSerializing_ItShouldIncludeWriteOnlyProperties() public void WhenDeserializing_ItShouldNotIncludeWriteOnlyProperties() { var json = @"{ - ""pickup_window"": { - ""end_at"": ""2024-07-19T12:27:35+00:00"", - ""start_at"": ""2024-07-17T12:27:35+00:00"" - } + ""label_download_type"": ""inline"", + ""label_format"": ""png"" }"; - var pickup = JsonSerializer.Deserialize(json, ShipEngineClient.JsonSerializerOptions); + var pickup = JsonSerializer.Deserialize(json, ShipEngineClient.JsonSerializerOptions); - Assert.Equal("se-12345", pickup.CarrierId); - Assert.Null(pickup.PickupWindow); + Assert.Equal(LabelFormat.Png, pickup.LabelFormat); + Assert.Null(pickup.LabelDownloadType); } } } diff --git a/ShipEngineSDK/JsonWriteOnlyAttribute.cs b/ShipEngineSDK/JsonWriteOnlyAttribute.cs new file mode 100644 index 00000000..067b1a21 --- /dev/null +++ b/ShipEngineSDK/JsonWriteOnlyAttribute.cs @@ -0,0 +1,12 @@ +using System; + +namespace ShipEngineSDK; + +/// +/// Marks a property as write only, which means it won't be deserialized +/// +[AttributeUsage(AttributeTargets.Property)] +internal class JsonWriteOnlyAttribute : Attribute +{ + +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/AccountSettings.cs b/ShipEngineSDK/Model/AccountSettings.cs index 83044028..0bd33f26 100644 --- a/ShipEngineSDK/Model/AccountSettings.cs +++ b/ShipEngineSDK/Model/AccountSettings.cs @@ -41,7 +41,7 @@ public partial class AccountSettings /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class AccountSettings {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" DefaultLabelLayout: ").Append(DefaultLabelLayout).Append("\n"); diff --git a/ShipEngineSDK/Model/AccountSettingsImages.cs b/ShipEngineSDK/Model/AccountSettingsImages.cs index 501219ba..dd6a64fc 100644 --- a/ShipEngineSDK/Model/AccountSettingsImages.cs +++ b/ShipEngineSDK/Model/AccountSettingsImages.cs @@ -88,13 +88,6 @@ public override bool CanConvert(Type typeToConvert) => } - /// - /// The image type - /// - /// The image type - [JsonPropertyName("image_content_type"), JsonPropertyOrder(2)] - public ImageContentTypeEnum? ImageContentType { get; set; } - /// /// The date and time that the image was created in ShipEngine. /// @@ -105,6 +98,13 @@ public override bool CanConvert(Type typeToConvert) => [JsonPropertyName("created_at"), JsonInclude] public DateTimeOffset? CreatedAt { get; private set; } + /// + /// The image type + /// + /// The image type + [JsonPropertyName("image_content_type"), JsonPropertyOrder(2)] + public ImageContentTypeEnum? ImageContentType { get; set; } + /// /// A base64 encoded string representation of the image. /// @@ -162,7 +162,7 @@ public override bool CanConvert(Type typeToConvert) => /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class AccountSettingsImages {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); diff --git a/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs b/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs index 27a9a343..43be557b 100644 --- a/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs +++ b/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs @@ -32,14 +32,14 @@ public partial class AddFundsToCarrierRequestBody /// The monetary amount, in the specified currency. /// /// The monetary amount, in the specified currency. - [JsonPropertyName("amount"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("amount"), JsonPropertyOrder(1)] public required double Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("currency"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("currency"), JsonPropertyOrder(2)] public required string Currency { get; set; } @@ -49,7 +49,7 @@ public partial class AddFundsToCarrierRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class AddFundsToCarrierRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Amount: ").Append(Amount).Append("\n"); diff --git a/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs b/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs index 85e77ebf..fc345f93 100644 --- a/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs +++ b/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs @@ -42,7 +42,7 @@ public partial class AddFundsToCarrierResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class AddFundsToCarrierResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Balance: ").Append(Balance).Append("\n"); diff --git a/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs b/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs index e2ff3640..4506da48 100644 --- a/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs +++ b/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs @@ -32,14 +32,14 @@ public partial class AddFundsToInsuranceRequestBody /// The monetary amount, in the specified currency. /// /// The monetary amount, in the specified currency. - [JsonPropertyName("amount"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("amount"), JsonPropertyOrder(1)] public required double Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("currency"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("currency"), JsonPropertyOrder(2)] public required string Currency { get; set; } @@ -49,7 +49,7 @@ public partial class AddFundsToInsuranceRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class AddFundsToInsuranceRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Amount: ").Append(Amount).Append("\n"); diff --git a/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs b/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs index 36bd1b15..4c12ccc6 100644 --- a/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs +++ b/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs @@ -32,14 +32,14 @@ public partial class AddFundsToInsuranceResponseBody /// The monetary amount, in the specified currency. /// /// The monetary amount, in the specified currency. - [JsonPropertyName("amount"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("amount"), JsonPropertyOrder(1)] public required double Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("currency"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("currency"), JsonPropertyOrder(2)] public required string Currency { get; set; } @@ -49,7 +49,7 @@ public partial class AddFundsToInsuranceResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class AddFundsToInsuranceResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Amount: ").Append(Amount).Append("\n"); diff --git a/ShipEngineSDK/Model/AddToBatchRequestBody.cs b/ShipEngineSDK/Model/AddToBatchRequestBody.cs index c7541760..78e8b206 100644 --- a/ShipEngineSDK/Model/AddToBatchRequestBody.cs +++ b/ShipEngineSDK/Model/AddToBatchRequestBody.cs @@ -49,7 +49,7 @@ public partial class AddToBatchRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class AddToBatchRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" RateIds: ").Append(RateIds).Append("\n"); diff --git a/ShipEngineSDK/Model/Address.cs b/ShipEngineSDK/Model/Address.cs index 255f165a..089abb25 100644 --- a/ShipEngineSDK/Model/Address.cs +++ b/ShipEngineSDK/Model/Address.cs @@ -28,13 +28,6 @@ namespace ShipEngineSDK.Model; public partial class Address { - /// - /// Indicates whether this is a residential address. - /// - /// Indicates whether this is a residential address. - [JsonPropertyName("address_residential_indicator"), JsonRequired, JsonPropertyOrder(2)] - public required AddressResidentialIndicator AddressResidentialIndicator { get; set; } - /// /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. /// @@ -42,9 +35,16 @@ public partial class Address /// /// 1999 Bishop Grandin Blvd. /// - [JsonPropertyName("address_line1"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("address_line1"), JsonPropertyOrder(1)] public required string AddressLine1 { get; set; } + /// + /// Indicates whether this is a residential address. + /// + /// Indicates whether this is a residential address. + [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(2)] + public required AddressResidentialIndicator AddressResidentialIndicator { get; set; } + /// /// The name of the city or locality /// @@ -52,7 +52,7 @@ public partial class Address /// /// Winnipeg /// - [JsonPropertyName("city_locality"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("city_locality"), JsonPropertyOrder(3)] public required string CityLocality { get; set; } /// @@ -62,7 +62,7 @@ public partial class Address /// /// CA /// - [JsonPropertyName("country_code"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("country_code"), JsonPropertyOrder(4)] public required string CountryCode { get; set; } /// @@ -72,7 +72,7 @@ public partial class Address /// /// John Doe /// - [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("name"), JsonPropertyOrder(5)] public required string Name { get; set; } /// @@ -82,7 +82,7 @@ public partial class Address /// /// +1 204-253-9411 ext. 123 /// - [JsonPropertyName("phone"), JsonRequired, JsonPropertyOrder(6)] + [JsonPropertyName("phone"), JsonPropertyOrder(6)] public required string Phone { get; set; } /// @@ -92,7 +92,7 @@ public partial class Address /// /// 78756-3717 /// - [JsonPropertyName("postal_code"), JsonRequired, JsonPropertyOrder(7)] + [JsonPropertyName("postal_code"), JsonPropertyOrder(7)] public required string PostalCode { get; set; } /// @@ -102,7 +102,7 @@ public partial class Address /// /// Manitoba /// - [JsonPropertyName("state_province"), JsonRequired, JsonPropertyOrder(8)] + [JsonPropertyName("state_province"), JsonPropertyOrder(8)] public required string StateProvince { get; set; } /// @@ -152,7 +152,7 @@ public partial class Address /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class Address {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); diff --git a/ShipEngineSDK/Model/AddressResidentialIndicator.cs b/ShipEngineSDK/Model/AddressResidentialIndicator.cs index 5765f3e7..145fabb4 100644 --- a/ShipEngineSDK/Model/AddressResidentialIndicator.cs +++ b/ShipEngineSDK/Model/AddressResidentialIndicator.cs @@ -80,6 +80,11 @@ public AddressResidentialIndicator(string value) /// public override bool Equals(object? obj) => obj is AddressResidentialIndicator other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class AddressResidentialIndicatorJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/AddressToValidate.cs b/ShipEngineSDK/Model/AddressToValidate.cs index e324d159..0871b482 100644 --- a/ShipEngineSDK/Model/AddressToValidate.cs +++ b/ShipEngineSDK/Model/AddressToValidate.cs @@ -28,13 +28,6 @@ namespace ShipEngineSDK.Model; public partial class AddressToValidate { - /// - /// Indicates whether this is a residential address. - /// - /// Indicates whether this is a residential address. - [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(7)] - public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } - /// /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. /// @@ -42,7 +35,7 @@ public partial class AddressToValidate /// /// 1999 Bishop Grandin Blvd. /// - [JsonPropertyName("address_line1"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("address_line1"), JsonPropertyOrder(1)] public required string AddressLine1 { get; set; } /// @@ -52,7 +45,7 @@ public partial class AddressToValidate /// /// Winnipeg /// - [JsonPropertyName("city_locality"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("city_locality"), JsonPropertyOrder(2)] public required string CityLocality { get; set; } /// @@ -62,7 +55,7 @@ public partial class AddressToValidate /// /// CA /// - [JsonPropertyName("country_code"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("country_code"), JsonPropertyOrder(3)] public required string CountryCode { get; set; } /// @@ -72,7 +65,7 @@ public partial class AddressToValidate /// /// Manitoba /// - [JsonPropertyName("state_province"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("state_province"), JsonPropertyOrder(4)] public required string StateProvince { get; set; } /// @@ -95,6 +88,13 @@ public partial class AddressToValidate [JsonPropertyName("address_line3"), JsonPropertyOrder(6)] public string? AddressLine3 { get; set; } + /// + /// Indicates whether this is a residential address. + /// + /// Indicates whether this is a residential address. + [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(7)] + public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } + /// /// If this is a business address, then the company name should be specified here. /// @@ -152,7 +152,7 @@ public partial class AddressToValidate /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class AddressToValidate {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); diff --git a/ShipEngineSDK/Model/AddressValidatingShipment.cs b/ShipEngineSDK/Model/AddressValidatingShipment.cs index 709ae39d..c3e03c33 100644 --- a/ShipEngineSDK/Model/AddressValidatingShipment.cs +++ b/ShipEngineSDK/Model/AddressValidatingShipment.cs @@ -28,39 +28,6 @@ namespace ShipEngineSDK.Model; public partial class AddressValidatingShipment { - /// - /// The type of delivery confirmation that is required for this shipment. - /// - /// The type of delivery confirmation that is required for this shipment. - [JsonPropertyName("confirmation"), JsonPropertyOrder(8)] - public DeliveryConfirmation? Confirmation { get; set; } - - /// - /// The insurance provider to use for any insured packages in the shipment. - /// - /// The insurance provider to use for any insured packages in the shipment. - [JsonPropertyName("insurance_provider"), JsonPropertyOrder(13)] - public InsuranceProvider? InsuranceProvider { get; set; } - - /// - /// Gets or Sets OrderSourceCode - /// - [JsonPropertyName("order_source_code"), JsonPropertyOrder(17)] - public OrderSourceName? OrderSourceCode { get; set; } - - /// - /// The current status of the shipment - /// - /// The current status of the shipment - [JsonPropertyName("shipment_status"), JsonInclude] - public ShipmentStatus? ShipmentStatus { get; private set; } - - /// - /// Gets or Sets ValidateAddress - /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(27)] - public ValidateAddress? ValidateAddress { get; set; } - /// /// The carrier account that is billed for the shipping charges /// @@ -68,7 +35,7 @@ public partial class AddressValidatingShipment /// /// se-28529731 /// - [JsonPropertyName("carrier_id"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("carrier_id"), JsonPropertyOrder(1)] public required string CarrierId { get; set; } /// @@ -78,21 +45,21 @@ public partial class AddressValidatingShipment /// /// usps_first_class_mail /// - [JsonPropertyName("service_code"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("service_code"), JsonPropertyOrder(2)] public required string ServiceCode { get; set; } /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("ship_from"), JsonPropertyOrder(3)] public required ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address /// /// The recipient's mailing address - [JsonPropertyName("ship_to"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("ship_to"), JsonPropertyOrder(4)] public required ShippingAddressTo ShipTo { get; set; } /// @@ -122,6 +89,13 @@ public partial class AddressValidatingShipment [JsonPropertyName("comparison_rate_type"), JsonPropertyOrder(7)] public string? ComparisonRateType { 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"), JsonPropertyOrder(8)] + public DeliveryConfirmation? Confirmation { get; set; } + /// /// The date and time that the shipment was created in ShipEngine. /// @@ -153,6 +127,13 @@ public partial class AddressValidatingShipment [JsonPropertyName("external_shipment_id"), JsonPropertyOrder(12)] public string? ExternalShipmentId { get; set; } + /// + /// The insurance provider to use for any insured packages in the shipment. + /// + /// The insurance provider to use for any insured packages in the shipment. + [JsonPropertyName("insurance_provider"), JsonPropertyOrder(13)] + public InsuranceProvider? InsuranceProvider { get; set; } + /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// @@ -177,6 +158,12 @@ public partial class AddressValidatingShipment [JsonPropertyName("modified_at"), JsonInclude] public DateTimeOffset? ModifiedAt { get; private set; } + /// + /// Gets or Sets OrderSourceCode + /// + [JsonPropertyName("order_source_code"), JsonPropertyOrder(17)] + public OrderSourceName? OrderSourceCode { get; set; } + /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// @@ -208,6 +195,13 @@ public partial class AddressValidatingShipment [JsonPropertyName("shipment_number"), JsonPropertyOrder(21)] public string? ShipmentNumber { get; set; } + /// + /// The current status of the shipment + /// + /// The current status of the shipment + [JsonPropertyName("shipment_status"), JsonInclude] + public ShipmentStatus? ShipmentStatus { get; private set; } + /// /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment /// @@ -238,6 +232,12 @@ public partial class AddressValidatingShipment [JsonPropertyName("total_weight"), JsonInclude] public Weight? TotalWeight { get; private set; } + /// + /// Gets or Sets ValidateAddress + /// + [JsonPropertyName("validate_address"), JsonPropertyOrder(27)] + public ValidateAddress? ValidateAddress { get; set; } + /// /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. /// @@ -255,7 +255,7 @@ public partial class AddressValidatingShipment /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class AddressValidatingShipment {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); diff --git a/ShipEngineSDK/Model/AddressValidationCode.cs b/ShipEngineSDK/Model/AddressValidationCode.cs index 8e9467c2..a738d326 100644 --- a/ShipEngineSDK/Model/AddressValidationCode.cs +++ b/ShipEngineSDK/Model/AddressValidationCode.cs @@ -140,6 +140,11 @@ public AddressValidationCode(string value) /// public override bool Equals(object? obj) => obj is AddressValidationCode other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class AddressValidationCodeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/AddressValidationDetailCode.cs b/ShipEngineSDK/Model/AddressValidationDetailCode.cs index c46db4bd..e6107542 100644 --- a/ShipEngineSDK/Model/AddressValidationDetailCode.cs +++ b/ShipEngineSDK/Model/AddressValidationDetailCode.cs @@ -410,6 +410,11 @@ public AddressValidationDetailCode(string value) /// public override bool Equals(object? obj) => obj is AddressValidationDetailCode other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class AddressValidationDetailCodeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/AddressValidationMessageType.cs b/ShipEngineSDK/Model/AddressValidationMessageType.cs index e95cfacb..d11085cb 100644 --- a/ShipEngineSDK/Model/AddressValidationMessageType.cs +++ b/ShipEngineSDK/Model/AddressValidationMessageType.cs @@ -80,6 +80,11 @@ public AddressValidationMessageType(string value) /// public override bool Equals(object? obj) => obj is AddressValidationMessageType other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class AddressValidationMessageTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/AddressValidationResult.cs b/ShipEngineSDK/Model/AddressValidationResult.cs index 01c4ef12..d716043a 100644 --- a/ShipEngineSDK/Model/AddressValidationResult.cs +++ b/ShipEngineSDK/Model/AddressValidationResult.cs @@ -28,12 +28,6 @@ namespace ShipEngineSDK.Model; public partial class AddressValidationResult { - /// - /// Gets or Sets Status - /// - [JsonPropertyName("status"), JsonRequired, JsonPropertyOrder(3)] - public required AddressValidationStatus Status { get; set; } - /// /// The list of messages that were generated during the address validation request. /// @@ -45,9 +39,15 @@ public partial class AddressValidationResult /// The original address that was sent for validation /// /// The original address that was sent for validation - [JsonPropertyName("original_address"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("original_address"), JsonPropertyOrder(2)] public required Address OriginalAddress { get; set; } + /// + /// Gets or Sets Status + /// + [JsonPropertyName("status"), JsonPropertyOrder(3)] + public required AddressValidationStatus Status { get; set; } + /// /// The matched address found by the Shipengine API /// @@ -62,7 +62,7 @@ public partial class AddressValidationResult /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class AddressValidationResult {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Messages: ").Append(Messages).Append("\n"); diff --git a/ShipEngineSDK/Model/AddressValidationStatus.cs b/ShipEngineSDK/Model/AddressValidationStatus.cs index 3aedd121..6414d692 100644 --- a/ShipEngineSDK/Model/AddressValidationStatus.cs +++ b/ShipEngineSDK/Model/AddressValidationStatus.cs @@ -86,6 +86,11 @@ public AddressValidationStatus(string value) /// public override bool Equals(object? obj) => obj is AddressValidationStatus other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class AddressValidationStatusJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptions.cs b/ShipEngineSDK/Model/AdvancedShipmentOptions.cs index c51ecb6e..a190cb62 100644 --- a/ShipEngineSDK/Model/AdvancedShipmentOptions.cs +++ b/ShipEngineSDK/Model/AdvancedShipmentOptions.cs @@ -28,19 +28,6 @@ namespace ShipEngineSDK.Model; public partial class AdvancedShipmentOptions { - /// - /// Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set. - /// - /// Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set. - [JsonPropertyName("bill_to_party"), JsonPropertyOrder(4)] - public BillToParty? BillToParty { get; set; } - - /// - /// Gets or Sets OriginType - /// - [JsonPropertyName("origin_type"), JsonPropertyOrder(19)] - public OriginType? OriginType { get; set; } - /// /// Indicate to the carrier that this shipment requires additional handling. /// @@ -65,6 +52,13 @@ public partial class AdvancedShipmentOptions [JsonPropertyName("bill_to_country_code"), JsonPropertyOrder(3)] public string? BillToCountryCode { get; set; } + /// + /// Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set. + /// + /// Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set. + [JsonPropertyName("bill_to_party"), JsonPropertyOrder(4)] + public BillToParty? BillToParty { get; set; } + /// /// The postal code of the third-party that is responsible for shipping costs. /// @@ -163,6 +157,12 @@ public partial class AdvancedShipmentOptions [JsonPropertyName("non_machinable"), JsonPropertyOrder(18)] public bool? NonMachinable { get; set; } + /// + /// Gets or Sets OriginType + /// + [JsonPropertyName("origin_type"), JsonPropertyOrder(19)] + public OriginType? OriginType { get; set; } + /// /// Enables Saturday delivery, if supported by the carrier. /// @@ -197,7 +197,7 @@ public partial class AdvancedShipmentOptions /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class AdvancedShipmentOptions {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AdditionalHandling: ").Append(AdditionalHandling).Append("\n"); diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs b/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs index f532e911..42eb1b9d 100644 --- a/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs +++ b/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs @@ -49,7 +49,7 @@ public partial class AdvancedShipmentOptionsDangerousGoodsContact /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class AdvancedShipmentOptionsDangerousGoodsContact {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs b/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs index 802e2e7f..2a9d97da 100644 --- a/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs +++ b/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs @@ -47,7 +47,7 @@ public partial class AdvancedShipmentOptionsFedexFreight /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class AdvancedShipmentOptionsFedexFreight {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" BookingConfirmation: ").Append(BookingConfirmation).Append("\n"); diff --git a/ShipEngineSDK/Model/AllowedIncoterms.cs b/ShipEngineSDK/Model/AllowedIncoterms.cs index 5cd68917..020876ab 100644 --- a/ShipEngineSDK/Model/AllowedIncoterms.cs +++ b/ShipEngineSDK/Model/AllowedIncoterms.cs @@ -151,6 +151,11 @@ public AllowedIncoterms(string value) /// public override bool Equals(object? obj) => obj is AllowedIncoterms other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class AllowedIncotermsJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/AlternativeIdentifier.cs b/ShipEngineSDK/Model/AlternativeIdentifier.cs index 483ae03e..400d1be5 100644 --- a/ShipEngineSDK/Model/AlternativeIdentifier.cs +++ b/ShipEngineSDK/Model/AlternativeIdentifier.cs @@ -55,7 +55,7 @@ public partial class AlternativeIdentifier /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class AlternativeIdentifier {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Type: ").Append(Type).Append("\n"); diff --git a/ShipEngineSDK/Model/AlternativeIdentifiers.cs b/ShipEngineSDK/Model/AlternativeIdentifiers.cs index 9a5c05b3..69ee9afa 100644 --- a/ShipEngineSDK/Model/AlternativeIdentifiers.cs +++ b/ShipEngineSDK/Model/AlternativeIdentifiers.cs @@ -42,7 +42,7 @@ public partial class AlternativeIdentifiers /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class AlternativeIdentifiers {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" VarAlternativeIdentifiers: ").Append(VarAlternativeIdentifiers).Append("\n"); diff --git a/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs b/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs index c6fdf034..204c7fa5 100644 --- a/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs +++ b/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs @@ -98,6 +98,11 @@ public AncillaryServiceEndorsement(string value) /// public override bool Equals(object? obj) => obj is AncillaryServiceEndorsement other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class AncillaryServiceEndorsementJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/Batch.cs b/ShipEngineSDK/Model/Batch.cs index d44f8c27..6375cc46 100644 --- a/ShipEngineSDK/Model/Batch.cs +++ b/ShipEngineSDK/Model/Batch.cs @@ -28,25 +28,6 @@ namespace ShipEngineSDK.Model; public partial class Batch { - /// - /// Gets or Sets LabelFormat - /// - [JsonPropertyName("label_format"), JsonInclude] - public LabelFormat? LabelFormat { get; private set; } - - /// - /// label layout - /// - /// label layout - [JsonPropertyName("label_layout"), JsonInclude] - public LabelLayout? LabelLayout { get; private set; } - - /// - /// Gets or Sets Status - /// - [JsonPropertyName("status"), JsonInclude] - public BatchStatus? Status { get; private set; } - /// /// Link to batch errors endpoint /// @@ -68,7 +49,7 @@ public partial class Batch /// Link to batch labels query /// /// Link to batch labels query - [JsonPropertyName("batch_labels_url"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("batch_labels_url"), JsonPropertyOrder(3)] public required OptionalLink BatchLabelsUrl { get; set; } /// @@ -82,7 +63,7 @@ public partial class Batch /// The batch shipments endpoint /// /// The batch shipments endpoint - [JsonPropertyName("batch_shipments_url"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("batch_shipments_url"), JsonPropertyOrder(5)] public required OptionalLink BatchShipmentsUrl { get; set; } /// @@ -149,6 +130,19 @@ public partial class Batch [JsonPropertyName("label_download"), JsonInclude] public LabelDownload? LabelDownload { get; private set; } + /// + /// Gets or Sets LabelFormat + /// + [JsonPropertyName("label_format"), JsonInclude] + public LabelFormat? LabelFormat { get; private set; } + + /// + /// label layout + /// + /// label layout + [JsonPropertyName("label_layout"), JsonInclude] + public LabelLayout? LabelLayout { get; private set; } + /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// @@ -163,6 +157,12 @@ public partial class Batch [JsonPropertyName("process_errors"), JsonInclude] public List? ProcessErrors { get; private set; } + /// + /// Gets or Sets Status + /// + [JsonPropertyName("status"), JsonInclude] + public BatchStatus? Status { get; private set; } + /// /// The number of warnings that occurred while generating the batch /// @@ -207,7 +207,7 @@ public partial class Batch /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class Batch {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" BatchErrorsUrl: ").Append(BatchErrorsUrl).Append("\n"); diff --git a/ShipEngineSDK/Model/BatchResponseError.cs b/ShipEngineSDK/Model/BatchResponseError.cs index 2f989ac9..508fb327 100644 --- a/ShipEngineSDK/Model/BatchResponseError.cs +++ b/ShipEngineSDK/Model/BatchResponseError.cs @@ -62,7 +62,7 @@ public partial class BatchResponseError /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class BatchResponseError {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Error: ").Append(Error).Append("\n"); diff --git a/ShipEngineSDK/Model/BatchStatus.cs b/ShipEngineSDK/Model/BatchStatus.cs index bba5579c..0bf16b29 100644 --- a/ShipEngineSDK/Model/BatchStatus.cs +++ b/ShipEngineSDK/Model/BatchStatus.cs @@ -110,6 +110,11 @@ public BatchStatus(string value) /// public override bool Equals(object? obj) => obj is BatchStatus other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class BatchStatusJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/BatchesSortBy.cs b/ShipEngineSDK/Model/BatchesSortBy.cs index e9e60bcf..c8c8d0de 100644 --- a/ShipEngineSDK/Model/BatchesSortBy.cs +++ b/ShipEngineSDK/Model/BatchesSortBy.cs @@ -80,6 +80,11 @@ public BatchesSortBy(string value) /// public override bool Equals(object? obj) => obj is BatchesSortBy other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class BatchesSortByJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/BillToParty.cs b/ShipEngineSDK/Model/BillToParty.cs index 45ffd441..6da594ab 100644 --- a/ShipEngineSDK/Model/BillToParty.cs +++ b/ShipEngineSDK/Model/BillToParty.cs @@ -74,6 +74,11 @@ public BillToParty(string value) /// public override bool Equals(object? obj) => obj is BillToParty other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class BillToPartyJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/BulkRate.cs b/ShipEngineSDK/Model/BulkRate.cs index 014a7290..732e2e7e 100644 --- a/ShipEngineSDK/Model/BulkRate.cs +++ b/ShipEngineSDK/Model/BulkRate.cs @@ -28,12 +28,6 @@ namespace ShipEngineSDK.Model; public partial class BulkRate { - /// - /// Gets or Sets Status - /// - [JsonPropertyName("status"), JsonInclude] - public RateResponseStatus? Status { get; private set; } - /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. /// @@ -71,6 +65,12 @@ public partial class BulkRate [JsonPropertyName("shipment_id"), JsonInclude] public string? ShipmentId { get; private set; } + /// + /// Gets or Sets Status + /// + [JsonPropertyName("status"), JsonInclude] + public RateResponseStatus? Status { get; private set; } + /// /// Returns the string presentation of the object @@ -78,7 +78,7 @@ public partial class BulkRate /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class BulkRate {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); diff --git a/ShipEngineSDK/Model/CalculateRatesResponseBody.cs b/ShipEngineSDK/Model/CalculateRatesResponseBody.cs index 43e4e59f..fb52aa47 100644 --- a/ShipEngineSDK/Model/CalculateRatesResponseBody.cs +++ b/ShipEngineSDK/Model/CalculateRatesResponseBody.cs @@ -28,40 +28,20 @@ namespace ShipEngineSDK.Model; public partial class CalculateRatesResponseBody { - /// - /// The type of delivery confirmation that is required for this shipment. - /// - /// The type of delivery confirmation that is required for this shipment. - [JsonPropertyName("confirmation"), JsonRequired, JsonPropertyOrder(2)] - public required DeliveryConfirmation Confirmation { get; set; } - - /// - /// The insurance provider to use for any insured packages in the shipment. - /// - /// The insurance provider to use for any insured packages in the shipment. - [JsonPropertyName("insurance_provider"), JsonRequired, JsonPropertyOrder(4)] - public required InsuranceProvider InsuranceProvider { get; set; } - - /// - /// The current status of the shipment - /// - /// The current status of the shipment - [JsonPropertyName("shipment_status"), JsonInclude] - public ShipmentStatus? ShipmentStatus { get; private set; } - - /// - /// Gets or Sets OrderSourceCode - /// - [JsonPropertyName("order_source_code"), JsonPropertyOrder(21)] - public OrderSourceName? OrderSourceCode { get; set; } - /// /// Advanced shipment options. These are entirely optional. /// /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("advanced_options"), JsonPropertyOrder(1)] public required AdvancedShipmentOptions AdvancedOptions { 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"), JsonPropertyOrder(2)] + public required DeliveryConfirmation Confirmation { get; set; } + /// /// The date and time that the shipment was created in ShipEngine. /// @@ -72,6 +52,13 @@ public partial class CalculateRatesResponseBody [JsonPropertyName("created_at"), JsonInclude] public DateTimeOffset? CreatedAt { get; private set; } + /// + /// The insurance provider to use for any insured packages in the shipment. + /// + /// The insurance provider to use for any insured packages in the shipment. + [JsonPropertyName("insurance_provider"), JsonPropertyOrder(4)] + public required InsuranceProvider InsuranceProvider { get; set; } + /// /// The date and time that the shipment was created or last modified. /// @@ -86,21 +73,21 @@ public partial class CalculateRatesResponseBody /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages"), JsonRequired, JsonPropertyOrder(6)] + [JsonPropertyName("packages"), JsonPropertyOrder(6)] public required List Packages { get; set; } /// /// The rates response /// /// The rates response - [JsonPropertyName("rate_response"), JsonRequired, JsonPropertyOrder(7)] + [JsonPropertyName("rate_response"), JsonPropertyOrder(7)] public required RatesInformation RateResponse { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. /// /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to"), JsonRequired, JsonPropertyOrder(8)] + [JsonPropertyName("return_to"), JsonPropertyOrder(8)] public required ShippingAddress ReturnTo { get; set; } /// @@ -110,7 +97,7 @@ public partial class CalculateRatesResponseBody /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date"), JsonRequired, JsonPropertyOrder(9)] + [JsonPropertyName("ship_date"), JsonPropertyOrder(9)] public required DateTimeOffset ShipDate { get; set; } /// @@ -123,6 +110,13 @@ public partial class CalculateRatesResponseBody [JsonPropertyName("shipment_id"), JsonInclude] public string? ShipmentId { get; private set; } + /// + /// The current status of the shipment + /// + /// The current status of the shipment + [JsonPropertyName("shipment_status"), JsonInclude] + public ShipmentStatus? ShipmentStatus { get; private set; } + /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// @@ -161,7 +155,7 @@ public partial class CalculateRatesResponseBody /// Customs information. This is usually only needed for international shipments. /// /// Customs information. This is usually only needed for international shipments. - [JsonPropertyName("customs"), JsonRequired, JsonPropertyOrder(16)] + [JsonPropertyName("customs"), JsonPropertyOrder(16)] public required InternationalShipmentOptions Customs { get; set; } /// @@ -192,6 +186,12 @@ public partial class CalculateRatesResponseBody [JsonPropertyName("items"), JsonPropertyOrder(20)] public List? Items { get; set; } + /// + /// Gets or Sets OrderSourceCode + /// + [JsonPropertyName("order_source_code"), JsonPropertyOrder(21)] + public OrderSourceName? OrderSourceCode { get; set; } + /// /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// @@ -256,7 +256,7 @@ public partial class CalculateRatesResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CalculateRatesResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); diff --git a/ShipEngineSDK/Model/Carrier.cs b/ShipEngineSDK/Model/Carrier.cs index 78ea7179..8b9c2b5c 100644 --- a/ShipEngineSDK/Model/Carrier.cs +++ b/ShipEngineSDK/Model/Carrier.cs @@ -151,7 +151,7 @@ public partial class Carrier /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class Carrier {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); diff --git a/ShipEngineSDK/Model/CarrierAdvancedOption.cs b/ShipEngineSDK/Model/CarrierAdvancedOption.cs index e6af5277..8a3eae69 100644 --- a/ShipEngineSDK/Model/CarrierAdvancedOption.cs +++ b/ShipEngineSDK/Model/CarrierAdvancedOption.cs @@ -62,7 +62,7 @@ public partial class CarrierAdvancedOption /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CarrierAdvancedOption {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" DefaultValue: ").Append(DefaultValue).Append("\n"); diff --git a/ShipEngineSDK/Model/CarrierName.cs b/ShipEngineSDK/Model/CarrierName.cs index 7ee91955..f5bec1d7 100644 --- a/ShipEngineSDK/Model/CarrierName.cs +++ b/ShipEngineSDK/Model/CarrierName.cs @@ -230,6 +230,11 @@ public CarrierName(string value) /// public override bool Equals(object? obj) => obj is CarrierName other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class CarrierNameJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/CarrierNameWithSettings.cs b/ShipEngineSDK/Model/CarrierNameWithSettings.cs index 33b47a7a..889c79a3 100644 --- a/ShipEngineSDK/Model/CarrierNameWithSettings.cs +++ b/ShipEngineSDK/Model/CarrierNameWithSettings.cs @@ -86,6 +86,11 @@ public CarrierNameWithSettings(string value) /// public override bool Equals(object? obj) => obj is CarrierNameWithSettings other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class CarrierNameWithSettingsJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/CollectOnDelivery.cs b/ShipEngineSDK/Model/CollectOnDelivery.cs index 9da6ff3c..d0d1739f 100644 --- a/ShipEngineSDK/Model/CollectOnDelivery.cs +++ b/ShipEngineSDK/Model/CollectOnDelivery.cs @@ -28,18 +28,18 @@ namespace ShipEngineSDK.Model; public partial class CollectOnDelivery { - /// - /// Gets or Sets PaymentType - /// - [JsonPropertyName("payment_type"), JsonPropertyOrder(2)] - public CollectOnDeliveryPaymentType? PaymentType { get; set; } - /// /// Gets or Sets PaymentAmount /// [JsonPropertyName("payment_amount"), JsonPropertyOrder(1)] public PaymentAmount? PaymentAmount { get; set; } + /// + /// Gets or Sets PaymentType + /// + [JsonPropertyName("payment_type"), JsonPropertyOrder(2)] + public CollectOnDeliveryPaymentType? PaymentType { get; set; } + /// /// Returns the string presentation of the object @@ -47,7 +47,7 @@ public partial class CollectOnDelivery /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CollectOnDelivery {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" PaymentAmount: ").Append(PaymentAmount).Append("\n"); diff --git a/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs b/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs index c0158aae..70f39f82 100644 --- a/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs +++ b/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs @@ -86,6 +86,11 @@ public CollectOnDeliveryPaymentType(string value) /// public override bool Equals(object? obj) => obj is CollectOnDeliveryPaymentType other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class CollectOnDeliveryPaymentTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs b/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs index b2ff8076..49f63997 100644 --- a/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs +++ b/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs @@ -35,7 +35,7 @@ public partial class CompareBulkRatesRequestBody : AbstractOpenAPISchema /// The rate options /// /// The rate options - [JsonPropertyName("rate_options"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("rate_options"), JsonPropertyOrder(1)] public required RateRequestBody RateOptions { get; set; } diff --git a/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs b/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs index 3da17feb..f3e59df9 100644 --- a/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs @@ -35,21 +35,21 @@ public partial class ConnectAccessWorldwideRequestBody /// /// Stamps.com /// - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("nickname"), JsonPropertyOrder(1)] public required string Nickname { get; set; } /// /// Access Worldwide Password /// /// Access Worldwide Password - [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("password"), JsonPropertyOrder(2)] public required string Password { get; set; } /// /// Access Worldwide Username /// /// Access Worldwide Username - [JsonPropertyName("username"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("username"), JsonPropertyOrder(3)] public required string Username { get; set; } @@ -59,7 +59,7 @@ public partial class ConnectAccessWorldwideRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectAccessWorldwideRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs b/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs index 6e941d48..8096b718 100644 --- a/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs @@ -35,19 +35,19 @@ public partial class ConnectAmazonBuyShippingRequestBody /// /// john.doe@example.com /// - [JsonPropertyName("email"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("email"), JsonPropertyOrder(1)] public required string Email { get; set; } /// /// Gets or Sets MerchantSellerId /// - [JsonPropertyName("merchant_seller_id"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("merchant_seller_id"), JsonPropertyOrder(2)] public required string MerchantSellerId { get; set; } /// /// Gets or Sets MwsAuthToken /// - [JsonPropertyName("mws_auth_token"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("mws_auth_token"), JsonPropertyOrder(3)] public required string MwsAuthToken { get; set; } /// @@ -57,7 +57,7 @@ public partial class ConnectAmazonBuyShippingRequestBody /// /// Test Amazon Buy Shipping /// - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("nickname"), JsonPropertyOrder(4)] public required string Nickname { get; set; } @@ -67,7 +67,7 @@ public partial class ConnectAmazonBuyShippingRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectAmazonBuyShippingRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Email: ").Append(Email).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs b/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs index 8caf1968..ade4cba8 100644 --- a/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs +++ b/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs @@ -32,7 +32,7 @@ public partial class ConnectAmazonShippingUk /// Amazon UK Shipping auth code. /// /// Amazon UK Shipping auth code. - [JsonPropertyName("auth_code"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("auth_code"), JsonPropertyOrder(1)] public required string AuthCode { get; set; } /// @@ -42,7 +42,7 @@ public partial class ConnectAmazonShippingUk /// /// Stamps.com /// - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("nickname"), JsonPropertyOrder(2)] public required string Nickname { get; set; } @@ -52,7 +52,7 @@ public partial class ConnectAmazonShippingUk /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectAmazonShippingUk {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AuthCode: ").Append(AuthCode).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectApcRequestBody.cs b/ShipEngineSDK/Model/ConnectApcRequestBody.cs index c9826bbe..97008eec 100644 --- a/ShipEngineSDK/Model/ConnectApcRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectApcRequestBody.cs @@ -35,7 +35,7 @@ public partial class ConnectApcRequestBody /// /// APC carrier account /// - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("nickname"), JsonPropertyOrder(1)] public required string Nickname { get; set; } /// @@ -45,7 +45,7 @@ public partial class ConnectApcRequestBody /// /// 12345 /// - [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("password"), JsonPropertyOrder(2)] public required string Password { get; set; } /// @@ -55,7 +55,7 @@ public partial class ConnectApcRequestBody /// /// john_doe /// - [JsonPropertyName("username"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("username"), JsonPropertyOrder(3)] public required string Username { get; set; } @@ -65,7 +65,7 @@ public partial class ConnectApcRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectApcRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs b/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs index 8bd159e2..62612540 100644 --- a/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs @@ -32,21 +32,21 @@ public partial class ConnectAsendiaRequestBody /// Asendia account number /// /// Asendia account number - [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("account_number"), JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// FTP password /// /// FTP password - [JsonPropertyName("ftp_password"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("ftp_password"), JsonPropertyOrder(2)] public required string FtpPassword { get; set; } /// /// FTP username /// /// FTP username - [JsonPropertyName("ftp_username"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("ftp_username"), JsonPropertyOrder(3)] public required string FtpUsername { get; set; } /// @@ -56,7 +56,7 @@ public partial class ConnectAsendiaRequestBody /// /// Asendia account /// - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("nickname"), JsonPropertyOrder(4)] public required string Nickname { get; set; } @@ -66,7 +66,7 @@ public partial class ConnectAsendiaRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectAsendiaRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs b/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs index bc27728b..906f73a1 100644 --- a/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs @@ -32,28 +32,28 @@ public partial class ConnectAustraliaPostRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("account_number"), JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// API key /// /// API key - [JsonPropertyName("api_key"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("api_key"), JsonPropertyOrder(2)] public required string ApiKey { get; set; } /// /// API secret /// /// API secret - [JsonPropertyName("api_secret"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("api_secret"), JsonPropertyOrder(3)] public required string ApiSecret { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("nickname"), JsonPropertyOrder(4)] public required string Nickname { get; set; } @@ -63,7 +63,7 @@ public partial class ConnectAustraliaPostRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectAustraliaPostRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs b/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs index 7ab61a7e..0ed8c4fd 100644 --- a/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs @@ -32,35 +32,35 @@ public partial class ConnectCanadaPostRequestBody /// Canada Post Account Number /// /// Canada Post Account Number - [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("account_number"), JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Canada Post Account API Key /// /// Canada Post Account API Key - [JsonPropertyName("api_key"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("api_key"), JsonPropertyOrder(2)] public required string ApiKey { get; set; } /// /// Canada Post Account API Secret /// /// Canada Post Account API Secret - [JsonPropertyName("api_secret"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("api_secret"), JsonPropertyOrder(3)] public required string ApiSecret { get; set; } /// /// Canada Post Account Contract ID /// /// Canada Post Account Contract ID - [JsonPropertyName("contract_id"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("contract_id"), JsonPropertyOrder(4)] public required string ContractId { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("nickname"), JsonPropertyOrder(5)] public required string Nickname { get; set; } @@ -70,7 +70,7 @@ public partial class ConnectCanadaPostRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectCanadaPostRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs b/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs index 5bb665f4..e692c841 100644 --- a/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs +++ b/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs @@ -35,7 +35,7 @@ public partial class ConnectCarrierResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("carrier_id"), JsonPropertyOrder(1)] public required string CarrierId { get; set; } @@ -45,7 +45,7 @@ public partial class ConnectCarrierResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectCarrierResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs index 6c58f052..e5c62316 100644 --- a/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs @@ -28,52 +28,46 @@ namespace ShipEngineSDK.Model; public partial class ConnectDhlEcommerceRequestBody { - /// - /// Gets or Sets AncillaryEndorsement - /// - [JsonPropertyName("ancillary_endorsement"), JsonPropertyOrder(8)] - public AncillaryServiceEndorsement? AncillaryEndorsement { get; set; } - /// /// The client id /// /// The client id - [JsonPropertyName("client_id"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("client_id"), JsonPropertyOrder(1)] public required string ClientId { get; set; } /// /// The distribution center /// /// The distribution center - [JsonPropertyName("distribution_center"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("distribution_center"), JsonPropertyOrder(2)] public required string DistributionCenter { get; set; } /// /// A nickname to help you identify this account /// /// A nickname to help you identify this account - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("nickname"), JsonPropertyOrder(3)] public required string Nickname { get; set; } /// /// The account password /// /// The account password - [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("password"), JsonPropertyOrder(4)] public required string Password { get; set; } /// /// The pickup number /// /// The pickup number - [JsonPropertyName("pickup_number"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("pickup_number"), JsonPropertyOrder(5)] public required string PickupNumber { get; set; } /// /// The account username /// /// The account username - [JsonPropertyName("username"), JsonRequired, JsonPropertyOrder(6)] + [JsonPropertyName("username"), JsonPropertyOrder(6)] public required string Username { get; set; } /// @@ -83,6 +77,12 @@ public partial class ConnectDhlEcommerceRequestBody [JsonPropertyName("account_number"), JsonPropertyOrder(7), Obsolete] public string? AccountNumber { get; set; } + /// + /// Gets or Sets AncillaryEndorsement + /// + [JsonPropertyName("ancillary_endorsement"), JsonPropertyOrder(8)] + public AncillaryServiceEndorsement? AncillaryEndorsement { get; set; } + /// /// The DHL E-Commerce API key. This field is optional, but if not set you will not be able to get rates for this account. /// @@ -137,7 +137,7 @@ public partial class ConnectDhlEcommerceRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectDhlEcommerceRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ClientId: ").Append(ClientId).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs index a2a8477e..149088a5 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs @@ -32,14 +32,14 @@ public partial class ConnectDhlExpressAuRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("account_number"), JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("nickname"), JsonPropertyOrder(2)] public required string Nickname { get; set; } @@ -49,7 +49,7 @@ public partial class ConnectDhlExpressAuRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectDhlExpressAuRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs index 2ea1a316..9b95a696 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs @@ -32,14 +32,14 @@ public partial class ConnectDhlExpressCaRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("account_number"), JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("nickname"), JsonPropertyOrder(2)] public required string Nickname { get; set; } @@ -49,7 +49,7 @@ public partial class ConnectDhlExpressCaRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectDhlExpressCaRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs index 9a491b30..2d8aad21 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs @@ -32,14 +32,14 @@ public partial class ConnectDhlExpressRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("account_number"), JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("nickname"), JsonPropertyOrder(2)] public required string Nickname { get; set; } /// @@ -73,7 +73,7 @@ public partial class ConnectDhlExpressRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectDhlExpressRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs index 519e0fe1..9766f1df 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs @@ -32,21 +32,21 @@ public partial class ConnectDhlExpressUkRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("account_number"), JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("nickname"), JsonPropertyOrder(2)] public required string Nickname { get; set; } /// /// Password /// /// Password - [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("password"), JsonPropertyOrder(3)] public required string Password { get; set; } /// @@ -56,7 +56,7 @@ public partial class ConnectDhlExpressUkRequestBody /// /// se-28529731 /// - [JsonPropertyName("site_id"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("site_id"), JsonPropertyOrder(4)] public required string SiteId { get; set; } @@ -66,7 +66,7 @@ public partial class ConnectDhlExpressUkRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectDhlExpressUkRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectDpdRequestBody.cs b/ShipEngineSDK/Model/ConnectDpdRequestBody.cs index 8e6b4b71..2be6e4a1 100644 --- a/ShipEngineSDK/Model/ConnectDpdRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDpdRequestBody.cs @@ -32,21 +32,21 @@ public partial class ConnectDpdRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("account_number"), JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("nickname"), JsonPropertyOrder(2)] public required string Nickname { get; set; } /// /// Password /// /// Password - [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("password"), JsonPropertyOrder(3)] public required string Password { get; set; } @@ -56,7 +56,7 @@ public partial class ConnectDpdRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectDpdRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs b/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs index e2821afd..8935e2f9 100644 --- a/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs @@ -32,21 +32,21 @@ public partial class ConnectEndiciaRequestBody /// Account /// /// Account - [JsonPropertyName("account"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("account"), JsonPropertyOrder(1)] public required string Account { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("nickname"), JsonPropertyOrder(2)] public required string Nickname { get; set; } /// /// Passphrase /// /// Passphrase - [JsonPropertyName("passphrase"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("passphrase"), JsonPropertyOrder(3)] public required string Passphrase { get; set; } @@ -56,7 +56,7 @@ public partial class ConnectEndiciaRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectEndiciaRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Account: ").Append(Account).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectFedexRequestBody.cs b/ShipEngineSDK/Model/ConnectFedexRequestBody.cs index b165fb34..cedbc183 100644 --- a/ShipEngineSDK/Model/ConnectFedexRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectFedexRequestBody.cs @@ -32,35 +32,35 @@ public partial class ConnectFedexRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("account_number"), JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Address /// /// Address - [JsonPropertyName("address1"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("address1"), JsonPropertyOrder(2)] public required string Address1 { get; set; } /// /// Boolean signaling agreement to the Fedex End User License Agreement /// /// Boolean signaling agreement to the Fedex End User License Agreement - [JsonPropertyName("agree_to_eula"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("agree_to_eula"), JsonPropertyOrder(3)] public required bool AgreeToEula { get; set; } /// /// The city /// /// The city - [JsonPropertyName("city"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("city"), JsonPropertyOrder(4)] public required string City { get; set; } /// /// Country code /// /// Country code - [JsonPropertyName("country_code"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("country_code"), JsonPropertyOrder(5)] public required string CountryCode { get; set; } /// @@ -70,49 +70,49 @@ public partial class ConnectFedexRequestBody /// /// john.doe@example.com /// - [JsonPropertyName("email"), JsonRequired, JsonPropertyOrder(6)] + [JsonPropertyName("email"), JsonPropertyOrder(6)] public required string Email { get; set; } /// /// First name /// /// First name - [JsonPropertyName("first_name"), JsonRequired, JsonPropertyOrder(7)] + [JsonPropertyName("first_name"), JsonPropertyOrder(7)] public required string FirstName { get; set; } /// /// Last name /// /// Last name - [JsonPropertyName("last_name"), JsonRequired, JsonPropertyOrder(8)] + [JsonPropertyName("last_name"), JsonPropertyOrder(8)] public required string LastName { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(9)] + [JsonPropertyName("nickname"), JsonPropertyOrder(9)] public required string Nickname { get; set; } /// /// Phone number /// /// Phone number - [JsonPropertyName("phone"), JsonRequired, JsonPropertyOrder(10)] + [JsonPropertyName("phone"), JsonPropertyOrder(10)] public required string Phone { get; set; } /// /// Postal Code /// /// Postal Code - [JsonPropertyName("postal_code"), JsonRequired, JsonPropertyOrder(11)] + [JsonPropertyName("postal_code"), JsonPropertyOrder(11)] public required string PostalCode { get; set; } /// /// State /// /// State - [JsonPropertyName("state"), JsonRequired, JsonPropertyOrder(12)] + [JsonPropertyName("state"), JsonPropertyOrder(12)] public required string State { get; set; } /// @@ -143,7 +143,7 @@ public partial class ConnectFedexRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectFedexRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs b/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs index a36439b6..119234a5 100644 --- a/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs @@ -32,35 +32,35 @@ public partial class ConnectFedexUkRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("account_number"), JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Address /// /// Address - [JsonPropertyName("address1"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("address1"), JsonPropertyOrder(2)] public required string Address1 { get; set; } /// /// Boolean signaling agreement to the Fedex End User License Agreement /// /// Boolean signaling agreement to the Fedex End User License Agreement - [JsonPropertyName("agree_to_eula"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("agree_to_eula"), JsonPropertyOrder(3)] public required bool AgreeToEula { get; set; } /// /// The city /// /// The city - [JsonPropertyName("city"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("city"), JsonPropertyOrder(4)] public required string City { get; set; } /// /// Country code /// /// Country code - [JsonPropertyName("country_code"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("country_code"), JsonPropertyOrder(5)] public required string CountryCode { get; set; } /// @@ -70,49 +70,49 @@ public partial class ConnectFedexUkRequestBody /// /// john.doe@example.com /// - [JsonPropertyName("email"), JsonRequired, JsonPropertyOrder(6)] + [JsonPropertyName("email"), JsonPropertyOrder(6)] public required string Email { get; set; } /// /// First name /// /// First name - [JsonPropertyName("first_name"), JsonRequired, JsonPropertyOrder(7)] + [JsonPropertyName("first_name"), JsonPropertyOrder(7)] public required string FirstName { get; set; } /// /// Last name /// /// Last name - [JsonPropertyName("last_name"), JsonRequired, JsonPropertyOrder(8)] + [JsonPropertyName("last_name"), JsonPropertyOrder(8)] public required string LastName { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(9)] + [JsonPropertyName("nickname"), JsonPropertyOrder(9)] public required string Nickname { get; set; } /// /// Phone number /// /// Phone number - [JsonPropertyName("phone"), JsonRequired, JsonPropertyOrder(10)] + [JsonPropertyName("phone"), JsonPropertyOrder(10)] public required string Phone { get; set; } /// /// Postal Code /// /// Postal Code - [JsonPropertyName("postal_code"), JsonRequired, JsonPropertyOrder(11)] + [JsonPropertyName("postal_code"), JsonPropertyOrder(11)] public required string PostalCode { get; set; } /// /// State /// /// State - [JsonPropertyName("state"), JsonRequired, JsonPropertyOrder(12)] + [JsonPropertyName("state"), JsonPropertyOrder(12)] public required string State { get; set; } /// @@ -143,7 +143,7 @@ public partial class ConnectFedexUkRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectFedexUkRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs b/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs index 56679bd8..85b1e8d4 100644 --- a/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs @@ -35,21 +35,21 @@ public partial class ConnectFirstmileRequestBody /// /// se-28529731 /// - [JsonPropertyName("mailer_id"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("mailer_id"), JsonPropertyOrder(1)] public required string MailerId { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("nickname"), JsonPropertyOrder(2)] public required string Nickname { get; set; } /// /// Password /// /// Password - [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("password"), JsonPropertyOrder(3)] public required string Password { get; set; } /// @@ -66,7 +66,7 @@ public partial class ConnectFirstmileRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectFirstmileRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" MailerId: ").Append(MailerId).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectImexRequestBody.cs b/ShipEngineSDK/Model/ConnectImexRequestBody.cs index 5c35bd41..ed555a5f 100644 --- a/ShipEngineSDK/Model/ConnectImexRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectImexRequestBody.cs @@ -32,21 +32,21 @@ public partial class ConnectImexRequestBody /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("nickname"), JsonPropertyOrder(1)] public required string Nickname { get; set; } /// /// Password /// /// Password - [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("password"), JsonPropertyOrder(2)] public required string Password { get; set; } /// /// Username /// /// Username - [JsonPropertyName("username"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("username"), JsonPropertyOrder(3)] public required string Username { get; set; } @@ -56,7 +56,7 @@ public partial class ConnectImexRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectImexRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs b/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs index 5f421097..a2103cc9 100644 --- a/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs @@ -35,13 +35,13 @@ public partial class ConnectInsurerRequestBody /// /// john.doe@example.com /// - [JsonPropertyName("email"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("email"), JsonPropertyOrder(1)] public required string Email { get; set; } /// /// Gets or Sets PolicyId /// - [JsonPropertyName("policy_id"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("policy_id"), JsonPropertyOrder(2)] public required string PolicyId { get; set; } @@ -51,7 +51,7 @@ public partial class ConnectInsurerRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectInsurerRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Email: ").Append(Email).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs b/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs index b06e82fb..dcecb4dc 100644 --- a/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs @@ -32,70 +32,70 @@ public partial class ConnectLasershipRequestBody /// Address /// /// Address - [JsonPropertyName("Address"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("Address"), JsonPropertyOrder(1)] public required string Address { get; set; } /// /// City /// /// City - [JsonPropertyName("City"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("City"), JsonPropertyOrder(2)] public required string City { get; set; } /// /// Customer Branch /// /// Customer Branch - [JsonPropertyName("customer_branch"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("customer_branch"), JsonPropertyOrder(3)] public required string CustomerBranch { get; set; } /// /// Critical Entry Time (local time) /// /// Critical Entry Time (local time) - [JsonPropertyName("lasership_critical_entry_time"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("lasership_critical_entry_time"), JsonPropertyOrder(4)] public required string LasershipCriticalEntryTime { get; set; } /// /// Critical Pull Time (local time) /// /// Critical Pull Time (local time) - [JsonPropertyName("lasership_critical_pull_time"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("lasership_critical_pull_time"), JsonPropertyOrder(5)] public required string LasershipCriticalPullTime { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(6)] + [JsonPropertyName("nickname"), JsonPropertyOrder(6)] public required string Nickname { get; set; } /// /// PostalCode /// /// PostalCode - [JsonPropertyName("PostalCode"), JsonRequired, JsonPropertyOrder(7)] + [JsonPropertyName("PostalCode"), JsonPropertyOrder(7)] public required string PostalCode { get; set; } /// /// State /// /// State - [JsonPropertyName("State"), JsonRequired, JsonPropertyOrder(8)] + [JsonPropertyName("State"), JsonPropertyOrder(8)] public required string State { get; set; } /// /// Web Service ID (WSID) /// /// Web Service ID (WSID) - [JsonPropertyName("web_services_id"), JsonRequired, JsonPropertyOrder(9)] + [JsonPropertyName("web_services_id"), JsonPropertyOrder(9)] public required string WebServicesId { get; set; } /// /// Web Service Key (WSKey) /// /// Web Service Key (WSKey) - [JsonPropertyName("web_services_key"), JsonRequired, JsonPropertyOrder(10)] + [JsonPropertyName("web_services_key"), JsonPropertyOrder(10)] public required string WebServicesKey { get; set; } /// @@ -217,7 +217,7 @@ public partial class ConnectLasershipRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectLasershipRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Address: ").Append(Address).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs b/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs index 5b79e5e8..5473048b 100644 --- a/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs @@ -32,14 +32,14 @@ public partial class ConnectNewgisticsRequestBody /// Induction site /// /// Induction site - [JsonPropertyName("induction_site"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("induction_site"), JsonPropertyOrder(1)] public required string InductionSite { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("nickname"), JsonPropertyOrder(2)] public required string Nickname { get; set; } /// @@ -63,7 +63,7 @@ public partial class ConnectNewgisticsRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectNewgisticsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" InductionSite: ").Append(InductionSite).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectOntracRequestBody.cs b/ShipEngineSDK/Model/ConnectOntracRequestBody.cs index 2846350b..57b2fa46 100644 --- a/ShipEngineSDK/Model/ConnectOntracRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectOntracRequestBody.cs @@ -32,21 +32,21 @@ public partial class ConnectOntracRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("account_number"), JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("nickname"), JsonPropertyOrder(2)] public required string Nickname { get; set; } /// /// Password /// /// Password - [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("password"), JsonPropertyOrder(3)] public required string Password { get; set; } @@ -56,7 +56,7 @@ public partial class ConnectOntracRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectOntracRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs b/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs index 29772f2a..aa1e8c12 100644 --- a/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs @@ -32,21 +32,21 @@ public partial class ConnectPurolatorRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("account_number"), JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Activation key /// /// Activation key - [JsonPropertyName("activation_key"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("activation_key"), JsonPropertyOrder(2)] public required string ActivationKey { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("nickname"), JsonPropertyOrder(3)] public required string Nickname { get; set; } @@ -56,7 +56,7 @@ public partial class ConnectPurolatorRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectPurolatorRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs b/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs index b96c6a9a..c9265ca7 100644 --- a/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs @@ -32,35 +32,35 @@ public partial class ConnectRoyalMailRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("account_number"), JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// City /// /// City - [JsonPropertyName("city"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("city"), JsonPropertyOrder(2)] public required string City { get; set; } /// /// Contact name /// /// Contact name - [JsonPropertyName("contact_name"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("contact_name"), JsonPropertyOrder(3)] public required string ContactName { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("nickname"), JsonPropertyOrder(4)] public required string Nickname { get; set; } /// /// Postal code /// /// Postal code - [JsonPropertyName("postal_code"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("postal_code"), JsonPropertyOrder(5)] public required string PostalCode { get; set; } /// @@ -125,7 +125,7 @@ public partial class ConnectRoyalMailRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectRoyalMailRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs b/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs index 79fc7e5b..97c80d8e 100644 --- a/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs @@ -32,21 +32,21 @@ public partial class ConnectRrDonnelleyRequestBody /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("nickname"), JsonPropertyOrder(1)] public required string Nickname { get; set; } /// /// Password /// /// Password - [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("password"), JsonPropertyOrder(2)] public required string Password { get; set; } /// /// Username /// /// Username - [JsonPropertyName("username"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("username"), JsonPropertyOrder(3)] public required string Username { get; set; } @@ -56,7 +56,7 @@ public partial class ConnectRrDonnelleyRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectRrDonnelleyRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectSekoRequestBody.cs b/ShipEngineSDK/Model/ConnectSekoRequestBody.cs index 58cfedf2..afae6d2e 100644 --- a/ShipEngineSDK/Model/ConnectSekoRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectSekoRequestBody.cs @@ -32,14 +32,14 @@ public partial class ConnectSekoRequestBody /// Seko Account Access Key /// /// Seko Account Access Key - [JsonPropertyName("access_key"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("access_key"), JsonPropertyOrder(1)] public required string AccessKey { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("nickname"), JsonPropertyOrder(2)] public required string Nickname { get; set; } @@ -49,7 +49,7 @@ public partial class ConnectSekoRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectSekoRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccessKey: ").Append(AccessKey).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectSendleRequestBody.cs b/ShipEngineSDK/Model/ConnectSendleRequestBody.cs index 00449944..531e5051 100644 --- a/ShipEngineSDK/Model/ConnectSendleRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectSendleRequestBody.cs @@ -32,14 +32,14 @@ public partial class ConnectSendleRequestBody /// API key /// /// API key - [JsonPropertyName("api_key"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("api_key"), JsonPropertyOrder(1)] public required string ApiKey { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("nickname"), JsonPropertyOrder(2)] public required string Nickname { get; set; } /// @@ -49,7 +49,7 @@ public partial class ConnectSendleRequestBody /// /// se-28529731 /// - [JsonPropertyName("sendle_id"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("sendle_id"), JsonPropertyOrder(3)] public required string SendleId { get; set; } @@ -59,7 +59,7 @@ public partial class ConnectSendleRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectSendleRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ApiKey: ").Append(ApiKey).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectStampsRequestBody.cs b/ShipEngineSDK/Model/ConnectStampsRequestBody.cs index 172422c9..04b63d49 100644 --- a/ShipEngineSDK/Model/ConnectStampsRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectStampsRequestBody.cs @@ -32,21 +32,21 @@ public partial class ConnectStampsRequestBody /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("nickname"), JsonPropertyOrder(1)] public required string Nickname { get; set; } /// /// Password /// /// Password - [JsonPropertyName("password"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("password"), JsonPropertyOrder(2)] public required string Password { get; set; } /// /// Username /// /// Username - [JsonPropertyName("username"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("username"), JsonPropertyOrder(3)] public required string Username { get; set; } @@ -56,7 +56,7 @@ public partial class ConnectStampsRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectStampsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Nickname: ").Append(Nickname).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectUpsRequestBody.cs b/ShipEngineSDK/Model/ConnectUpsRequestBody.cs index bffdc58e..f2028414 100644 --- a/ShipEngineSDK/Model/ConnectUpsRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectUpsRequestBody.cs @@ -32,14 +32,14 @@ public partial class ConnectUpsRequestBody /// Account number /// /// Account number - [JsonPropertyName("account_number"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("account_number"), JsonPropertyOrder(1)] public required string AccountNumber { get; set; } /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("nickname"), JsonPropertyOrder(2)] public required string Nickname { get; set; } @@ -49,7 +49,7 @@ public partial class ConnectUpsRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ConnectUpsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); diff --git a/ShipEngineSDK/Model/ContactDetails.cs b/ShipEngineSDK/Model/ContactDetails.cs index 3fbf01c4..5ae8de24 100644 --- a/ShipEngineSDK/Model/ContactDetails.cs +++ b/ShipEngineSDK/Model/ContactDetails.cs @@ -35,20 +35,20 @@ public partial class ContactDetails /// /// john.doe@example.com /// - [JsonPropertyName("email"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("email"), JsonPropertyOrder(1)] public required string Email { get; set; } /// /// Gets or Sets Name /// - [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("name"), JsonPropertyOrder(2)] public required string Name { get; set; } /// /// Phone number associated /// /// Phone number associated - [JsonPropertyName("phone"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("phone"), JsonPropertyOrder(3)] public required string Phone { get; set; } @@ -58,7 +58,7 @@ public partial class ContactDetails /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ContactDetails {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Email: ").Append(Email).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs index d6fe4c04..9d2d31de 100644 --- a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs @@ -92,7 +92,7 @@ public override bool CanConvert(Type typeToConvert) => /// The image type /// /// The image type - [JsonPropertyName("image_content_type"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("image_content_type"), JsonPropertyOrder(1)] public required ImageContentTypeEnum ImageContentType { get; set; } /// @@ -102,7 +102,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg== /// - [JsonPropertyName("image_data"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("image_data"), JsonPropertyOrder(2)] public required string ImageData { get; set; } /// @@ -112,7 +112,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// My logo /// - [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("name"), JsonPropertyOrder(3)] public required string Name { get; set; } /// @@ -162,7 +162,7 @@ public override bool CanConvert(Type typeToConvert) => /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateAccountSettingsImageRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ImageContentType: ").Append(ImageContentType).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs index a69a8cbe..e4a5b7d2 100644 --- a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs +++ b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs @@ -75,7 +75,7 @@ public partial class CreateAndProcessBatchRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateAndProcessBatchRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" BatchNotes: ").Append(BatchNotes).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs index e0961fb6..e56b4fef 100644 --- a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs +++ b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs @@ -28,6 +28,13 @@ namespace ShipEngineSDK.Model; public partial class CreateAndProcessBatchRequestBodyProcessLabels { + /// + /// When 'true', the batch will be enqueued for processing + /// + /// When 'true', the batch will be enqueued for processing + [JsonPropertyName("create_batch_and_process_labels"), JsonPropertyOrder(1)] + public bool? CreateBatchAndProcessLabels { get; set; } + /// /// The display format that the label should be shown in. /// @@ -47,13 +54,6 @@ public partial class CreateAndProcessBatchRequestBodyProcessLabels [JsonPropertyName("label_layout"), JsonPropertyOrder(4)] public LabelLayout? LabelLayout { get; set; } - /// - /// When 'true', the batch will be enqueued for processing - /// - /// When 'true', the batch will be enqueued for processing - [JsonPropertyName("create_batch_and_process_labels"), JsonPropertyOrder(1)] - public bool? CreateBatchAndProcessLabels { get; set; } - /// /// The Ship date the batch is being processed for /// @@ -71,7 +71,7 @@ public partial class CreateAndProcessBatchRequestBodyProcessLabels /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateAndProcessBatchRequestBodyProcessLabels {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CreateBatchAndProcessLabels: ").Append(CreateBatchAndProcessLabels).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateAndValidateShipment.cs b/ShipEngineSDK/Model/CreateAndValidateShipment.cs index bd0dfc6a..3c031722 100644 --- a/ShipEngineSDK/Model/CreateAndValidateShipment.cs +++ b/ShipEngineSDK/Model/CreateAndValidateShipment.cs @@ -28,33 +28,6 @@ namespace ShipEngineSDK.Model; public partial class CreateAndValidateShipment { - /// - /// The type of delivery confirmation that is required for this shipment. - /// - /// The type of delivery confirmation that is required for this shipment. - [JsonPropertyName("confirmation"), JsonPropertyOrder(5)] - public DeliveryConfirmation? Confirmation { get; set; } - - /// - /// The insurance provider to use for any insured packages in the shipment. - /// - /// The insurance provider to use for any insured packages in the shipment. - [JsonPropertyName("insurance_provider"), JsonPropertyOrder(11)] - public InsuranceProvider? InsuranceProvider { get; set; } - - /// - /// Gets or Sets OrderSourceCode - /// - [JsonPropertyName("order_source_code"), JsonPropertyOrder(15)] - public OrderSourceName? OrderSourceCode { get; set; } - - /// - /// The current status of the shipment - /// - /// The current status of the shipment - [JsonPropertyName("shipment_status"), JsonInclude] - public ShipmentStatus? ShipmentStatus { get; private set; } - /// /// The address validation /// @@ -89,6 +62,13 @@ public partial class CreateAndValidateShipment [JsonPropertyName("comparison_rate_type"), JsonPropertyOrder(4)] public string? ComparisonRateType { 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"), JsonPropertyOrder(5)] + public DeliveryConfirmation? Confirmation { get; set; } + /// /// The date and time that the shipment was created in ShipEngine. /// @@ -127,6 +107,13 @@ public partial class CreateAndValidateShipment [JsonPropertyName("external_shipment_id"), JsonPropertyOrder(10)] public string? ExternalShipmentId { get; set; } + /// + /// The insurance provider to use for any insured packages in the shipment. + /// + /// The insurance provider to use for any insured packages in the shipment. + [JsonPropertyName("insurance_provider"), JsonPropertyOrder(11)] + public InsuranceProvider? InsuranceProvider { get; set; } + /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// @@ -151,6 +138,12 @@ public partial class CreateAndValidateShipment [JsonPropertyName("modified_at"), JsonInclude] public DateTimeOffset? ModifiedAt { get; private set; } + /// + /// Gets or Sets OrderSourceCode + /// + [JsonPropertyName("order_source_code"), JsonPropertyOrder(15)] + public OrderSourceName? OrderSourceCode { get; set; } + /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// @@ -216,6 +209,13 @@ public partial class CreateAndValidateShipment [JsonPropertyName("shipment_number"), JsonPropertyOrder(23)] public string? ShipmentNumber { get; set; } + /// + /// The current status of the shipment + /// + /// The current status of the shipment + [JsonPropertyName("shipment_status"), JsonInclude] + public ShipmentStatus? ShipmentStatus { get; private set; } + /// /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment /// @@ -263,7 +263,7 @@ public partial class CreateAndValidateShipment /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateAndValidateShipment {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AddressValidation: ").Append(AddressValidation).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateBatchRequestBody.cs b/ShipEngineSDK/Model/CreateBatchRequestBody.cs index 0cfe5907..c4c683bd 100644 --- a/ShipEngineSDK/Model/CreateBatchRequestBody.cs +++ b/ShipEngineSDK/Model/CreateBatchRequestBody.cs @@ -69,7 +69,7 @@ public partial class CreateBatchRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateBatchRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" BatchNotes: ").Append(BatchNotes).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateBatchResponseBody.cs b/ShipEngineSDK/Model/CreateBatchResponseBody.cs index c0d27b15..f48f515a 100644 --- a/ShipEngineSDK/Model/CreateBatchResponseBody.cs +++ b/ShipEngineSDK/Model/CreateBatchResponseBody.cs @@ -28,25 +28,6 @@ namespace ShipEngineSDK.Model; public partial class CreateBatchResponseBody { - /// - /// Gets or Sets LabelFormat - /// - [JsonPropertyName("label_format"), JsonInclude] - public LabelFormat? LabelFormat { get; private set; } - - /// - /// label layout - /// - /// label layout - [JsonPropertyName("label_layout"), JsonInclude] - public LabelLayout? LabelLayout { get; private set; } - - /// - /// Gets or Sets Status - /// - [JsonPropertyName("status"), JsonInclude] - public BatchStatus? Status { get; private set; } - /// /// Link to batch errors endpoint /// @@ -68,7 +49,7 @@ public partial class CreateBatchResponseBody /// Link to batch labels query /// /// Link to batch labels query - [JsonPropertyName("batch_labels_url"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("batch_labels_url"), JsonPropertyOrder(3)] public required OptionalLink BatchLabelsUrl { get; set; } /// @@ -82,7 +63,7 @@ public partial class CreateBatchResponseBody /// The batch shipments endpoint /// /// The batch shipments endpoint - [JsonPropertyName("batch_shipments_url"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("batch_shipments_url"), JsonPropertyOrder(5)] public required OptionalLink BatchShipmentsUrl { get; set; } /// @@ -149,6 +130,19 @@ public partial class CreateBatchResponseBody [JsonPropertyName("label_download"), JsonInclude] public LabelDownload? LabelDownload { get; private set; } + /// + /// Gets or Sets LabelFormat + /// + [JsonPropertyName("label_format"), JsonInclude] + public LabelFormat? LabelFormat { get; private set; } + + /// + /// label layout + /// + /// label layout + [JsonPropertyName("label_layout"), JsonInclude] + public LabelLayout? LabelLayout { get; private set; } + /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// @@ -163,6 +157,12 @@ public partial class CreateBatchResponseBody [JsonPropertyName("process_errors"), JsonInclude] public List? ProcessErrors { get; private set; } + /// + /// Gets or Sets Status + /// + [JsonPropertyName("status"), JsonInclude] + public BatchStatus? Status { get; private set; } + /// /// The number of warnings that occurred while generating the batch /// @@ -207,7 +207,7 @@ public partial class CreateBatchResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateBatchResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" BatchErrorsUrl: ").Append(BatchErrorsUrl).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs b/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs index e252fdd4..59283a65 100644 --- a/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs @@ -66,7 +66,7 @@ public partial class CreateLabelFromRateRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateLabelFromRateRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs index 588c39e6..599a018c 100644 --- a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs @@ -28,59 +28,6 @@ namespace ShipEngineSDK.Model; public partial class CreateLabelFromRateResponseBody { - /// - /// The label charge event. - /// - /// The label charge event. - [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] - public LabelChargeEvent? ChargeEvent { get; set; } - - /// - /// 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)] - public DisplayScheme? DisplayScheme { get; set; } - - /// - /// Gets or Sets LabelDownloadType - /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(14)] - 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)] - public LabelFormat? LabelFormat { 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)] - public LabelLayout? LabelLayout { get; set; } - - /// - /// Gets or Sets Status - /// - [JsonPropertyName("status"), JsonInclude] - public LabelStatus? Status { get; private set; } - - /// - /// The current status of the package, such as `in_transit` or `delivered` - /// - /// The current status of the package, such as `in_transit` or `delivered` - [JsonPropertyName("tracking_status"), JsonInclude] - public TrackingStatus? TrackingStatus { get; private set; } - - /// - /// Gets or Sets ValidateAddress - /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(36)] - public ValidateAddress? ValidateAddress { get; set; } - /// /// Additional information some carriers may provide by which to identify a given label in their system. /// @@ -118,6 +65,13 @@ public partial class CreateLabelFromRateResponseBody [JsonPropertyName("carrier_id"), JsonInclude] public string? CarrierId { get; private set; } + /// + /// The label charge event. + /// + /// The label charge event. + [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] + public LabelChargeEvent? ChargeEvent { get; set; } + /// /// The date and time that the label was created in ShipEngine. /// @@ -128,6 +82,13 @@ public partial class CreateLabelFromRateResponseBody [JsonPropertyName("created_at"), JsonInclude] public DateTimeOffset? CreatedAt { get; private set; } + /// + /// 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)] + public DisplayScheme? DisplayScheme { 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. /// @@ -169,6 +130,19 @@ public partial class CreateLabelFromRateResponseBody [JsonPropertyName("label_download"), JsonInclude] public LabelDownload? LabelDownload { get; private set; } + /// + /// Gets or Sets LabelDownloadType + /// + [JsonPropertyName("label_download_type"), JsonPropertyOrder(14), 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)] + public LabelFormat? LabelFormat { get; set; } + /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// @@ -189,6 +163,13 @@ public partial class CreateLabelFromRateResponseBody [JsonPropertyName("label_image_id"), JsonPropertyOrder(17)] 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)] + public LabelLayout? LabelLayout { get; set; } + /// /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. /// @@ -196,7 +177,7 @@ public partial class CreateLabelFromRateResponseBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19)] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19), JsonWriteOnly] public string? OutboundLabelId { get; set; } /// @@ -261,7 +242,7 @@ public partial class CreateLabelFromRateResponseBody /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(27)] + [JsonPropertyName("shipment"), JsonPropertyOrder(27), JsonWriteOnly] public Shipment? Shipment { get; set; } /// @@ -281,11 +262,17 @@ public partial class CreateLabelFromRateResponseBody [JsonPropertyName("shipment_id"), JsonInclude] public string? ShipmentId { get; private set; } + /// + /// Gets or Sets Status + /// + [JsonPropertyName("status"), JsonInclude] + public LabelStatus? Status { get; private 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(31), Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(31), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -305,6 +292,13 @@ public partial class CreateLabelFromRateResponseBody [JsonPropertyName("tracking_number"), JsonInclude] public string? TrackingNumber { get; private set; } + /// + /// The current status of the package, such as `in_transit` or `delivered` + /// + /// The current status of the package, such as `in_transit` or `delivered` + [JsonPropertyName("tracking_status"), JsonInclude] + public TrackingStatus? TrackingStatus { get; private set; } + /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. /// @@ -315,6 +309,12 @@ public partial class CreateLabelFromRateResponseBody [JsonPropertyName("tracking_url"), JsonInclude] public string? TrackingUrl { get; private set; } + /// + /// Gets or Sets ValidateAddress + /// + [JsonPropertyName("validate_address"), JsonPropertyOrder(36), JsonWriteOnly] + public ValidateAddress? ValidateAddress { get; set; } + /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// @@ -339,7 +339,7 @@ public partial class CreateLabelFromRateResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateLabelFromRateResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs b/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs index 05ee8297..1ed5a112 100644 --- a/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs @@ -66,7 +66,7 @@ public partial class CreateLabelFromShipmentRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateLabelFromShipmentRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs index 6ad86de5..3e7aea52 100644 --- a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs @@ -28,59 +28,6 @@ namespace ShipEngineSDK.Model; public partial class CreateLabelFromShipmentResponseBody { - /// - /// The label charge event. - /// - /// The label charge event. - [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] - public LabelChargeEvent? ChargeEvent { get; set; } - - /// - /// 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)] - public DisplayScheme? DisplayScheme { get; set; } - - /// - /// Gets or Sets LabelDownloadType - /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(14)] - 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)] - public LabelFormat? LabelFormat { 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)] - public LabelLayout? LabelLayout { get; set; } - - /// - /// Gets or Sets Status - /// - [JsonPropertyName("status"), JsonInclude] - public LabelStatus? Status { get; private set; } - - /// - /// The current status of the package, such as `in_transit` or `delivered` - /// - /// The current status of the package, such as `in_transit` or `delivered` - [JsonPropertyName("tracking_status"), JsonInclude] - public TrackingStatus? TrackingStatus { get; private set; } - - /// - /// Gets or Sets ValidateAddress - /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(36)] - public ValidateAddress? ValidateAddress { get; set; } - /// /// Additional information some carriers may provide by which to identify a given label in their system. /// @@ -118,6 +65,13 @@ public partial class CreateLabelFromShipmentResponseBody [JsonPropertyName("carrier_id"), JsonInclude] public string? CarrierId { get; private set; } + /// + /// The label charge event. + /// + /// The label charge event. + [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] + public LabelChargeEvent? ChargeEvent { get; set; } + /// /// The date and time that the label was created in ShipEngine. /// @@ -128,6 +82,13 @@ public partial class CreateLabelFromShipmentResponseBody [JsonPropertyName("created_at"), JsonInclude] public DateTimeOffset? CreatedAt { get; private set; } + /// + /// 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)] + public DisplayScheme? DisplayScheme { 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. /// @@ -169,6 +130,19 @@ public partial class CreateLabelFromShipmentResponseBody [JsonPropertyName("label_download"), JsonInclude] public LabelDownload? LabelDownload { get; private set; } + /// + /// Gets or Sets LabelDownloadType + /// + [JsonPropertyName("label_download_type"), JsonPropertyOrder(14), 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)] + public LabelFormat? LabelFormat { get; set; } + /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// @@ -189,6 +163,13 @@ public partial class CreateLabelFromShipmentResponseBody [JsonPropertyName("label_image_id"), JsonPropertyOrder(17)] 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)] + public LabelLayout? LabelLayout { get; set; } + /// /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. /// @@ -196,7 +177,7 @@ public partial class CreateLabelFromShipmentResponseBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19)] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19), JsonWriteOnly] public string? OutboundLabelId { get; set; } /// @@ -261,7 +242,7 @@ public partial class CreateLabelFromShipmentResponseBody /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(27)] + [JsonPropertyName("shipment"), JsonPropertyOrder(27), JsonWriteOnly] public Shipment? Shipment { get; set; } /// @@ -281,11 +262,17 @@ public partial class CreateLabelFromShipmentResponseBody [JsonPropertyName("shipment_id"), JsonInclude] public string? ShipmentId { get; private set; } + /// + /// Gets or Sets Status + /// + [JsonPropertyName("status"), JsonInclude] + public LabelStatus? Status { get; private 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(31), Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(31), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -305,6 +292,13 @@ public partial class CreateLabelFromShipmentResponseBody [JsonPropertyName("tracking_number"), JsonInclude] public string? TrackingNumber { get; private set; } + /// + /// The current status of the package, such as `in_transit` or `delivered` + /// + /// The current status of the package, such as `in_transit` or `delivered` + [JsonPropertyName("tracking_status"), JsonInclude] + public TrackingStatus? TrackingStatus { get; private set; } + /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. /// @@ -315,6 +309,12 @@ public partial class CreateLabelFromShipmentResponseBody [JsonPropertyName("tracking_url"), JsonInclude] public string? TrackingUrl { get; private set; } + /// + /// Gets or Sets ValidateAddress + /// + [JsonPropertyName("validate_address"), JsonPropertyOrder(36), JsonWriteOnly] + public ValidateAddress? ValidateAddress { get; set; } + /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// @@ -339,7 +339,7 @@ public partial class CreateLabelFromShipmentResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateLabelFromShipmentResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateLabelRequestBody.cs b/ShipEngineSDK/Model/CreateLabelRequestBody.cs index 5f532363..7e52286d 100644 --- a/ShipEngineSDK/Model/CreateLabelRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelRequestBody.cs @@ -28,64 +28,11 @@ namespace ShipEngineSDK.Model; public partial class CreateLabelRequestBody { - /// - /// The label charge event. - /// - /// The label charge event. - [JsonPropertyName("charge_event"), JsonPropertyOrder(6)] - public LabelChargeEvent? ChargeEvent { get; set; } - - /// - /// The display format that the label should be shown in. - /// - /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme"), JsonPropertyOrder(8)] - public DisplayScheme? DisplayScheme { get; set; } - - /// - /// Gets or Sets LabelDownloadType - /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(15)] - 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(16)] - public LabelFormat? LabelFormat { 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(19)] - public LabelLayout? LabelLayout { get; set; } - - /// - /// Gets or Sets Status - /// - [JsonPropertyName("status"), JsonInclude] - public LabelStatus? Status { get; private set; } - - /// - /// The current status of the package, such as `in_transit` or `delivered` - /// - /// The current status of the package, such as `in_transit` or `delivered` - [JsonPropertyName("tracking_status"), JsonInclude] - public TrackingStatus? TrackingStatus { get; private set; } - - /// - /// Gets or Sets ValidateAddress - /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(38)] - public ValidateAddress? ValidateAddress { get; set; } - /// /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("shipment"), JsonPropertyOrder(1), JsonWriteOnly] public required Shipment Shipment { get; set; } /// @@ -125,6 +72,13 @@ public partial class CreateLabelRequestBody [JsonPropertyName("carrier_id"), JsonInclude] public string? CarrierId { get; private set; } + /// + /// The label charge event. + /// + /// The label charge event. + [JsonPropertyName("charge_event"), JsonPropertyOrder(6)] + public LabelChargeEvent? ChargeEvent { get; set; } + /// /// The date and time that the label was created in ShipEngine. /// @@ -135,6 +89,13 @@ public partial class CreateLabelRequestBody [JsonPropertyName("created_at"), JsonInclude] public DateTimeOffset? CreatedAt { get; private set; } + /// + /// The display format that the label should be shown in. + /// + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme"), JsonPropertyOrder(8)] + public DisplayScheme? DisplayScheme { 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. /// @@ -176,6 +137,19 @@ public partial class CreateLabelRequestBody [JsonPropertyName("label_download"), JsonInclude] public LabelDownload? LabelDownload { get; private set; } + /// + /// Gets or Sets LabelDownloadType + /// + [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(16)] + public LabelFormat? LabelFormat { get; set; } + /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// @@ -196,6 +170,13 @@ public partial class CreateLabelRequestBody [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(19)] + public LabelLayout? LabelLayout { get; set; } + /// /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. /// @@ -203,7 +184,7 @@ public partial class CreateLabelRequestBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(20)] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(20), JsonWriteOnly] public string? OutboundLabelId { get; set; } /// @@ -301,11 +282,17 @@ public partial class CreateLabelRequestBody [JsonPropertyName("shipment_id"), JsonInclude] public string? ShipmentId { get; private set; } + /// + /// Gets or Sets Status + /// + [JsonPropertyName("status"), JsonInclude] + public LabelStatus? Status { get; private 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(33), Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(33), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -325,6 +312,13 @@ public partial class CreateLabelRequestBody [JsonPropertyName("tracking_number"), JsonInclude] public string? TrackingNumber { get; private set; } + /// + /// The current status of the package, such as `in_transit` or `delivered` + /// + /// The current status of the package, such as `in_transit` or `delivered` + [JsonPropertyName("tracking_status"), JsonInclude] + public TrackingStatus? TrackingStatus { get; private set; } + /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. /// @@ -335,6 +329,12 @@ public partial class CreateLabelRequestBody [JsonPropertyName("tracking_url"), JsonInclude] public string? TrackingUrl { get; private set; } + /// + /// Gets or Sets ValidateAddress + /// + [JsonPropertyName("validate_address"), JsonPropertyOrder(38), JsonWriteOnly] + public ValidateAddress? ValidateAddress { get; set; } + /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// @@ -359,7 +359,7 @@ public partial class CreateLabelRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateLabelRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Shipment: ").Append(Shipment).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateLabelResponseBody.cs b/ShipEngineSDK/Model/CreateLabelResponseBody.cs index a8063aaf..13af393a 100644 --- a/ShipEngineSDK/Model/CreateLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelResponseBody.cs @@ -28,59 +28,6 @@ namespace ShipEngineSDK.Model; public partial class CreateLabelResponseBody { - /// - /// The label charge event. - /// - /// The label charge event. - [JsonPropertyName("charge_event"), JsonRequired, JsonPropertyOrder(4)] - public required LabelChargeEvent ChargeEvent { get; set; } - - /// - /// The display format that the label should be shown in. - /// - /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme"), JsonRequired, JsonPropertyOrder(6)] - public required DisplayScheme DisplayScheme { 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"), JsonRequired, JsonPropertyOrder(11)] - public required LabelFormat LabelFormat { 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"), JsonRequired, JsonPropertyOrder(13)] - public required LabelLayout LabelLayout { get; set; } - - /// - /// Gets or Sets Status - /// - [JsonPropertyName("status"), JsonInclude] - public LabelStatus? Status { get; private set; } - - /// - /// The current status of the package, such as `in_transit` or `delivered` - /// - /// The current status of the package, such as `in_transit` or `delivered` - [JsonPropertyName("tracking_status"), JsonInclude] - public TrackingStatus? TrackingStatus { get; private set; } - - /// - /// Gets or Sets LabelDownloadType - /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(28)] - public LabelDownloadType? LabelDownloadType { get; set; } - - /// - /// Gets or Sets ValidateAddress - /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(37)] - public ValidateAddress? ValidateAddress { get; set; } - /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// @@ -111,6 +58,13 @@ public partial class CreateLabelResponseBody [JsonPropertyName("carrier_id"), JsonInclude] public string? CarrierId { get; private set; } + /// + /// The label charge event. + /// + /// The label charge event. + [JsonPropertyName("charge_event"), JsonPropertyOrder(4)] + public required LabelChargeEvent ChargeEvent { get; set; } + /// /// The date and time that the label was created in ShipEngine. /// @@ -121,6 +75,13 @@ public partial class CreateLabelResponseBody [JsonPropertyName("created_at"), JsonInclude] public DateTimeOffset? CreatedAt { get; private set; } + /// + /// The display format that the label should be shown in. + /// + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme"), JsonPropertyOrder(6)] + public required DisplayScheme DisplayScheme { get; set; } + /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// @@ -139,7 +100,7 @@ public partial class CreateLabelResponseBody /// 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"), JsonRequired, JsonPropertyOrder(9)] + [JsonPropertyName("is_return_label"), JsonPropertyOrder(9)] public required bool IsReturnLabel { get; set; } /// @@ -148,6 +109,13 @@ public partial class CreateLabelResponseBody [JsonPropertyName("label_download"), JsonInclude] public LabelDownload? LabelDownload { get; private 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(11)] + public required LabelFormat LabelFormat { get; set; } + /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// @@ -158,6 +126,13 @@ public partial class CreateLabelResponseBody [JsonPropertyName("label_id"), JsonInclude] public string? LabelId { get; private 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(13)] + public required LabelLayout LabelLayout { get; set; } + /// /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. /// @@ -212,6 +187,12 @@ public partial class CreateLabelResponseBody [JsonPropertyName("shipment_id"), JsonInclude] public string? ShipmentId { get; private set; } + /// + /// Gets or Sets Status + /// + [JsonPropertyName("status"), JsonInclude] + public LabelStatus? Status { get; private set; } + /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// @@ -229,6 +210,13 @@ public partial class CreateLabelResponseBody [JsonPropertyName("tracking_number"), JsonInclude] public string? TrackingNumber { get; private set; } + /// + /// The current status of the package, such as `in_transit` or `delivered` + /// + /// The current status of the package, such as `in_transit` or `delivered` + [JsonPropertyName("tracking_status"), JsonInclude] + public TrackingStatus? TrackingStatus { get; private set; } + /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// @@ -257,6 +245,12 @@ public partial class CreateLabelResponseBody [JsonPropertyName("insurance_claim"), JsonInclude] public Link? InsuranceClaim { get; private set; } + /// + /// Gets or Sets LabelDownloadType + /// + [JsonPropertyName("label_download_type"), JsonPropertyOrder(28), JsonWriteOnly] + public LabelDownloadType? LabelDownloadType { get; set; } + /// /// The label image resource that was used to create a custom label image. /// @@ -264,7 +258,7 @@ public partial class CreateLabelResponseBody /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id"), JsonRequired, JsonPropertyOrder(29)] + [JsonPropertyName("label_image_id"), JsonPropertyOrder(29)] public required string LabelImageId { get; set; } /// @@ -274,7 +268,7 @@ public partial class CreateLabelResponseBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(30)] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(30), JsonWriteOnly] public string? OutboundLabelId { get; set; } /// @@ -295,21 +289,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"), JsonRequired, JsonPropertyOrder(33)] + [JsonPropertyName("rma_number"), JsonPropertyOrder(33)] 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(34)] + [JsonPropertyName("shipment"), JsonPropertyOrder(34), 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(35), Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(35), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -322,6 +316,12 @@ public partial class CreateLabelResponseBody [JsonPropertyName("tracking_url"), JsonInclude] public string? TrackingUrl { get; private set; } + /// + /// Gets or Sets ValidateAddress + /// + [JsonPropertyName("validate_address"), JsonPropertyOrder(37), JsonWriteOnly] + public ValidateAddress? ValidateAddress { get; set; } + /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided /// @@ -339,7 +339,7 @@ public partial class CreateLabelResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateLabelResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" BatchId: ").Append(BatchId).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs b/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs index 68178c63..3cb36c6c 100644 --- a/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs +++ b/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs @@ -35,7 +35,7 @@ public partial class CreateManifestByObjectRequestBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("carrier_id"), JsonPropertyOrder(1)] public required string CarrierId { get; set; } /// @@ -45,7 +45,7 @@ public partial class CreateManifestByObjectRequestBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("ship_date"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("ship_date"), JsonPropertyOrder(2)] public required DateTimeOffset ShipDate { get; set; } /// @@ -55,7 +55,7 @@ public partial class CreateManifestByObjectRequestBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("warehouse_id"), JsonPropertyOrder(3)] public required string WarehouseId { get; set; } /// @@ -79,7 +79,7 @@ public partial class CreateManifestByObjectRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateManifestByObjectRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs b/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs index 2658768a..6a51c641 100644 --- a/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs +++ b/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs @@ -32,7 +32,7 @@ public partial class CreateManifestLabelIdsRequestBody /// The list of label ids to include in the manifest /// /// The list of label ids to include in the manifest - [JsonPropertyName("label_ids"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("label_ids"), JsonPropertyOrder(1)] public required List LabelIds { get; set; } @@ -42,7 +42,7 @@ public partial class CreateManifestLabelIdsRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateManifestLabelIdsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" LabelIds: ").Append(LabelIds).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateManifestResponseBody.cs b/ShipEngineSDK/Model/CreateManifestResponseBody.cs index a56e7fd7..6138583c 100644 --- a/ShipEngineSDK/Model/CreateManifestResponseBody.cs +++ b/ShipEngineSDK/Model/CreateManifestResponseBody.cs @@ -35,7 +35,7 @@ public partial class CreateManifestResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id"), JsonRequired, JsonPropertyOrder(1), Obsolete] + [JsonPropertyName("carrier_id"), JsonPropertyOrder(1), Obsolete] public required string CarrierId { get; set; } /// @@ -45,7 +45,7 @@ public partial class CreateManifestResponseBody /// /// 2019-07-12T13:37:39.050Z /// - [JsonPropertyName("created_at"), JsonRequired, JsonPropertyOrder(2), Obsolete] + [JsonPropertyName("created_at"), JsonPropertyOrder(2), Obsolete] public required DateTimeOffset CreatedAt { get; set; } /// @@ -62,13 +62,13 @@ public partial class CreateManifestResponseBody /// /// se-28529731 /// - [JsonPropertyName("form_id"), JsonRequired, JsonPropertyOrder(4), Obsolete] + [JsonPropertyName("form_id"), JsonPropertyOrder(4), Obsolete] public required string FormId { get; set; } /// /// Gets or Sets ManifestDownload /// - [JsonPropertyName("manifest_download"), JsonRequired, JsonPropertyOrder(5), Obsolete] + [JsonPropertyName("manifest_download"), JsonPropertyOrder(5), Obsolete] public required ManifestDownload ManifestDownload { get; set; } /// @@ -78,7 +78,7 @@ public partial class CreateManifestResponseBody /// /// se-28529731 /// - [JsonPropertyName("manifest_id"), JsonRequired, JsonPropertyOrder(6), Obsolete] + [JsonPropertyName("manifest_id"), JsonPropertyOrder(6), Obsolete] public required string ManifestId { get; set; } /// @@ -88,7 +88,7 @@ public partial class CreateManifestResponseBody /// /// aa3d8e8e-462b-4476-9618-72db7f7b7009 /// - [JsonPropertyName("request_id"), JsonRequired, JsonPropertyOrder(7)] + [JsonPropertyName("request_id"), JsonPropertyOrder(7)] public required Guid RequestId { get; set; } /// @@ -98,7 +98,7 @@ public partial class CreateManifestResponseBody /// /// 2019-07-12T13:37:39.050Z /// - [JsonPropertyName("ship_date"), JsonRequired, JsonPropertyOrder(8), Obsolete] + [JsonPropertyName("ship_date"), JsonPropertyOrder(8), Obsolete] public required DateTimeOffset ShipDate { get; set; } /// @@ -118,7 +118,7 @@ public partial class CreateManifestResponseBody /// /// 9475711899564878915476 /// - [JsonPropertyName("submission_id"), JsonRequired, JsonPropertyOrder(10), Obsolete] + [JsonPropertyName("submission_id"), JsonPropertyOrder(10), Obsolete] public required string SubmissionId { get; set; } /// @@ -128,7 +128,7 @@ public partial class CreateManifestResponseBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id"), JsonRequired, JsonPropertyOrder(11), Obsolete] + [JsonPropertyName("warehouse_id"), JsonPropertyOrder(11), Obsolete] public required string WarehouseId { get; set; } /// @@ -159,7 +159,7 @@ public partial class CreateManifestResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateManifestResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); diff --git a/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs b/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs index c1c553e1..ec05e75f 100644 --- a/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs +++ b/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs @@ -34,7 +34,7 @@ public partial class CreatePackageTypeRequestBody /// /// laptop_box /// - [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("name"), JsonPropertyOrder(1)] public required string Name { get; set; } /// @@ -44,7 +44,7 @@ public partial class CreatePackageTypeRequestBody /// /// small_flat_rate_box /// - [JsonPropertyName("package_code"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("package_code"), JsonPropertyOrder(2)] public required string PackageCode { get; set; } /// @@ -81,7 +81,7 @@ public partial class CreatePackageTypeRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreatePackageTypeRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); diff --git a/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs b/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs index b75b9ff0..59e9065f 100644 --- a/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs +++ b/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs @@ -34,7 +34,7 @@ public partial class CreatePackageTypeResponseBody /// /// laptop_box /// - [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("name"), JsonPropertyOrder(1)] public required string Name { get; set; } /// @@ -44,7 +44,7 @@ public partial class CreatePackageTypeResponseBody /// /// small_flat_rate_box /// - [JsonPropertyName("package_code"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("package_code"), JsonPropertyOrder(2)] public required string PackageCode { get; set; } /// @@ -81,7 +81,7 @@ public partial class CreatePackageTypeResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreatePackageTypeResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs b/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs index f973f35d..6e49a97b 100644 --- a/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs +++ b/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs @@ -45,7 +45,7 @@ public partial class CreateReturnLabelRequestBody /// /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(3)] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(3), JsonWriteOnly] public LabelDownloadType? LabelDownloadType { get; set; } /// @@ -55,13 +55,6 @@ public partial class CreateReturnLabelRequestBody [JsonPropertyName("label_format"), JsonPropertyOrder(4)] public LabelFormat? LabelFormat { 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(6)] - public LabelLayout? LabelLayout { get; set; } - /// /// The label image resource that was used to create a custom label image. /// @@ -72,6 +65,13 @@ public partial class CreateReturnLabelRequestBody [JsonPropertyName("label_image_id"), JsonPropertyOrder(5)] 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(6)] + public LabelLayout? LabelLayout { get; set; } + /// /// Returns the string presentation of the object @@ -79,7 +79,7 @@ public partial class CreateReturnLabelRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateReturnLabelRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs index bd3d49fb..eae127eb 100644 --- a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs @@ -28,59 +28,6 @@ namespace ShipEngineSDK.Model; public partial class CreateReturnLabelResponseBody { - /// - /// The label charge event. - /// - /// The label charge event. - [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] - public LabelChargeEvent? ChargeEvent { get; set; } - - /// - /// 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)] - public DisplayScheme? DisplayScheme { get; set; } - - /// - /// Gets or Sets LabelDownloadType - /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(14)] - 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)] - public LabelFormat? LabelFormat { 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)] - public LabelLayout? LabelLayout { get; set; } - - /// - /// Gets or Sets Status - /// - [JsonPropertyName("status"), JsonInclude] - public LabelStatus? Status { get; private set; } - - /// - /// The current status of the package, such as `in_transit` or `delivered` - /// - /// The current status of the package, such as `in_transit` or `delivered` - [JsonPropertyName("tracking_status"), JsonInclude] - public TrackingStatus? TrackingStatus { get; private set; } - - /// - /// Gets or Sets ValidateAddress - /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(36)] - public ValidateAddress? ValidateAddress { get; set; } - /// /// Additional information some carriers may provide by which to identify a given label in their system. /// @@ -118,6 +65,13 @@ public partial class CreateReturnLabelResponseBody [JsonPropertyName("carrier_id"), JsonInclude] public string? CarrierId { get; private set; } + /// + /// The label charge event. + /// + /// The label charge event. + [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] + public LabelChargeEvent? ChargeEvent { get; set; } + /// /// The date and time that the label was created in ShipEngine. /// @@ -128,6 +82,13 @@ public partial class CreateReturnLabelResponseBody [JsonPropertyName("created_at"), JsonInclude] public DateTimeOffset? CreatedAt { get; private set; } + /// + /// 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)] + public DisplayScheme? DisplayScheme { 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. /// @@ -169,6 +130,19 @@ public partial class CreateReturnLabelResponseBody [JsonPropertyName("label_download"), JsonInclude] public LabelDownload? LabelDownload { get; private set; } + /// + /// Gets or Sets LabelDownloadType + /// + [JsonPropertyName("label_download_type"), JsonPropertyOrder(14), 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)] + public LabelFormat? LabelFormat { get; set; } + /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// @@ -189,6 +163,13 @@ public partial class CreateReturnLabelResponseBody [JsonPropertyName("label_image_id"), JsonPropertyOrder(17)] 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)] + public LabelLayout? LabelLayout { get; set; } + /// /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. /// @@ -196,7 +177,7 @@ public partial class CreateReturnLabelResponseBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19)] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19), JsonWriteOnly] public string? OutboundLabelId { get; set; } /// @@ -261,7 +242,7 @@ public partial class CreateReturnLabelResponseBody /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(27)] + [JsonPropertyName("shipment"), JsonPropertyOrder(27), JsonWriteOnly] public Shipment? Shipment { get; set; } /// @@ -281,11 +262,17 @@ public partial class CreateReturnLabelResponseBody [JsonPropertyName("shipment_id"), JsonInclude] public string? ShipmentId { get; private set; } + /// + /// Gets or Sets Status + /// + [JsonPropertyName("status"), JsonInclude] + public LabelStatus? Status { get; private 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(31), Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(31), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -305,6 +292,13 @@ public partial class CreateReturnLabelResponseBody [JsonPropertyName("tracking_number"), JsonInclude] public string? TrackingNumber { get; private set; } + /// + /// The current status of the package, such as `in_transit` or `delivered` + /// + /// The current status of the package, such as `in_transit` or `delivered` + [JsonPropertyName("tracking_status"), JsonInclude] + public TrackingStatus? TrackingStatus { get; private set; } + /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. /// @@ -315,6 +309,12 @@ public partial class CreateReturnLabelResponseBody [JsonPropertyName("tracking_url"), JsonInclude] public string? TrackingUrl { get; private set; } + /// + /// Gets or Sets ValidateAddress + /// + [JsonPropertyName("validate_address"), JsonPropertyOrder(36), JsonWriteOnly] + public ValidateAddress? ValidateAddress { get; set; } + /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// @@ -339,7 +339,7 @@ public partial class CreateReturnLabelResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateReturnLabelResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs b/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs index 384eebeb..28271633 100644 --- a/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs +++ b/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs @@ -49,7 +49,7 @@ public partial class CreateShipmentResponseBodyFields /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateShipmentResponseBodyFields {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AddressValidation: ").Append(AddressValidation).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs b/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs index d8824e3d..d4404413 100644 --- a/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs +++ b/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs @@ -32,7 +32,7 @@ public partial class CreateShipmentsRequestBody /// An array of shipments to be created. /// /// An array of shipments to be created. - [JsonPropertyName("shipments"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("shipments"), JsonPropertyOrder(1)] public required List Shipments { get; set; } @@ -42,7 +42,7 @@ public partial class CreateShipmentsRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateShipmentsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Shipments: ").Append(Shipments).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs b/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs index ff29860d..6a7540d3 100644 --- a/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs +++ b/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs @@ -32,14 +32,14 @@ public partial class CreateShipmentsResponseBody /// An array of shipments that were created. /// /// An array of shipments that were created. - [JsonPropertyName("shipments"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("shipments"), JsonPropertyOrder(1)] public required List Shipments { get; set; } /// /// Indicates if errors occured while creating the shipments /// /// Indicates if errors occured while creating the shipments - [JsonPropertyName("has_errors"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("has_errors"), JsonPropertyOrder(2)] public required bool HasErrors { get; set; } @@ -49,7 +49,7 @@ public partial class CreateShipmentsResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateShipmentsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Shipments: ").Append(Shipments).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateTagResponseBody.cs b/ShipEngineSDK/Model/CreateTagResponseBody.cs index 43047f4e..9309b220 100644 --- a/ShipEngineSDK/Model/CreateTagResponseBody.cs +++ b/ShipEngineSDK/Model/CreateTagResponseBody.cs @@ -35,7 +35,7 @@ public partial class CreateTagResponseBody /// /// Fragile /// - [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("name"), JsonPropertyOrder(1)] public required string Name { get; set; } @@ -45,7 +45,7 @@ public partial class CreateTagResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateTagResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs b/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs index 3755a0f8..82138812 100644 --- a/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs +++ b/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs @@ -35,14 +35,14 @@ public partial class CreateWarehouseRequestBody /// /// Zero Cool HQ /// - [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("name"), JsonPropertyOrder(1)] public required string Name { get; set; } /// /// The origin address of the warehouse /// /// The origin address of the warehouse - [JsonPropertyName("origin_address"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("origin_address"), JsonPropertyOrder(2)] public required Address OriginAddress { get; set; } /// @@ -86,7 +86,7 @@ public partial class CreateWarehouseRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateWarehouseRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs b/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs index 245caf67..a0641429 100644 --- a/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs +++ b/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs @@ -45,21 +45,21 @@ public partial class CreateWarehouseResponseBody /// /// Zero Cool HQ /// - [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("name"), JsonPropertyOrder(2)] public required string Name { get; set; } /// /// The origin address of the warehouse /// /// The origin address of the warehouse - [JsonPropertyName("origin_address"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("origin_address"), JsonPropertyOrder(3)] public required Address OriginAddress { get; set; } /// /// The return address associated with the warehouse /// /// The return address associated with the warehouse - [JsonPropertyName("return_address"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("return_address"), JsonPropertyOrder(4)] public required Address ReturnAddress { get; set; } /// @@ -86,7 +86,7 @@ public partial class CreateWarehouseResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateWarehouseResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateWebhookRequestBody.cs b/ShipEngineSDK/Model/CreateWebhookRequestBody.cs index 0d50d616..ef766310 100644 --- a/ShipEngineSDK/Model/CreateWebhookRequestBody.cs +++ b/ShipEngineSDK/Model/CreateWebhookRequestBody.cs @@ -31,7 +31,7 @@ public partial class CreateWebhookRequestBody /// /// Gets or Sets Event /// - [JsonPropertyName("event"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("event"), JsonPropertyOrder(1)] public required WebhookEvent Event { get; set; } /// @@ -41,7 +41,7 @@ public partial class CreateWebhookRequestBody /// /// http://api.shipengine.com/v1/labels/se-28529731 /// - [JsonPropertyName("url"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("url"), JsonPropertyOrder(2)] public required string Url { get; set; } /// @@ -58,7 +58,7 @@ public partial class CreateWebhookRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateWebhookRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Event: ").Append(Event).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateWebhookResponseBody.cs b/ShipEngineSDK/Model/CreateWebhookResponseBody.cs index fdaaff7a..a7387ce7 100644 --- a/ShipEngineSDK/Model/CreateWebhookResponseBody.cs +++ b/ShipEngineSDK/Model/CreateWebhookResponseBody.cs @@ -31,7 +31,7 @@ public partial class CreateWebhookResponseBody /// /// Gets or Sets Event /// - [JsonPropertyName("event"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("event"), JsonPropertyOrder(1)] public required WebhookEvent Event { get; set; } /// @@ -41,7 +41,7 @@ public partial class CreateWebhookResponseBody /// /// http://api.shipengine.com/v1/labels/se-28529731 /// - [JsonPropertyName("url"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("url"), JsonPropertyOrder(2)] public required string Url { get; set; } /// @@ -68,7 +68,7 @@ public partial class CreateWebhookResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CreateWebhookResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Event: ").Append(Event).Append("\n"); diff --git a/ShipEngineSDK/Model/CustomsItem.cs b/ShipEngineSDK/Model/CustomsItem.cs index 4e6ac0b3..af4a3dd5 100644 --- a/ShipEngineSDK/Model/CustomsItem.cs +++ b/ShipEngineSDK/Model/CustomsItem.cs @@ -120,7 +120,7 @@ public partial class CustomsItem /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class CustomsItem {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CustomsItemId: ").Append(CustomsItemId).Append("\n"); diff --git a/ShipEngineSDK/Model/DangerousAmount.cs b/ShipEngineSDK/Model/DangerousAmount.cs index 2e0ce79a..c813112a 100644 --- a/ShipEngineSDK/Model/DangerousAmount.cs +++ b/ShipEngineSDK/Model/DangerousAmount.cs @@ -49,7 +49,7 @@ public partial class DangerousAmount /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class DangerousAmount {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Amount: ").Append(Amount).Append("\n"); diff --git a/ShipEngineSDK/Model/DangerousGoods.cs b/ShipEngineSDK/Model/DangerousGoods.cs index fc6c0d5c..0f4e2fb4 100644 --- a/ShipEngineSDK/Model/DangerousGoods.cs +++ b/ShipEngineSDK/Model/DangerousGoods.cs @@ -28,30 +28,6 @@ namespace ShipEngineSDK.Model; public partial class DangerousGoods { - /// - /// Gets or Sets PackagingGroup - /// - [JsonPropertyName("packaging_group"), JsonPropertyOrder(4)] - public PackagingGroup? PackagingGroup { get; set; } - - /// - /// Gets or Sets PackagingInstructionSection - /// - [JsonPropertyName("packaging_instruction_section"), JsonPropertyOrder(6)] - public PackagingInstructionSection? PackagingInstructionSection { get; set; } - - /// - /// Gets or Sets RegulationLevel - /// - [JsonPropertyName("regulation_level"), JsonPropertyOrder(13)] - public RegulationLevel? RegulationLevel { get; set; } - - /// - /// Gets or Sets TransportMean - /// - [JsonPropertyName("transport_mean"), JsonPropertyOrder(18)] - public TransportMean? TransportMean { get; set; } - /// /// Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier /// @@ -73,6 +49,12 @@ public partial class DangerousGoods [JsonPropertyName("id_number"), JsonPropertyOrder(3)] public string? IdNumber { get; set; } + /// + /// Gets or Sets PackagingGroup + /// + [JsonPropertyName("packaging_group"), JsonPropertyOrder(4)] + public PackagingGroup? PackagingGroup { get; set; } + /// /// The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container. /// @@ -80,6 +62,12 @@ public partial class DangerousGoods [JsonPropertyName("packaging_instruction"), JsonPropertyOrder(5)] public string? PackagingInstruction { get; set; } + /// + /// Gets or Sets PackagingInstructionSection + /// + [JsonPropertyName("packaging_instruction_section"), JsonPropertyOrder(6)] + public PackagingInstructionSection? PackagingInstructionSection { get; set; } + /// /// The type of exterior packaging used to contain the dangerous good. /// @@ -125,6 +113,12 @@ public partial class DangerousGoods [JsonPropertyName("regulation_authority"), JsonPropertyOrder(12)] public string? RegulationAuthority { get; set; } + /// + /// Gets or Sets RegulationLevel + /// + [JsonPropertyName("regulation_level"), JsonPropertyOrder(13)] + public RegulationLevel? RegulationLevel { get; set; } + /// /// Indication if the substance needs to be reported to regulatory authority based on the quantity. /// @@ -156,6 +150,12 @@ public partial class DangerousGoods [JsonPropertyName("transport_category"), JsonPropertyOrder(17)] public string? TransportCategory { get; set; } + /// + /// Gets or Sets TransportMean + /// + [JsonPropertyName("transport_mean"), JsonPropertyOrder(18)] + public TransportMean? TransportMean { get; set; } + /// /// Defines which types of tunnels the shipment is allowed to go through /// @@ -170,7 +170,7 @@ public partial class DangerousGoods /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class DangerousGoods {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AdditionalDescription: ").Append(AdditionalDescription).Append("\n"); diff --git a/ShipEngineSDK/Model/DefaultLabelLayout.cs b/ShipEngineSDK/Model/DefaultLabelLayout.cs index da2e059d..63c092b6 100644 --- a/ShipEngineSDK/Model/DefaultLabelLayout.cs +++ b/ShipEngineSDK/Model/DefaultLabelLayout.cs @@ -74,6 +74,11 @@ public DefaultLabelLayout(string value) /// public override bool Equals(object? obj) => obj is DefaultLabelLayout other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class DefaultLabelLayoutJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs b/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs index 05d88b01..31917652 100644 --- a/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs +++ b/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs @@ -42,7 +42,7 @@ public partial class DeletePickupByIdResponseBody /// /// pik_3YcKU5zdtJuCqoeNwyqqbW /// - [JsonPropertyName("pickup_id"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("pickup_id"), JsonPropertyOrder(2)] public required string PickupId { get; set; } /// @@ -52,7 +52,7 @@ public partial class DeletePickupByIdResponseBody /// /// aa3d8e8e-462b-4476-9618-72db7f7b7009 /// - [JsonPropertyName("request_id"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("request_id"), JsonPropertyOrder(3)] public required Guid RequestId { get; set; } @@ -62,7 +62,7 @@ public partial class DeletePickupByIdResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class DeletePickupByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Errors: ").Append(Errors).Append("\n"); diff --git a/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs b/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs index 53a5a06f..d758464d 100644 --- a/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs +++ b/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs @@ -35,7 +35,7 @@ public partial class DeleteScheduledPickupResponseBody /// /// pik_3YcKU5zdtJuCqoeNwyqqbW /// - [JsonPropertyName("pickup_id"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("pickup_id"), JsonPropertyOrder(1)] public required string PickupId { get; set; } @@ -45,7 +45,7 @@ public partial class DeleteScheduledPickupResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class DeleteScheduledPickupResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" PickupId: ").Append(PickupId).Append("\n"); diff --git a/ShipEngineSDK/Model/DeliveryConfirmation.cs b/ShipEngineSDK/Model/DeliveryConfirmation.cs index 2d6a370b..19028548 100644 --- a/ShipEngineSDK/Model/DeliveryConfirmation.cs +++ b/ShipEngineSDK/Model/DeliveryConfirmation.cs @@ -104,6 +104,11 @@ public DeliveryConfirmation(string value) /// public override bool Equals(object? obj) => obj is DeliveryConfirmation other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class DeliveryConfirmationJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/DeprecatedManifest.cs b/ShipEngineSDK/Model/DeprecatedManifest.cs index d73e5240..d7ac4b7d 100644 --- a/ShipEngineSDK/Model/DeprecatedManifest.cs +++ b/ShipEngineSDK/Model/DeprecatedManifest.cs @@ -128,7 +128,7 @@ public partial class DeprecatedManifest /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class DeprecatedManifest {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); diff --git a/ShipEngineSDK/Model/DhlExpressAccountSettings.cs b/ShipEngineSDK/Model/DhlExpressAccountSettings.cs index 30124d28..d74406d0 100644 --- a/ShipEngineSDK/Model/DhlExpressAccountSettings.cs +++ b/ShipEngineSDK/Model/DhlExpressAccountSettings.cs @@ -56,7 +56,7 @@ public partial class DhlExpressAccountSettings /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class DhlExpressAccountSettings {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); diff --git a/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs b/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs index 8f21712f..580228f8 100644 --- a/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs @@ -56,7 +56,7 @@ public partial class DhlExpressSettingsResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class DhlExpressSettingsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); diff --git a/ShipEngineSDK/Model/DimensionUnit.cs b/ShipEngineSDK/Model/DimensionUnit.cs index d66f3a5a..638e29b4 100644 --- a/ShipEngineSDK/Model/DimensionUnit.cs +++ b/ShipEngineSDK/Model/DimensionUnit.cs @@ -74,6 +74,11 @@ public DimensionUnit(string value) /// public override bool Equals(object? obj) => obj is DimensionUnit other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class DimensionUnitJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/Dimensions.cs b/ShipEngineSDK/Model/Dimensions.cs index 127b8ec2..fe208ee2 100644 --- a/ShipEngineSDK/Model/Dimensions.cs +++ b/ShipEngineSDK/Model/Dimensions.cs @@ -31,28 +31,28 @@ public partial class Dimensions /// /// Gets or Sets Unit /// - [JsonPropertyName("unit"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("unit"), JsonPropertyOrder(1)] public required DimensionUnit Unit { get; set; } /// /// The height of the package, in the specified unit /// /// The height of the package, in the specified unit - [JsonPropertyName("height"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("height"), JsonPropertyOrder(2)] public required double Height { get; set; } /// /// The length of the package, in the specified unit /// /// The length of the package, in the specified unit - [JsonPropertyName("length"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("length"), JsonPropertyOrder(3)] public required double Length { get; set; } /// /// The width of the package, in the specified unit /// /// The width of the package, in the specified unit - [JsonPropertyName("width"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("width"), JsonPropertyOrder(4)] public required double Width { get; set; } @@ -62,7 +62,7 @@ public partial class Dimensions /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class Dimensions {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Unit: ").Append(Unit).Append("\n"); diff --git a/ShipEngineSDK/Model/DisplayScheme.cs b/ShipEngineSDK/Model/DisplayScheme.cs index 530b2623..936cd521 100644 --- a/ShipEngineSDK/Model/DisplayScheme.cs +++ b/ShipEngineSDK/Model/DisplayScheme.cs @@ -92,6 +92,11 @@ public DisplayScheme(string value) /// public override bool Equals(object? obj) => obj is DisplayScheme other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class DisplaySchemeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/Error.cs b/ShipEngineSDK/Model/Error.cs index 9049604e..7bda1a06 100644 --- a/ShipEngineSDK/Model/Error.cs +++ b/ShipEngineSDK/Model/Error.cs @@ -31,19 +31,19 @@ public partial class Error /// /// Gets or Sets ErrorCode /// - [JsonPropertyName("error_code"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("error_code"), JsonPropertyOrder(1)] public required ErrorCode ErrorCode { get; set; } /// /// Gets or Sets ErrorSource /// - [JsonPropertyName("error_source"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("error_source"), JsonPropertyOrder(2)] public required ErrorSource ErrorSource { get; set; } /// /// Gets or Sets ErrorType /// - [JsonPropertyName("error_type"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("error_type"), JsonPropertyOrder(3)] public required ErrorType ErrorType { get; set; } /// @@ -63,7 +63,7 @@ public partial class Error /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class Error {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ErrorCode: ").Append(ErrorCode).Append("\n"); diff --git a/ShipEngineSDK/Model/ErrorCode.cs b/ShipEngineSDK/Model/ErrorCode.cs index 617686f6..9bffb150 100644 --- a/ShipEngineSDK/Model/ErrorCode.cs +++ b/ShipEngineSDK/Model/ErrorCode.cs @@ -320,6 +320,11 @@ public ErrorCode(string value) /// public override bool Equals(object? obj) => obj is ErrorCode other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class ErrorCodeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/ErrorResponseBody.cs b/ShipEngineSDK/Model/ErrorResponseBody.cs index 9bd8903f..08735200 100644 --- a/ShipEngineSDK/Model/ErrorResponseBody.cs +++ b/ShipEngineSDK/Model/ErrorResponseBody.cs @@ -42,7 +42,7 @@ public partial class ErrorResponseBody /// /// aa3d8e8e-462b-4476-9618-72db7f7b7009 /// - [JsonPropertyName("request_id"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("request_id"), JsonPropertyOrder(2)] public required Guid RequestId { get; set; } @@ -52,7 +52,7 @@ public partial class ErrorResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ErrorResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Errors: ").Append(Errors).Append("\n"); diff --git a/ShipEngineSDK/Model/ErrorSource.cs b/ShipEngineSDK/Model/ErrorSource.cs index aaac9d4d..20dfc373 100644 --- a/ShipEngineSDK/Model/ErrorSource.cs +++ b/ShipEngineSDK/Model/ErrorSource.cs @@ -80,6 +80,11 @@ public ErrorSource(string value) /// public override bool Equals(object? obj) => obj is ErrorSource other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class ErrorSourceJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/ErrorType.cs b/ShipEngineSDK/Model/ErrorType.cs index b288f7fb..64498c7b 100644 --- a/ShipEngineSDK/Model/ErrorType.cs +++ b/ShipEngineSDK/Model/ErrorType.cs @@ -98,6 +98,11 @@ public ErrorType(string value) /// public override bool Equals(object? obj) => obj is ErrorType other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class ErrorTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs b/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs index c3a4ac89..9cf4b452 100644 --- a/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs +++ b/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs @@ -42,7 +42,7 @@ public partial class ErrorWithLabelIdResponseBody /// /// aa3d8e8e-462b-4476-9618-72db7f7b7009 /// - [JsonPropertyName("request_id"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("request_id"), JsonPropertyOrder(2)] public required Guid RequestId { get; set; } @@ -52,7 +52,7 @@ public partial class ErrorWithLabelIdResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ErrorWithLabelIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Errors: ").Append(Errors).Append("\n"); diff --git a/ShipEngineSDK/Model/EstimateRatesRequestBody.cs b/ShipEngineSDK/Model/EstimateRatesRequestBody.cs index 4d3acd53..42638397 100644 --- a/ShipEngineSDK/Model/EstimateRatesRequestBody.cs +++ b/ShipEngineSDK/Model/EstimateRatesRequestBody.cs @@ -31,16 +31,6 @@ namespace ShipEngineSDK.Model; public partial class EstimateRatesRequestBody : AbstractOpenAPISchema { - /// - /// Gets or Sets AddressResidentialIndicator - /// - [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(11)] - public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } - /// - /// Gets or Sets Confirmation - /// - [JsonPropertyName("confirmation"), JsonPropertyOrder(12)] - public DeliveryConfirmation? Confirmation { get; set; } /// /// from postal code /// @@ -48,7 +38,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// Austin /// - [JsonPropertyName("from_city_locality"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("from_city_locality"), JsonPropertyOrder(1)] public required string FromCityLocality { get; set; } /// @@ -58,7 +48,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// CA /// - [JsonPropertyName("from_country_code"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("from_country_code"), JsonPropertyOrder(2)] public required string FromCountryCode { get; set; } /// @@ -68,7 +58,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// 78756-3717 /// - [JsonPropertyName("from_postal_code"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("from_postal_code"), JsonPropertyOrder(3)] public required string FromPostalCode { get; set; } /// @@ -78,7 +68,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// Austin /// - [JsonPropertyName("from_state_province"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("from_state_province"), JsonPropertyOrder(4)] public required string FromStateProvince { get; set; } /// @@ -88,7 +78,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("ship_date"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("ship_date"), JsonPropertyOrder(5)] public required DateTimeOffset ShipDate { get; set; } /// @@ -98,7 +88,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// Austin /// - [JsonPropertyName("to_city_locality"), JsonRequired, JsonPropertyOrder(6)] + [JsonPropertyName("to_city_locality"), JsonPropertyOrder(6)] public required string ToCityLocality { get; set; } /// @@ -108,7 +98,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// CA /// - [JsonPropertyName("to_country_code"), JsonRequired, JsonPropertyOrder(7)] + [JsonPropertyName("to_country_code"), JsonPropertyOrder(7)] public required string ToCountryCode { get; set; } /// @@ -118,7 +108,7 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// 78756-3717 /// - [JsonPropertyName("to_postal_code"), JsonRequired, JsonPropertyOrder(8)] + [JsonPropertyName("to_postal_code"), JsonPropertyOrder(8)] public required string ToPostalCode { get; set; } /// @@ -128,17 +118,25 @@ public partial class EstimateRatesRequestBody : AbstractOpenAPISchema /// /// Houston /// - [JsonPropertyName("to_state_province"), JsonRequired, JsonPropertyOrder(9)] + [JsonPropertyName("to_state_province"), JsonPropertyOrder(9)] public required string ToStateProvince { get; set; } /// /// The weight of the package /// /// The weight of the package - [JsonPropertyName("weight"), JsonRequired, JsonPropertyOrder(10)] + [JsonPropertyName("weight"), JsonPropertyOrder(10)] public required Weight Weight { get; set; } /// + /// Gets or Sets AddressResidentialIndicator + /// + [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(11)] + public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } /// + /// Gets or Sets Confirmation + /// + [JsonPropertyName("confirmation"), JsonPropertyOrder(12)] + public DeliveryConfirmation? Confirmation { get; set; } /// /// The dimensions of the package /// /// The dimensions of the package diff --git a/ShipEngineSDK/Model/FedexAccountSettings.cs b/ShipEngineSDK/Model/FedexAccountSettings.cs index 57a3ecbf..bb3434ab 100644 --- a/ShipEngineSDK/Model/FedexAccountSettings.cs +++ b/ShipEngineSDK/Model/FedexAccountSettings.cs @@ -28,24 +28,6 @@ namespace ShipEngineSDK.Model; public partial class FedexAccountSettings { - /// - /// Gets or Sets PickupType - /// - [JsonPropertyName("pickup_type"), JsonPropertyOrder(4)] - public FedexPickupType? PickupType { get; set; } - - /// - /// Gets or Sets SmartPostEndorsement - /// - [JsonPropertyName("smart_post_endorsement"), JsonPropertyOrder(6)] - public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } - - /// - /// Gets or Sets SmartPostHub - /// - [JsonPropertyName("smart_post_hub"), JsonPropertyOrder(7)] - public SmartPostHub? SmartPostHub { get; set; } - /// /// Gets or Sets IsPrimaryAccount /// @@ -65,12 +47,30 @@ public partial class FedexAccountSettings [JsonPropertyName("nickname"), JsonPropertyOrder(3)] public string? Nickname { get; set; } + /// + /// Gets or Sets PickupType + /// + [JsonPropertyName("pickup_type"), JsonPropertyOrder(4)] + public FedexPickupType? PickupType { get; set; } + /// /// Gets or Sets SignatureImage /// [JsonPropertyName("signature_image"), JsonPropertyOrder(5)] public string? SignatureImage { get; set; } + /// + /// Gets or Sets SmartPostEndorsement + /// + [JsonPropertyName("smart_post_endorsement"), JsonPropertyOrder(6)] + public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } + + /// + /// Gets or Sets SmartPostHub + /// + [JsonPropertyName("smart_post_hub"), JsonPropertyOrder(7)] + public SmartPostHub? SmartPostHub { get; set; } + /// /// Returns the string presentation of the object @@ -78,7 +78,7 @@ public partial class FedexAccountSettings /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class FedexAccountSettings {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); diff --git a/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs b/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs index 8074e060..2cd039b4 100644 --- a/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs @@ -28,24 +28,6 @@ namespace ShipEngineSDK.Model; public partial class FedexAccountSettingsRequestBody { - /// - /// Gets or Sets PickupType - /// - [JsonPropertyName("pickup_type"), JsonPropertyOrder(4)] - public FedexPickupType? PickupType { get; set; } - - /// - /// Gets or Sets SmartPostEndorsement - /// - [JsonPropertyName("smart_post_endorsement"), JsonPropertyOrder(6)] - public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } - - /// - /// Gets or Sets SmartPostHub - /// - [JsonPropertyName("smart_post_hub"), JsonPropertyOrder(7)] - public SmartPostHub? SmartPostHub { get; set; } - /// /// Gets or Sets IsPrimaryAccount /// @@ -65,12 +47,30 @@ public partial class FedexAccountSettingsRequestBody [JsonPropertyName("nickname"), JsonPropertyOrder(3)] public string? Nickname { get; set; } + /// + /// Gets or Sets PickupType + /// + [JsonPropertyName("pickup_type"), JsonPropertyOrder(4)] + public FedexPickupType? PickupType { get; set; } + /// /// Gets or Sets SignatureImage /// [JsonPropertyName("signature_image"), JsonPropertyOrder(5)] public string? SignatureImage { get; set; } + /// + /// Gets or Sets SmartPostEndorsement + /// + [JsonPropertyName("smart_post_endorsement"), JsonPropertyOrder(6)] + public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } + + /// + /// Gets or Sets SmartPostHub + /// + [JsonPropertyName("smart_post_hub"), JsonPropertyOrder(7)] + public SmartPostHub? SmartPostHub { get; set; } + /// /// Returns the string presentation of the object @@ -78,7 +78,7 @@ public partial class FedexAccountSettingsRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class FedexAccountSettingsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); diff --git a/ShipEngineSDK/Model/FedexPickupType.cs b/ShipEngineSDK/Model/FedexPickupType.cs index 7ab3fa51..c84fc1c4 100644 --- a/ShipEngineSDK/Model/FedexPickupType.cs +++ b/ShipEngineSDK/Model/FedexPickupType.cs @@ -98,6 +98,11 @@ public FedexPickupType(string value) /// public override bool Equals(object? obj) => obj is FedexPickupType other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class FedexPickupTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/FedexSettingsResponseBody.cs b/ShipEngineSDK/Model/FedexSettingsResponseBody.cs index e5f2c6d8..677fcdb8 100644 --- a/ShipEngineSDK/Model/FedexSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/FedexSettingsResponseBody.cs @@ -28,24 +28,6 @@ namespace ShipEngineSDK.Model; public partial class FedexSettingsResponseBody { - /// - /// Gets or Sets PickupType - /// - [JsonPropertyName("pickup_type"), JsonPropertyOrder(4)] - public FedexPickupType? PickupType { get; set; } - - /// - /// Gets or Sets SmartPostEndorsement - /// - [JsonPropertyName("smart_post_endorsement"), JsonPropertyOrder(6)] - public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } - - /// - /// Gets or Sets SmartPostHub - /// - [JsonPropertyName("smart_post_hub"), JsonPropertyOrder(7)] - public SmartPostHub? SmartPostHub { get; set; } - /// /// Gets or Sets IsPrimaryAccount /// @@ -65,12 +47,30 @@ public partial class FedexSettingsResponseBody [JsonPropertyName("nickname"), JsonPropertyOrder(3)] public string? Nickname { get; set; } + /// + /// Gets or Sets PickupType + /// + [JsonPropertyName("pickup_type"), JsonPropertyOrder(4)] + public FedexPickupType? PickupType { get; set; } + /// /// Gets or Sets SignatureImage /// [JsonPropertyName("signature_image"), JsonPropertyOrder(5)] public string? SignatureImage { get; set; } + /// + /// Gets or Sets SmartPostEndorsement + /// + [JsonPropertyName("smart_post_endorsement"), JsonPropertyOrder(6)] + public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } + + /// + /// Gets or Sets SmartPostHub + /// + [JsonPropertyName("smart_post_hub"), JsonPropertyOrder(7)] + public SmartPostHub? SmartPostHub { get; set; } + /// /// Returns the string presentation of the object @@ -78,7 +78,7 @@ public partial class FedexSettingsResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class FedexSettingsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); diff --git a/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs b/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs index fbafd504..593753fe 100644 --- a/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs +++ b/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs @@ -88,13 +88,6 @@ public override bool CanConvert(Type typeToConvert) => } - /// - /// The image type - /// - /// The image type - [JsonPropertyName("image_content_type"), JsonPropertyOrder(2)] - public ImageContentTypeEnum? ImageContentType { get; set; } - /// /// The date and time that the image was created in ShipEngine. /// @@ -105,6 +98,13 @@ public override bool CanConvert(Type typeToConvert) => [JsonPropertyName("created_at"), JsonInclude] public DateTimeOffset? CreatedAt { get; private set; } + /// + /// The image type + /// + /// The image type + [JsonPropertyName("image_content_type"), JsonPropertyOrder(2)] + public ImageContentTypeEnum? ImageContentType { get; set; } + /// /// A base64 encoded string representation of the image. /// @@ -162,7 +162,7 @@ public override bool CanConvert(Type typeToConvert) => /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetAccountSettingsImagesResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); diff --git a/ShipEngineSDK/Model/GetAccountSettingsResponseBody.cs b/ShipEngineSDK/Model/GetAccountSettingsResponseBody.cs index a7075f7d..5511ca70 100644 --- a/ShipEngineSDK/Model/GetAccountSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/GetAccountSettingsResponseBody.cs @@ -41,7 +41,7 @@ public partial class GetAccountSettingsResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetAccountSettingsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" DefaultLabelLayout: ").Append(DefaultLabelLayout).Append("\n"); diff --git a/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs b/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs index 1c973793..415c5d24 100644 --- a/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs @@ -28,25 +28,6 @@ namespace ShipEngineSDK.Model; public partial class GetBatchByExternalIdResponseBody { - /// - /// Gets or Sets LabelFormat - /// - [JsonPropertyName("label_format"), JsonInclude] - public LabelFormat? LabelFormat { get; private set; } - - /// - /// label layout - /// - /// label layout - [JsonPropertyName("label_layout"), JsonInclude] - public LabelLayout? LabelLayout { get; private set; } - - /// - /// Gets or Sets Status - /// - [JsonPropertyName("status"), JsonInclude] - public BatchStatus? Status { get; private set; } - /// /// Link to batch errors endpoint /// @@ -68,7 +49,7 @@ public partial class GetBatchByExternalIdResponseBody /// Link to batch labels query /// /// Link to batch labels query - [JsonPropertyName("batch_labels_url"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("batch_labels_url"), JsonPropertyOrder(3)] public required OptionalLink BatchLabelsUrl { get; set; } /// @@ -82,7 +63,7 @@ public partial class GetBatchByExternalIdResponseBody /// The batch shipments endpoint /// /// The batch shipments endpoint - [JsonPropertyName("batch_shipments_url"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("batch_shipments_url"), JsonPropertyOrder(5)] public required OptionalLink BatchShipmentsUrl { get; set; } /// @@ -149,6 +130,19 @@ public partial class GetBatchByExternalIdResponseBody [JsonPropertyName("label_download"), JsonInclude] public LabelDownload? LabelDownload { get; private set; } + /// + /// Gets or Sets LabelFormat + /// + [JsonPropertyName("label_format"), JsonInclude] + public LabelFormat? LabelFormat { get; private set; } + + /// + /// label layout + /// + /// label layout + [JsonPropertyName("label_layout"), JsonInclude] + public LabelLayout? LabelLayout { get; private set; } + /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// @@ -163,6 +157,12 @@ public partial class GetBatchByExternalIdResponseBody [JsonPropertyName("process_errors"), JsonInclude] public List? ProcessErrors { get; private set; } + /// + /// Gets or Sets Status + /// + [JsonPropertyName("status"), JsonInclude] + public BatchStatus? Status { get; private set; } + /// /// The number of warnings that occurred while generating the batch /// @@ -207,7 +207,7 @@ public partial class GetBatchByExternalIdResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetBatchByExternalIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" BatchErrorsUrl: ").Append(BatchErrorsUrl).Append("\n"); diff --git a/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs b/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs index 2d63c6da..a90a3a0c 100644 --- a/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs @@ -28,25 +28,6 @@ namespace ShipEngineSDK.Model; public partial class GetBatchByIdResponseBody { - /// - /// Gets or Sets LabelFormat - /// - [JsonPropertyName("label_format"), JsonInclude] - public LabelFormat? LabelFormat { get; private set; } - - /// - /// label layout - /// - /// label layout - [JsonPropertyName("label_layout"), JsonInclude] - public LabelLayout? LabelLayout { get; private set; } - - /// - /// Gets or Sets Status - /// - [JsonPropertyName("status"), JsonInclude] - public BatchStatus? Status { get; private set; } - /// /// Link to batch errors endpoint /// @@ -68,7 +49,7 @@ public partial class GetBatchByIdResponseBody /// Link to batch labels query /// /// Link to batch labels query - [JsonPropertyName("batch_labels_url"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("batch_labels_url"), JsonPropertyOrder(3)] public required OptionalLink BatchLabelsUrl { get; set; } /// @@ -82,7 +63,7 @@ public partial class GetBatchByIdResponseBody /// The batch shipments endpoint /// /// The batch shipments endpoint - [JsonPropertyName("batch_shipments_url"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("batch_shipments_url"), JsonPropertyOrder(5)] public required OptionalLink BatchShipmentsUrl { get; set; } /// @@ -149,6 +130,19 @@ public partial class GetBatchByIdResponseBody [JsonPropertyName("label_download"), JsonInclude] public LabelDownload? LabelDownload { get; private set; } + /// + /// Gets or Sets LabelFormat + /// + [JsonPropertyName("label_format"), JsonInclude] + public LabelFormat? LabelFormat { get; private set; } + + /// + /// label layout + /// + /// label layout + [JsonPropertyName("label_layout"), JsonInclude] + public LabelLayout? LabelLayout { get; private set; } + /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// @@ -163,6 +157,12 @@ public partial class GetBatchByIdResponseBody [JsonPropertyName("process_errors"), JsonInclude] public List? ProcessErrors { get; private set; } + /// + /// Gets or Sets Status + /// + [JsonPropertyName("status"), JsonInclude] + public BatchStatus? Status { get; private set; } + /// /// The number of warnings that occurred while generating the batch /// @@ -207,7 +207,7 @@ public partial class GetBatchByIdResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetBatchByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" BatchErrorsUrl: ").Append(BatchErrorsUrl).Append("\n"); diff --git a/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs b/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs index c2421eac..4c249bae 100644 --- a/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs @@ -151,7 +151,7 @@ public partial class GetCarrierByIdResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetCarrierByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); diff --git a/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs b/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs index a7d0be52..79a5aeac 100644 --- a/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs @@ -42,7 +42,7 @@ public partial class GetCarrierOptionsResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetCarrierOptionsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Options: ").Append(Options).Append("\n"); diff --git a/ShipEngineSDK/Model/GetCarriersResponseBody.cs b/ShipEngineSDK/Model/GetCarriersResponseBody.cs index a6e57556..2b9ade8c 100644 --- a/ShipEngineSDK/Model/GetCarriersResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarriersResponseBody.cs @@ -49,7 +49,7 @@ public partial class GetCarriersResponseBody /// /// aa3d8e8e-462b-4476-9618-72db7f7b7009 /// - [JsonPropertyName("request_id"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("request_id"), JsonPropertyOrder(3)] public required Guid RequestId { get; set; } @@ -59,7 +59,7 @@ public partial class GetCarriersResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetCarriersResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Carriers: ").Append(Carriers).Append("\n"); diff --git a/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs b/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs index 7e3aeb17..06a1f168 100644 --- a/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs +++ b/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs @@ -32,14 +32,14 @@ public partial class GetInsuranceBalanceResponseBody /// The monetary amount, in the specified currency. /// /// The monetary amount, in the specified currency. - [JsonPropertyName("amount"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("amount"), JsonPropertyOrder(1)] public required double Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("currency"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("currency"), JsonPropertyOrder(2)] public required string Currency { get; set; } @@ -49,7 +49,7 @@ public partial class GetInsuranceBalanceResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetInsuranceBalanceResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Amount: ").Append(Amount).Append("\n"); diff --git a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs index c4c035e9..a947f009 100644 --- a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs @@ -28,59 +28,6 @@ namespace ShipEngineSDK.Model; public partial class GetLabelByExternalShipmentIdResponseBody { - /// - /// The label charge event. - /// - /// The label charge event. - [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] - public LabelChargeEvent? ChargeEvent { get; set; } - - /// - /// 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)] - public DisplayScheme? DisplayScheme { get; set; } - - /// - /// Gets or Sets LabelDownloadType - /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(14)] - 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)] - public LabelFormat? LabelFormat { 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)] - public LabelLayout? LabelLayout { get; set; } - - /// - /// Gets or Sets Status - /// - [JsonPropertyName("status"), JsonInclude] - public LabelStatus? Status { get; private set; } - - /// - /// The current status of the package, such as `in_transit` or `delivered` - /// - /// The current status of the package, such as `in_transit` or `delivered` - [JsonPropertyName("tracking_status"), JsonInclude] - public TrackingStatus? TrackingStatus { get; private set; } - - /// - /// Gets or Sets ValidateAddress - /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(36)] - public ValidateAddress? ValidateAddress { get; set; } - /// /// Additional information some carriers may provide by which to identify a given label in their system. /// @@ -118,6 +65,13 @@ public partial class GetLabelByExternalShipmentIdResponseBody [JsonPropertyName("carrier_id"), JsonInclude] public string? CarrierId { get; private set; } + /// + /// The label charge event. + /// + /// The label charge event. + [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] + public LabelChargeEvent? ChargeEvent { get; set; } + /// /// The date and time that the label was created in ShipEngine. /// @@ -128,6 +82,13 @@ public partial class GetLabelByExternalShipmentIdResponseBody [JsonPropertyName("created_at"), JsonInclude] public DateTimeOffset? CreatedAt { get; private set; } + /// + /// 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)] + public DisplayScheme? DisplayScheme { 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. /// @@ -169,6 +130,19 @@ public partial class GetLabelByExternalShipmentIdResponseBody [JsonPropertyName("label_download"), JsonInclude] public LabelDownload? LabelDownload { get; private set; } + /// + /// Gets or Sets LabelDownloadType + /// + [JsonPropertyName("label_download_type"), JsonPropertyOrder(14), 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)] + public LabelFormat? LabelFormat { get; set; } + /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// @@ -189,6 +163,13 @@ public partial class GetLabelByExternalShipmentIdResponseBody [JsonPropertyName("label_image_id"), JsonPropertyOrder(17)] 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)] + public LabelLayout? LabelLayout { get; set; } + /// /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. /// @@ -196,7 +177,7 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19)] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19), JsonWriteOnly] public string? OutboundLabelId { get; set; } /// @@ -261,7 +242,7 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(27)] + [JsonPropertyName("shipment"), JsonPropertyOrder(27), JsonWriteOnly] public Shipment? Shipment { get; set; } /// @@ -281,11 +262,17 @@ public partial class GetLabelByExternalShipmentIdResponseBody [JsonPropertyName("shipment_id"), JsonInclude] public string? ShipmentId { get; private set; } + /// + /// Gets or Sets Status + /// + [JsonPropertyName("status"), JsonInclude] + public LabelStatus? Status { get; private 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(31), Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(31), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -305,6 +292,13 @@ public partial class GetLabelByExternalShipmentIdResponseBody [JsonPropertyName("tracking_number"), JsonInclude] public string? TrackingNumber { get; private set; } + /// + /// The current status of the package, such as `in_transit` or `delivered` + /// + /// The current status of the package, such as `in_transit` or `delivered` + [JsonPropertyName("tracking_status"), JsonInclude] + public TrackingStatus? TrackingStatus { get; private set; } + /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. /// @@ -315,6 +309,12 @@ public partial class GetLabelByExternalShipmentIdResponseBody [JsonPropertyName("tracking_url"), JsonInclude] public string? TrackingUrl { get; private set; } + /// + /// Gets or Sets ValidateAddress + /// + [JsonPropertyName("validate_address"), JsonPropertyOrder(36), JsonWriteOnly] + public ValidateAddress? ValidateAddress { get; set; } + /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// @@ -339,7 +339,7 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetLabelByExternalShipmentIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); diff --git a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs index d82505af..c0ee4ccf 100644 --- a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs @@ -28,59 +28,6 @@ namespace ShipEngineSDK.Model; public partial class GetLabelByIdResponseBody { - /// - /// The label charge event. - /// - /// The label charge event. - [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] - public LabelChargeEvent? ChargeEvent { get; set; } - - /// - /// 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)] - public DisplayScheme? DisplayScheme { get; set; } - - /// - /// Gets or Sets LabelDownloadType - /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(14)] - 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)] - public LabelFormat? LabelFormat { 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)] - public LabelLayout? LabelLayout { get; set; } - - /// - /// Gets or Sets Status - /// - [JsonPropertyName("status"), JsonInclude] - public LabelStatus? Status { get; private set; } - - /// - /// The current status of the package, such as `in_transit` or `delivered` - /// - /// The current status of the package, such as `in_transit` or `delivered` - [JsonPropertyName("tracking_status"), JsonInclude] - public TrackingStatus? TrackingStatus { get; private set; } - - /// - /// Gets or Sets ValidateAddress - /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(36)] - public ValidateAddress? ValidateAddress { get; set; } - /// /// Additional information some carriers may provide by which to identify a given label in their system. /// @@ -118,6 +65,13 @@ public partial class GetLabelByIdResponseBody [JsonPropertyName("carrier_id"), JsonInclude] public string? CarrierId { get; private set; } + /// + /// The label charge event. + /// + /// The label charge event. + [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] + public LabelChargeEvent? ChargeEvent { get; set; } + /// /// The date and time that the label was created in ShipEngine. /// @@ -128,6 +82,13 @@ public partial class GetLabelByIdResponseBody [JsonPropertyName("created_at"), JsonInclude] public DateTimeOffset? CreatedAt { get; private set; } + /// + /// 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)] + public DisplayScheme? DisplayScheme { 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. /// @@ -169,6 +130,19 @@ public partial class GetLabelByIdResponseBody [JsonPropertyName("label_download"), JsonInclude] public LabelDownload? LabelDownload { get; private set; } + /// + /// Gets or Sets LabelDownloadType + /// + [JsonPropertyName("label_download_type"), JsonPropertyOrder(14), 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)] + public LabelFormat? LabelFormat { get; set; } + /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// @@ -189,6 +163,13 @@ public partial class GetLabelByIdResponseBody [JsonPropertyName("label_image_id"), JsonPropertyOrder(17)] 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)] + public LabelLayout? LabelLayout { get; set; } + /// /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. /// @@ -196,7 +177,7 @@ public partial class GetLabelByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19)] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19), JsonWriteOnly] public string? OutboundLabelId { get; set; } /// @@ -261,7 +242,7 @@ public partial class GetLabelByIdResponseBody /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(27)] + [JsonPropertyName("shipment"), JsonPropertyOrder(27), JsonWriteOnly] public Shipment? Shipment { get; set; } /// @@ -281,11 +262,17 @@ public partial class GetLabelByIdResponseBody [JsonPropertyName("shipment_id"), JsonInclude] public string? ShipmentId { get; private set; } + /// + /// Gets or Sets Status + /// + [JsonPropertyName("status"), JsonInclude] + public LabelStatus? Status { get; private 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(31), Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(31), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -305,6 +292,13 @@ public partial class GetLabelByIdResponseBody [JsonPropertyName("tracking_number"), JsonInclude] public string? TrackingNumber { get; private set; } + /// + /// The current status of the package, such as `in_transit` or `delivered` + /// + /// The current status of the package, such as `in_transit` or `delivered` + [JsonPropertyName("tracking_status"), JsonInclude] + public TrackingStatus? TrackingStatus { get; private set; } + /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. /// @@ -315,6 +309,12 @@ public partial class GetLabelByIdResponseBody [JsonPropertyName("tracking_url"), JsonInclude] public string? TrackingUrl { get; private set; } + /// + /// Gets or Sets ValidateAddress + /// + [JsonPropertyName("validate_address"), JsonPropertyOrder(36), JsonWriteOnly] + public ValidateAddress? ValidateAddress { get; set; } + /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// @@ -339,7 +339,7 @@ public partial class GetLabelByIdResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetLabelByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); diff --git a/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs b/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs index 69aead5b..00bcd1d0 100644 --- a/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs @@ -128,7 +128,7 @@ public partial class GetManifestByIdResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetManifestByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); diff --git a/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs b/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs index e04a44ed..4262fa10 100644 --- a/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs @@ -34,7 +34,7 @@ public partial class GetPackageTypeByIdResponseBody /// /// laptop_box /// - [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("name"), JsonPropertyOrder(1)] public required string Name { get; set; } /// @@ -44,7 +44,7 @@ public partial class GetPackageTypeByIdResponseBody /// /// small_flat_rate_box /// - [JsonPropertyName("package_code"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("package_code"), JsonPropertyOrder(2)] public required string PackageCode { get; set; } /// @@ -81,7 +81,7 @@ public partial class GetPackageTypeByIdResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetPackageTypeByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); diff --git a/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs b/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs index 6ab9fd39..741d59f3 100644 --- a/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs @@ -41,7 +41,7 @@ public partial class GetPickupByIdResponseBody /// /// Gets or Sets ContactDetails /// - [JsonPropertyName("contact_details"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("contact_details"), JsonPropertyOrder(2)] public required ContactDetails ContactDetails { get; set; } /// @@ -65,7 +65,7 @@ public partial class GetPickupByIdResponseBody /// Label IDs that will be included in the pickup request /// /// Label IDs that will be included in the pickup request - [JsonPropertyName("label_ids"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("label_ids"), JsonPropertyOrder(5)] public required List LabelIds { get; set; } /// @@ -87,7 +87,7 @@ public partial class GetPickupByIdResponseBody /// /// Gets or Sets PickupWindow /// - [JsonPropertyName("pickup_window"), JsonRequired, JsonPropertyOrder(8)] + [JsonPropertyName("pickup_window"), JsonPropertyOrder(8)] public required PickupWindow PickupWindow { get; set; } /// @@ -97,7 +97,7 @@ public partial class GetPickupByIdResponseBody /// /// aa3d8e8e-462b-4476-9618-72db7f7b7009 /// - [JsonPropertyName("request_id"), JsonRequired, JsonPropertyOrder(9)] + [JsonPropertyName("request_id"), JsonPropertyOrder(9)] public required Guid RequestId { get; set; } /// @@ -151,7 +151,7 @@ public partial class GetPickupByIdResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetPickupByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); diff --git a/ShipEngineSDK/Model/GetPickupsResponseBody.cs b/ShipEngineSDK/Model/GetPickupsResponseBody.cs index e33ba7c4..8b2e81e9 100644 --- a/ShipEngineSDK/Model/GetPickupsResponseBody.cs +++ b/ShipEngineSDK/Model/GetPickupsResponseBody.cs @@ -66,7 +66,7 @@ public partial class GetPickupsResponseBody /// An array of pickups associated with the user's account. /// /// An array of pickups associated with the user's account. - [JsonPropertyName("pickups"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("pickups"), JsonPropertyOrder(5)] public required List Pickups { get; set; } /// @@ -76,7 +76,7 @@ public partial class GetPickupsResponseBody /// /// aa3d8e8e-462b-4476-9618-72db7f7b7009 /// - [JsonPropertyName("request_id"), JsonRequired, JsonPropertyOrder(6)] + [JsonPropertyName("request_id"), JsonPropertyOrder(6)] public required Guid RequestId { get; set; } /// @@ -96,7 +96,7 @@ public partial class GetPickupsResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetPickupsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Errors: ").Append(Errors).Append("\n"); diff --git a/ShipEngineSDK/Model/GetRateByIdResponseBody.cs b/ShipEngineSDK/Model/GetRateByIdResponseBody.cs index 8452ee64..9044ef20 100644 --- a/ShipEngineSDK/Model/GetRateByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetRateByIdResponseBody.cs @@ -28,18 +28,6 @@ namespace ShipEngineSDK.Model; public partial class GetRateByIdResponseBody { - /// - /// Gets or Sets RateType - /// - [JsonPropertyName("rate_type"), JsonInclude] - public RateType? RateType { get; private set; } - - /// - /// Gets or Sets ValidationStatus - /// - [JsonPropertyName("validation_status"), JsonInclude] - public ValidationStatus? ValidationStatus { get; private set; } - /// /// carrier code /// @@ -123,6 +111,12 @@ public partial class GetRateByIdResponseBody [JsonPropertyName("rate_id"), JsonInclude] public string? RateId { get; private set; } + /// + /// Gets or Sets RateType + /// + [JsonPropertyName("rate_type"), JsonInclude] + public RateType? RateType { get; private set; } + /// /// service code for the rate /// @@ -151,6 +145,12 @@ public partial class GetRateByIdResponseBody [JsonPropertyName("trackable"), JsonInclude] public bool? Trackable { get; private set; } + /// + /// Gets or Sets ValidationStatus + /// + [JsonPropertyName("validation_status"), JsonInclude] + public ValidationStatus? ValidationStatus { get; private set; } + /// /// The warning messages /// @@ -233,7 +233,7 @@ public partial class GetRateByIdResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetRateByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); diff --git a/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs b/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs index 1e7274de..e9f3af5a 100644 --- a/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs @@ -41,7 +41,7 @@ public partial class GetServicePointByIdResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetServicePointByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ServicePoint: ").Append(ServicePoint).Append("\n"); diff --git a/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs b/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs index 1154162c..2e59315b 100644 --- a/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs +++ b/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs @@ -165,13 +165,6 @@ public override bool CanConvert(Type typeToConvert) => } - /// - /// Service point type - /// - /// Service point type - [JsonPropertyName("type"), JsonPropertyOrder(15)] - public TypeEnum? Type { get; set; } - /// /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. /// @@ -301,6 +294,13 @@ public override bool CanConvert(Type typeToConvert) => [JsonPropertyName("state_province"), JsonPropertyOrder(14)] public string? StateProvince { get; set; } + /// + /// Service point type + /// + /// Service point type + [JsonPropertyName("type"), JsonPropertyOrder(15)] + public TypeEnum? Type { get; set; } + /// /// Returns the string presentation of the object @@ -308,7 +308,7 @@ public override bool CanConvert(Type typeToConvert) => /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetServicePointByIdResponseBodyServicePoint {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBody.cs b/ShipEngineSDK/Model/GetServicePointsRequestBody.cs index 1bb2c0d1..1052f074 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBody.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBody.cs @@ -32,7 +32,7 @@ public partial class GetServicePointsRequestBody /// An array of shipping service providers and service codes /// /// An array of shipping service providers and service codes - [JsonPropertyName("providers"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("providers"), JsonPropertyOrder(1)] public required List Providers { get; set; } /// @@ -104,7 +104,7 @@ public partial class GetServicePointsRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetServicePointsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Providers: ").Append(Providers).Append("\n"); diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs index 72c4c928..26d910cc 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs @@ -35,7 +35,7 @@ public partial class GetServicePointsRequestBodyAddress /// /// CA /// - [JsonPropertyName("country_code"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("country_code"), JsonPropertyOrder(1)] public required string CountryCode { get; set; } /// @@ -91,7 +91,7 @@ public partial class GetServicePointsRequestBodyAddress /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetServicePointsRequestBodyAddress {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs index 6d4fcb55..a8352939 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs @@ -51,7 +51,7 @@ public partial class GetServicePointsRequestBodyProvidersInner /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetServicePointsRequestBodyProvidersInner {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs index 9b218119..89b34fdf 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs @@ -42,7 +42,7 @@ public partial class GetServicePointsRequestBodyShipment /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetServicePointsRequestBodyShipment {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); diff --git a/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs b/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs index e37abe8e..9486ea6e 100644 --- a/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs @@ -28,38 +28,11 @@ namespace ShipEngineSDK.Model; public partial class GetShipmentByExternalIdResponseBody { - /// - /// The type of delivery confirmation that is required for this shipment. - /// - /// The type of delivery confirmation that is required for this shipment. - [JsonPropertyName("confirmation"), JsonRequired, JsonPropertyOrder(3)] - public required DeliveryConfirmation Confirmation { get; set; } - - /// - /// The insurance provider to use for any insured packages in the shipment. - /// - /// The insurance provider to use for any insured packages in the shipment. - [JsonPropertyName("insurance_provider"), JsonRequired, JsonPropertyOrder(5)] - public required InsuranceProvider InsuranceProvider { get; set; } - - /// - /// The current status of the shipment - /// - /// The current status of the shipment - [JsonPropertyName("shipment_status"), JsonInclude] - public ShipmentStatus? ShipmentStatus { get; private set; } - - /// - /// Gets or Sets OrderSourceCode - /// - [JsonPropertyName("order_source_code"), JsonPropertyOrder(23)] - public OrderSourceName? OrderSourceCode { get; set; } - /// /// Advanced shipment options. These are entirely optional. /// /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("advanced_options"), JsonPropertyOrder(1)] public required AdvancedShipmentOptions AdvancedOptions { get; set; } /// @@ -69,9 +42,16 @@ public partial class GetShipmentByExternalIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("carrier_id"), JsonPropertyOrder(2)] public required string CarrierId { 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"), JsonPropertyOrder(3)] + public required DeliveryConfirmation Confirmation { get; set; } + /// /// The date and time that the shipment was created in ShipEngine. /// @@ -82,6 +62,13 @@ public partial class GetShipmentByExternalIdResponseBody [JsonPropertyName("created_at"), JsonInclude] public DateTimeOffset? CreatedAt { get; private set; } + /// + /// The insurance provider to use for any insured packages in the shipment. + /// + /// The insurance provider to use for any insured packages in the shipment. + [JsonPropertyName("insurance_provider"), JsonPropertyOrder(5)] + public required InsuranceProvider InsuranceProvider { get; set; } + /// /// The date and time that the shipment was created or last modified. /// @@ -96,14 +83,14 @@ public partial class GetShipmentByExternalIdResponseBody /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages"), JsonRequired, JsonPropertyOrder(7)] + [JsonPropertyName("packages"), JsonPropertyOrder(7)] public required List Packages { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. /// /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to"), JsonRequired, JsonPropertyOrder(8)] + [JsonPropertyName("return_to"), JsonPropertyOrder(8)] public required ShippingAddress ReturnTo { get; set; } /// @@ -113,7 +100,7 @@ public partial class GetShipmentByExternalIdResponseBody /// /// usps_first_class_mail /// - [JsonPropertyName("service_code"), JsonRequired, JsonPropertyOrder(9)] + [JsonPropertyName("service_code"), JsonPropertyOrder(9)] public required string ServiceCode { get; set; } /// @@ -123,21 +110,21 @@ public partial class GetShipmentByExternalIdResponseBody /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date"), JsonRequired, JsonPropertyOrder(10)] + [JsonPropertyName("ship_date"), JsonPropertyOrder(10)] public required DateTimeOffset ShipDate { get; set; } /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from"), JsonRequired, JsonPropertyOrder(11)] + [JsonPropertyName("ship_from"), JsonPropertyOrder(11)] public required ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address /// /// The recipient's mailing address - [JsonPropertyName("ship_to"), JsonRequired, JsonPropertyOrder(12)] + [JsonPropertyName("ship_to"), JsonPropertyOrder(12)] public required ShippingAddressTo ShipTo { get; set; } /// @@ -150,6 +137,13 @@ public partial class GetShipmentByExternalIdResponseBody [JsonPropertyName("shipment_id"), JsonInclude] public string? ShipmentId { get; private set; } + /// + /// The current status of the shipment + /// + /// The current status of the shipment + [JsonPropertyName("shipment_status"), JsonInclude] + public ShipmentStatus? ShipmentStatus { get; private set; } + /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// @@ -178,7 +172,7 @@ public partial class GetShipmentByExternalIdResponseBody /// Customs information. This is usually only needed for international shipments. /// /// Customs information. This is usually only needed for international shipments. - [JsonPropertyName("customs"), JsonRequired, JsonPropertyOrder(18)] + [JsonPropertyName("customs"), JsonPropertyOrder(18)] public required InternationalShipmentOptions Customs { get; set; } /// @@ -209,6 +203,12 @@ public partial class GetShipmentByExternalIdResponseBody [JsonPropertyName("items"), JsonPropertyOrder(22)] public List? Items { get; set; } + /// + /// Gets or Sets OrderSourceCode + /// + [JsonPropertyName("order_source_code"), JsonPropertyOrder(23)] + public OrderSourceName? OrderSourceCode { get; set; } + /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// @@ -239,7 +239,7 @@ public partial class GetShipmentByExternalIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id"), JsonRequired, JsonPropertyOrder(27)] + [JsonPropertyName("warehouse_id"), JsonPropertyOrder(27)] public required string WarehouseId { get; set; } @@ -249,7 +249,7 @@ public partial class GetShipmentByExternalIdResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetShipmentByExternalIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); diff --git a/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs b/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs index a94a29fe..e560a275 100644 --- a/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs @@ -28,38 +28,11 @@ namespace ShipEngineSDK.Model; public partial class GetShipmentByIdResponseBody { - /// - /// The type of delivery confirmation that is required for this shipment. - /// - /// The type of delivery confirmation that is required for this shipment. - [JsonPropertyName("confirmation"), JsonRequired, JsonPropertyOrder(3)] - public required DeliveryConfirmation Confirmation { get; set; } - - /// - /// The insurance provider to use for any insured packages in the shipment. - /// - /// The insurance provider to use for any insured packages in the shipment. - [JsonPropertyName("insurance_provider"), JsonRequired, JsonPropertyOrder(5)] - public required InsuranceProvider InsuranceProvider { get; set; } - - /// - /// The current status of the shipment - /// - /// The current status of the shipment - [JsonPropertyName("shipment_status"), JsonInclude] - public ShipmentStatus? ShipmentStatus { get; private set; } - - /// - /// Gets or Sets OrderSourceCode - /// - [JsonPropertyName("order_source_code"), JsonPropertyOrder(23)] - public OrderSourceName? OrderSourceCode { get; set; } - /// /// Advanced shipment options. These are entirely optional. /// /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("advanced_options"), JsonPropertyOrder(1)] public required AdvancedShipmentOptions AdvancedOptions { get; set; } /// @@ -69,9 +42,16 @@ public partial class GetShipmentByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("carrier_id"), JsonPropertyOrder(2)] public required string CarrierId { 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"), JsonPropertyOrder(3)] + public required DeliveryConfirmation Confirmation { get; set; } + /// /// The date and time that the shipment was created in ShipEngine. /// @@ -82,6 +62,13 @@ public partial class GetShipmentByIdResponseBody [JsonPropertyName("created_at"), JsonInclude] public DateTimeOffset? CreatedAt { get; private set; } + /// + /// The insurance provider to use for any insured packages in the shipment. + /// + /// The insurance provider to use for any insured packages in the shipment. + [JsonPropertyName("insurance_provider"), JsonPropertyOrder(5)] + public required InsuranceProvider InsuranceProvider { get; set; } + /// /// The date and time that the shipment was created or last modified. /// @@ -96,14 +83,14 @@ public partial class GetShipmentByIdResponseBody /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages"), JsonRequired, JsonPropertyOrder(7)] + [JsonPropertyName("packages"), JsonPropertyOrder(7)] public required List Packages { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. /// /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to"), JsonRequired, JsonPropertyOrder(8)] + [JsonPropertyName("return_to"), JsonPropertyOrder(8)] public required ShippingAddress ReturnTo { get; set; } /// @@ -113,7 +100,7 @@ public partial class GetShipmentByIdResponseBody /// /// usps_first_class_mail /// - [JsonPropertyName("service_code"), JsonRequired, JsonPropertyOrder(9)] + [JsonPropertyName("service_code"), JsonPropertyOrder(9)] public required string ServiceCode { get; set; } /// @@ -123,21 +110,21 @@ public partial class GetShipmentByIdResponseBody /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date"), JsonRequired, JsonPropertyOrder(10)] + [JsonPropertyName("ship_date"), JsonPropertyOrder(10)] public required DateTimeOffset ShipDate { get; set; } /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from"), JsonRequired, JsonPropertyOrder(11)] + [JsonPropertyName("ship_from"), JsonPropertyOrder(11)] public required ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address /// /// The recipient's mailing address - [JsonPropertyName("ship_to"), JsonRequired, JsonPropertyOrder(12)] + [JsonPropertyName("ship_to"), JsonPropertyOrder(12)] public required ShippingAddressTo ShipTo { get; set; } /// @@ -150,6 +137,13 @@ public partial class GetShipmentByIdResponseBody [JsonPropertyName("shipment_id"), JsonInclude] public string? ShipmentId { get; private set; } + /// + /// The current status of the shipment + /// + /// The current status of the shipment + [JsonPropertyName("shipment_status"), JsonInclude] + public ShipmentStatus? ShipmentStatus { get; private set; } + /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// @@ -178,7 +172,7 @@ public partial class GetShipmentByIdResponseBody /// Customs information. This is usually only needed for international shipments. /// /// Customs information. This is usually only needed for international shipments. - [JsonPropertyName("customs"), JsonRequired, JsonPropertyOrder(18)] + [JsonPropertyName("customs"), JsonPropertyOrder(18)] public required InternationalShipmentOptions Customs { get; set; } /// @@ -209,6 +203,12 @@ public partial class GetShipmentByIdResponseBody [JsonPropertyName("items"), JsonPropertyOrder(22)] public List? Items { get; set; } + /// + /// Gets or Sets OrderSourceCode + /// + [JsonPropertyName("order_source_code"), JsonPropertyOrder(23)] + public OrderSourceName? OrderSourceCode { get; set; } + /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// @@ -239,7 +239,7 @@ public partial class GetShipmentByIdResponseBody /// /// se-28529731 /// - [JsonPropertyName("warehouse_id"), JsonRequired, JsonPropertyOrder(27)] + [JsonPropertyName("warehouse_id"), JsonPropertyOrder(27)] public required string WarehouseId { get; set; } @@ -249,7 +249,7 @@ public partial class GetShipmentByIdResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetShipmentByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); diff --git a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs index 5464d0a6..564f1f5a 100644 --- a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs @@ -28,12 +28,6 @@ namespace ShipEngineSDK.Model; public partial class GetTrackingLogFromLabelResponseBody { - /// - /// Gets or Sets StatusCode - /// - [JsonPropertyName("status_code"), JsonRequired, JsonPropertyOrder(4)] - public required StatusCode StatusCode { get; set; } - /// /// Carrier status code /// @@ -51,7 +45,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("estimated_delivery_date"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("estimated_delivery_date"), JsonPropertyOrder(2)] public required DateTimeOffset EstimatedDeliveryDate { get; set; } /// @@ -61,6 +55,12 @@ public partial class GetTrackingLogFromLabelResponseBody [JsonPropertyName("events"), JsonInclude] public List? Events { get; private set; } + /// + /// Gets or Sets StatusCode + /// + [JsonPropertyName("status_code"), JsonPropertyOrder(4)] + public required StatusCode StatusCode { get; set; } + /// /// A tracking number for a package. The format depends on the carrier. /// @@ -68,7 +68,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// /// 1Z932R800392060079 /// - [JsonPropertyName("tracking_number"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("tracking_number"), JsonPropertyOrder(5)] public required string TrackingNumber { get; set; } /// @@ -165,7 +165,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetTrackingLogFromLabelResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierStatusCode: ").Append(CarrierStatusCode).Append("\n"); diff --git a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs index 896580a8..a885e661 100644 --- a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs @@ -28,12 +28,6 @@ namespace ShipEngineSDK.Model; public partial class GetTrackingLogResponseBody { - /// - /// Gets or Sets StatusCode - /// - [JsonPropertyName("status_code"), JsonRequired, JsonPropertyOrder(7)] - public required StatusCode StatusCode { get; set; } - /// /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. /// @@ -41,7 +35,7 @@ public partial class GetTrackingLogResponseBody /// /// dhl_express /// - [JsonPropertyName("carrier_code"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("carrier_code"), JsonPropertyOrder(1)] public required string CarrierCode { get; set; } /// @@ -61,7 +55,7 @@ public partial class GetTrackingLogResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("carrier_id"), JsonPropertyOrder(3)] public required string CarrierId { get; set; } /// @@ -81,7 +75,7 @@ public partial class GetTrackingLogResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("estimated_delivery_date"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("estimated_delivery_date"), JsonPropertyOrder(5)] public required DateTimeOffset EstimatedDeliveryDate { get; set; } /// @@ -91,6 +85,12 @@ public partial class GetTrackingLogResponseBody [JsonPropertyName("events"), JsonInclude] public List? Events { get; private set; } + /// + /// Gets or Sets StatusCode + /// + [JsonPropertyName("status_code"), JsonPropertyOrder(7)] + public required StatusCode StatusCode { get; set; } + /// /// A tracking number for a package. The format depends on the carrier. /// @@ -98,7 +98,7 @@ public partial class GetTrackingLogResponseBody /// /// 1Z932R800392060079 /// - [JsonPropertyName("tracking_number"), JsonRequired, JsonPropertyOrder(8)] + [JsonPropertyName("tracking_number"), JsonPropertyOrder(8)] public required string TrackingNumber { get; set; } /// @@ -165,7 +165,7 @@ public partial class GetTrackingLogResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetTrackingLogResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); diff --git a/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs b/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs index 25867a5b..3a16b565 100644 --- a/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs @@ -45,21 +45,21 @@ public partial class GetWarehouseByIdResponseBody /// /// Zero Cool HQ /// - [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("name"), JsonPropertyOrder(2)] public required string Name { get; set; } /// /// The origin address of the warehouse /// /// The origin address of the warehouse - [JsonPropertyName("origin_address"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("origin_address"), JsonPropertyOrder(3)] public required Address OriginAddress { get; set; } /// /// The return address associated with the warehouse /// /// The return address associated with the warehouse - [JsonPropertyName("return_address"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("return_address"), JsonPropertyOrder(4)] public required Address ReturnAddress { get; set; } /// @@ -86,7 +86,7 @@ public partial class GetWarehouseByIdResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetWarehouseByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); diff --git a/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs b/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs index 84fc1609..cda5438f 100644 --- a/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs @@ -31,7 +31,7 @@ public partial class GetWebhookByIdResponseBody /// /// Gets or Sets Event /// - [JsonPropertyName("event"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("event"), JsonPropertyOrder(1)] public required WebhookEvent Event { get; set; } /// @@ -41,7 +41,7 @@ public partial class GetWebhookByIdResponseBody /// /// http://api.shipengine.com/v1/labels/se-28529731 /// - [JsonPropertyName("url"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("url"), JsonPropertyOrder(2)] public required string Url { get; set; } /// @@ -68,7 +68,7 @@ public partial class GetWebhookByIdResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class GetWebhookByIdResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Event: ").Append(Event).Append("\n"); diff --git a/ShipEngineSDK/Model/IdentifierType.cs b/ShipEngineSDK/Model/IdentifierType.cs index fde76f2c..b3354a59 100644 --- a/ShipEngineSDK/Model/IdentifierType.cs +++ b/ShipEngineSDK/Model/IdentifierType.cs @@ -134,6 +134,11 @@ public IdentifierType(string value) /// public override bool Equals(object? obj) => obj is IdentifierType other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class IdentifierTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/ImporterOfRecords.cs b/ShipEngineSDK/Model/ImporterOfRecords.cs index b48400f5..34e06203 100644 --- a/ShipEngineSDK/Model/ImporterOfRecords.cs +++ b/ShipEngineSDK/Model/ImporterOfRecords.cs @@ -35,7 +35,7 @@ public partial class ImporterOfRecords /// /// 1999 Bishop Grandin Blvd. /// - [JsonPropertyName("address_line1"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("address_line1"), JsonPropertyOrder(1)] public required string AddressLine1 { get; set; } /// @@ -45,7 +45,7 @@ public partial class ImporterOfRecords /// /// Winnipeg /// - [JsonPropertyName("city_locality"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("city_locality"), JsonPropertyOrder(2)] public required string CityLocality { get; set; } /// @@ -55,7 +55,7 @@ public partial class ImporterOfRecords /// /// CA /// - [JsonPropertyName("country_code"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("country_code"), JsonPropertyOrder(3)] public required string CountryCode { get; set; } /// @@ -65,7 +65,7 @@ public partial class ImporterOfRecords /// /// John Doe /// - [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("name"), JsonPropertyOrder(4)] public required string Name { get; set; } /// @@ -75,7 +75,7 @@ public partial class ImporterOfRecords /// /// 78756-3717 /// - [JsonPropertyName("postal_code"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("postal_code"), JsonPropertyOrder(5)] public required string PostalCode { get; set; } /// @@ -145,7 +145,7 @@ public partial class ImporterOfRecords /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ImporterOfRecords {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); diff --git a/ShipEngineSDK/Model/InsuranceProvider.cs b/ShipEngineSDK/Model/InsuranceProvider.cs index 34b0c231..c5337613 100644 --- a/ShipEngineSDK/Model/InsuranceProvider.cs +++ b/ShipEngineSDK/Model/InsuranceProvider.cs @@ -86,6 +86,11 @@ public InsuranceProvider(string value) /// public override bool Equals(object? obj) => obj is InsuranceProvider other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class InsuranceProviderJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/InternationalShipmentOptions.cs b/ShipEngineSDK/Model/InternationalShipmentOptions.cs index 151a0d85..c6db0831 100644 --- a/ShipEngineSDK/Model/InternationalShipmentOptions.cs +++ b/ShipEngineSDK/Model/InternationalShipmentOptions.cs @@ -32,23 +32,16 @@ public partial class InternationalShipmentOptions /// The type of contents in this shipment. This may impact import duties or customs treatment. /// /// The type of contents in this shipment. This may impact import duties or customs treatment. - [JsonPropertyName("contents"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("contents"), JsonPropertyOrder(1)] public required PackageContents Contents { get; set; } /// /// Indicates what to do if a package is unable to be delivered. /// /// Indicates what to do if a package is unable to be delivered. - [JsonPropertyName("non_delivery"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("non_delivery"), JsonPropertyOrder(2)] public required NonDelivery NonDelivery { get; set; } - /// - /// Specifies the supported terms of trade code (incoterms) - /// - /// Specifies the supported terms of trade code (incoterms) - [JsonPropertyName("terms_of_trade_code"), JsonPropertyOrder(8)] - public AllowedIncoterms? TermsOfTradeCode { get; set; } - /// /// Explanation for contents (required if the `contents` is provided as `other`) /// @@ -82,6 +75,13 @@ public partial class InternationalShipmentOptions [JsonPropertyName("invoice_additional_details"), JsonPropertyOrder(7)] public InvoiceAdditionalDetails? InvoiceAdditionalDetails { get; set; } + /// + /// Specifies the supported terms of trade code (incoterms) + /// + /// Specifies the supported terms of trade code (incoterms) + [JsonPropertyName("terms_of_trade_code"), JsonPropertyOrder(8)] + public AllowedIncoterms? TermsOfTradeCode { get; set; } + /// /// Returns the string presentation of the object @@ -89,7 +89,7 @@ public partial class InternationalShipmentOptions /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class InternationalShipmentOptions {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Contents: ").Append(Contents).Append("\n"); diff --git a/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs b/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs index 947441f7..07a069b8 100644 --- a/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs +++ b/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs @@ -70,7 +70,7 @@ public partial class InvoiceAdditionalDetails /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class InvoiceAdditionalDetails {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Discount: ").Append(Discount).Append("\n"); diff --git a/ShipEngineSDK/Model/Label.cs b/ShipEngineSDK/Model/Label.cs index 32605a3a..3997b8b6 100644 --- a/ShipEngineSDK/Model/Label.cs +++ b/ShipEngineSDK/Model/Label.cs @@ -28,59 +28,6 @@ namespace ShipEngineSDK.Model; public partial class Label { - /// - /// The label charge event. - /// - /// The label charge event. - [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] - public LabelChargeEvent? ChargeEvent { get; set; } - - /// - /// 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)] - public DisplayScheme? DisplayScheme { get; set; } - - /// - /// Gets or Sets LabelDownloadType - /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(14)] - 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)] - public LabelFormat? LabelFormat { 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)] - public LabelLayout? LabelLayout { get; set; } - - /// - /// Gets or Sets Status - /// - [JsonPropertyName("status"), JsonInclude] - public LabelStatus? Status { get; private set; } - - /// - /// The current status of the package, such as `in_transit` or `delivered` - /// - /// The current status of the package, such as `in_transit` or `delivered` - [JsonPropertyName("tracking_status"), JsonInclude] - public TrackingStatus? TrackingStatus { get; private set; } - - /// - /// Gets or Sets ValidateAddress - /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(36)] - public ValidateAddress? ValidateAddress { get; set; } - /// /// Additional information some carriers may provide by which to identify a given label in their system. /// @@ -118,6 +65,13 @@ public partial class Label [JsonPropertyName("carrier_id"), JsonInclude] public string? CarrierId { get; private set; } + /// + /// The label charge event. + /// + /// The label charge event. + [JsonPropertyName("charge_event"), JsonPropertyOrder(5)] + public LabelChargeEvent? ChargeEvent { get; set; } + /// /// The date and time that the label was created in ShipEngine. /// @@ -128,6 +82,13 @@ public partial class Label [JsonPropertyName("created_at"), JsonInclude] public DateTimeOffset? CreatedAt { get; private set; } + /// + /// 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)] + public DisplayScheme? DisplayScheme { 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. /// @@ -169,6 +130,19 @@ public partial class Label [JsonPropertyName("label_download"), JsonInclude] public LabelDownload? LabelDownload { get; private set; } + /// + /// Gets or Sets LabelDownloadType + /// + [JsonPropertyName("label_download_type"), JsonPropertyOrder(14), 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)] + public LabelFormat? LabelFormat { get; set; } + /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// @@ -189,6 +163,13 @@ public partial class Label [JsonPropertyName("label_image_id"), JsonPropertyOrder(17)] 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)] + public LabelLayout? LabelLayout { get; set; } + /// /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. /// @@ -196,7 +177,7 @@ public partial class Label /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19)] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(19), JsonWriteOnly] public string? OutboundLabelId { get; set; } /// @@ -261,7 +242,7 @@ public partial class Label /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(27)] + [JsonPropertyName("shipment"), JsonPropertyOrder(27), JsonWriteOnly] public Shipment? Shipment { get; set; } /// @@ -281,11 +262,17 @@ public partial class Label [JsonPropertyName("shipment_id"), JsonInclude] public string? ShipmentId { get; private set; } + /// + /// Gets or Sets Status + /// + [JsonPropertyName("status"), JsonInclude] + public LabelStatus? Status { get; private 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(31), Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(31), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -305,6 +292,13 @@ public partial class Label [JsonPropertyName("tracking_number"), JsonInclude] public string? TrackingNumber { get; private set; } + /// + /// The current status of the package, such as `in_transit` or `delivered` + /// + /// The current status of the package, such as `in_transit` or `delivered` + [JsonPropertyName("tracking_status"), JsonInclude] + public TrackingStatus? TrackingStatus { get; private set; } + /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. /// @@ -315,6 +309,12 @@ public partial class Label [JsonPropertyName("tracking_url"), JsonInclude] public string? TrackingUrl { get; private set; } + /// + /// Gets or Sets ValidateAddress + /// + [JsonPropertyName("validate_address"), JsonPropertyOrder(36), JsonWriteOnly] + public ValidateAddress? ValidateAddress { get; set; } + /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// @@ -339,7 +339,7 @@ public partial class Label /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class Label {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); diff --git a/ShipEngineSDK/Model/LabelChargeEvent.cs b/ShipEngineSDK/Model/LabelChargeEvent.cs index 44b7cf36..74331da9 100644 --- a/ShipEngineSDK/Model/LabelChargeEvent.cs +++ b/ShipEngineSDK/Model/LabelChargeEvent.cs @@ -80,6 +80,11 @@ public LabelChargeEvent(string value) /// public override bool Equals(object? obj) => obj is LabelChargeEvent other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class LabelChargeEventJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/LabelDownload.cs b/ShipEngineSDK/Model/LabelDownload.cs index 545614b4..11ea846a 100644 --- a/ShipEngineSDK/Model/LabelDownload.cs +++ b/ShipEngineSDK/Model/LabelDownload.cs @@ -75,7 +75,7 @@ public partial class LabelDownload /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class LabelDownload {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Href: ").Append(Href).Append("\n"); diff --git a/ShipEngineSDK/Model/LabelDownloadType.cs b/ShipEngineSDK/Model/LabelDownloadType.cs index 64cb6e2a..6221bfa8 100644 --- a/ShipEngineSDK/Model/LabelDownloadType.cs +++ b/ShipEngineSDK/Model/LabelDownloadType.cs @@ -74,6 +74,11 @@ public LabelDownloadType(string value) /// public override bool Equals(object? obj) => obj is LabelDownloadType other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class LabelDownloadTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/LabelFormat.cs b/ShipEngineSDK/Model/LabelFormat.cs index 3e8f6a79..00a609f9 100644 --- a/ShipEngineSDK/Model/LabelFormat.cs +++ b/ShipEngineSDK/Model/LabelFormat.cs @@ -80,6 +80,11 @@ public LabelFormat(string value) /// public override bool Equals(object? obj) => obj is LabelFormat other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class LabelFormatJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/LabelLayout.cs b/ShipEngineSDK/Model/LabelLayout.cs index 93ff6f7f..ec8211ad 100644 --- a/ShipEngineSDK/Model/LabelLayout.cs +++ b/ShipEngineSDK/Model/LabelLayout.cs @@ -74,6 +74,11 @@ public LabelLayout(string value) /// public override bool Equals(object? obj) => obj is LabelLayout other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class LabelLayoutJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/LabelMessages.cs b/ShipEngineSDK/Model/LabelMessages.cs index 82ed5e80..f9f7a34e 100644 --- a/ShipEngineSDK/Model/LabelMessages.cs +++ b/ShipEngineSDK/Model/LabelMessages.cs @@ -32,21 +32,21 @@ public partial class LabelMessages /// The first line of the custom label message. Some carriers may prefix this line with something like \"REF\", \"Reference\", \"Trx Ref No.\", etc. /// /// The first line of the custom label message. Some carriers may prefix this line with something like \"REF\", \"Reference\", \"Trx Ref No.\", etc. - [JsonPropertyName("reference1"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("reference1"), JsonPropertyOrder(1)] public required string Reference1 { get; set; } /// /// The second line of the custom label message. Some carriers may prefix this line with something like \"INV\", \"Reference 2\", \"Trx Ref No.\", etc. /// /// The second line of the custom label message. Some carriers may prefix this line with something like \"INV\", \"Reference 2\", \"Trx Ref No.\", etc. - [JsonPropertyName("reference2"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("reference2"), JsonPropertyOrder(2)] public required string Reference2 { get; set; } /// /// The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc. /// /// The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc. - [JsonPropertyName("reference3"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("reference3"), JsonPropertyOrder(3)] public required string Reference3 { get; set; } @@ -56,7 +56,7 @@ public partial class LabelMessages /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class LabelMessages {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Reference1: ").Append(Reference1).Append("\n"); diff --git a/ShipEngineSDK/Model/LabelPackagesInner.cs b/ShipEngineSDK/Model/LabelPackagesInner.cs index 03d62717..b0d5d283 100644 --- a/ShipEngineSDK/Model/LabelPackagesInner.cs +++ b/ShipEngineSDK/Model/LabelPackagesInner.cs @@ -32,7 +32,7 @@ public partial class LabelPackagesInner /// The package weight /// /// The package weight - [JsonPropertyName("weight"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("weight"), JsonPropertyOrder(1)] public required Weight Weight { get; set; } /// @@ -151,7 +151,7 @@ public partial class LabelPackagesInner /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class LabelPackagesInner {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Weight: ").Append(Weight).Append("\n"); diff --git a/ShipEngineSDK/Model/LabelStatus.cs b/ShipEngineSDK/Model/LabelStatus.cs index f6034537..6309224d 100644 --- a/ShipEngineSDK/Model/LabelStatus.cs +++ b/ShipEngineSDK/Model/LabelStatus.cs @@ -86,6 +86,11 @@ public LabelStatus(string value) /// public override bool Equals(object? obj) => obj is LabelStatus other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class LabelStatusJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/Link.cs b/ShipEngineSDK/Model/Link.cs index 64821b7d..cc855ad0 100644 --- a/ShipEngineSDK/Model/Link.cs +++ b/ShipEngineSDK/Model/Link.cs @@ -35,7 +35,7 @@ public partial class Link /// /// http://api.shipengine.com/v1/labels/se-28529731 /// - [JsonPropertyName("href"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("href"), JsonPropertyOrder(1)] public required string Href { get; set; } /// @@ -52,7 +52,7 @@ public partial class Link /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class Link {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Href: ").Append(Href).Append("\n"); diff --git a/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs b/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs index 0e87903d..57d99736 100644 --- a/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs +++ b/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs @@ -111,7 +111,7 @@ public class ListAccountImagesResponseBodyItem /// /// Gets or Sets Links /// - [JsonPropertyName("links"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("links"), JsonPropertyOrder(2)] public required PaginationLink Links { get; set; } /// @@ -121,7 +121,7 @@ public class ListAccountImagesResponseBodyItem /// /// 1 /// - [JsonPropertyName("page"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("page"), JsonPropertyOrder(3)] public required int Page { get; set; } /// @@ -131,7 +131,7 @@ public class ListAccountImagesResponseBodyItem /// /// 4 /// - [JsonPropertyName("pages"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("pages"), JsonPropertyOrder(4)] public required int Pages { get; set; } /// @@ -141,7 +141,7 @@ public class ListAccountImagesResponseBodyItem /// /// 2750 /// - [JsonPropertyName("total"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("total"), JsonPropertyOrder(5)] public required int Total { get; set; } @@ -151,7 +151,7 @@ public class ListAccountImagesResponseBodyItem /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListAccountImagesResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Images: ").Append(Images).Append("\n"); diff --git a/ShipEngineSDK/Model/ListAccountSettingsBody.cs b/ShipEngineSDK/Model/ListAccountSettingsBody.cs index 021e4854..5466d742 100644 --- a/ShipEngineSDK/Model/ListAccountSettingsBody.cs +++ b/ShipEngineSDK/Model/ListAccountSettingsBody.cs @@ -41,7 +41,7 @@ public partial class ListAccountSettingsBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListAccountSettingsBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" DefaultLabelLayout: ").Append(DefaultLabelLayout).Append("\n"); diff --git a/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs b/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs index fa68b4ca..a557a1c0 100644 --- a/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs +++ b/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs @@ -111,7 +111,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// /// Gets or Sets Links /// - [JsonPropertyName("links"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("links"), JsonPropertyOrder(2)] public required PaginationLink Links { get; set; } /// @@ -121,7 +121,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// /// 1 /// - [JsonPropertyName("page"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("page"), JsonPropertyOrder(3)] public required int Page { get; set; } /// @@ -131,7 +131,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// /// 4 /// - [JsonPropertyName("pages"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("pages"), JsonPropertyOrder(4)] public required int Pages { get; set; } /// @@ -141,7 +141,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// /// 2750 /// - [JsonPropertyName("total"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("total"), JsonPropertyOrder(5)] public required int Total { get; set; } @@ -151,7 +151,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListAccountSettingsImagesResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Images: ").Append(Images).Append("\n"); diff --git a/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs b/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs index ad86ccdb..041d9d2a 100644 --- a/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs +++ b/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs @@ -48,7 +48,7 @@ public partial class ListBatchErrorsResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListBatchErrorsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Errors: ").Append(Errors).Append("\n"); diff --git a/ShipEngineSDK/Model/ListBatchesResponseBody.cs b/ShipEngineSDK/Model/ListBatchesResponseBody.cs index 76ca5edb..7c1688c1 100644 --- a/ShipEngineSDK/Model/ListBatchesResponseBody.cs +++ b/ShipEngineSDK/Model/ListBatchesResponseBody.cs @@ -78,7 +78,7 @@ public partial class ListBatchesResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListBatchesResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Batches: ").Append(Batches).Append("\n"); diff --git a/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs b/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs index 60cb70a2..378306aa 100644 --- a/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs +++ b/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs @@ -42,7 +42,7 @@ public partial class ListCarrierPackageTypesResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListCarrierPackageTypesResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Packages: ").Append(Packages).Append("\n"); diff --git a/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs b/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs index e286f4ea..4a0a9fd6 100644 --- a/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs +++ b/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs @@ -42,7 +42,7 @@ public partial class ListCarrierServicesResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListCarrierServicesResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Services: ").Append(Services).Append("\n"); diff --git a/ShipEngineSDK/Model/ListCarriersResponseBody.cs b/ShipEngineSDK/Model/ListCarriersResponseBody.cs index 747f3ca7..4bfe9dcd 100644 --- a/ShipEngineSDK/Model/ListCarriersResponseBody.cs +++ b/ShipEngineSDK/Model/ListCarriersResponseBody.cs @@ -42,7 +42,7 @@ public partial class ListCarriersResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListCarriersResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Carriers: ").Append(Carriers).Append("\n"); diff --git a/ShipEngineSDK/Model/ListLabelsResponseBody.cs b/ShipEngineSDK/Model/ListLabelsResponseBody.cs index 07fae5d6..5e3179d5 100644 --- a/ShipEngineSDK/Model/ListLabelsResponseBody.cs +++ b/ShipEngineSDK/Model/ListLabelsResponseBody.cs @@ -63,7 +63,7 @@ public class ListLabelsResponseBodyItem /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(4)] + [JsonPropertyName("shipment"), JsonPropertyOrder(4), JsonWriteOnly] public Shipment? Shipment { get; set; } /// @@ -172,7 +172,7 @@ public class ListLabelsResponseBodyItem /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(17)] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(17), JsonWriteOnly] public string? OutboundLabelId { get; set; } /// @@ -189,7 +189,7 @@ public class ListLabelsResponseBodyItem /// 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(19), Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(19), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -205,7 +205,7 @@ public class ListLabelsResponseBodyItem /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(21)] + [JsonPropertyName("validate_address"), JsonPropertyOrder(21), JsonWriteOnly] public ValidateAddress? ValidateAddress { get; set; } /// @@ -228,7 +228,7 @@ public class ListLabelsResponseBodyItem /// /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(24)] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(24), JsonWriteOnly] public LabelDownloadType? LabelDownloadType { get; set; } /// @@ -342,13 +342,13 @@ public class ListLabelsResponseBodyItem /// The labels that matched the query criteria. If no matching labels were found, then this array is empty; otherwise, it contains one page of results. The last page of results may have fewer labels than the `page_size`. /// /// The labels that matched the query criteria. If no matching labels were found, then this array is empty; otherwise, it contains one page of results. The last page of results may have fewer labels than the `page_size`. - [JsonPropertyName("labels"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("labels"), JsonPropertyOrder(1)] public required List Labels { get; set; } /// /// Gets or Sets Links /// - [JsonPropertyName("links"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("links"), JsonPropertyOrder(2)] public required PaginationLink Links { get; set; } /// @@ -358,7 +358,7 @@ public class ListLabelsResponseBodyItem /// /// 1 /// - [JsonPropertyName("page"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("page"), JsonPropertyOrder(3)] public required int Page { get; set; } /// @@ -368,7 +368,7 @@ public class ListLabelsResponseBodyItem /// /// 4 /// - [JsonPropertyName("pages"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("pages"), JsonPropertyOrder(4)] public required int Pages { get; set; } /// @@ -378,7 +378,7 @@ public class ListLabelsResponseBodyItem /// /// 2750 /// - [JsonPropertyName("total"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("total"), JsonPropertyOrder(5)] public required int Total { get; set; } @@ -388,7 +388,7 @@ public class ListLabelsResponseBodyItem /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListLabelsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Labels: ").Append(Labels).Append("\n"); diff --git a/ShipEngineSDK/Model/ListManifestsResponseBody.cs b/ShipEngineSDK/Model/ListManifestsResponseBody.cs index 0b07315f..b396e0cb 100644 --- a/ShipEngineSDK/Model/ListManifestsResponseBody.cs +++ b/ShipEngineSDK/Model/ListManifestsResponseBody.cs @@ -79,7 +79,7 @@ public partial class ListManifestsResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListManifestsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Links: ").Append(Links).Append("\n"); diff --git a/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs b/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs index f0ba7b8b..cffeb2b6 100644 --- a/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs +++ b/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs @@ -42,7 +42,7 @@ public partial class ListPackageTypesResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListPackageTypesResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Packages: ").Append(Packages).Append("\n"); diff --git a/ShipEngineSDK/Model/ListPickupResponseBody.cs b/ShipEngineSDK/Model/ListPickupResponseBody.cs index 5abc367f..69e3d859 100644 --- a/ShipEngineSDK/Model/ListPickupResponseBody.cs +++ b/ShipEngineSDK/Model/ListPickupResponseBody.cs @@ -59,7 +59,7 @@ public partial class ListPickupResponseBody /// An array of pickups associated with the user's account. /// /// An array of pickups associated with the user's account. - [JsonPropertyName("pickups"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("pickups"), JsonPropertyOrder(4)] public required List Pickups { get; set; } /// @@ -79,7 +79,7 @@ public partial class ListPickupResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListPickupResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Links: ").Append(Links).Append("\n"); diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBody.cs b/ShipEngineSDK/Model/ListServicePointsResponseBody.cs index 4c70af02..ccad8e7e 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBody.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBody.cs @@ -68,7 +68,7 @@ public partial class ListServicePointsResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListServicePointsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Errors: ").Append(Errors).Append("\n"); diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs index c5496278..8b63fcdf 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs @@ -165,13 +165,6 @@ public override bool CanConvert(Type typeToConvert) => } - /// - /// Service point type - /// - /// Service point type - [JsonPropertyName("type"), JsonPropertyOrder(16)] - public TypeEnum? Type { get; set; } - /// /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. /// @@ -311,6 +304,13 @@ public override bool CanConvert(Type typeToConvert) => [JsonPropertyName("state_province"), JsonPropertyOrder(15)] public string? StateProvince { get; set; } + /// + /// Service point type + /// + /// Service point type + [JsonPropertyName("type"), JsonPropertyOrder(16)] + public TypeEnum? Type { get; set; } + /// /// Returns the string presentation of the object @@ -318,7 +318,7 @@ public override bool CanConvert(Type typeToConvert) => /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListServicePointsResponseBodyServicePointsInner {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs index 64d5d90c..962e0668 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs @@ -77,7 +77,7 @@ public partial class ListServicePointsResponseBodyServicePointsInnerHoursOfOpera /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListServicePointsResponseBodyServicePointsInnerHoursOfOperation {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Friday: ").Append(Friday).Append("\n"); diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs index ee44adc8..5adb3b54 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs @@ -55,7 +55,7 @@ public partial class ListServicePointsResponseBodyServicePointsInnerHoursOfOpera /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Close: ").Append(Close).Append("\n"); diff --git a/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs b/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs index 7b723f6f..5e5c2d5b 100644 --- a/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs +++ b/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs @@ -28,12 +28,6 @@ namespace ShipEngineSDK.Model; public partial class ListShipmentRatesResponseBody { - /// - /// Gets or Sets Status - /// - [JsonPropertyName("status"), JsonInclude] - public RateResponseStatus? Status { get; private set; } - /// /// When the rate was created /// @@ -41,13 +35,13 @@ public partial class ListShipmentRatesResponseBody /// /// se-28529731 /// - [JsonPropertyName("created_at"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("created_at"), JsonPropertyOrder(1)] public required string CreatedAt { get; set; } /// /// Gets or Sets Errors /// - [JsonPropertyName("errors"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("errors"), JsonPropertyOrder(2)] public required List Errors { get; set; } /// @@ -84,6 +78,12 @@ public partial class ListShipmentRatesResponseBody [JsonPropertyName("shipment_id"), JsonInclude] public string? ShipmentId { get; private set; } + /// + /// Gets or Sets Status + /// + [JsonPropertyName("status"), JsonInclude] + public RateResponseStatus? Status { get; private set; } + /// /// Returns the string presentation of the object @@ -91,7 +91,7 @@ public partial class ListShipmentRatesResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListShipmentRatesResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); diff --git a/ShipEngineSDK/Model/ListShipmentsResponseBody.cs b/ShipEngineSDK/Model/ListShipmentsResponseBody.cs index 4f35dc48..cd18907a 100644 --- a/ShipEngineSDK/Model/ListShipmentsResponseBody.cs +++ b/ShipEngineSDK/Model/ListShipmentsResponseBody.cs @@ -70,7 +70,7 @@ public partial class ListShipmentsResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListShipmentsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Links: ").Append(Links).Append("\n"); diff --git a/ShipEngineSDK/Model/ListTagsResponseBody.cs b/ShipEngineSDK/Model/ListTagsResponseBody.cs index 298cc80e..36446899 100644 --- a/ShipEngineSDK/Model/ListTagsResponseBody.cs +++ b/ShipEngineSDK/Model/ListTagsResponseBody.cs @@ -42,7 +42,7 @@ public partial class ListTagsResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListTagsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Tags: ").Append(Tags).Append("\n"); diff --git a/ShipEngineSDK/Model/ListWarehousesResponseBody.cs b/ShipEngineSDK/Model/ListWarehousesResponseBody.cs index 95cd2d4e..4f3bc395 100644 --- a/ShipEngineSDK/Model/ListWarehousesResponseBody.cs +++ b/ShipEngineSDK/Model/ListWarehousesResponseBody.cs @@ -42,7 +42,7 @@ public partial class ListWarehousesResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ListWarehousesResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Warehouses: ").Append(Warehouses).Append("\n"); diff --git a/ShipEngineSDK/Model/Manifest.cs b/ShipEngineSDK/Model/Manifest.cs index 037e7d7e..118698f2 100644 --- a/ShipEngineSDK/Model/Manifest.cs +++ b/ShipEngineSDK/Model/Manifest.cs @@ -128,7 +128,7 @@ public partial class Manifest /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class Manifest {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); diff --git a/ShipEngineSDK/Model/ManifestDownload.cs b/ShipEngineSDK/Model/ManifestDownload.cs index ee9f6c9b..5de10152 100644 --- a/ShipEngineSDK/Model/ManifestDownload.cs +++ b/ShipEngineSDK/Model/ManifestDownload.cs @@ -45,7 +45,7 @@ public partial class ManifestDownload /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ManifestDownload {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Href: ").Append(Href).Append("\n"); diff --git a/ShipEngineSDK/Model/ManifestRequest.cs b/ShipEngineSDK/Model/ManifestRequest.cs index 29ff0675..fe193e46 100644 --- a/ShipEngineSDK/Model/ManifestRequest.cs +++ b/ShipEngineSDK/Model/ManifestRequest.cs @@ -28,12 +28,6 @@ namespace ShipEngineSDK.Model; public partial class ManifestRequest { - /// - /// Gets or Sets Status - /// - [JsonPropertyName("status"), JsonPropertyOrder(2)] - public ManifestRequestStatus? Status { get; set; } - /// /// A string that uniquely identifies a manifest request /// @@ -44,6 +38,12 @@ public partial class ManifestRequest [JsonPropertyName("manifest_request_id"), JsonInclude] public string? ManifestRequestId { get; private set; } + /// + /// Gets or Sets Status + /// + [JsonPropertyName("status"), JsonPropertyOrder(2)] + public ManifestRequestStatus? Status { get; set; } + /// /// Returns the string presentation of the object @@ -51,7 +51,7 @@ public partial class ManifestRequest /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ManifestRequest {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ManifestRequestId: ").Append(ManifestRequestId).Append("\n"); diff --git a/ShipEngineSDK/Model/ManifestRequestStatus.cs b/ShipEngineSDK/Model/ManifestRequestStatus.cs index cb5516ec..bdf4cfbc 100644 --- a/ShipEngineSDK/Model/ManifestRequestStatus.cs +++ b/ShipEngineSDK/Model/ManifestRequestStatus.cs @@ -74,6 +74,11 @@ public ManifestRequestStatus(string value) /// public override bool Equals(object? obj) => obj is ManifestRequestStatus other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class ManifestRequestStatusJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/Manifests.cs b/ShipEngineSDK/Model/Manifests.cs index 08a947be..19642ed7 100644 --- a/ShipEngineSDK/Model/Manifests.cs +++ b/ShipEngineSDK/Model/Manifests.cs @@ -42,7 +42,7 @@ public partial class Manifests /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class Manifests {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" VarManifests: ").Append(VarManifests).Append("\n"); diff --git a/ShipEngineSDK/Model/ManifestsRequests.cs b/ShipEngineSDK/Model/ManifestsRequests.cs index 5f62f111..2a029aee 100644 --- a/ShipEngineSDK/Model/ManifestsRequests.cs +++ b/ShipEngineSDK/Model/ManifestsRequests.cs @@ -42,7 +42,7 @@ public partial class ManifestsRequests /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ManifestsRequests {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ManifestRequests: ").Append(ManifestRequests).Append("\n"); diff --git a/ShipEngineSDK/Model/ModifyBatch.cs b/ShipEngineSDK/Model/ModifyBatch.cs index 90c5b92e..d026a6e3 100644 --- a/ShipEngineSDK/Model/ModifyBatch.cs +++ b/ShipEngineSDK/Model/ModifyBatch.cs @@ -49,7 +49,7 @@ public partial class ModifyBatch /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ModifyBatch {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" RateIds: ").Append(RateIds).Append("\n"); diff --git a/ShipEngineSDK/Model/MonetaryValue.cs b/ShipEngineSDK/Model/MonetaryValue.cs index dd5f5f42..a3b54f7c 100644 --- a/ShipEngineSDK/Model/MonetaryValue.cs +++ b/ShipEngineSDK/Model/MonetaryValue.cs @@ -32,14 +32,14 @@ public partial class MonetaryValue /// The monetary amount, in the specified currency. /// /// The monetary amount, in the specified currency. - [JsonPropertyName("amount"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("amount"), JsonPropertyOrder(1)] public required double Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html - [JsonPropertyName("currency"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("currency"), JsonPropertyOrder(2)] public required string Currency { get; set; } @@ -49,7 +49,7 @@ public partial class MonetaryValue /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class MonetaryValue {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Amount: ").Append(Amount).Append("\n"); diff --git a/ShipEngineSDK/Model/NonDelivery.cs b/ShipEngineSDK/Model/NonDelivery.cs index 7b3eb3cd..352bdcfb 100644 --- a/ShipEngineSDK/Model/NonDelivery.cs +++ b/ShipEngineSDK/Model/NonDelivery.cs @@ -74,6 +74,11 @@ public NonDelivery(string value) /// public override bool Equals(object? obj) => obj is NonDelivery other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class NonDeliveryJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/OptionalLink.cs b/ShipEngineSDK/Model/OptionalLink.cs index 4d83bf5b..954aa527 100644 --- a/ShipEngineSDK/Model/OptionalLink.cs +++ b/ShipEngineSDK/Model/OptionalLink.cs @@ -52,7 +52,7 @@ public partial class OptionalLink /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class OptionalLink {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Href: ").Append(Href).Append("\n"); diff --git a/ShipEngineSDK/Model/OrderSourceName.cs b/ShipEngineSDK/Model/OrderSourceName.cs index 1b6c3b0d..9720e3ac 100644 --- a/ShipEngineSDK/Model/OrderSourceName.cs +++ b/ShipEngineSDK/Model/OrderSourceName.cs @@ -182,6 +182,11 @@ public OrderSourceName(string value) /// public override bool Equals(object? obj) => obj is OrderSourceName other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class OrderSourceNameJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/OriginType.cs b/ShipEngineSDK/Model/OriginType.cs index 28f526af..6e521ec5 100644 --- a/ShipEngineSDK/Model/OriginType.cs +++ b/ShipEngineSDK/Model/OriginType.cs @@ -74,6 +74,11 @@ public OriginType(string value) /// public override bool Equals(object? obj) => obj is OriginType other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class OriginTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/Package.cs b/ShipEngineSDK/Model/Package.cs index b1cbf48e..0cee32c7 100644 --- a/ShipEngineSDK/Model/Package.cs +++ b/ShipEngineSDK/Model/Package.cs @@ -32,7 +32,7 @@ public partial class Package /// The package weight /// /// The package weight - [JsonPropertyName("weight"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("weight"), JsonPropertyOrder(1)] public required Weight Weight { get; set; } /// @@ -144,7 +144,7 @@ public partial class Package /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class Package {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Weight: ").Append(Weight).Append("\n"); diff --git a/ShipEngineSDK/Model/PackageContents.cs b/ShipEngineSDK/Model/PackageContents.cs index c60226ad..ea6b79cd 100644 --- a/ShipEngineSDK/Model/PackageContents.cs +++ b/ShipEngineSDK/Model/PackageContents.cs @@ -98,6 +98,11 @@ public PackageContents(string value) /// public override bool Equals(object? obj) => obj is PackageContents other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class PackageContentsJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/PackageType.cs b/ShipEngineSDK/Model/PackageType.cs index 12897308..3976fa4f 100644 --- a/ShipEngineSDK/Model/PackageType.cs +++ b/ShipEngineSDK/Model/PackageType.cs @@ -34,7 +34,7 @@ public partial class PackageType /// /// laptop_box /// - [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("name"), JsonPropertyOrder(1)] public required string Name { get; set; } /// @@ -44,7 +44,7 @@ public partial class PackageType /// /// small_flat_rate_box /// - [JsonPropertyName("package_code"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("package_code"), JsonPropertyOrder(2)] public required string PackageCode { get; set; } /// @@ -81,7 +81,7 @@ public partial class PackageType /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class PackageType {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); diff --git a/ShipEngineSDK/Model/PackagingGroup.cs b/ShipEngineSDK/Model/PackagingGroup.cs index c5d441d9..d3222849 100644 --- a/ShipEngineSDK/Model/PackagingGroup.cs +++ b/ShipEngineSDK/Model/PackagingGroup.cs @@ -79,6 +79,11 @@ public PackagingGroup(string value) /// public override bool Equals(object? obj) => obj is PackagingGroup other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class PackagingGroupJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/PackagingInstructionSection.cs b/ShipEngineSDK/Model/PackagingInstructionSection.cs index deae3798..a9b7a9d2 100644 --- a/ShipEngineSDK/Model/PackagingInstructionSection.cs +++ b/ShipEngineSDK/Model/PackagingInstructionSection.cs @@ -85,6 +85,11 @@ public PackagingInstructionSection(string value) /// public override bool Equals(object? obj) => obj is PackagingInstructionSection other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class PackagingInstructionSectionJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/PagedListResponseBody.cs b/ShipEngineSDK/Model/PagedListResponseBody.cs index a3359a19..5788f827 100644 --- a/ShipEngineSDK/Model/PagedListResponseBody.cs +++ b/ShipEngineSDK/Model/PagedListResponseBody.cs @@ -31,7 +31,7 @@ public partial class PagedListResponseBody /// /// Gets or Sets Links /// - [JsonPropertyName("links"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("links"), JsonPropertyOrder(1)] public required PaginationLink Links { get; set; } /// @@ -41,7 +41,7 @@ public partial class PagedListResponseBody /// /// 1 /// - [JsonPropertyName("page"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("page"), JsonPropertyOrder(2)] public required int Page { get; set; } /// @@ -51,7 +51,7 @@ public partial class PagedListResponseBody /// /// 4 /// - [JsonPropertyName("pages"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("pages"), JsonPropertyOrder(3)] public required int Pages { get; set; } /// @@ -61,7 +61,7 @@ public partial class PagedListResponseBody /// /// 2750 /// - [JsonPropertyName("total"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("total"), JsonPropertyOrder(4)] public required int Total { get; set; } /// @@ -77,7 +77,7 @@ public partial class PagedListResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class PagedListResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Links: ").Append(Links).Append("\n"); diff --git a/ShipEngineSDK/Model/PaginationLink.cs b/ShipEngineSDK/Model/PaginationLink.cs index 481902f7..2e5706f1 100644 --- a/ShipEngineSDK/Model/PaginationLink.cs +++ b/ShipEngineSDK/Model/PaginationLink.cs @@ -32,28 +32,28 @@ public partial class PaginationLink /// The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items. /// /// The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items. - [JsonPropertyName("first"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("first"), JsonPropertyOrder(1)] public required Link First { get; set; } /// /// The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items. /// /// The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items. - [JsonPropertyName("last"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("last"), JsonPropertyOrder(2)] public required Link Last { get; set; } /// /// The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`. /// /// The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`. - [JsonPropertyName("next"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("next"), JsonPropertyOrder(3)] public required OptionalLink Next { get; set; } /// /// The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater. /// /// The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater. - [JsonPropertyName("prev"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("prev"), JsonPropertyOrder(4)] public required OptionalLink Prev { get; set; } @@ -63,7 +63,7 @@ public partial class PaginationLink /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class PaginationLink {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" First: ").Append(First).Append("\n"); diff --git a/ShipEngineSDK/Model/PaperlessDownload.cs b/ShipEngineSDK/Model/PaperlessDownload.cs index 7a26c980..4701d74a 100644 --- a/ShipEngineSDK/Model/PaperlessDownload.cs +++ b/ShipEngineSDK/Model/PaperlessDownload.cs @@ -59,7 +59,7 @@ public partial class PaperlessDownload /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class PaperlessDownload {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" HandoffCode: ").Append(HandoffCode).Append("\n"); diff --git a/ShipEngineSDK/Model/ParseAddressRequestBody.cs b/ShipEngineSDK/Model/ParseAddressRequestBody.cs index b4a74fc7..7520824b 100644 --- a/ShipEngineSDK/Model/ParseAddressRequestBody.cs +++ b/ShipEngineSDK/Model/ParseAddressRequestBody.cs @@ -35,7 +35,7 @@ public partial class ParseAddressRequestBody /// /// Margie McMiller at 3800 North Lamar suite 200 in austin, tx. The zip code there is 78652. /// - [JsonPropertyName("text"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("text"), JsonPropertyOrder(1)] public required string Text { get; set; } /// @@ -52,7 +52,7 @@ public partial class ParseAddressRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ParseAddressRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Text: ").Append(Text).Append("\n"); diff --git a/ShipEngineSDK/Model/ParseAddressResponseBody.cs b/ShipEngineSDK/Model/ParseAddressResponseBody.cs index 268c163a..77b9b77b 100644 --- a/ShipEngineSDK/Model/ParseAddressResponseBody.cs +++ b/ShipEngineSDK/Model/ParseAddressResponseBody.cs @@ -32,21 +32,21 @@ public partial class ParseAddressResponseBody /// The parsed address. This address may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The address-recognition API does not currently perform any validation of the parsed address, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the address is correct. /// /// The parsed address. This address may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The address-recognition API does not currently perform any validation of the parsed address, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the address is correct. - [JsonPropertyName("address"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("address"), JsonPropertyOrder(1)] public required PartialAddress Address { get; set; } /// /// All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, or an address line. Each entity includes the original text and the parsed value. /// /// All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, or an address line. Each entity includes the original text and the parsed value. - [JsonPropertyName("entities"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("entities"), JsonPropertyOrder(2)] public required List Entities { get; set; } /// /// A confidence score between zero and one that indicates how certain the API is that it understood the text. /// /// A confidence score between zero and one that indicates how certain the API is that it understood the text. - [JsonPropertyName("score"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("score"), JsonPropertyOrder(3)] public required double Score { get; set; } @@ -56,7 +56,7 @@ public partial class ParseAddressResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ParseAddressResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Address: ").Append(Address).Append("\n"); diff --git a/ShipEngineSDK/Model/ParseShipmentRequestBody.cs b/ShipEngineSDK/Model/ParseShipmentRequestBody.cs index a69b503a..5ca143e5 100644 --- a/ShipEngineSDK/Model/ParseShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/ParseShipmentRequestBody.cs @@ -36,7 +36,7 @@ public partial class ParseShipmentRequestBody /// I have a 4oz package that's 5x10x14in, and I need to ship it to Margie McMiller at 3800 North Lamar suite 200 in austin, tx 78652. Please send it via USPS first class and require an adult signature. It also needs to be insured for $400. /// - [JsonPropertyName("text"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("text"), JsonPropertyOrder(1)] public required string Text { get; set; } /// @@ -53,7 +53,7 @@ public partial class ParseShipmentRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ParseShipmentRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Text: ").Append(Text).Append("\n"); diff --git a/ShipEngineSDK/Model/ParseShipmentResponseBody.cs b/ShipEngineSDK/Model/ParseShipmentResponseBody.cs index 2caa127a..ac1d6234 100644 --- a/ShipEngineSDK/Model/ParseShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/ParseShipmentResponseBody.cs @@ -32,21 +32,21 @@ public partial class ParseShipmentResponseBody /// All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, a carrier name, or a package weight. Each entity includes the original text and the parsed value. /// /// All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, a carrier name, or a package weight. Each entity includes the original text and the parsed value. - [JsonPropertyName("entities"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("entities"), JsonPropertyOrder(1)] public required List Entities { get; set; } /// /// A confidence score between zero and one that indicates how certain the API is that it understood the text. /// /// A confidence score between zero and one that indicates how certain the API is that it understood the text. - [JsonPropertyName("score"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("score"), JsonPropertyOrder(2)] public required double Score { get; set; } /// /// The parsed shipment. This shipment may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The shipment-recognition API does not currently perform any validation of the parsed addresses, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the addresses are correct. /// /// The parsed shipment. This shipment may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The shipment-recognition API does not currently perform any validation of the parsed addresses, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the addresses are correct. - [JsonPropertyName("shipment"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("shipment"), JsonPropertyOrder(3)] public required PartialShipment Shipment { get; set; } @@ -56,7 +56,7 @@ public partial class ParseShipmentResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ParseShipmentResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Entities: ").Append(Entities).Append("\n"); diff --git a/ShipEngineSDK/Model/PartialAddress.cs b/ShipEngineSDK/Model/PartialAddress.cs index 4564c50a..f673dec1 100644 --- a/ShipEngineSDK/Model/PartialAddress.cs +++ b/ShipEngineSDK/Model/PartialAddress.cs @@ -28,13 +28,6 @@ namespace ShipEngineSDK.Model; public partial class PartialAddress { - /// - /// Indicates whether this is a residential address. - /// - /// Indicates whether this is a residential address. - [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(4)] - public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } - /// /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. /// @@ -65,6 +58,13 @@ public partial class PartialAddress [JsonPropertyName("address_line3"), JsonPropertyOrder(3)] public string? AddressLine3 { get; set; } + /// + /// Indicates whether this is a residential address. + /// + /// Indicates whether this is a residential address. + [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(4)] + public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } + /// /// The name of the city or locality /// @@ -152,7 +152,7 @@ public partial class PartialAddress /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class PartialAddress {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); diff --git a/ShipEngineSDK/Model/PartialShipment.cs b/ShipEngineSDK/Model/PartialShipment.cs index 2d4af8da..e9ea90df 100644 --- a/ShipEngineSDK/Model/PartialShipment.cs +++ b/ShipEngineSDK/Model/PartialShipment.cs @@ -28,33 +28,6 @@ namespace ShipEngineSDK.Model; public partial class PartialShipment { - /// - /// The type of delivery confirmation that is required for this shipment. - /// - /// The type of delivery confirmation that is required for this shipment. - [JsonPropertyName("confirmation"), JsonPropertyOrder(4)] - public DeliveryConfirmation? Confirmation { get; set; } - - /// - /// The insurance provider to use for any insured packages in the shipment. - /// - /// The insurance provider to use for any insured packages in the shipment. - [JsonPropertyName("insurance_provider"), JsonPropertyOrder(9)] - public InsuranceProvider? InsuranceProvider { get; set; } - - /// - /// Gets or Sets OrderSourceCode - /// - [JsonPropertyName("order_source_code"), JsonPropertyOrder(13)] - public OrderSourceName? OrderSourceCode { get; set; } - - /// - /// The current status of the shipment - /// - /// The current status of the shipment - [JsonPropertyName("shipment_status"), JsonInclude] - public ShipmentStatus? ShipmentStatus { get; private set; } - /// /// Advanced shipment options. These are entirely optional. /// @@ -82,6 +55,13 @@ public partial class PartialShipment [JsonPropertyName("comparison_rate_type"), JsonPropertyOrder(3)] public string? ComparisonRateType { 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"), JsonPropertyOrder(4)] + public DeliveryConfirmation? Confirmation { get; set; } + /// /// The date and time that the shipment was created in ShipEngine. /// @@ -113,6 +93,13 @@ public partial class PartialShipment [JsonPropertyName("external_shipment_id"), JsonPropertyOrder(8)] public string? ExternalShipmentId { get; set; } + /// + /// The insurance provider to use for any insured packages in the shipment. + /// + /// The insurance provider to use for any insured packages in the shipment. + [JsonPropertyName("insurance_provider"), JsonPropertyOrder(9)] + public InsuranceProvider? InsuranceProvider { get; set; } + /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// @@ -137,6 +124,12 @@ public partial class PartialShipment [JsonPropertyName("modified_at"), JsonInclude] public DateTimeOffset? ModifiedAt { get; private set; } + /// + /// Gets or Sets OrderSourceCode + /// + [JsonPropertyName("order_source_code"), JsonPropertyOrder(13)] + public OrderSourceName? OrderSourceCode { get; set; } + /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// @@ -202,6 +195,13 @@ public partial class PartialShipment [JsonPropertyName("shipment_number"), JsonPropertyOrder(21)] public string? ShipmentNumber { get; set; } + /// + /// The current status of the shipment + /// + /// The current status of the shipment + [JsonPropertyName("shipment_status"), JsonInclude] + public ShipmentStatus? ShipmentStatus { get; private set; } + /// /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment /// @@ -249,7 +249,7 @@ public partial class PartialShipment /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class PartialShipment {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); diff --git a/ShipEngineSDK/Model/PartialShippingAddress.cs b/ShipEngineSDK/Model/PartialShippingAddress.cs index 0a640f22..8d88f6db 100644 --- a/ShipEngineSDK/Model/PartialShippingAddress.cs +++ b/ShipEngineSDK/Model/PartialShippingAddress.cs @@ -42,7 +42,7 @@ public partial class PartialShippingAddress /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class PartialShippingAddress {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Instructions: ").Append(Instructions).Append("\n"); diff --git a/ShipEngineSDK/Model/PartialShippingAddressTo.cs b/ShipEngineSDK/Model/PartialShippingAddressTo.cs index d690754d..f2a50ef9 100644 --- a/ShipEngineSDK/Model/PartialShippingAddressTo.cs +++ b/ShipEngineSDK/Model/PartialShippingAddressTo.cs @@ -48,7 +48,7 @@ public partial class PartialShippingAddressTo /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class PartialShippingAddressTo {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Geolocation: ").Append(Geolocation).Append("\n"); diff --git a/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs b/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs index e8fd0e7e..9acec524 100644 --- a/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs +++ b/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs @@ -109,7 +109,7 @@ public override bool CanConvert(Type typeToConvert) => /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class PartialShippingAddressToGeolocationInner {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Type: ").Append(Type).Append("\n"); diff --git a/ShipEngineSDK/Model/PaymentAmount.cs b/ShipEngineSDK/Model/PaymentAmount.cs index 47e44438..1e91e777 100644 --- a/ShipEngineSDK/Model/PaymentAmount.cs +++ b/ShipEngineSDK/Model/PaymentAmount.cs @@ -48,7 +48,7 @@ public partial class PaymentAmount /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class PaymentAmount {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Amount: ").Append(Amount).Append("\n"); diff --git a/ShipEngineSDK/Model/Pickup.cs b/ShipEngineSDK/Model/Pickup.cs index e17b8fd0..0fb48069 100644 --- a/ShipEngineSDK/Model/Pickup.cs +++ b/ShipEngineSDK/Model/Pickup.cs @@ -23,7 +23,7 @@ namespace ShipEngineSDK.Model; /// -/// The information necessary to schedule a package pickup +/// The information necessary to schedule a package pickup /// public partial class Pickup { @@ -111,10 +111,10 @@ public partial class Pickup public PickupWindow? PickupWindow { get; set; } /// - /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. + /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. - [JsonPropertyName("pickup_windows"), JsonInclude, JsonRequired] + [JsonPropertyName("pickup_windows"), JsonInclude] public List? PickupWindows { get; private set; } /// @@ -134,7 +134,7 @@ public partial class Pickup /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class Pickup {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CancelledAt: ").Append(CancelledAt).Append("\n"); diff --git a/ShipEngineSDK/Model/PickupResponseBody.cs b/ShipEngineSDK/Model/PickupResponseBody.cs index 3267f9d0..caa43a0f 100644 --- a/ShipEngineSDK/Model/PickupResponseBody.cs +++ b/ShipEngineSDK/Model/PickupResponseBody.cs @@ -41,7 +41,7 @@ public partial class PickupResponseBody /// /// Gets or Sets ContactDetails /// - [JsonPropertyName("contact_details"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("contact_details"), JsonPropertyOrder(2)] public required ContactDetails ContactDetails { get; set; } /// @@ -58,7 +58,7 @@ public partial class PickupResponseBody /// Label IDs that will be included in the pickup request /// /// Label IDs that will be included in the pickup request - [JsonPropertyName("label_ids"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("label_ids"), JsonPropertyOrder(4)] public required List LabelIds { get; set; } /// @@ -80,7 +80,7 @@ public partial class PickupResponseBody /// /// Gets or Sets PickupWindow /// - [JsonPropertyName("pickup_window"), JsonRequired, JsonPropertyOrder(7)] + [JsonPropertyName("pickup_window"), JsonPropertyOrder(7)] public required PickupWindow PickupWindow { get; set; } /// @@ -134,7 +134,7 @@ public partial class PickupResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class PickupResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); diff --git a/ShipEngineSDK/Model/PickupWindow.cs b/ShipEngineSDK/Model/PickupWindow.cs index edec12a5..d21c8152 100644 --- a/ShipEngineSDK/Model/PickupWindow.cs +++ b/ShipEngineSDK/Model/PickupWindow.cs @@ -35,7 +35,7 @@ public partial class PickupWindow /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("end_at"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("end_at"), JsonPropertyOrder(1)] public required DateTimeOffset EndAt { get; set; } /// @@ -45,7 +45,7 @@ public partial class PickupWindow /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("start_at"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("start_at"), JsonPropertyOrder(2)] public required DateTimeOffset StartAt { get; set; } @@ -55,7 +55,7 @@ public partial class PickupWindow /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class PickupWindow {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" EndAt: ").Append(EndAt).Append("\n"); diff --git a/ShipEngineSDK/Model/PickupWindows.cs b/ShipEngineSDK/Model/PickupWindows.cs index 60a13b18..d9236d22 100644 --- a/ShipEngineSDK/Model/PickupWindows.cs +++ b/ShipEngineSDK/Model/PickupWindows.cs @@ -55,7 +55,7 @@ public partial class PickupWindows /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class PickupWindows {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" EndAt: ").Append(EndAt).Append("\n"); diff --git a/ShipEngineSDK/Model/ProcessBatchRequestBody.cs b/ShipEngineSDK/Model/ProcessBatchRequestBody.cs index 02f67db3..9a9f64ef 100644 --- a/ShipEngineSDK/Model/ProcessBatchRequestBody.cs +++ b/ShipEngineSDK/Model/ProcessBatchRequestBody.cs @@ -64,7 +64,7 @@ public partial class ProcessBatchRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ProcessBatchRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); diff --git a/ShipEngineSDK/Model/Products.cs b/ShipEngineSDK/Model/Products.cs index b4c60bff..aefbc037 100644 --- a/ShipEngineSDK/Model/Products.cs +++ b/ShipEngineSDK/Model/Products.cs @@ -134,7 +134,7 @@ public partial class Products /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class Products {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CountryOfOrigin: ").Append(CountryOfOrigin).Append("\n"); diff --git a/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs b/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs index 65c0749c..7d6929e6 100644 --- a/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs +++ b/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs @@ -66,7 +66,7 @@ public partial class PurchaseLabelWithoutShipment /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class PurchaseLabelWithoutShipment {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); diff --git a/ShipEngineSDK/Model/Rate.cs b/ShipEngineSDK/Model/Rate.cs index 05013a8d..564c113b 100644 --- a/ShipEngineSDK/Model/Rate.cs +++ b/ShipEngineSDK/Model/Rate.cs @@ -28,18 +28,6 @@ namespace ShipEngineSDK.Model; public partial class Rate { - /// - /// Gets or Sets RateType - /// - [JsonPropertyName("rate_type"), JsonInclude] - public RateType? RateType { get; private set; } - - /// - /// Gets or Sets ValidationStatus - /// - [JsonPropertyName("validation_status"), JsonInclude] - public ValidationStatus? ValidationStatus { get; private set; } - /// /// carrier code /// @@ -123,6 +111,12 @@ public partial class Rate [JsonPropertyName("rate_id"), JsonInclude] public string? RateId { get; private set; } + /// + /// Gets or Sets RateType + /// + [JsonPropertyName("rate_type"), JsonInclude] + public RateType? RateType { get; private set; } + /// /// service code for the rate /// @@ -151,6 +145,12 @@ public partial class Rate [JsonPropertyName("trackable"), JsonInclude] public bool? Trackable { get; private set; } + /// + /// Gets or Sets ValidationStatus + /// + [JsonPropertyName("validation_status"), JsonInclude] + public ValidationStatus? ValidationStatus { get; private set; } + /// /// The warning messages /// @@ -233,7 +233,7 @@ public partial class Rate /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class Rate {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); diff --git a/ShipEngineSDK/Model/RateEstimate.cs b/ShipEngineSDK/Model/RateEstimate.cs index 41a8ae04..5c040357 100644 --- a/ShipEngineSDK/Model/RateEstimate.cs +++ b/ShipEngineSDK/Model/RateEstimate.cs @@ -28,18 +28,6 @@ namespace ShipEngineSDK.Model; public partial class RateEstimate { - /// - /// Gets or Sets RateType - /// - [JsonPropertyName("rate_type"), JsonInclude] - public RateType? RateType { get; private set; } - - /// - /// Gets or Sets ValidationStatus - /// - [JsonPropertyName("validation_status"), JsonInclude] - public ValidationStatus? ValidationStatus { get; private set; } - /// /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. /// @@ -113,6 +101,12 @@ public partial class RateEstimate [JsonPropertyName("other_amount"), JsonInclude] public MonetaryValue? OtherAmount { get; private set; } + /// + /// Gets or Sets RateType + /// + [JsonPropertyName("rate_type"), JsonInclude] + public RateType? RateType { get; private set; } + /// /// service code for the rate /// @@ -141,6 +135,12 @@ public partial class RateEstimate [JsonPropertyName("trackable"), JsonInclude] public bool? Trackable { get; private set; } + /// + /// Gets or Sets ValidationStatus + /// + [JsonPropertyName("validation_status"), JsonInclude] + public ValidationStatus? ValidationStatus { get; private set; } + /// /// The warning messages /// @@ -216,7 +216,7 @@ public partial class RateEstimate /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class RateEstimate {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); diff --git a/ShipEngineSDK/Model/RateEstimateByCarrierId.cs b/ShipEngineSDK/Model/RateEstimateByCarrierId.cs index 82119fd4..3500cb8c 100644 --- a/ShipEngineSDK/Model/RateEstimateByCarrierId.cs +++ b/ShipEngineSDK/Model/RateEstimateByCarrierId.cs @@ -45,7 +45,7 @@ public partial class RateEstimateByCarrierId /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class RateEstimateByCarrierId {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); diff --git a/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs b/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs index a2bc688c..f079257e 100644 --- a/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs +++ b/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs @@ -42,7 +42,7 @@ public partial class RateEstimateByCarrierIds /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class RateEstimateByCarrierIds {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierIds: ").Append(CarrierIds).Append("\n"); diff --git a/ShipEngineSDK/Model/RateEstimateOptions.cs b/ShipEngineSDK/Model/RateEstimateOptions.cs index 2c82a721..e46d61db 100644 --- a/ShipEngineSDK/Model/RateEstimateOptions.cs +++ b/ShipEngineSDK/Model/RateEstimateOptions.cs @@ -151,7 +151,7 @@ public partial class RateEstimateOptions /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class RateEstimateOptions {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); diff --git a/ShipEngineSDK/Model/RateRequestBody.cs b/ShipEngineSDK/Model/RateRequestBody.cs index 3cac59dc..31d566a0 100644 --- a/ShipEngineSDK/Model/RateRequestBody.cs +++ b/ShipEngineSDK/Model/RateRequestBody.cs @@ -32,7 +32,7 @@ public partial class RateRequestBody /// Array of carrier ids to get rates for /// /// Array of carrier ids to get rates for - [JsonPropertyName("carrier_ids"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("carrier_ids"), JsonPropertyOrder(1)] public required List CarrierIds { get; set; } /// @@ -75,7 +75,7 @@ public partial class RateRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class RateRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierIds: ").Append(CarrierIds).Append("\n"); diff --git a/ShipEngineSDK/Model/RateRequestByShipmentIds.cs b/ShipEngineSDK/Model/RateRequestByShipmentIds.cs index 079bc712..9585ecc8 100644 --- a/ShipEngineSDK/Model/RateRequestByShipmentIds.cs +++ b/ShipEngineSDK/Model/RateRequestByShipmentIds.cs @@ -32,7 +32,7 @@ public partial class RateRequestByShipmentIds /// The array of shipment IDs /// /// The array of shipment IDs - [JsonPropertyName("shipment_ids"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("shipment_ids"), JsonPropertyOrder(1)] public required List ShipmentIds { get; set; } @@ -42,7 +42,7 @@ public partial class RateRequestByShipmentIds /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class RateRequestByShipmentIds {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentIds: ").Append(ShipmentIds).Append("\n"); diff --git a/ShipEngineSDK/Model/RateRequestByShipments.cs b/ShipEngineSDK/Model/RateRequestByShipments.cs index a2cc64f5..3e2836a1 100644 --- a/ShipEngineSDK/Model/RateRequestByShipments.cs +++ b/ShipEngineSDK/Model/RateRequestByShipments.cs @@ -32,7 +32,7 @@ public partial class RateRequestByShipments /// The array of shipments to get bulk rate estimates for /// /// The array of shipments to get bulk rate estimates for - [JsonPropertyName("shipments"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("shipments"), JsonPropertyOrder(1)] public required List Shipments { get; set; } @@ -42,7 +42,7 @@ public partial class RateRequestByShipments /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class RateRequestByShipments {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Shipments: ").Append(Shipments).Append("\n"); diff --git a/ShipEngineSDK/Model/RateRequestOptions.cs b/ShipEngineSDK/Model/RateRequestOptions.cs index 1712577a..e891ea5e 100644 --- a/ShipEngineSDK/Model/RateRequestOptions.cs +++ b/ShipEngineSDK/Model/RateRequestOptions.cs @@ -42,7 +42,7 @@ public partial class RateRequestOptions /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class RateRequestOptions {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" RateOptions: ").Append(RateOptions).Append("\n"); diff --git a/ShipEngineSDK/Model/RateRequestRateOptions.cs b/ShipEngineSDK/Model/RateRequestRateOptions.cs index d61b1853..cb67a60c 100644 --- a/ShipEngineSDK/Model/RateRequestRateOptions.cs +++ b/ShipEngineSDK/Model/RateRequestRateOptions.cs @@ -42,7 +42,7 @@ public partial class RateRequestRateOptions /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class RateRequestRateOptions {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" RateOptions: ").Append(RateOptions).Append("\n"); diff --git a/ShipEngineSDK/Model/RateResponse.cs b/ShipEngineSDK/Model/RateResponse.cs index 7054595f..d15e9eb4 100644 --- a/ShipEngineSDK/Model/RateResponse.cs +++ b/ShipEngineSDK/Model/RateResponse.cs @@ -42,7 +42,7 @@ public partial class RateResponse /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class RateResponse {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" VarRateResponse: ").Append(VarRateResponse).Append("\n"); diff --git a/ShipEngineSDK/Model/RateResponseStatus.cs b/ShipEngineSDK/Model/RateResponseStatus.cs index d1a17fac..1cc871bf 100644 --- a/ShipEngineSDK/Model/RateResponseStatus.cs +++ b/ShipEngineSDK/Model/RateResponseStatus.cs @@ -86,6 +86,11 @@ public RateResponseStatus(string value) /// public override bool Equals(object? obj) => obj is RateResponseStatus other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class RateResponseStatusJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/RateType.cs b/ShipEngineSDK/Model/RateType.cs index 743cb036..aa07205f 100644 --- a/ShipEngineSDK/Model/RateType.cs +++ b/ShipEngineSDK/Model/RateType.cs @@ -74,6 +74,11 @@ public RateType(string value) /// public override bool Equals(object? obj) => obj is RateType other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class RateTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/RatesInformation.cs b/ShipEngineSDK/Model/RatesInformation.cs index 484f2bf4..7f8f655a 100644 --- a/ShipEngineSDK/Model/RatesInformation.cs +++ b/ShipEngineSDK/Model/RatesInformation.cs @@ -28,12 +28,6 @@ namespace ShipEngineSDK.Model; public partial class RatesInformation { - /// - /// Gets or Sets Status - /// - [JsonPropertyName("status"), JsonInclude] - public RateResponseStatus? Status { get; private set; } - /// /// When the rate was created /// @@ -84,6 +78,12 @@ public partial class RatesInformation [JsonPropertyName("shipment_id"), JsonInclude] public string? ShipmentId { get; private set; } + /// + /// Gets or Sets Status + /// + [JsonPropertyName("status"), JsonInclude] + public RateResponseStatus? Status { get; private set; } + /// /// Returns the string presentation of the object @@ -91,7 +91,7 @@ public partial class RatesInformation /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class RatesInformation {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); diff --git a/ShipEngineSDK/Model/ReasonCode.cs b/ShipEngineSDK/Model/ReasonCode.cs index 7de06e38..20cdc72f 100644 --- a/ShipEngineSDK/Model/ReasonCode.cs +++ b/ShipEngineSDK/Model/ReasonCode.cs @@ -104,6 +104,11 @@ public ReasonCode(string value) /// public override bool Equals(object? obj) => obj is ReasonCode other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class ReasonCodeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/RecognizedEntity.cs b/ShipEngineSDK/Model/RecognizedEntity.cs index 8f341749..406bfd3e 100644 --- a/ShipEngineSDK/Model/RecognizedEntity.cs +++ b/ShipEngineSDK/Model/RecognizedEntity.cs @@ -32,35 +32,35 @@ public partial class RecognizedEntity /// The index of the last character of this entity within the original text /// /// The index of the last character of this entity within the original text - [JsonPropertyName("end_index"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("end_index"), JsonPropertyOrder(1)] public required int EndIndex { get; set; } /// /// A confidence score between zero and one that indicates how certain the API is that it correctly recognized this entity /// /// A confidence score between zero and one that indicates how certain the API is that it correctly recognized this entity - [JsonPropertyName("score"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("score"), JsonPropertyOrder(2)] public required double Score { get; set; } /// /// The index of the first character of this entity within the original text /// /// The index of the first character of this entity within the original text - [JsonPropertyName("start_index"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("start_index"), JsonPropertyOrder(3)] public required int StartIndex { get; set; } /// /// The substring from the original text that was recognized as this entity /// /// The substring from the original text that was recognized as this entity - [JsonPropertyName("text"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("text"), JsonPropertyOrder(4)] public required string Text { get; set; } /// /// The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.) /// /// The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.) - [JsonPropertyName("type"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("type"), JsonPropertyOrder(5)] public required string Type { get; set; } /// @@ -77,7 +77,7 @@ public partial class RecognizedEntity /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class RecognizedEntity {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" EndIndex: ").Append(EndIndex).Append("\n"); diff --git a/ShipEngineSDK/Model/Redirect.cs b/ShipEngineSDK/Model/Redirect.cs index 00560d87..9f8d8dbf 100644 --- a/ShipEngineSDK/Model/Redirect.cs +++ b/ShipEngineSDK/Model/Redirect.cs @@ -68,6 +68,11 @@ public Redirect(string value) /// public override bool Equals(object? obj) => obj is Redirect other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class RedirectJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/RegulationLevel.cs b/ShipEngineSDK/Model/RegulationLevel.cs index 0c97c939..5a63c391 100644 --- a/ShipEngineSDK/Model/RegulationLevel.cs +++ b/ShipEngineSDK/Model/RegulationLevel.cs @@ -85,6 +85,11 @@ public RegulationLevel(string value) /// public override bool Equals(object? obj) => obj is RegulationLevel other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class RegulationLevelJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs b/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs index c4021f87..85f48838 100644 --- a/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs +++ b/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs @@ -49,7 +49,7 @@ public partial class RemoveFromBatchRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class RemoveFromBatchRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" RateIds: ").Append(RateIds).Append("\n"); diff --git a/ShipEngineSDK/Model/ResponseMessage.cs b/ShipEngineSDK/Model/ResponseMessage.cs index 319511cd..0d7956ae 100644 --- a/ShipEngineSDK/Model/ResponseMessage.cs +++ b/ShipEngineSDK/Model/ResponseMessage.cs @@ -34,6 +34,16 @@ public partial class ResponseMessage [JsonPropertyName("code"), JsonInclude] public AddressValidationCode? Code { get; private set; } + /// + /// Message explaining the address validation error + /// + /// Message explaining the address validation error + /// + /// Invalid Postal Code + /// + [JsonPropertyName("message"), JsonInclude] + public string? Message { get; private set; } + /// /// Gets or Sets Type /// @@ -43,19 +53,9 @@ public partial class ResponseMessage /// /// Gets or Sets DetailCode /// - [JsonPropertyName("detail_code"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("detail_code"), JsonPropertyOrder(4)] public required AddressValidationDetailCode DetailCode { get; set; } - /// - /// Message explaining the address validation error - /// - /// Message explaining the address validation error - /// - /// Invalid Postal Code - /// - [JsonPropertyName("message"), JsonInclude] - public string? Message { get; private set; } - /// /// Returns the string presentation of the object @@ -63,7 +63,7 @@ public partial class ResponseMessage /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ResponseMessage {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Code: ").Append(Code).Append("\n"); diff --git a/ShipEngineSDK/Model/SchedulePickupRequestBody.cs b/ShipEngineSDK/Model/SchedulePickupRequestBody.cs index a99c2654..fc2e1d49 100644 --- a/ShipEngineSDK/Model/SchedulePickupRequestBody.cs +++ b/ShipEngineSDK/Model/SchedulePickupRequestBody.cs @@ -31,20 +31,20 @@ public partial class SchedulePickupRequestBody /// /// Gets or Sets ContactDetails /// - [JsonPropertyName("contact_details"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("contact_details"), JsonPropertyOrder(1)] public required ContactDetails ContactDetails { get; set; } /// /// Label IDs that will be included in the pickup request /// /// Label IDs that will be included in the pickup request - [JsonPropertyName("label_ids"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("label_ids"), JsonPropertyOrder(2)] public required List LabelIds { get; set; } /// /// Gets or Sets PickupWindow /// - [JsonPropertyName("pickup_window"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("pickup_window"), JsonPropertyOrder(3)] public required PickupWindow PickupWindow { get; set; } /// @@ -134,7 +134,7 @@ public partial class SchedulePickupRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class SchedulePickupRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ContactDetails: ").Append(ContactDetails).Append("\n"); diff --git a/ShipEngineSDK/Model/SchedulePickupResponseBody.cs b/ShipEngineSDK/Model/SchedulePickupResponseBody.cs index c54735bb..291c66c3 100644 --- a/ShipEngineSDK/Model/SchedulePickupResponseBody.cs +++ b/ShipEngineSDK/Model/SchedulePickupResponseBody.cs @@ -42,7 +42,7 @@ public partial class SchedulePickupResponseBody /// /// aa3d8e8e-462b-4476-9618-72db7f7b7009 /// - [JsonPropertyName("request_id"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("request_id"), JsonPropertyOrder(2)] public required Guid RequestId { get; set; } /// @@ -151,7 +151,7 @@ public partial class SchedulePickupResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class SchedulePickupResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Errors: ").Append(Errors).Append("\n"); diff --git a/ShipEngineSDK/Model/Service.cs b/ShipEngineSDK/Model/Service.cs index 5c858cc4..02a1ea89 100644 --- a/ShipEngineSDK/Model/Service.cs +++ b/ShipEngineSDK/Model/Service.cs @@ -96,7 +96,7 @@ public partial class Service /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class Service {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); diff --git a/ShipEngineSDK/Model/Shipment.cs b/ShipEngineSDK/Model/Shipment.cs index f289015e..4a731fcd 100644 --- a/ShipEngineSDK/Model/Shipment.cs +++ b/ShipEngineSDK/Model/Shipment.cs @@ -28,38 +28,11 @@ namespace ShipEngineSDK.Model; public partial class Shipment { - /// - /// The type of delivery confirmation that is required for this shipment. - /// - /// The type of delivery confirmation that is required for this shipment. - [JsonPropertyName("confirmation"), JsonRequired, JsonPropertyOrder(3)] - public required DeliveryConfirmation Confirmation { get; set; } - - /// - /// The insurance provider to use for any insured packages in the shipment. - /// - /// The insurance provider to use for any insured packages in the shipment. - [JsonPropertyName("insurance_provider"), JsonRequired, JsonPropertyOrder(5)] - public required InsuranceProvider InsuranceProvider { get; set; } - - /// - /// The current status of the shipment - /// - /// The current status of the shipment - [JsonPropertyName("shipment_status"), JsonInclude] - public ShipmentStatus? ShipmentStatus { get; private set; } - - /// - /// Gets or Sets OrderSourceCode - /// - [JsonPropertyName("order_source_code"), JsonPropertyOrder(23)] - public OrderSourceName? OrderSourceCode { get; set; } - /// /// Advanced shipment options. These are entirely optional. /// /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("advanced_options"), JsonPropertyOrder(1)] public required AdvancedShipmentOptions AdvancedOptions { get; set; } /// @@ -69,9 +42,16 @@ public partial class Shipment /// /// se-28529731 /// - [JsonPropertyName("carrier_id"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("carrier_id"), JsonPropertyOrder(2)] public required string CarrierId { 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"), JsonPropertyOrder(3)] + public required DeliveryConfirmation Confirmation { get; set; } + /// /// The date and time that the shipment was created in ShipEngine. /// @@ -82,6 +62,13 @@ public partial class Shipment [JsonPropertyName("created_at"), JsonInclude] public DateTimeOffset? CreatedAt { get; private set; } + /// + /// The insurance provider to use for any insured packages in the shipment. + /// + /// The insurance provider to use for any insured packages in the shipment. + [JsonPropertyName("insurance_provider"), JsonPropertyOrder(5)] + public required InsuranceProvider InsuranceProvider { get; set; } + /// /// The date and time that the shipment was created or last modified. /// @@ -96,14 +83,14 @@ public partial class Shipment /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages"), JsonRequired, JsonPropertyOrder(7)] + [JsonPropertyName("packages"), JsonPropertyOrder(7)] public required List Packages { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. /// /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to"), JsonRequired, JsonPropertyOrder(8)] + [JsonPropertyName("return_to"), JsonPropertyOrder(8)] public required ShippingAddress ReturnTo { get; set; } /// @@ -113,7 +100,7 @@ public partial class Shipment /// /// usps_first_class_mail /// - [JsonPropertyName("service_code"), JsonRequired, JsonPropertyOrder(9)] + [JsonPropertyName("service_code"), JsonPropertyOrder(9)] public required string ServiceCode { get; set; } /// @@ -123,21 +110,21 @@ public partial class Shipment /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date"), JsonRequired, JsonPropertyOrder(10)] + [JsonPropertyName("ship_date"), JsonPropertyOrder(10)] public required DateTimeOffset ShipDate { get; set; } /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from"), JsonRequired, JsonPropertyOrder(11)] + [JsonPropertyName("ship_from"), JsonPropertyOrder(11)] public required ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address /// /// The recipient's mailing address - [JsonPropertyName("ship_to"), JsonRequired, JsonPropertyOrder(12)] + [JsonPropertyName("ship_to"), JsonPropertyOrder(12)] public required ShippingAddressTo ShipTo { get; set; } /// @@ -150,6 +137,13 @@ public partial class Shipment [JsonPropertyName("shipment_id"), JsonInclude] public string? ShipmentId { get; private set; } + /// + /// The current status of the shipment + /// + /// The current status of the shipment + [JsonPropertyName("shipment_status"), JsonInclude] + public ShipmentStatus? ShipmentStatus { get; private set; } + /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// @@ -178,7 +172,7 @@ public partial class Shipment /// Customs information. This is usually only needed for international shipments. /// /// Customs information. This is usually only needed for international shipments. - [JsonPropertyName("customs"), JsonRequired, JsonPropertyOrder(18)] + [JsonPropertyName("customs"), JsonPropertyOrder(18)] public required InternationalShipmentOptions Customs { get; set; } /// @@ -209,6 +203,12 @@ public partial class Shipment [JsonPropertyName("items"), JsonPropertyOrder(22)] public List? Items { get; set; } + /// + /// Gets or Sets OrderSourceCode + /// + [JsonPropertyName("order_source_code"), JsonPropertyOrder(23)] + public OrderSourceName? OrderSourceCode { get; set; } + /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// @@ -239,7 +239,7 @@ public partial class Shipment /// /// se-28529731 /// - [JsonPropertyName("warehouse_id"), JsonRequired, JsonPropertyOrder(27)] + [JsonPropertyName("warehouse_id"), JsonPropertyOrder(27)] public required string WarehouseId { get; set; } @@ -249,7 +249,7 @@ public partial class Shipment /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class Shipment {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); diff --git a/ShipEngineSDK/Model/ShipmentIdRequest.cs b/ShipEngineSDK/Model/ShipmentIdRequest.cs index 7803faf0..eb7abb9c 100644 --- a/ShipEngineSDK/Model/ShipmentIdRequest.cs +++ b/ShipEngineSDK/Model/ShipmentIdRequest.cs @@ -45,7 +45,7 @@ public partial class ShipmentIdRequest /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ShipmentIdRequest {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); diff --git a/ShipEngineSDK/Model/ShipmentItem.cs b/ShipEngineSDK/Model/ShipmentItem.cs index 2f1f98a3..20b74a79 100644 --- a/ShipEngineSDK/Model/ShipmentItem.cs +++ b/ShipEngineSDK/Model/ShipmentItem.cs @@ -28,12 +28,6 @@ namespace ShipEngineSDK.Model; public partial class ShipmentItem { - /// - /// Gets or Sets OrderSourceCode - /// - [JsonPropertyName("order_source_code"), JsonPropertyOrder(5)] - public OrderSourceName? OrderSourceCode { get; set; } - /// /// Amazon Standard Identification Number /// @@ -65,6 +59,12 @@ public partial class ShipmentItem [JsonPropertyName("name"), JsonPropertyOrder(4)] public string? Name { get; set; } + /// + /// Gets or Sets OrderSourceCode + /// + [JsonPropertyName("order_source_code"), JsonPropertyOrder(5)] + public OrderSourceName? OrderSourceCode { get; set; } + /// /// The quantity of this item included in the shipment /// @@ -100,7 +100,7 @@ public partial class ShipmentItem /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ShipmentItem {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Asin: ").Append(Asin).Append("\n"); diff --git a/ShipEngineSDK/Model/ShipmentRequest.cs b/ShipEngineSDK/Model/ShipmentRequest.cs index 4b31a201..f79b50c5 100644 --- a/ShipEngineSDK/Model/ShipmentRequest.cs +++ b/ShipEngineSDK/Model/ShipmentRequest.cs @@ -42,7 +42,7 @@ public partial class ShipmentRequest /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ShipmentRequest {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Shipment: ").Append(Shipment).Append("\n"); diff --git a/ShipEngineSDK/Model/ShipmentStatus.cs b/ShipEngineSDK/Model/ShipmentStatus.cs index 954476e7..8a92886a 100644 --- a/ShipEngineSDK/Model/ShipmentStatus.cs +++ b/ShipEngineSDK/Model/ShipmentStatus.cs @@ -86,6 +86,11 @@ public ShipmentStatus(string value) /// public override bool Equals(object? obj) => obj is ShipmentStatus other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class ShipmentStatusJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/ShipmentsSortBy.cs b/ShipEngineSDK/Model/ShipmentsSortBy.cs index 5440d5d4..7acca9ca 100644 --- a/ShipEngineSDK/Model/ShipmentsSortBy.cs +++ b/ShipEngineSDK/Model/ShipmentsSortBy.cs @@ -74,6 +74,11 @@ public ShipmentsSortBy(string value) /// public override bool Equals(object? obj) => obj is ShipmentsSortBy other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class ShipmentsSortByJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/ShippingAddress.cs b/ShipEngineSDK/Model/ShippingAddress.cs index 657a277e..52cdd1bc 100644 --- a/ShipEngineSDK/Model/ShippingAddress.cs +++ b/ShipEngineSDK/Model/ShippingAddress.cs @@ -28,13 +28,6 @@ namespace ShipEngineSDK.Model; public partial class ShippingAddress { - /// - /// Indicates whether this is a residential address. - /// - /// Indicates whether this is a residential address. - [JsonPropertyName("address_residential_indicator"), JsonRequired, JsonPropertyOrder(2)] - public required AddressResidentialIndicator AddressResidentialIndicator { get; set; } - /// /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. /// @@ -42,9 +35,16 @@ public partial class ShippingAddress /// /// 1999 Bishop Grandin Blvd. /// - [JsonPropertyName("address_line1"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("address_line1"), JsonPropertyOrder(1)] public required string AddressLine1 { get; set; } + /// + /// Indicates whether this is a residential address. + /// + /// Indicates whether this is a residential address. + [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(2)] + public required AddressResidentialIndicator AddressResidentialIndicator { get; set; } + /// /// The name of the city or locality /// @@ -52,7 +52,7 @@ public partial class ShippingAddress /// /// Winnipeg /// - [JsonPropertyName("city_locality"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("city_locality"), JsonPropertyOrder(3)] public required string CityLocality { get; set; } /// @@ -62,7 +62,7 @@ public partial class ShippingAddress /// /// CA /// - [JsonPropertyName("country_code"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("country_code"), JsonPropertyOrder(4)] public required string CountryCode { get; set; } /// @@ -72,7 +72,7 @@ public partial class ShippingAddress /// /// John Doe /// - [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("name"), JsonPropertyOrder(5)] public required string Name { get; set; } /// @@ -82,7 +82,7 @@ public partial class ShippingAddress /// /// +1 204-253-9411 ext. 123 /// - [JsonPropertyName("phone"), JsonRequired, JsonPropertyOrder(6)] + [JsonPropertyName("phone"), JsonPropertyOrder(6)] public required string Phone { get; set; } /// @@ -92,7 +92,7 @@ public partial class ShippingAddress /// /// 78756-3717 /// - [JsonPropertyName("postal_code"), JsonRequired, JsonPropertyOrder(7)] + [JsonPropertyName("postal_code"), JsonPropertyOrder(7)] public required string PostalCode { get; set; } /// @@ -102,7 +102,7 @@ public partial class ShippingAddress /// /// Manitoba /// - [JsonPropertyName("state_province"), JsonRequired, JsonPropertyOrder(8)] + [JsonPropertyName("state_province"), JsonPropertyOrder(8)] public required string StateProvince { get; set; } /// @@ -159,7 +159,7 @@ public partial class ShippingAddress /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ShippingAddress {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); diff --git a/ShipEngineSDK/Model/ShippingAddressTo.cs b/ShipEngineSDK/Model/ShippingAddressTo.cs index 9836d8c7..d8e2a210 100644 --- a/ShipEngineSDK/Model/ShippingAddressTo.cs +++ b/ShipEngineSDK/Model/ShippingAddressTo.cs @@ -28,13 +28,6 @@ namespace ShipEngineSDK.Model; public partial class ShippingAddressTo { - /// - /// Indicates whether this is a residential address. - /// - /// Indicates whether this is a residential address. - [JsonPropertyName("address_residential_indicator"), JsonRequired, JsonPropertyOrder(2)] - public required AddressResidentialIndicator AddressResidentialIndicator { get; set; } - /// /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. /// @@ -42,9 +35,16 @@ public partial class ShippingAddressTo /// /// 1999 Bishop Grandin Blvd. /// - [JsonPropertyName("address_line1"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("address_line1"), JsonPropertyOrder(1)] public required string AddressLine1 { get; set; } + /// + /// Indicates whether this is a residential address. + /// + /// Indicates whether this is a residential address. + [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(2)] + public required AddressResidentialIndicator AddressResidentialIndicator { get; set; } + /// /// The name of the city or locality /// @@ -52,7 +52,7 @@ public partial class ShippingAddressTo /// /// Winnipeg /// - [JsonPropertyName("city_locality"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("city_locality"), JsonPropertyOrder(3)] public required string CityLocality { get; set; } /// @@ -62,7 +62,7 @@ public partial class ShippingAddressTo /// /// CA /// - [JsonPropertyName("country_code"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("country_code"), JsonPropertyOrder(4)] public required string CountryCode { get; set; } /// @@ -72,7 +72,7 @@ public partial class ShippingAddressTo /// /// John Doe /// - [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("name"), JsonPropertyOrder(5)] public required string Name { get; set; } /// @@ -82,7 +82,7 @@ public partial class ShippingAddressTo /// /// +1 204-253-9411 ext. 123 /// - [JsonPropertyName("phone"), JsonRequired, JsonPropertyOrder(6)] + [JsonPropertyName("phone"), JsonPropertyOrder(6)] public required string Phone { get; set; } /// @@ -92,7 +92,7 @@ public partial class ShippingAddressTo /// /// 78756-3717 /// - [JsonPropertyName("postal_code"), JsonRequired, JsonPropertyOrder(7)] + [JsonPropertyName("postal_code"), JsonPropertyOrder(7)] public required string PostalCode { get; set; } /// @@ -102,7 +102,7 @@ public partial class ShippingAddressTo /// /// Manitoba /// - [JsonPropertyName("state_province"), JsonRequired, JsonPropertyOrder(8)] + [JsonPropertyName("state_province"), JsonPropertyOrder(8)] public required string StateProvince { get; set; } /// @@ -165,7 +165,7 @@ public partial class ShippingAddressTo /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ShippingAddressTo {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); diff --git a/ShipEngineSDK/Model/SmartPostHub.cs b/ShipEngineSDK/Model/SmartPostHub.cs index 8f68aa31..fec83ff7 100644 --- a/ShipEngineSDK/Model/SmartPostHub.cs +++ b/ShipEngineSDK/Model/SmartPostHub.cs @@ -266,6 +266,11 @@ public SmartPostHub(string value) /// public override bool Equals(object? obj) => obj is SmartPostHub other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class SmartPostHubJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/SortDir.cs b/ShipEngineSDK/Model/SortDir.cs index db392f43..7736282e 100644 --- a/ShipEngineSDK/Model/SortDir.cs +++ b/ShipEngineSDK/Model/SortDir.cs @@ -74,6 +74,11 @@ public SortDir(string value) /// public override bool Equals(object? obj) => obj is SortDir other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class SortDirJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/StatusCode.cs b/ShipEngineSDK/Model/StatusCode.cs index 202d10d5..3643c7dd 100644 --- a/ShipEngineSDK/Model/StatusCode.cs +++ b/ShipEngineSDK/Model/StatusCode.cs @@ -104,6 +104,11 @@ public StatusCode(string value) /// public override bool Equals(object? obj) => obj is StatusCode other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class StatusCodeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/Tag.cs b/ShipEngineSDK/Model/Tag.cs index 303e7b64..c53bf96e 100644 --- a/ShipEngineSDK/Model/Tag.cs +++ b/ShipEngineSDK/Model/Tag.cs @@ -35,7 +35,7 @@ public partial class Tag /// /// Fragile /// - [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("name"), JsonPropertyOrder(1)] public required string Name { get; set; } @@ -45,7 +45,7 @@ public partial class Tag /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class Tag {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); diff --git a/ShipEngineSDK/Model/TagShipmentResponseBody.cs b/ShipEngineSDK/Model/TagShipmentResponseBody.cs index 09421417..95ac8cf6 100644 --- a/ShipEngineSDK/Model/TagShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/TagShipmentResponseBody.cs @@ -31,7 +31,7 @@ public partial class TagShipmentResponseBody /// /// Gets or Sets Tags /// - [JsonPropertyName("tags"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("tags"), JsonPropertyOrder(1)] public required List Tags { get; set; } @@ -41,7 +41,7 @@ public partial class TagShipmentResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class TagShipmentResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Tags: ").Append(Tags).Append("\n"); diff --git a/ShipEngineSDK/Model/TaxIdentifier.cs b/ShipEngineSDK/Model/TaxIdentifier.cs index 23d78e21..cafe6228 100644 --- a/ShipEngineSDK/Model/TaxIdentifier.cs +++ b/ShipEngineSDK/Model/TaxIdentifier.cs @@ -31,27 +31,27 @@ public partial class TaxIdentifier /// /// Gets or Sets IdentifierType /// - [JsonPropertyName("identifier_type"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("identifier_type"), JsonPropertyOrder(1)] public required IdentifierType IdentifierType { get; set; } - /// - /// Gets or Sets TaxableEntityType - /// - [JsonPropertyName("taxable_entity_type"), JsonRequired, JsonPropertyOrder(3)] - public required TaxableEntityType TaxableEntityType { get; set; } - /// /// The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code. /// /// The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code. - [JsonPropertyName("issuing_authority"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("issuing_authority"), JsonPropertyOrder(2)] public required string IssuingAuthority { get; set; } + /// + /// Gets or Sets TaxableEntityType + /// + [JsonPropertyName("taxable_entity_type"), JsonPropertyOrder(3)] + public required TaxableEntityType TaxableEntityType { get; set; } + /// /// The value of the identifier /// /// The value of the identifier - [JsonPropertyName("value"), JsonRequired, JsonPropertyOrder(4)] + [JsonPropertyName("value"), JsonPropertyOrder(4)] public required string Value { get; set; } @@ -61,7 +61,7 @@ public partial class TaxIdentifier /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class TaxIdentifier {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" IdentifierType: ").Append(IdentifierType).Append("\n"); diff --git a/ShipEngineSDK/Model/TaxableEntityType.cs b/ShipEngineSDK/Model/TaxableEntityType.cs index 74dd8559..abe9b3c9 100644 --- a/ShipEngineSDK/Model/TaxableEntityType.cs +++ b/ShipEngineSDK/Model/TaxableEntityType.cs @@ -80,6 +80,11 @@ public TaxableEntityType(string value) /// public override bool Equals(object? obj) => obj is TaxableEntityType other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class TaxableEntityTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs b/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs index f8a42f28..721bc0bb 100644 --- a/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs +++ b/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs @@ -49,7 +49,7 @@ public partial class TokensGetEphemeralTokenResponseBodyYaml /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class TokensGetEphemeralTokenResponseBodyYaml {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" RedirectUrl: ").Append(RedirectUrl).Append("\n"); diff --git a/ShipEngineSDK/Model/TrackEvent.cs b/ShipEngineSDK/Model/TrackEvent.cs index 325e1cc7..62191243 100644 --- a/ShipEngineSDK/Model/TrackEvent.cs +++ b/ShipEngineSDK/Model/TrackEvent.cs @@ -28,12 +28,6 @@ namespace ShipEngineSDK.Model; public partial class TrackEvent { - /// - /// Gets or Sets StatusCode - /// - [JsonPropertyName("status_code"), JsonRequired, JsonPropertyOrder(8)] - public required StatusCode StatusCode { get; set; } - /// /// Carrier detail code /// @@ -81,7 +75,7 @@ public partial class TrackEvent /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("occurred_at"), JsonRequired, JsonPropertyOrder(5)] + [JsonPropertyName("occurred_at"), JsonPropertyOrder(5)] public required DateTimeOffset OccurredAt { get; set; } /// @@ -104,6 +98,12 @@ public partial class TrackEvent [JsonPropertyName("state_province"), JsonInclude] public string? StateProvince { get; private set; } + /// + /// Gets or Sets StatusCode + /// + [JsonPropertyName("status_code"), JsonPropertyOrder(8)] + public required StatusCode StatusCode { get; set; } + /// /// Event Status Description /// @@ -189,7 +189,7 @@ public partial class TrackEvent /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class TrackEvent {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierDetailCode: ").Append(CarrierDetailCode).Append("\n"); diff --git a/ShipEngineSDK/Model/TrackingInformation.cs b/ShipEngineSDK/Model/TrackingInformation.cs index 212c3610..4fcbb1c0 100644 --- a/ShipEngineSDK/Model/TrackingInformation.cs +++ b/ShipEngineSDK/Model/TrackingInformation.cs @@ -28,12 +28,6 @@ namespace ShipEngineSDK.Model; public partial class TrackingInformation { - /// - /// Gets or Sets StatusCode - /// - [JsonPropertyName("status_code"), JsonPropertyOrder(11)] - public StatusCode? StatusCode { get; set; } - /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. /// @@ -128,6 +122,12 @@ public partial class TrackingInformation [JsonPropertyName("ship_date"), JsonPropertyOrder(10)] public DateTimeOffset? ShipDate { get; set; } + /// + /// Gets or Sets StatusCode + /// + [JsonPropertyName("status_code"), JsonPropertyOrder(11)] + public StatusCode? StatusCode { get; set; } + /// /// Status description /// @@ -165,7 +165,7 @@ public partial class TrackingInformation /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class TrackingInformation {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ActualDeliveryDate: ").Append(ActualDeliveryDate).Append("\n"); diff --git a/ShipEngineSDK/Model/TrackingStatus.cs b/ShipEngineSDK/Model/TrackingStatus.cs index c94ae426..735f7a64 100644 --- a/ShipEngineSDK/Model/TrackingStatus.cs +++ b/ShipEngineSDK/Model/TrackingStatus.cs @@ -86,6 +86,11 @@ public TrackingStatus(string value) /// public override bool Equals(object? obj) => obj is TrackingStatus other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class TrackingStatusJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/TransportMean.cs b/ShipEngineSDK/Model/TransportMean.cs index 16ef8045..b5a6ad74 100644 --- a/ShipEngineSDK/Model/TransportMean.cs +++ b/ShipEngineSDK/Model/TransportMean.cs @@ -85,6 +85,11 @@ public TransportMean(string value) /// public override bool Equals(object? obj) => obj is TransportMean other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class TransportMeanJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs index 1af066cb..652d9d69 100644 --- a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs @@ -88,13 +88,6 @@ public override bool CanConvert(Type typeToConvert) => } - /// - /// The image type - /// - /// The image type - [JsonPropertyName("image_content_type"), JsonPropertyOrder(3)] - public ImageContentTypeEnum? ImageContentType { get; set; } - /// /// Indicates whether this image is set as default. /// @@ -102,7 +95,7 @@ public override bool CanConvert(Type typeToConvert) => /// /// false /// - [JsonPropertyName("is_default"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("is_default"), JsonPropertyOrder(1)] public required bool IsDefault { get; set; } /// @@ -115,6 +108,13 @@ public override bool CanConvert(Type typeToConvert) => [JsonPropertyName("created_at"), JsonInclude] public DateTimeOffset? CreatedAt { get; private set; } + /// + /// The image type + /// + /// The image type + [JsonPropertyName("image_content_type"), JsonPropertyOrder(3)] + public ImageContentTypeEnum? ImageContentType { get; set; } + /// /// A base64 encoded string representation of the image. /// @@ -162,7 +162,7 @@ public override bool CanConvert(Type typeToConvert) => /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class UpdateAccountSettingsImageRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); diff --git a/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs b/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs index 4c1a4de7..dcf8e0ca 100644 --- a/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs @@ -42,7 +42,7 @@ public partial class UpdateAmazonBuyShippingRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class UpdateAmazonBuyShippingRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Email: ").Append(Email).Append("\n"); diff --git a/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs index 2728d564..d652d40f 100644 --- a/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs @@ -56,7 +56,7 @@ public partial class UpdateDhlExpressSettingsRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class UpdateDhlExpressSettingsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); diff --git a/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs index e69ae007..cc8807ec 100644 --- a/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs @@ -28,24 +28,6 @@ namespace ShipEngineSDK.Model; public partial class UpdateFedexSettingsRequestBody { - /// - /// Gets or Sets PickupType - /// - [JsonPropertyName("pickup_type"), JsonPropertyOrder(4)] - public FedexPickupType? PickupType { get; set; } - - /// - /// Gets or Sets SmartPostEndorsement - /// - [JsonPropertyName("smart_post_endorsement"), JsonPropertyOrder(6)] - public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } - - /// - /// Gets or Sets SmartPostHub - /// - [JsonPropertyName("smart_post_hub"), JsonPropertyOrder(7)] - public SmartPostHub? SmartPostHub { get; set; } - /// /// Gets or Sets IsPrimaryAccount /// @@ -65,12 +47,30 @@ public partial class UpdateFedexSettingsRequestBody [JsonPropertyName("nickname"), JsonPropertyOrder(3)] public string? Nickname { get; set; } + /// + /// Gets or Sets PickupType + /// + [JsonPropertyName("pickup_type"), JsonPropertyOrder(4)] + public FedexPickupType? PickupType { get; set; } + /// /// Gets or Sets SignatureImage /// [JsonPropertyName("signature_image"), JsonPropertyOrder(5)] public string? SignatureImage { get; set; } + /// + /// Gets or Sets SmartPostEndorsement + /// + [JsonPropertyName("smart_post_endorsement"), JsonPropertyOrder(6)] + public AncillaryServiceEndorsement? SmartPostEndorsement { get; set; } + + /// + /// Gets or Sets SmartPostHub + /// + [JsonPropertyName("smart_post_hub"), JsonPropertyOrder(7)] + public SmartPostHub? SmartPostHub { get; set; } + /// /// Returns the string presentation of the object @@ -78,7 +78,7 @@ public partial class UpdateFedexSettingsRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class UpdateFedexSettingsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" IsPrimaryAccount: ").Append(IsPrimaryAccount).Append("\n"); diff --git a/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs index b54213b5..3e3eb4ed 100644 --- a/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs @@ -47,7 +47,7 @@ public partial class UpdateNewgisticsSettingsRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class UpdateNewgisticsSettingsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" IncludeBarcodeWithOrderNumber: ").Append(IncludeBarcodeWithOrderNumber).Append("\n"); diff --git a/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs b/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs index 7ce3c552..a87ae852 100644 --- a/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs +++ b/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs @@ -34,7 +34,7 @@ public partial class UpdatePackageTypeRequestBody /// /// laptop_box /// - [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("name"), JsonPropertyOrder(1)] public required string Name { get; set; } /// @@ -44,7 +44,7 @@ public partial class UpdatePackageTypeRequestBody /// /// small_flat_rate_box /// - [JsonPropertyName("package_code"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("package_code"), JsonPropertyOrder(2)] public required string PackageCode { get; set; } /// @@ -81,7 +81,7 @@ public partial class UpdatePackageTypeRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class UpdatePackageTypeRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); diff --git a/ShipEngineSDK/Model/UpdateShipmentFields.cs b/ShipEngineSDK/Model/UpdateShipmentFields.cs index fdc5d727..08fd33f0 100644 --- a/ShipEngineSDK/Model/UpdateShipmentFields.cs +++ b/ShipEngineSDK/Model/UpdateShipmentFields.cs @@ -41,7 +41,7 @@ public partial class UpdateShipmentFields /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class UpdateShipmentFields {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); diff --git a/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs b/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs index dadbf319..22ddee4a 100644 --- a/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs @@ -28,51 +28,18 @@ namespace ShipEngineSDK.Model; public partial class UpdateShipmentRequestBody { - /// - /// The type of delivery confirmation that is required for this shipment. - /// - /// The type of delivery confirmation that is required for this shipment. - [JsonPropertyName("confirmation"), JsonPropertyOrder(6)] - public DeliveryConfirmation? Confirmation { get; set; } - - /// - /// The insurance provider to use for any insured packages in the shipment. - /// - /// The insurance provider to use for any insured packages in the shipment. - [JsonPropertyName("insurance_provider"), JsonPropertyOrder(11)] - public InsuranceProvider? InsuranceProvider { get; set; } - - /// - /// Gets or Sets OrderSourceCode - /// - [JsonPropertyName("order_source_code"), JsonPropertyOrder(15)] - public OrderSourceName? OrderSourceCode { get; set; } - - /// - /// The current status of the shipment - /// - /// The current status of the shipment - [JsonPropertyName("shipment_status"), JsonInclude] - public ShipmentStatus? ShipmentStatus { get; private set; } - - /// - /// Gets or Sets ValidateAddress - /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(27)] - public ValidateAddress? ValidateAddress { get; set; } - /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("ship_from"), JsonPropertyOrder(1)] public required ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address /// /// The recipient's mailing address - [JsonPropertyName("ship_to"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("ship_to"), JsonPropertyOrder(2)] public required ShippingAddressTo ShipTo { get; set; } /// @@ -102,6 +69,13 @@ public partial class UpdateShipmentRequestBody [JsonPropertyName("comparison_rate_type"), JsonPropertyOrder(5)] public string? ComparisonRateType { 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"), JsonPropertyOrder(6)] + public DeliveryConfirmation? Confirmation { get; set; } + /// /// The date and time that the shipment was created in ShipEngine. /// @@ -133,6 +107,13 @@ public partial class UpdateShipmentRequestBody [JsonPropertyName("external_shipment_id"), JsonPropertyOrder(10)] public string? ExternalShipmentId { get; set; } + /// + /// The insurance provider to use for any insured packages in the shipment. + /// + /// The insurance provider to use for any insured packages in the shipment. + [JsonPropertyName("insurance_provider"), JsonPropertyOrder(11)] + public InsuranceProvider? InsuranceProvider { get; set; } + /// /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. /// @@ -157,6 +138,12 @@ public partial class UpdateShipmentRequestBody [JsonPropertyName("modified_at"), JsonInclude] public DateTimeOffset? ModifiedAt { get; private set; } + /// + /// Gets or Sets OrderSourceCode + /// + [JsonPropertyName("order_source_code"), JsonPropertyOrder(15)] + public OrderSourceName? OrderSourceCode { get; set; } + /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// @@ -208,6 +195,13 @@ public partial class UpdateShipmentRequestBody [JsonPropertyName("shipment_number"), JsonPropertyOrder(21)] public string? ShipmentNumber { get; set; } + /// + /// The current status of the shipment + /// + /// The current status of the shipment + [JsonPropertyName("shipment_status"), JsonInclude] + public ShipmentStatus? ShipmentStatus { get; private set; } + /// /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment /// @@ -238,6 +232,12 @@ public partial class UpdateShipmentRequestBody [JsonPropertyName("total_weight"), JsonInclude] public Weight? TotalWeight { get; private set; } + /// + /// Gets or Sets ValidateAddress + /// + [JsonPropertyName("validate_address"), JsonPropertyOrder(27)] + public ValidateAddress? ValidateAddress { get; set; } + /// /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. /// @@ -255,7 +255,7 @@ public partial class UpdateShipmentRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class UpdateShipmentRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipFrom: ").Append(ShipFrom).Append("\n"); diff --git a/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs b/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs index 433daa85..fe95b9b1 100644 --- a/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs @@ -28,45 +28,18 @@ namespace ShipEngineSDK.Model; public partial class UpdateShipmentResponseBody { - /// - /// The type of delivery confirmation that is required for this shipment. - /// - /// The type of delivery confirmation that is required for this shipment. - [JsonPropertyName("confirmation"), JsonRequired, JsonPropertyOrder(4)] - public required DeliveryConfirmation Confirmation { get; set; } - - /// - /// The insurance provider to use for any insured packages in the shipment. - /// - /// The insurance provider to use for any insured packages in the shipment. - [JsonPropertyName("insurance_provider"), JsonRequired, JsonPropertyOrder(7)] - public required InsuranceProvider InsuranceProvider { get; set; } - - /// - /// The current status of the shipment - /// - /// The current status of the shipment - [JsonPropertyName("shipment_status"), JsonInclude] - public ShipmentStatus? ShipmentStatus { get; private set; } - - /// - /// Gets or Sets OrderSourceCode - /// - [JsonPropertyName("order_source_code"), JsonPropertyOrder(25)] - public OrderSourceName? OrderSourceCode { get; set; } - /// /// The address validation /// /// The address validation - [JsonPropertyName("address_validation"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("address_validation"), JsonPropertyOrder(1)] public required AddressValidationResult AddressValidation { get; set; } /// /// Advanced shipment options. These are entirely optional. /// /// Advanced shipment options. These are entirely optional. - [JsonPropertyName("advanced_options"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("advanced_options"), JsonPropertyOrder(2)] public required AdvancedShipmentOptions AdvancedOptions { get; set; } /// @@ -76,9 +49,16 @@ public partial class UpdateShipmentResponseBody /// /// se-28529731 /// - [JsonPropertyName("carrier_id"), JsonRequired, JsonPropertyOrder(3)] + [JsonPropertyName("carrier_id"), JsonPropertyOrder(3)] public required string CarrierId { 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"), JsonPropertyOrder(4)] + public required DeliveryConfirmation Confirmation { get; set; } + /// /// The date and time that the shipment was created in ShipEngine. /// @@ -96,18 +76,25 @@ public partial class UpdateShipmentResponseBody [JsonPropertyName("errors"), JsonInclude, Obsolete] public List? Errors { get; private set; } + /// + /// The insurance provider to use for any insured packages in the shipment. + /// + /// The insurance provider to use for any insured packages in the shipment. + [JsonPropertyName("insurance_provider"), JsonPropertyOrder(7)] + public required InsuranceProvider InsuranceProvider { get; set; } + /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. - [JsonPropertyName("packages"), JsonRequired, JsonPropertyOrder(8)] + [JsonPropertyName("packages"), JsonPropertyOrder(8)] public required List Packages { get; set; } /// /// The return address for this shipment. Defaults to the `ship_from` address. /// /// The return address for this shipment. Defaults to the `ship_from` address. - [JsonPropertyName("return_to"), JsonRequired, JsonPropertyOrder(9)] + [JsonPropertyName("return_to"), JsonPropertyOrder(9)] public required ShippingAddress ReturnTo { get; set; } /// @@ -117,7 +104,7 @@ public partial class UpdateShipmentResponseBody /// /// usps_first_class_mail /// - [JsonPropertyName("service_code"), JsonRequired, JsonPropertyOrder(10)] + [JsonPropertyName("service_code"), JsonPropertyOrder(10)] public required string ServiceCode { get; set; } /// @@ -127,21 +114,21 @@ public partial class UpdateShipmentResponseBody /// /// 2018-09-23T00:00Z /// - [JsonPropertyName("ship_date"), JsonRequired, JsonPropertyOrder(11)] + [JsonPropertyName("ship_date"), JsonPropertyOrder(11)] public required DateTimeOffset ShipDate { get; set; } /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. /// /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. - [JsonPropertyName("ship_from"), JsonRequired, JsonPropertyOrder(12)] + [JsonPropertyName("ship_from"), JsonPropertyOrder(12)] public required ShippingAddress ShipFrom { get; set; } /// /// The recipient's mailing address /// /// The recipient's mailing address - [JsonPropertyName("ship_to"), JsonRequired, JsonPropertyOrder(13)] + [JsonPropertyName("ship_to"), JsonPropertyOrder(13)] public required ShippingAddressTo ShipTo { get; set; } /// @@ -154,6 +141,13 @@ public partial class UpdateShipmentResponseBody [JsonPropertyName("shipment_id"), JsonInclude] public string? ShipmentId { get; private set; } + /// + /// The current status of the shipment + /// + /// The current status of the shipment + [JsonPropertyName("shipment_status"), JsonInclude] + public ShipmentStatus? ShipmentStatus { get; private set; } + /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// @@ -182,7 +176,7 @@ public partial class UpdateShipmentResponseBody /// Customs information. This is usually only needed for international shipments. /// /// Customs information. This is usually only needed for international shipments. - [JsonPropertyName("customs"), JsonRequired, JsonPropertyOrder(19)] + [JsonPropertyName("customs"), JsonPropertyOrder(19)] public required InternationalShipmentOptions Customs { get; set; } /// @@ -223,6 +217,12 @@ public partial class UpdateShipmentResponseBody [JsonPropertyName("modified_at"), JsonInclude] public DateTimeOffset? ModifiedAt { get; private set; } + /// + /// Gets or Sets OrderSourceCode + /// + [JsonPropertyName("order_source_code"), JsonPropertyOrder(25)] + public OrderSourceName? OrderSourceCode { get; set; } + /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. /// @@ -263,7 +263,7 @@ public partial class UpdateShipmentResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class UpdateShipmentResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AddressValidation: ").Append(AddressValidation).Append("\n"); diff --git a/ShipEngineSDK/Model/UpdateShipmentsTags.cs b/ShipEngineSDK/Model/UpdateShipmentsTags.cs index d2c70b8e..6457d09e 100644 --- a/ShipEngineSDK/Model/UpdateShipmentsTags.cs +++ b/ShipEngineSDK/Model/UpdateShipmentsTags.cs @@ -41,7 +41,7 @@ public partial class UpdateShipmentsTags /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class UpdateShipmentsTags {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentsTags: ").Append(ShipmentsTags).Append("\n"); diff --git a/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs b/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs index cfa9ca0c..28a244f2 100644 --- a/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs @@ -41,7 +41,7 @@ public partial class UpdateShipmentsTagsRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class UpdateShipmentsTagsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentsTags: ").Append(ShipmentsTags).Append("\n"); diff --git a/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs b/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs index 39237e3b..ed54af22 100644 --- a/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs +++ b/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs @@ -47,7 +47,7 @@ public partial class UpdateShipmentsTagsShipmentsTagsInner /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class UpdateShipmentsTagsShipmentsTagsInner {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); diff --git a/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs index ce94b9c7..b99ae615 100644 --- a/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs @@ -28,18 +28,6 @@ namespace ShipEngineSDK.Model; public partial class UpdateUpsSettingsRequestBody { - /// - /// Gets or Sets MailInnovationsEndorsement - /// - [JsonPropertyName("mail_innovations_endorsement"), JsonPropertyOrder(5)] - public AncillaryServiceEndorsement? MailInnovationsEndorsement { get; set; } - - /// - /// Gets or Sets PickupType - /// - [JsonPropertyName("pickup_type"), JsonPropertyOrder(7)] - public UpsPickupType? PickupType { get; set; } - /// /// account postal code /// @@ -68,6 +56,12 @@ public partial class UpdateUpsSettingsRequestBody [JsonPropertyName("mail_innovations_cost_center"), JsonPropertyOrder(4)] public string? MailInnovationsCostCenter { get; set; } + /// + /// Gets or Sets MailInnovationsEndorsement + /// + [JsonPropertyName("mail_innovations_endorsement"), JsonPropertyOrder(5)] + public AncillaryServiceEndorsement? MailInnovationsEndorsement { get; set; } + /// /// nickname /// @@ -75,6 +69,12 @@ public partial class UpdateUpsSettingsRequestBody [JsonPropertyName("nickname"), JsonPropertyOrder(6)] public string? Nickname { get; set; } + /// + /// Gets or Sets PickupType + /// + [JsonPropertyName("pickup_type"), JsonPropertyOrder(7)] + public UpsPickupType? PickupType { get; set; } + /// /// The use carbon neutral shipping program /// @@ -117,7 +117,7 @@ public partial class UpdateUpsSettingsRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class UpdateUpsSettingsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountPostalCode: ").Append(AccountPostalCode).Append("\n"); diff --git a/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs b/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs index 593de5eb..335d8a80 100644 --- a/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs @@ -35,14 +35,14 @@ public partial class UpdateWarehouseRequestBody /// /// Zero Cool HQ /// - [JsonPropertyName("name"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("name"), JsonPropertyOrder(1)] public required string Name { get; set; } /// /// The origin address of the warehouse /// /// The origin address of the warehouse - [JsonPropertyName("origin_address"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("origin_address"), JsonPropertyOrder(2)] public required Address OriginAddress { get; set; } /// @@ -86,7 +86,7 @@ public partial class UpdateWarehouseRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class UpdateWarehouseRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Name: ").Append(Name).Append("\n"); diff --git a/ShipEngineSDK/Model/UpdateWarehouseSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateWarehouseSettingsRequestBody.cs index f3050be2..ff2cf9a3 100644 --- a/ShipEngineSDK/Model/UpdateWarehouseSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateWarehouseSettingsRequestBody.cs @@ -45,7 +45,7 @@ public partial class UpdateWarehouseSettingsRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class UpdateWarehouseSettingsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" IsDefault: ").Append(IsDefault).Append("\n"); diff --git a/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs b/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs index 2881ecd0..34bd10b3 100644 --- a/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs @@ -52,7 +52,7 @@ public partial class UpdateWebhookRequestBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class UpdateWebhookRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Headers: ").Append(Headers).Append("\n"); diff --git a/ShipEngineSDK/Model/UpsAccountSettings.cs b/ShipEngineSDK/Model/UpsAccountSettings.cs index 5fc95ad7..17c5663d 100644 --- a/ShipEngineSDK/Model/UpsAccountSettings.cs +++ b/ShipEngineSDK/Model/UpsAccountSettings.cs @@ -28,18 +28,6 @@ namespace ShipEngineSDK.Model; public partial class UpsAccountSettings { - /// - /// Gets or Sets MailInnovationsEndorsement - /// - [JsonPropertyName("mail_innovations_endorsement"), JsonPropertyOrder(5)] - public AncillaryServiceEndorsement? MailInnovationsEndorsement { get; set; } - - /// - /// Gets or Sets PickupType - /// - [JsonPropertyName("pickup_type"), JsonPropertyOrder(7)] - public UpsPickupType? PickupType { get; set; } - /// /// account postal code /// @@ -68,6 +56,12 @@ public partial class UpsAccountSettings [JsonPropertyName("mail_innovations_cost_center"), JsonPropertyOrder(4)] public string? MailInnovationsCostCenter { get; set; } + /// + /// Gets or Sets MailInnovationsEndorsement + /// + [JsonPropertyName("mail_innovations_endorsement"), JsonPropertyOrder(5)] + public AncillaryServiceEndorsement? MailInnovationsEndorsement { get; set; } + /// /// nickname /// @@ -75,6 +69,12 @@ public partial class UpsAccountSettings [JsonPropertyName("nickname"), JsonPropertyOrder(6)] public string? Nickname { get; set; } + /// + /// Gets or Sets PickupType + /// + [JsonPropertyName("pickup_type"), JsonPropertyOrder(7)] + public UpsPickupType? PickupType { get; set; } + /// /// The use carbon neutral shipping program /// @@ -117,7 +117,7 @@ public partial class UpsAccountSettings /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class UpsAccountSettings {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountPostalCode: ").Append(AccountPostalCode).Append("\n"); diff --git a/ShipEngineSDK/Model/UpsInvoice.cs b/ShipEngineSDK/Model/UpsInvoice.cs index e57df158..dec384b7 100644 --- a/ShipEngineSDK/Model/UpsInvoice.cs +++ b/ShipEngineSDK/Model/UpsInvoice.cs @@ -71,7 +71,7 @@ public partial class UpsInvoice /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class UpsInvoice {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ControlId: ").Append(ControlId).Append("\n"); diff --git a/ShipEngineSDK/Model/UpsPickupType.cs b/ShipEngineSDK/Model/UpsPickupType.cs index 5d86becc..1dfb0945 100644 --- a/ShipEngineSDK/Model/UpsPickupType.cs +++ b/ShipEngineSDK/Model/UpsPickupType.cs @@ -80,6 +80,11 @@ public UpsPickupType(string value) /// public override bool Equals(object? obj) => obj is UpsPickupType other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class UpsPickupTypeJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/UpsSettingsResponseBody.cs b/ShipEngineSDK/Model/UpsSettingsResponseBody.cs index b45e290e..4378e7ea 100644 --- a/ShipEngineSDK/Model/UpsSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/UpsSettingsResponseBody.cs @@ -28,18 +28,6 @@ namespace ShipEngineSDK.Model; public partial class UpsSettingsResponseBody { - /// - /// Gets or Sets MailInnovationsEndorsement - /// - [JsonPropertyName("mail_innovations_endorsement"), JsonPropertyOrder(5)] - public AncillaryServiceEndorsement? MailInnovationsEndorsement { get; set; } - - /// - /// Gets or Sets PickupType - /// - [JsonPropertyName("pickup_type"), JsonPropertyOrder(7)] - public UpsPickupType? PickupType { get; set; } - /// /// account postal code /// @@ -68,6 +56,12 @@ public partial class UpsSettingsResponseBody [JsonPropertyName("mail_innovations_cost_center"), JsonPropertyOrder(4)] public string? MailInnovationsCostCenter { get; set; } + /// + /// Gets or Sets MailInnovationsEndorsement + /// + [JsonPropertyName("mail_innovations_endorsement"), JsonPropertyOrder(5)] + public AncillaryServiceEndorsement? MailInnovationsEndorsement { get; set; } + /// /// nickname /// @@ -75,6 +69,12 @@ public partial class UpsSettingsResponseBody [JsonPropertyName("nickname"), JsonPropertyOrder(6)] public string? Nickname { get; set; } + /// + /// Gets or Sets PickupType + /// + [JsonPropertyName("pickup_type"), JsonPropertyOrder(7)] + public UpsPickupType? PickupType { get; set; } + /// /// The use carbon neutral shipping program /// @@ -117,7 +117,7 @@ public partial class UpsSettingsResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class UpsSettingsResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountPostalCode: ").Append(AccountPostalCode).Append("\n"); diff --git a/ShipEngineSDK/Model/ValidateAddress.cs b/ShipEngineSDK/Model/ValidateAddress.cs index 929cb05f..2d187265 100644 --- a/ShipEngineSDK/Model/ValidateAddress.cs +++ b/ShipEngineSDK/Model/ValidateAddress.cs @@ -80,6 +80,11 @@ public ValidateAddress(string value) /// public override bool Equals(object? obj) => obj is ValidateAddress other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class ValidateAddressJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/ValidateShipmentFields.cs b/ShipEngineSDK/Model/ValidateShipmentFields.cs index 9622de8d..0c2d2d0f 100644 --- a/ShipEngineSDK/Model/ValidateShipmentFields.cs +++ b/ShipEngineSDK/Model/ValidateShipmentFields.cs @@ -41,7 +41,7 @@ public partial class ValidateShipmentFields /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class ValidateShipmentFields {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); diff --git a/ShipEngineSDK/Model/ValidationStatus.cs b/ShipEngineSDK/Model/ValidationStatus.cs index 0dc17de2..685a19d7 100644 --- a/ShipEngineSDK/Model/ValidationStatus.cs +++ b/ShipEngineSDK/Model/ValidationStatus.cs @@ -86,6 +86,11 @@ public ValidationStatus(string value) /// public override bool Equals(object? obj) => obj is ValidationStatus other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class ValidationStatusJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/VoidLabelResponseBody.cs b/ShipEngineSDK/Model/VoidLabelResponseBody.cs index ea8924d8..d19a9d97 100644 --- a/ShipEngineSDK/Model/VoidLabelResponseBody.cs +++ b/ShipEngineSDK/Model/VoidLabelResponseBody.cs @@ -28,13 +28,6 @@ namespace ShipEngineSDK.Model; public partial class VoidLabelResponseBody { - /// - /// Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later. - /// - /// Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later. - [JsonPropertyName("reason_code"), JsonInclude] - public ReasonCode? ReasonCode { get; private set; } - /// /// Indicates whether the attempt to void the label was successful /// @@ -54,6 +47,13 @@ public partial class VoidLabelResponseBody [JsonPropertyName("message"), JsonInclude] public string? Message { get; private set; } + /// + /// Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later. + /// + /// Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later. + [JsonPropertyName("reason_code"), JsonInclude] + public ReasonCode? ReasonCode { get; private set; } + /// /// Returns the string presentation of the object @@ -61,7 +61,7 @@ public partial class VoidLabelResponseBody /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class VoidLabelResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Approved: ").Append(Approved).Append("\n"); diff --git a/ShipEngineSDK/Model/Warehouse.cs b/ShipEngineSDK/Model/Warehouse.cs index 0ddb4780..0e1eb809 100644 --- a/ShipEngineSDK/Model/Warehouse.cs +++ b/ShipEngineSDK/Model/Warehouse.cs @@ -86,7 +86,7 @@ public partial class Warehouse /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class Warehouse {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); diff --git a/ShipEngineSDK/Model/Webhook.cs b/ShipEngineSDK/Model/Webhook.cs index 9bdde813..5021844c 100644 --- a/ShipEngineSDK/Model/Webhook.cs +++ b/ShipEngineSDK/Model/Webhook.cs @@ -68,7 +68,7 @@ public partial class Webhook /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class Webhook {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Event: ").Append(Event).Append("\n"); diff --git a/ShipEngineSDK/Model/WebhookEvent.cs b/ShipEngineSDK/Model/WebhookEvent.cs index 169b9dd2..b6cb343f 100644 --- a/ShipEngineSDK/Model/WebhookEvent.cs +++ b/ShipEngineSDK/Model/WebhookEvent.cs @@ -104,6 +104,11 @@ public WebhookEvent(string value) /// public override bool Equals(object? obj) => obj is WebhookEvent other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class WebhookEventJsonConverter : JsonConverter diff --git a/ShipEngineSDK/Model/WebhookHeader.cs b/ShipEngineSDK/Model/WebhookHeader.cs index f1c4750b..80d645ea 100644 --- a/ShipEngineSDK/Model/WebhookHeader.cs +++ b/ShipEngineSDK/Model/WebhookHeader.cs @@ -35,7 +35,7 @@ public partial class WebhookHeader /// /// custom-key /// - [JsonPropertyName("key"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("key"), JsonPropertyOrder(1)] public required string Key { get; set; } /// @@ -45,7 +45,7 @@ public partial class WebhookHeader /// /// custom-value /// - [JsonPropertyName("value"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("value"), JsonPropertyOrder(2)] public required string Value { get; set; } @@ -55,7 +55,7 @@ public partial class WebhookHeader /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class WebhookHeader {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Key: ").Append(Key).Append("\n"); diff --git a/ShipEngineSDK/Model/Weight.cs b/ShipEngineSDK/Model/Weight.cs index 27791660..b6e18fb5 100644 --- a/ShipEngineSDK/Model/Weight.cs +++ b/ShipEngineSDK/Model/Weight.cs @@ -31,14 +31,14 @@ public partial class Weight /// /// Gets or Sets Unit /// - [JsonPropertyName("unit"), JsonRequired, JsonPropertyOrder(1)] + [JsonPropertyName("unit"), JsonPropertyOrder(1)] public required WeightUnit Unit { get; set; } /// /// The weight, in the specified unit /// /// The weight, in the specified unit - [JsonPropertyName("value"), JsonRequired, JsonPropertyOrder(2)] + [JsonPropertyName("value"), JsonPropertyOrder(2)] public required double Value { get; set; } @@ -48,7 +48,7 @@ public partial class Weight /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class Weight {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Unit: ").Append(Unit).Append("\n"); diff --git a/ShipEngineSDK/Model/WeightUnit.cs b/ShipEngineSDK/Model/WeightUnit.cs index 2beb2770..93f28c00 100644 --- a/ShipEngineSDK/Model/WeightUnit.cs +++ b/ShipEngineSDK/Model/WeightUnit.cs @@ -86,6 +86,11 @@ public WeightUnit(string value) /// public override bool Equals(object? obj) => obj is WeightUnit other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class WeightUnitJsonConverter : JsonConverter diff --git a/ShipEngineSDK/ShipEngineClient.cs b/ShipEngineSDK/ShipEngineClient.cs index 9f30ddd2..85e38d35 100644 --- a/ShipEngineSDK/ShipEngineClient.cs +++ b/ShipEngineSDK/ShipEngineClient.cs @@ -6,13 +6,12 @@ using System.Net.Http.Headers; using System.Text.Json; using System.Text.Json.Serialization; +using System.Text.Json.Serialization.Metadata; using System.Threading; using System.Threading.Tasks; namespace ShipEngineSDK { - using HttpMethod = System.Net.Http.HttpMethod; - /// /// ShipEngine Client is used for handling generic calls and settings that /// are needed for all ShipEngine API calls. @@ -23,14 +22,40 @@ public class ShipEngineClient /// Options for serializing the method call params to JSON. /// A separate inline setting is used for deserializing the response /// - internal static readonly JsonSerializerOptions JsonSerializerOptions = new JsonSerializerOptions + internal static readonly JsonSerializerOptions JsonSerializerOptions = new() { DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull, IgnoreReadOnlyProperties = true, PropertyNamingPolicy = JsonNamingPolicy.SnakeCaseLower, PropertyNameCaseInsensitive = true, WriteIndented = true, - Converters = { new JsonStringEnumMemberConverter() } + Converters = { new JsonStringEnumMemberConverter() }, + TypeInfoResolver = new DefaultJsonTypeInfoResolver + { + Modifiers = + { + static typeInfo => + { + if (typeInfo.Kind != JsonTypeInfoKind.Object) + return; + + foreach (JsonPropertyInfo propertyInfo in typeInfo.Properties) + { + // Don't require any properties when deserializing since we should not break consumers + // if the API changes slightly without consumers updating + propertyInfo.IsRequired = false; + + // If a property is marked as writeOnly, we should not try deserializing it + var writeOnly = propertyInfo.AttributeProvider? + .GetCustomAttributes(typeof(JsonWriteOnlyAttribute), false).Any() ?? false; + if (writeOnly) + { + propertyInfo.Set = (o, o1) => { }; + } + } + } + } + } }; private static readonly string? OsPlatform = Environment.OSVersion.Platform.ToString(); diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index 97647017..f71bc131 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-beta.2 + 3.0.0-beta.3 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET diff --git a/generation/templates/modelEnum.mustache b/generation/templates/modelEnum.mustache index bcf0e6b6..bfb4702f 100644 --- a/generation/templates/modelEnum.mustache +++ b/generation/templates/modelEnum.mustache @@ -59,6 +59,11 @@ /// public override bool Equals(object? obj) => obj is {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); } internal class {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}JsonConverter : JsonConverter<{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}> diff --git a/generation/templates/modelGeneric.mustache b/generation/templates/modelGeneric.mustache index e5591a7c..17ed6f7f 100644 --- a/generation/templates/modelGeneric.mustache +++ b/generation/templates/modelGeneric.mustache @@ -30,8 +30,11 @@ {{>modelInnerEnum}} {{/complexType}} {{/isEnum}} - {{#isEnum}} + {{/vars}} + {{#vars}} + {{^isInherited}} + {{#isEnum}} /// /// {{description}}{{^description}}Gets or Sets {{{name}}}{{/description}} /// @@ -45,11 +48,8 @@ {{/example}} {{>partial_jsonAttributes}} public{{>partial_requiredAttribute}} {{{complexType}}}{{^complexType}}{{{datatypeWithEnum}}}{{/complexType}}{{^isContainer}}{{>partial_optional}}{{/isContainer}} {{name}} {{>partial_getSet}} - {{/isEnum}} - {{/vars}} - {{#vars}} - {{^isInherited}} + {{/isEnum}} {{^isEnum}} {{#items.vars}} {{#-first}} @@ -105,7 +105,7 @@ /// String presentation of the object public override string ToString() { - StringBuilder sb = new StringBuilder(); + var sb = new StringBuilder(); sb.Append("class {{classname}} {\n"); #pragma warning disable CS0612 // Type or member is obsolete {{#parent}} diff --git a/generation/templates/modelOneOf.mustache b/generation/templates/modelOneOf.mustache index 1a531395..896dcb06 100644 --- a/generation/templates/modelOneOf.mustache +++ b/generation/templates/modelOneOf.mustache @@ -26,8 +26,10 @@ {{>modelInnerEnum}} {{/complexType}} {{/isEnum}} - {{#isEnum}} + {{/allVars}} + {{#allVars}} + {{#isEnum}} /// /// {{description}}{{^description}}Gets or Sets {{{name}}}{{/description}} /// @@ -44,9 +46,6 @@ {{/required}} {{/isEnum}} - {{/allVars}} - - {{#allVars}} {{^isInherited}} {{^isEnum}} /// diff --git a/generation/templates/partial_jsonAttributes.mustache b/generation/templates/partial_jsonAttributes.mustache index f7dba4f3..f83bec0e 100644 --- a/generation/templates/partial_jsonAttributes.mustache +++ b/generation/templates/partial_jsonAttributes.mustache @@ -1 +1 @@ -[JsonPropertyName("{{baseName}}"){{^isReadOnly}}{{#required}}, JsonRequired{{/required}}, JsonPropertyOrder({{-index}}){{/isReadOnly}}{{#isReadOnly}}, JsonInclude{{/isReadOnly}}{{#isDate}}, JsonConverter(typeof(DateJsonConverter)){{/isDate}}{{#deprecated}}, Obsolete{{/deprecated}}] \ No newline at end of file +[JsonPropertyName("{{baseName}}"){{^isReadOnly}}, JsonPropertyOrder({{-index}}){{/isReadOnly}}{{#isReadOnly}}, JsonInclude{{/isReadOnly}}{{#isWriteOnly}}, JsonWriteOnly{{/isWriteOnly}}{{#isDate}}, JsonConverter(typeof(DateJsonConverter)){{/isDate}}{{#deprecated}}, Obsolete{{/deprecated}}] \ No newline at end of file diff --git a/openapitools.json b/openapitools.json index a6381e6c..89c8afe9 100644 --- a/openapitools.json +++ b/openapitools.json @@ -14,7 +14,7 @@ "ignoreFileOverride": "./.openapi-generator-ignore", "library": "generichost", "additionalProperties": { - "packageVersion": "3.0.0-beta.2", + "packageVersion": "3.0.0-beta.3", "targetFramework": "netstandard2.0", "validatable": false, "sourceFolder": "", diff --git a/package.json b/package.json index e99bea64..387b0600 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "shipengine-dotnet", - "version": "3.0.0-beta.2", + "version": "3.0.0-beta.3", "description": "Package primarily used to generate the API and models from OpenApi spec\"", "main": "index.js", "directories": { From f04470183a357367dec640af8fa02f4bf823d4d7 Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Fri, 19 Jul 2024 11:16:11 -0500 Subject: [PATCH 12/42] Relax private setters on readonly properties --- CHANGELOG.md | 8 +- ShipEngineSDK/Model/AccountSettingsImages.cs | 15 +- .../Model/AddFundsToCarrierResponseBody.cs | 5 +- .../Model/AddressValidatingShipment.cs | 30 +++- .../Model/AddressValidationResult.cs | 10 +- ShipEngineSDK/Model/AlternativeIdentifiers.cs | 5 +- ShipEngineSDK/Model/Batch.cs | 95 ++++++++++--- ShipEngineSDK/Model/BatchResponseError.cs | 15 +- ShipEngineSDK/Model/BulkRate.cs | 25 +++- .../Model/CalculateRatesResponseBody.cs | 30 +++- ShipEngineSDK/Model/Carrier.cs | 70 ++++++++-- ShipEngineSDK/Model/CarrierAdvancedOption.cs | 15 +- .../CreateAccountSettingsImageRequestBody.cs | 15 +- .../Model/CreateAndValidateShipment.cs | 35 ++++- .../Model/CreateBatchResponseBody.cs | 95 ++++++++++--- .../Model/CreateLabelFromRateResponseBody.cs | 130 ++++++++++++++---- .../CreateLabelFromShipmentResponseBody.cs | 130 ++++++++++++++---- ShipEngineSDK/Model/CreateLabelRequestBody.cs | 130 ++++++++++++++---- .../Model/CreateLabelResponseBody.cs | 130 ++++++++++++++---- .../Model/CreateManifestResponseBody.cs | 15 +- .../Model/CreateReturnLabelResponseBody.cs | 130 ++++++++++++++---- .../Model/CreateShipmentResponseBodyFields.cs | 5 +- .../Model/CreateWarehouseRequestBody.cs | 10 +- .../Model/CreateWarehouseResponseBody.cs | 10 +- .../Model/CreateWebhookResponseBody.cs | 5 +- ShipEngineSDK/Model/CustomsItem.cs | 5 +- .../Model/DeletePickupByIdResponseBody.cs | 5 +- ShipEngineSDK/Model/DeprecatedManifest.cs | 10 +- ShipEngineSDK/Model/Error.cs | 5 +- ShipEngineSDK/Model/ErrorResponseBody.cs | 5 +- .../Model/ErrorWithLabelIdResponseBody.cs | 5 +- .../GetAccountSettingsImagesResponseBody.cs | 15 +- .../Model/GetBatchByExternalIdResponseBody.cs | 95 ++++++++++--- .../Model/GetBatchByIdResponseBody.cs | 95 ++++++++++--- .../Model/GetCarrierByIdResponseBody.cs | 70 ++++++++-- .../Model/GetCarrierOptionsResponseBody.cs | 5 +- .../Model/GetCarriersResponseBody.cs | 10 +- ...etLabelByExternalShipmentIdResponseBody.cs | 130 ++++++++++++++---- .../Model/GetLabelByIdResponseBody.cs | 130 ++++++++++++++---- .../Model/GetManifestByIdResponseBody.cs | 50 +++++-- .../Model/GetPickupByIdResponseBody.cs | 45 ++++-- ShipEngineSDK/Model/GetPickupsResponseBody.cs | 25 +++- .../Model/GetRateByIdResponseBody.cs | 130 ++++++++++++++---- .../GetShipmentByExternalIdResponseBody.cs | 30 +++- .../Model/GetShipmentByIdResponseBody.cs | 30 +++- .../GetTrackingLogFromLabelResponseBody.cs | 35 ++++- .../Model/GetTrackingLogResponseBody.cs | 35 ++++- .../Model/GetWarehouseByIdResponseBody.cs | 10 +- .../Model/GetWebhookByIdResponseBody.cs | 5 +- ShipEngineSDK/Model/Label.cs | 130 ++++++++++++++---- ShipEngineSDK/Model/LabelPackagesInner.cs | 30 +++- .../Model/ListAccountImagesResponseBody.cs | 11 +- .../ListAccountSettingsImagesResponseBody.cs | 11 +- .../Model/ListBatchErrorsResponseBody.cs | 10 +- .../Model/ListBatchesResponseBody.cs | 25 +++- .../ListCarrierPackageTypesResponseBody.cs | 5 +- .../Model/ListCarrierServicesResponseBody.cs | 5 +- .../Model/ListCarriersResponseBody.cs | 5 +- ShipEngineSDK/Model/ListLabelsResponseBody.cs | 52 +++---- .../Model/ListManifestsResponseBody.cs | 25 +++- .../Model/ListPackageTypesResponseBody.cs | 5 +- ShipEngineSDK/Model/ListPickupResponseBody.cs | 20 ++- .../Model/ListServicePointsResponseBody.cs | 5 +- .../Model/ListShipmentRatesResponseBody.cs | 25 +++- .../Model/ListShipmentsResponseBody.cs | 25 +++- .../Model/ListWarehousesResponseBody.cs | 5 +- ShipEngineSDK/Model/Manifest.cs | 50 +++++-- ShipEngineSDK/Model/ManifestRequest.cs | 5 +- ShipEngineSDK/Model/Package.cs | 25 +++- ShipEngineSDK/Model/PartialShipment.cs | 30 +++- ShipEngineSDK/Model/Pickup.cs | 40 ++++-- ShipEngineSDK/Model/PickupResponseBody.cs | 40 ++++-- ShipEngineSDK/Model/Rate.cs | 130 ++++++++++++++---- ShipEngineSDK/Model/RateEstimate.cs | 120 ++++++++++++---- ShipEngineSDK/Model/RatesInformation.cs | 25 +++- ShipEngineSDK/Model/ResponseMessage.cs | 15 +- .../Model/SchedulePickupRequestBody.cs | 40 ++++-- .../Model/SchedulePickupResponseBody.cs | 45 ++++-- ShipEngineSDK/Model/Service.cs | 30 +++- ShipEngineSDK/Model/Shipment.cs | 30 +++- ShipEngineSDK/Model/TrackEvent.cs | 50 +++++-- ShipEngineSDK/Model/TrackingInformation.cs | 35 ++++- .../UpdateAccountSettingsImageRequestBody.cs | 15 +- .../Model/UpdateShipmentRequestBody.cs | 30 +++- .../Model/UpdateShipmentResponseBody.cs | 35 ++++- .../Model/UpdateWarehouseRequestBody.cs | 10 +- ShipEngineSDK/Model/VoidLabelResponseBody.cs | 15 +- ShipEngineSDK/Model/Warehouse.cs | 10 +- ShipEngineSDK/Model/Webhook.cs | 5 +- ShipEngineSDK/ShipEngineSDK.csproj | 2 +- generation/templates/modelGeneric.mustache | 16 ++- generation/templates/modelOneOf.mustache | 16 ++- generation/templates/partial_getSet.mustache | 2 +- openapitools.json | 2 +- package.json | 2 +- 95 files changed, 2707 insertions(+), 700 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9a04fd5a..4a881fb5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -177,4 +177,10 @@ Updated nuget package dependencies - Don't require any properties for deserialization so that small API changes don't completely break consumers - Don't try to serialize read-only properties -- Don't try to deserialize write-only properties \ No newline at end of file +- Don't try to deserialize write-only properties + +## 3.0.0-beta.4 + +## Changed + +- Make setters on readonly properties public diff --git a/ShipEngineSDK/Model/AccountSettingsImages.cs b/ShipEngineSDK/Model/AccountSettingsImages.cs index dd6a64fc..b7e01eb9 100644 --- a/ShipEngineSDK/Model/AccountSettingsImages.cs +++ b/ShipEngineSDK/Model/AccountSettingsImages.cs @@ -92,11 +92,14 @@ public override bool CanConvert(Type typeToConvert) => /// The date and time that the image was created in ShipEngine. /// /// The date and time that the image was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The image type @@ -129,21 +132,27 @@ public override bool CanConvert(Type typeToConvert) => /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. /// /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// img_DtBXupDBxREpHnwEXhTfgK /// [JsonPropertyName("label_image_id"), JsonInclude] - public string? LabelImageId { get; private set; } + public string? LabelImageId { get; set; } /// /// The date and time that the image was modified in ShipEngine. /// /// The date and time that the image was modified in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at"), JsonInclude] - public DateTimeOffset? ModifiedAt { get; private set; } + public DateTimeOffset? ModifiedAt { get; set; } /// /// A human readable name for the image. diff --git a/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs b/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs index fc345f93..cf28da28 100644 --- a/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs +++ b/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs @@ -32,8 +32,11 @@ public partial class AddFundsToCarrierResponseBody /// The current balance of the account /// /// The current balance of the account + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("balance"), JsonInclude] - public MonetaryValue? Balance { get; private set; } + public MonetaryValue? Balance { get; set; } /// diff --git a/ShipEngineSDK/Model/AddressValidatingShipment.cs b/ShipEngineSDK/Model/AddressValidatingShipment.cs index c3e03c33..8299ee07 100644 --- a/ShipEngineSDK/Model/AddressValidatingShipment.cs +++ b/ShipEngineSDK/Model/AddressValidatingShipment.cs @@ -66,11 +66,14 @@ public partial class AddressValidatingShipment /// A string that uniquely identifies the shipment /// /// A string that uniquely identifies the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// Advanced shipment options. These are entirely optional. @@ -100,11 +103,14 @@ public partial class AddressValidatingShipment /// The date and time that the shipment was created in ShipEngine. /// /// The date and time that the shipment was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// Customs information. This is usually only needed for international shipments. @@ -152,11 +158,14 @@ public partial class AddressValidatingShipment /// The date and time that the shipment was created or last modified. /// /// The date and time that the shipment was created or last modified. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at"), JsonInclude] - public DateTimeOffset? ModifiedAt { get; private set; } + public DateTimeOffset? ModifiedAt { get; set; } /// /// Gets or Sets OrderSourceCode @@ -199,8 +208,11 @@ public partial class AddressValidatingShipment /// The current status of the shipment /// /// The current status of the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipment_status"), JsonInclude] - public ShipmentStatus? ShipmentStatus { get; private set; } + public ShipmentStatus? ShipmentStatus { get; set; } /// /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment @@ -216,8 +228,11 @@ public partial class AddressValidatingShipment /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tags"), JsonInclude] - public List? Tags { get; private set; } + public List? Tags { get; set; } /// /// Gets or Sets TaxIdentifiers @@ -229,8 +244,11 @@ public partial class AddressValidatingShipment /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("total_weight"), JsonInclude] - public Weight? TotalWeight { get; private set; } + public Weight? TotalWeight { get; set; } /// /// Gets or Sets ValidateAddress diff --git a/ShipEngineSDK/Model/AddressValidationResult.cs b/ShipEngineSDK/Model/AddressValidationResult.cs index d716043a..16bc5c58 100644 --- a/ShipEngineSDK/Model/AddressValidationResult.cs +++ b/ShipEngineSDK/Model/AddressValidationResult.cs @@ -32,8 +32,11 @@ public partial class AddressValidationResult /// The list of messages that were generated during the address validation request. /// /// The list of messages that were generated during the address validation request. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("messages"), JsonInclude] - public List? Messages { get; private set; } + public List? Messages { get; set; } /// /// The original address that was sent for validation @@ -52,8 +55,11 @@ public partial class AddressValidationResult /// The matched address found by the Shipengine API /// /// The matched address found by the Shipengine API + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("matched_address"), JsonInclude] - public Address? MatchedAddress { get; private set; } + public Address? MatchedAddress { get; set; } /// diff --git a/ShipEngineSDK/Model/AlternativeIdentifiers.cs b/ShipEngineSDK/Model/AlternativeIdentifiers.cs index 69ee9afa..62cc8c98 100644 --- a/ShipEngineSDK/Model/AlternativeIdentifiers.cs +++ b/ShipEngineSDK/Model/AlternativeIdentifiers.cs @@ -32,8 +32,11 @@ public partial class AlternativeIdentifiers /// Alternative identifiers associated with this package. /// /// Alternative identifiers associated with this package. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("alternative_identifiers"), JsonInclude] - public List? VarAlternativeIdentifiers { get; private set; } + public List? VarAlternativeIdentifiers { get; set; } /// diff --git a/ShipEngineSDK/Model/Batch.cs b/ShipEngineSDK/Model/Batch.cs index 6375cc46..35987266 100644 --- a/ShipEngineSDK/Model/Batch.cs +++ b/ShipEngineSDK/Model/Batch.cs @@ -32,18 +32,24 @@ public partial class Batch /// Link to batch errors endpoint /// /// Link to batch errors endpoint + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("batch_errors_url"), JsonInclude] - public OptionalLink? BatchErrorsUrl { get; private set; } + public OptionalLink? BatchErrorsUrl { get; set; } /// /// A string that uniquely identifies the batch /// /// A string that uniquely identifies the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("batch_id"), JsonInclude] - public string? BatchId { get; private set; } + public string? BatchId { get; set; } /// /// Link to batch labels query @@ -56,8 +62,11 @@ public partial class Batch /// The batch number. /// /// The batch number. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("batch_number"), JsonInclude] - public string? BatchNumber { get; private set; } + public string? BatchNumber { get; set; } /// /// The batch shipments endpoint @@ -70,135 +79,183 @@ public partial class Batch /// The number of labels generated in the batch /// /// The number of labels generated in the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 1 /// [JsonPropertyName("completed"), JsonInclude] - public int? Completed { get; private set; } + public int? Completed { get; set; } /// /// The total of errors, warnings, and completed properties /// /// The total of errors, warnings, and completed properties + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2 /// [JsonPropertyName("count"), JsonInclude] - public int? Count { get; private set; } + public int? Count { get; set; } /// /// The date and time the batch was created in ShipEngine /// /// The date and time the batch was created in ShipEngine + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The number of errors that occurred while generating the batch /// /// The number of errors that occurred while generating the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2 /// [JsonPropertyName("errors"), JsonInclude] - public int? Errors { get; private set; } + public int? Errors { get; set; } /// /// The form download for any customs that are needed /// /// The form download for any customs that are needed + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("form_download"), JsonInclude] - public OptionalLink? FormDownload { get; private set; } + public OptionalLink? FormDownload { get; set; } /// /// The number of forms for customs that are available for download /// /// The number of forms for customs that are available for download + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 3 /// [JsonPropertyName("forms"), JsonInclude] - public int? Forms { get; private set; } + public int? Forms { get; set; } /// /// The label download for the batch /// /// The label download for the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_download"), JsonInclude] - public LabelDownload? LabelDownload { get; private set; } + public LabelDownload? LabelDownload { get; set; } /// /// Gets or Sets LabelFormat /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_format"), JsonInclude] - public LabelFormat? LabelFormat { get; private set; } + public LabelFormat? LabelFormat { get; set; } /// /// label layout /// /// label layout + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_layout"), JsonInclude] - public LabelLayout? LabelLayout { get; private set; } + public LabelLayout? LabelLayout { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("paperless_download"), JsonInclude] - public PaperlessDownload? PaperlessDownload { get; private set; } + public PaperlessDownload? PaperlessDownload { get; set; } /// /// The errors associated with the failed API call /// /// The errors associated with the failed API call + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("process_errors"), JsonInclude] - public List? ProcessErrors { get; private set; } + public List? ProcessErrors { get; set; } /// /// Gets or Sets Status /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("status"), JsonInclude] - public BatchStatus? Status { get; private set; } + public BatchStatus? Status { get; set; } /// /// The number of warnings that occurred while generating the batch /// /// The number of warnings that occurred while generating the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 1 /// [JsonPropertyName("warnings"), JsonInclude] - public int? Warnings { get; private set; } + public int? Warnings { get; set; } /// /// Custom notes you can add for each created batch /// /// Custom notes you can add for each created batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// Batch for morning shipment /// [JsonPropertyName("batch_notes"), JsonInclude] - public string? BatchNotes { get; private set; } + public string? BatchNotes { get; set; } /// /// A string that uniquely identifies the external batch /// /// A string that uniquely identifies the external batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("external_batch_id"), JsonInclude] - public string? ExternalBatchId { get; private set; } + public string? ExternalBatchId { get; set; } /// /// The date and time the batch was processed in ShipEngine /// /// The date and time the batch was processed in ShipEngine + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("processed_at"), JsonInclude] - public DateTimeOffset? ProcessedAt { get; private set; } + public DateTimeOffset? ProcessedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/BatchResponseError.cs b/ShipEngineSDK/Model/BatchResponseError.cs index 508fb327..078838d3 100644 --- a/ShipEngineSDK/Model/BatchResponseError.cs +++ b/ShipEngineSDK/Model/BatchResponseError.cs @@ -32,28 +32,37 @@ public partial class BatchResponseError /// Error message associated with the shipment. /// /// Error message associated with the shipment. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// Recipient address has not been verified. /// [JsonPropertyName("error"), JsonInclude] - public string? Error { get; private set; } + public string? Error { get; set; } /// /// An external shipment id associated with the shipment /// /// An external shipment id associated with the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("external_shipment_id"), JsonInclude] - public string? ExternalShipmentId { get; private set; } + public string? ExternalShipmentId { get; set; } /// /// A string that uniquely identifies the shipment /// /// A string that uniquely identifies the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// diff --git a/ShipEngineSDK/Model/BulkRate.cs b/ShipEngineSDK/Model/BulkRate.cs index 732e2e7e..cd646c96 100644 --- a/ShipEngineSDK/Model/BulkRate.cs +++ b/ShipEngineSDK/Model/BulkRate.cs @@ -32,44 +32,59 @@ public partial class BulkRate /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// An array of errors that were returned while retrieving the bulk rate /// /// An array of errors that were returned while retrieving the bulk rate + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("errors"), JsonInclude] - public List? Errors { get; private set; } + public List? Errors { get; set; } /// /// A string that uniquely identifies the rate request /// /// A string that uniquely identifies the rate request + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("rate_request_id"), JsonInclude] - public string? RateRequestId { get; private set; } + public string? RateRequestId { get; set; } /// /// A string that uniquely identifies the shipment /// /// A string that uniquely identifies the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// Gets or Sets Status /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("status"), JsonInclude] - public RateResponseStatus? Status { get; private set; } + public RateResponseStatus? Status { get; set; } /// diff --git a/ShipEngineSDK/Model/CalculateRatesResponseBody.cs b/ShipEngineSDK/Model/CalculateRatesResponseBody.cs index fb52aa47..d328db3b 100644 --- a/ShipEngineSDK/Model/CalculateRatesResponseBody.cs +++ b/ShipEngineSDK/Model/CalculateRatesResponseBody.cs @@ -46,11 +46,14 @@ public partial class CalculateRatesResponseBody /// The date and time that the shipment was created in ShipEngine. /// /// The date and time that the shipment was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The insurance provider to use for any insured packages in the shipment. @@ -63,11 +66,14 @@ public partial class CalculateRatesResponseBody /// The date and time that the shipment was created or last modified. /// /// The date and time that the shipment was created or last modified. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at"), JsonInclude] - public DateTimeOffset? ModifiedAt { get; private set; } + public DateTimeOffset? ModifiedAt { get; set; } /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. @@ -104,32 +110,44 @@ public partial class CalculateRatesResponseBody /// A string that uniquely identifies the shipment /// /// A string that uniquely identifies the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// The current status of the shipment /// /// The current status of the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipment_status"), JsonInclude] - public ShipmentStatus? ShipmentStatus { get; private set; } + public ShipmentStatus? ShipmentStatus { get; set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tags"), JsonInclude] - public List? Tags { get; private set; } + public List? Tags { get; set; } /// /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("total_weight"), JsonInclude] - public Weight? TotalWeight { get; private set; } + public Weight? TotalWeight { get; set; } /// /// The carrier account that is billed for the shipping charges diff --git a/ShipEngineSDK/Model/Carrier.cs b/ShipEngineSDK/Model/Carrier.cs index 8b9c2b5c..496943b3 100644 --- a/ShipEngineSDK/Model/Carrier.cs +++ b/ShipEngineSDK/Model/Carrier.cs @@ -32,117 +32,159 @@ public partial class Carrier /// The account number that the carrier is connected to. /// /// The account number that the carrier is connected to. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// account_570827 /// [JsonPropertyName("account_number"), JsonInclude] - public string? AccountNumber { get; private set; } + public string? AccountNumber { get; set; } /// /// Current available balance /// /// Current available balance + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 3799.52 /// [JsonPropertyName("balance"), JsonInclude] - public double? Balance { get; private set; } + public double? Balance { get; set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// dhl_express /// [JsonPropertyName("carrier_code"), JsonInclude] - public string? CarrierCode { get; private set; } + public string? CarrierCode { get; set; } /// /// A string that uniquely identifies the carrier. /// /// A string that uniquely identifies the carrier. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// The carrier is disabled by the current ShipEngine account's billing plan. /// /// The carrier is disabled by the current ShipEngine account's billing plan. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("disabled_by_billing_plan"), JsonInclude] - public bool? DisabledByBillingPlan { get; private set; } + public bool? DisabledByBillingPlan { get; set; } /// /// Screen readable name /// /// Screen readable name + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// Stamps.com /// [JsonPropertyName("friendly_name"), JsonInclude] - public string? FriendlyName { get; private set; } + public string? FriendlyName { get; set; } /// /// Carrier supports multiple packages per shipment /// /// Carrier supports multiple packages per shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("has_multi_package_supporting_services"), JsonInclude] - public bool? HasMultiPackageSupportingServices { get; private set; } + public bool? HasMultiPackageSupportingServices { get; set; } /// /// Nickname given to the account when initially setting up the carrier. /// /// Nickname given to the account when initially setting up the carrier. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// ShipEngine Account - Stamps.com /// [JsonPropertyName("nickname"), JsonInclude] - public string? Nickname { get; private set; } + public string? Nickname { get; set; } /// /// A list of options that are available to that carrier /// /// A list of options that are available to that carrier + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("options"), JsonInclude] - public List? Options { get; private set; } + public List? Options { get; set; } /// /// A list of package types that are supported by the carrier /// /// A list of package types that are supported by the carrier + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("packages"), JsonInclude] - public List? Packages { get; private set; } + public List? Packages { get; set; } /// /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation /// /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("primary"), JsonInclude] - public bool? Primary { get; private set; } + public bool? Primary { get; set; } /// /// Indicates whether the carrier requires funding to use its services /// /// Indicates whether the carrier requires funding to use its services + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("requires_funded_amount"), JsonInclude] - public bool? RequiresFundedAmount { get; private set; } + public bool? RequiresFundedAmount { get; set; } /// /// A list of services that are offered by the carrier /// /// A list of services that are offered by the carrier + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("services"), JsonInclude] - public List? Services { get; private set; } + public List? Services { get; set; } /// /// The carrier supports adding custom label messages to an order. /// /// The carrier supports adding custom label messages to an order. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("supports_label_messages"), JsonInclude] - public bool? SupportsLabelMessages { get; private set; } + public bool? SupportsLabelMessages { get; set; } /// diff --git a/ShipEngineSDK/Model/CarrierAdvancedOption.cs b/ShipEngineSDK/Model/CarrierAdvancedOption.cs index 8a3eae69..4bc111ce 100644 --- a/ShipEngineSDK/Model/CarrierAdvancedOption.cs +++ b/ShipEngineSDK/Model/CarrierAdvancedOption.cs @@ -32,28 +32,37 @@ public partial class CarrierAdvancedOption /// Default value of option /// /// Default value of option + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// false /// [JsonPropertyName("default_value"), JsonInclude] - public string? DefaultValue { get; private set; } + public string? DefaultValue { get; set; } /// /// Description of option /// /// Description of option + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("description"), JsonInclude] - public string? Description { get; private set; } + public string? Description { get; set; } /// /// Name of advanced option /// /// Name of advanced option + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// contains_alcohol /// [JsonPropertyName("name"), JsonInclude] - public string? Name { get; private set; } + public string? Name { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs index 9d2d31de..0645b2a3 100644 --- a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs @@ -119,11 +119,14 @@ public override bool CanConvert(Type typeToConvert) => /// The date and time that the image was created in ShipEngine. /// /// The date and time that the image was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// Indicates whether this image is set as default. @@ -139,21 +142,27 @@ public override bool CanConvert(Type typeToConvert) => /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. /// /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// img_DtBXupDBxREpHnwEXhTfgK /// [JsonPropertyName("label_image_id"), JsonInclude] - public string? LabelImageId { get; private set; } + public string? LabelImageId { get; set; } /// /// The date and time that the image was modified in ShipEngine. /// /// The date and time that the image was modified in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at"), JsonInclude] - public DateTimeOffset? ModifiedAt { get; private set; } + public DateTimeOffset? ModifiedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateAndValidateShipment.cs b/ShipEngineSDK/Model/CreateAndValidateShipment.cs index 3c031722..0aae5c46 100644 --- a/ShipEngineSDK/Model/CreateAndValidateShipment.cs +++ b/ShipEngineSDK/Model/CreateAndValidateShipment.cs @@ -73,11 +73,14 @@ public partial class CreateAndValidateShipment /// The date and time that the shipment was created in ShipEngine. /// /// The date and time that the shipment was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// Customs information. This is usually only needed for international shipments. @@ -90,8 +93,11 @@ public partial class CreateAndValidateShipment /// An array of errors that occurred while creating shipment. /// /// An array of errors that occurred while creating shipment. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("errors"), JsonInclude, Obsolete] - public List? Errors { get; private set; } + public List? Errors { get; set; } /// /// ID that the Order Source assigned @@ -132,11 +138,14 @@ public partial class CreateAndValidateShipment /// The date and time that the shipment was created or last modified. /// /// The date and time that the shipment was created or last modified. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at"), JsonInclude] - public DateTimeOffset? ModifiedAt { get; private set; } + public DateTimeOffset? ModifiedAt { get; set; } /// /// Gets or Sets OrderSourceCode @@ -196,11 +205,14 @@ public partial class CreateAndValidateShipment /// A string that uniquely identifies the shipment /// /// A string that uniquely identifies the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. @@ -213,8 +225,11 @@ public partial class CreateAndValidateShipment /// The current status of the shipment /// /// The current status of the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipment_status"), JsonInclude] - public ShipmentStatus? ShipmentStatus { get; private set; } + public ShipmentStatus? ShipmentStatus { get; set; } /// /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment @@ -230,8 +245,11 @@ public partial class CreateAndValidateShipment /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tags"), JsonInclude] - public List? Tags { get; private set; } + public List? Tags { get; set; } /// /// Gets or Sets TaxIdentifiers @@ -243,8 +261,11 @@ public partial class CreateAndValidateShipment /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("total_weight"), JsonInclude] - public Weight? TotalWeight { get; private set; } + public Weight? TotalWeight { get; set; } /// /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. diff --git a/ShipEngineSDK/Model/CreateBatchResponseBody.cs b/ShipEngineSDK/Model/CreateBatchResponseBody.cs index f48f515a..d22c3517 100644 --- a/ShipEngineSDK/Model/CreateBatchResponseBody.cs +++ b/ShipEngineSDK/Model/CreateBatchResponseBody.cs @@ -32,18 +32,24 @@ public partial class CreateBatchResponseBody /// Link to batch errors endpoint /// /// Link to batch errors endpoint + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("batch_errors_url"), JsonInclude] - public OptionalLink? BatchErrorsUrl { get; private set; } + public OptionalLink? BatchErrorsUrl { get; set; } /// /// A string that uniquely identifies the batch /// /// A string that uniquely identifies the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("batch_id"), JsonInclude] - public string? BatchId { get; private set; } + public string? BatchId { get; set; } /// /// Link to batch labels query @@ -56,8 +62,11 @@ public partial class CreateBatchResponseBody /// The batch number. /// /// The batch number. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("batch_number"), JsonInclude] - public string? BatchNumber { get; private set; } + public string? BatchNumber { get; set; } /// /// The batch shipments endpoint @@ -70,135 +79,183 @@ public partial class CreateBatchResponseBody /// The number of labels generated in the batch /// /// The number of labels generated in the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 1 /// [JsonPropertyName("completed"), JsonInclude] - public int? Completed { get; private set; } + public int? Completed { get; set; } /// /// The total of errors, warnings, and completed properties /// /// The total of errors, warnings, and completed properties + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2 /// [JsonPropertyName("count"), JsonInclude] - public int? Count { get; private set; } + public int? Count { get; set; } /// /// The date and time the batch was created in ShipEngine /// /// The date and time the batch was created in ShipEngine + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The number of errors that occurred while generating the batch /// /// The number of errors that occurred while generating the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2 /// [JsonPropertyName("errors"), JsonInclude] - public int? Errors { get; private set; } + public int? Errors { get; set; } /// /// The form download for any customs that are needed /// /// The form download for any customs that are needed + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("form_download"), JsonInclude] - public OptionalLink? FormDownload { get; private set; } + public OptionalLink? FormDownload { get; set; } /// /// The number of forms for customs that are available for download /// /// The number of forms for customs that are available for download + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 3 /// [JsonPropertyName("forms"), JsonInclude] - public int? Forms { get; private set; } + public int? Forms { get; set; } /// /// The label download for the batch /// /// The label download for the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_download"), JsonInclude] - public LabelDownload? LabelDownload { get; private set; } + public LabelDownload? LabelDownload { get; set; } /// /// Gets or Sets LabelFormat /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_format"), JsonInclude] - public LabelFormat? LabelFormat { get; private set; } + public LabelFormat? LabelFormat { get; set; } /// /// label layout /// /// label layout + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_layout"), JsonInclude] - public LabelLayout? LabelLayout { get; private set; } + public LabelLayout? LabelLayout { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("paperless_download"), JsonInclude] - public PaperlessDownload? PaperlessDownload { get; private set; } + public PaperlessDownload? PaperlessDownload { get; set; } /// /// The errors associated with the failed API call /// /// The errors associated with the failed API call + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("process_errors"), JsonInclude] - public List? ProcessErrors { get; private set; } + public List? ProcessErrors { get; set; } /// /// Gets or Sets Status /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("status"), JsonInclude] - public BatchStatus? Status { get; private set; } + public BatchStatus? Status { get; set; } /// /// The number of warnings that occurred while generating the batch /// /// The number of warnings that occurred while generating the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 1 /// [JsonPropertyName("warnings"), JsonInclude] - public int? Warnings { get; private set; } + public int? Warnings { get; set; } /// /// Custom notes you can add for each created batch /// /// Custom notes you can add for each created batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// Batch for morning shipment /// [JsonPropertyName("batch_notes"), JsonInclude] - public string? BatchNotes { get; private set; } + public string? BatchNotes { get; set; } /// /// A string that uniquely identifies the external batch /// /// A string that uniquely identifies the external batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("external_batch_id"), JsonInclude] - public string? ExternalBatchId { get; private set; } + public string? ExternalBatchId { get; set; } /// /// The date and time the batch was processed in ShipEngine /// /// The date and time the batch was processed in ShipEngine + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("processed_at"), JsonInclude] - public DateTimeOffset? ProcessedAt { get; private set; } + public DateTimeOffset? ProcessedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs index 599a018c..20f7fafa 100644 --- a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs @@ -32,38 +32,50 @@ public partial class CreateLabelFromRateResponseBody /// Additional information some carriers may provide by which to identify a given label in their system. /// /// Additional information some carriers may provide by which to identify a given label in their system. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("alternative_identifiers"), JsonInclude] - public List? AlternativeIdentifiers { get; private set; } + public List? AlternativeIdentifiers { get; set; } /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("batch_id"), JsonInclude] - public string? BatchId { get; private set; } + public string? BatchId { get; set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// dhl_express /// [JsonPropertyName("carrier_code"), JsonInclude] - public string? CarrierCode { get; private set; } + public string? CarrierCode { get; set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// The label charge event. @@ -76,11 +88,14 @@ public partial class CreateLabelFromRateResponseBody /// The date and time that the label was created in ShipEngine. /// /// The date and time that the label was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The display format that the label should be shown in. @@ -93,29 +108,41 @@ public partial class CreateLabelFromRateResponseBody /// 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. /// /// 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. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("form_download"), JsonInclude] - public Link? FormDownload { get; private set; } + public Link? FormDownload { get; set; } /// /// 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. /// /// 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. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("insurance_claim"), JsonInclude] - public Link? InsuranceClaim { get; private set; } + public Link? InsuranceClaim { get; set; } /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("insurance_cost"), JsonInclude] - public MonetaryValue? InsuranceCost { get; private set; } + public MonetaryValue? InsuranceCost { get; set; } /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("is_international"), JsonInclude] - public bool? IsInternational { get; private set; } + public bool? IsInternational { get; set; } /// /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. @@ -127,8 +154,11 @@ public partial class CreateLabelFromRateResponseBody /// /// Gets or Sets LabelDownload /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_download"), JsonInclude] - public LabelDownload? LabelDownload { get; private set; } + public LabelDownload? LabelDownload { get; set; } /// /// Gets or Sets LabelDownloadType @@ -147,11 +177,14 @@ public partial class CreateLabelFromRateResponseBody /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("label_id"), JsonInclude] - public string? LabelId { get; private set; } + public string? LabelId { get; set; } /// /// The label image resource that was used to create a custom label image. @@ -184,32 +217,44 @@ public partial class CreateLabelFromRateResponseBody /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. /// /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// small_flat_rate_box /// [JsonPropertyName("package_code"), JsonInclude] - public string? PackageCode { get; private set; } + public string? PackageCode { get; set; } /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("packages"), JsonInclude] - public List? Packages { get; private set; } + public List? Packages { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("paperless_download"), JsonInclude] - public PaperlessDownload? PaperlessDownload { get; private set; } + public PaperlessDownload? PaperlessDownload { get; set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("requested_comparison_amount"), JsonInclude] - public MonetaryValue? RequestedComparisonAmount { get; private set; } + public MonetaryValue? RequestedComparisonAmount { get; set; } /// /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. @@ -222,21 +267,27 @@ public partial class CreateLabelFromRateResponseBody /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// usps_first_class_mail /// [JsonPropertyName("service_code"), JsonInclude] - public string? ServiceCode { get; private set; } + public string? ServiceCode { get; set; } /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date"), JsonInclude] - public DateTimeOffset? ShipDate { get; private set; } + public DateTimeOffset? ShipDate { get; set; } /// /// The shipment information used to generate the label @@ -249,24 +300,33 @@ public partial class CreateLabelFromRateResponseBody /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipment_cost"), JsonInclude] - public MonetaryValue? ShipmentCost { get; private set; } + public MonetaryValue? ShipmentCost { get; set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// Gets or Sets Status /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("status"), JsonInclude] - public LabelStatus? Status { get; private set; } + public LabelStatus? Status { get; set; } /// /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. @@ -279,35 +339,47 @@ public partial class CreateLabelFromRateResponseBody /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("trackable"), JsonInclude] - public bool? Trackable { get; private set; } + public bool? Trackable { get; set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. /// /// The tracking number for the package. Tracking number formats vary across carriers. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 782758401696 /// [JsonPropertyName("tracking_number"), JsonInclude] - public string? TrackingNumber { get; private set; } + public string? TrackingNumber { get; set; } /// /// The current status of the package, such as `in_transit` or `delivered` /// /// The current status of the package, such as `in_transit` or `delivered` + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tracking_status"), JsonInclude] - public TrackingStatus? TrackingStatus { get; private set; } + public TrackingStatus? TrackingStatus { get; set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url"), JsonInclude] - public string? TrackingUrl { get; private set; } + public string? TrackingUrl { get; set; } /// /// Gets or Sets ValidateAddress @@ -319,18 +391,24 @@ public partial class CreateLabelFromRateResponseBody /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("voided"), JsonInclude] - public bool? Voided { get; private set; } + public bool? Voided { get; set; } /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("voided_at"), JsonInclude] - public DateTimeOffset? VoidedAt { get; private set; } + public DateTimeOffset? VoidedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs index 3e7aea52..16878523 100644 --- a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs @@ -32,38 +32,50 @@ public partial class CreateLabelFromShipmentResponseBody /// Additional information some carriers may provide by which to identify a given label in their system. /// /// Additional information some carriers may provide by which to identify a given label in their system. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("alternative_identifiers"), JsonInclude] - public List? AlternativeIdentifiers { get; private set; } + public List? AlternativeIdentifiers { get; set; } /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("batch_id"), JsonInclude] - public string? BatchId { get; private set; } + public string? BatchId { get; set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// dhl_express /// [JsonPropertyName("carrier_code"), JsonInclude] - public string? CarrierCode { get; private set; } + public string? CarrierCode { get; set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// The label charge event. @@ -76,11 +88,14 @@ public partial class CreateLabelFromShipmentResponseBody /// The date and time that the label was created in ShipEngine. /// /// The date and time that the label was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The display format that the label should be shown in. @@ -93,29 +108,41 @@ public partial class CreateLabelFromShipmentResponseBody /// 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. /// /// 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. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("form_download"), JsonInclude] - public Link? FormDownload { get; private set; } + public Link? FormDownload { get; set; } /// /// 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. /// /// 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. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("insurance_claim"), JsonInclude] - public Link? InsuranceClaim { get; private set; } + public Link? InsuranceClaim { get; set; } /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("insurance_cost"), JsonInclude] - public MonetaryValue? InsuranceCost { get; private set; } + public MonetaryValue? InsuranceCost { get; set; } /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("is_international"), JsonInclude] - public bool? IsInternational { get; private set; } + public bool? IsInternational { get; set; } /// /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. @@ -127,8 +154,11 @@ public partial class CreateLabelFromShipmentResponseBody /// /// Gets or Sets LabelDownload /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_download"), JsonInclude] - public LabelDownload? LabelDownload { get; private set; } + public LabelDownload? LabelDownload { get; set; } /// /// Gets or Sets LabelDownloadType @@ -147,11 +177,14 @@ public partial class CreateLabelFromShipmentResponseBody /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("label_id"), JsonInclude] - public string? LabelId { get; private set; } + public string? LabelId { get; set; } /// /// The label image resource that was used to create a custom label image. @@ -184,32 +217,44 @@ public partial class CreateLabelFromShipmentResponseBody /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. /// /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// small_flat_rate_box /// [JsonPropertyName("package_code"), JsonInclude] - public string? PackageCode { get; private set; } + public string? PackageCode { get; set; } /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("packages"), JsonInclude] - public List? Packages { get; private set; } + public List? Packages { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("paperless_download"), JsonInclude] - public PaperlessDownload? PaperlessDownload { get; private set; } + public PaperlessDownload? PaperlessDownload { get; set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("requested_comparison_amount"), JsonInclude] - public MonetaryValue? RequestedComparisonAmount { get; private set; } + public MonetaryValue? RequestedComparisonAmount { get; set; } /// /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. @@ -222,21 +267,27 @@ public partial class CreateLabelFromShipmentResponseBody /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// usps_first_class_mail /// [JsonPropertyName("service_code"), JsonInclude] - public string? ServiceCode { get; private set; } + public string? ServiceCode { get; set; } /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date"), JsonInclude] - public DateTimeOffset? ShipDate { get; private set; } + public DateTimeOffset? ShipDate { get; set; } /// /// The shipment information used to generate the label @@ -249,24 +300,33 @@ public partial class CreateLabelFromShipmentResponseBody /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipment_cost"), JsonInclude] - public MonetaryValue? ShipmentCost { get; private set; } + public MonetaryValue? ShipmentCost { get; set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// Gets or Sets Status /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("status"), JsonInclude] - public LabelStatus? Status { get; private set; } + public LabelStatus? Status { get; set; } /// /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. @@ -279,35 +339,47 @@ public partial class CreateLabelFromShipmentResponseBody /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("trackable"), JsonInclude] - public bool? Trackable { get; private set; } + public bool? Trackable { get; set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. /// /// The tracking number for the package. Tracking number formats vary across carriers. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 782758401696 /// [JsonPropertyName("tracking_number"), JsonInclude] - public string? TrackingNumber { get; private set; } + public string? TrackingNumber { get; set; } /// /// The current status of the package, such as `in_transit` or `delivered` /// /// The current status of the package, such as `in_transit` or `delivered` + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tracking_status"), JsonInclude] - public TrackingStatus? TrackingStatus { get; private set; } + public TrackingStatus? TrackingStatus { get; set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url"), JsonInclude] - public string? TrackingUrl { get; private set; } + public string? TrackingUrl { get; set; } /// /// Gets or Sets ValidateAddress @@ -319,18 +391,24 @@ public partial class CreateLabelFromShipmentResponseBody /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("voided"), JsonInclude] - public bool? Voided { get; private set; } + public bool? Voided { get; set; } /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("voided_at"), JsonInclude] - public DateTimeOffset? VoidedAt { get; private set; } + public DateTimeOffset? VoidedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateLabelRequestBody.cs b/ShipEngineSDK/Model/CreateLabelRequestBody.cs index 7e52286d..b9e77214 100644 --- a/ShipEngineSDK/Model/CreateLabelRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelRequestBody.cs @@ -39,38 +39,50 @@ public partial class CreateLabelRequestBody /// Additional information some carriers may provide by which to identify a given label in their system. /// /// Additional information some carriers may provide by which to identify a given label in their system. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("alternative_identifiers"), JsonInclude] - public List? AlternativeIdentifiers { get; private set; } + public List? AlternativeIdentifiers { get; set; } /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("batch_id"), JsonInclude] - public string? BatchId { get; private set; } + public string? BatchId { get; set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// dhl_express /// [JsonPropertyName("carrier_code"), JsonInclude] - public string? CarrierCode { get; private set; } + public string? CarrierCode { get; set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// The label charge event. @@ -83,11 +95,14 @@ public partial class CreateLabelRequestBody /// The date and time that the label was created in ShipEngine. /// /// The date and time that the label was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The display format that the label should be shown in. @@ -100,29 +115,41 @@ public partial class CreateLabelRequestBody /// 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. /// /// 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. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("form_download"), JsonInclude] - public Link? FormDownload { get; private set; } + public Link? FormDownload { get; set; } /// /// 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. /// /// 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. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("insurance_claim"), JsonInclude] - public Link? InsuranceClaim { get; private set; } + public Link? InsuranceClaim { get; set; } /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("insurance_cost"), JsonInclude] - public MonetaryValue? InsuranceCost { get; private set; } + public MonetaryValue? InsuranceCost { get; set; } /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("is_international"), JsonInclude] - public bool? IsInternational { get; private set; } + public bool? IsInternational { get; set; } /// /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. @@ -134,8 +161,11 @@ public partial class CreateLabelRequestBody /// /// Gets or Sets LabelDownload /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_download"), JsonInclude] - public LabelDownload? LabelDownload { get; private set; } + public LabelDownload? LabelDownload { get; set; } /// /// Gets or Sets LabelDownloadType @@ -154,11 +184,14 @@ public partial class CreateLabelRequestBody /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("label_id"), JsonInclude] - public string? LabelId { get; private set; } + public string? LabelId { get; set; } /// /// The label image resource that was used to create a custom label image. @@ -191,32 +224,44 @@ public partial class CreateLabelRequestBody /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. /// /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// small_flat_rate_box /// [JsonPropertyName("package_code"), JsonInclude] - public string? PackageCode { get; private set; } + public string? PackageCode { get; set; } /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("packages"), JsonInclude] - public List? Packages { get; private set; } + public List? Packages { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("paperless_download"), JsonInclude] - public PaperlessDownload? PaperlessDownload { get; private set; } + public PaperlessDownload? PaperlessDownload { get; set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("requested_comparison_amount"), JsonInclude] - public MonetaryValue? RequestedComparisonAmount { get; private set; } + public MonetaryValue? RequestedComparisonAmount { get; set; } /// /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. @@ -229,21 +274,27 @@ public partial class CreateLabelRequestBody /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// usps_first_class_mail /// [JsonPropertyName("service_code"), JsonInclude] - public string? ServiceCode { get; private set; } + public string? ServiceCode { get; set; } /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date"), JsonInclude] - public DateTimeOffset? ShipDate { get; private set; } + public DateTimeOffset? ShipDate { get; set; } /// /// A unique identifier for a carrier drop off point where a merchant plans to deliver packages. This will take precedence over a shipment's ship from address. @@ -269,24 +320,33 @@ public partial class CreateLabelRequestBody /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipment_cost"), JsonInclude] - public MonetaryValue? ShipmentCost { get; private set; } + public MonetaryValue? ShipmentCost { get; set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// Gets or Sets Status /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("status"), JsonInclude] - public LabelStatus? Status { get; private set; } + public LabelStatus? Status { get; set; } /// /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. @@ -299,35 +359,47 @@ public partial class CreateLabelRequestBody /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("trackable"), JsonInclude] - public bool? Trackable { get; private set; } + public bool? Trackable { get; set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. /// /// The tracking number for the package. Tracking number formats vary across carriers. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 782758401696 /// [JsonPropertyName("tracking_number"), JsonInclude] - public string? TrackingNumber { get; private set; } + public string? TrackingNumber { get; set; } /// /// The current status of the package, such as `in_transit` or `delivered` /// /// The current status of the package, such as `in_transit` or `delivered` + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tracking_status"), JsonInclude] - public TrackingStatus? TrackingStatus { get; private set; } + public TrackingStatus? TrackingStatus { get; set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url"), JsonInclude] - public string? TrackingUrl { get; private set; } + public string? TrackingUrl { get; set; } /// /// Gets or Sets ValidateAddress @@ -339,18 +411,24 @@ public partial class CreateLabelRequestBody /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("voided"), JsonInclude] - public bool? Voided { get; private set; } + public bool? Voided { get; set; } /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("voided_at"), JsonInclude] - public DateTimeOffset? VoidedAt { get; private set; } + public DateTimeOffset? VoidedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateLabelResponseBody.cs b/ShipEngineSDK/Model/CreateLabelResponseBody.cs index 13af393a..66941716 100644 --- a/ShipEngineSDK/Model/CreateLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelResponseBody.cs @@ -32,31 +32,40 @@ public partial class CreateLabelResponseBody /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("batch_id"), JsonInclude] - public string? BatchId { get; private set; } + public string? BatchId { get; set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// dhl_express /// [JsonPropertyName("carrier_code"), JsonInclude] - public string? CarrierCode { get; private set; } + public string? CarrierCode { get; set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// The label charge event. @@ -69,11 +78,14 @@ public partial class CreateLabelResponseBody /// The date and time that the label was created in ShipEngine. /// /// The date and time that the label was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The display format that the label should be shown in. @@ -86,15 +98,21 @@ public partial class CreateLabelResponseBody /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("insurance_cost"), JsonInclude] - public MonetaryValue? InsuranceCost { get; private set; } + public MonetaryValue? InsuranceCost { get; set; } /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("is_international"), JsonInclude] - public bool? IsInternational { get; private set; } + public bool? IsInternational { get; set; } /// /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. @@ -106,8 +124,11 @@ public partial class CreateLabelResponseBody /// /// Gets or Sets LabelDownload /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_download"), JsonInclude] - public LabelDownload? LabelDownload { get; private set; } + public LabelDownload? LabelDownload { 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. @@ -120,11 +141,14 @@ public partial class CreateLabelResponseBody /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("label_id"), JsonInclude] - public string? LabelId { get; private set; } + public string? LabelId { 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. @@ -137,113 +161,155 @@ public partial class CreateLabelResponseBody /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. /// /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// small_flat_rate_box /// [JsonPropertyName("package_code"), JsonInclude] - public string? PackageCode { get; private set; } + public string? PackageCode { get; set; } /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("packages"), JsonInclude] - public List? Packages { get; private set; } + public List? Packages { get; set; } /// /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// usps_first_class_mail /// [JsonPropertyName("service_code"), JsonInclude] - public string? ServiceCode { get; private set; } + public string? ServiceCode { get; set; } /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date"), JsonInclude] - public DateTimeOffset? ShipDate { get; private set; } + public DateTimeOffset? ShipDate { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipment_cost"), JsonInclude] - public MonetaryValue? ShipmentCost { get; private set; } + public MonetaryValue? ShipmentCost { get; set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// Gets or Sets Status /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("status"), JsonInclude] - public LabelStatus? Status { get; private set; } + public LabelStatus? Status { get; set; } /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("trackable"), JsonInclude] - public bool? Trackable { get; private set; } + public bool? Trackable { get; set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. /// /// The tracking number for the package. Tracking number formats vary across carriers. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 782758401696 /// [JsonPropertyName("tracking_number"), JsonInclude] - public string? TrackingNumber { get; private set; } + public string? TrackingNumber { get; set; } /// /// The current status of the package, such as `in_transit` or `delivered` /// /// The current status of the package, such as `in_transit` or `delivered` + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tracking_status"), JsonInclude] - public TrackingStatus? TrackingStatus { get; private set; } + public TrackingStatus? TrackingStatus { get; set; } /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("voided"), JsonInclude] - public bool? Voided { get; private set; } + public bool? Voided { get; set; } /// /// Additional information some carriers may provide by which to identify a given label in their system. /// /// Additional information some carriers may provide by which to identify a given label in their system. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("alternative_identifiers"), JsonInclude] - public List? AlternativeIdentifiers { get; private set; } + public List? AlternativeIdentifiers { 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. /// /// 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. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("form_download"), JsonInclude] - public Link? FormDownload { get; private set; } + public Link? FormDownload { get; set; } /// /// 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. /// /// 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. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("insurance_claim"), JsonInclude] - public Link? InsuranceClaim { get; private set; } + public Link? InsuranceClaim { get; set; } /// /// Gets or Sets LabelDownloadType @@ -275,15 +341,21 @@ public partial class CreateLabelResponseBody /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("paperless_download"), JsonInclude] - public PaperlessDownload? PaperlessDownload { get; private set; } + public PaperlessDownload? PaperlessDownload { get; set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("requested_comparison_amount"), JsonInclude] - public MonetaryValue? RequestedComparisonAmount { get; private set; } + public MonetaryValue? RequestedComparisonAmount { get; set; } /// /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. @@ -310,11 +382,14 @@ public partial class CreateLabelResponseBody /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url"), JsonInclude] - public string? TrackingUrl { get; private set; } + public string? TrackingUrl { get; set; } /// /// Gets or Sets ValidateAddress @@ -326,11 +401,14 @@ public partial class CreateLabelResponseBody /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("voided_at"), JsonInclude] - public DateTimeOffset? VoidedAt { get; private set; } + public DateTimeOffset? VoidedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateManifestResponseBody.cs b/ShipEngineSDK/Model/CreateManifestResponseBody.cs index 6138583c..845dea28 100644 --- a/ShipEngineSDK/Model/CreateManifestResponseBody.cs +++ b/ShipEngineSDK/Model/CreateManifestResponseBody.cs @@ -52,8 +52,11 @@ public partial class CreateManifestResponseBody /// The errors associated with the failed API call /// /// The errors associated with the failed API call + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("errors"), JsonInclude] - public List? Errors { get; private set; } + public List? Errors { get; set; } /// /// A string that uniquely identifies the form @@ -105,11 +108,14 @@ public partial class CreateManifestResponseBody /// The number of shipments that are included in this manifest /// /// The number of shipments that are included in this manifest + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 100 /// [JsonPropertyName("shipments"), JsonInclude, Obsolete] - public int? Shipments { get; private set; } + public int? Shipments { get; set; } /// /// A string that uniquely identifies the submission @@ -135,8 +141,11 @@ public partial class CreateManifestResponseBody /// An array of the label ids used in this manifest. /// /// An array of the label ids used in this manifest. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_ids"), JsonInclude, Obsolete] - public List? LabelIds { get; private set; } + public List? LabelIds { get; set; } /// /// Resulting manifest requests with statuses diff --git a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs index eae127eb..f495c654 100644 --- a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs @@ -32,38 +32,50 @@ public partial class CreateReturnLabelResponseBody /// Additional information some carriers may provide by which to identify a given label in their system. /// /// Additional information some carriers may provide by which to identify a given label in their system. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("alternative_identifiers"), JsonInclude] - public List? AlternativeIdentifiers { get; private set; } + public List? AlternativeIdentifiers { get; set; } /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("batch_id"), JsonInclude] - public string? BatchId { get; private set; } + public string? BatchId { get; set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// dhl_express /// [JsonPropertyName("carrier_code"), JsonInclude] - public string? CarrierCode { get; private set; } + public string? CarrierCode { get; set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// The label charge event. @@ -76,11 +88,14 @@ public partial class CreateReturnLabelResponseBody /// The date and time that the label was created in ShipEngine. /// /// The date and time that the label was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The display format that the label should be shown in. @@ -93,29 +108,41 @@ public partial class CreateReturnLabelResponseBody /// 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. /// /// 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. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("form_download"), JsonInclude] - public Link? FormDownload { get; private set; } + public Link? FormDownload { get; set; } /// /// 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. /// /// 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. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("insurance_claim"), JsonInclude] - public Link? InsuranceClaim { get; private set; } + public Link? InsuranceClaim { get; set; } /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("insurance_cost"), JsonInclude] - public MonetaryValue? InsuranceCost { get; private set; } + public MonetaryValue? InsuranceCost { get; set; } /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("is_international"), JsonInclude] - public bool? IsInternational { get; private set; } + public bool? IsInternational { get; set; } /// /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. @@ -127,8 +154,11 @@ public partial class CreateReturnLabelResponseBody /// /// Gets or Sets LabelDownload /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_download"), JsonInclude] - public LabelDownload? LabelDownload { get; private set; } + public LabelDownload? LabelDownload { get; set; } /// /// Gets or Sets LabelDownloadType @@ -147,11 +177,14 @@ public partial class CreateReturnLabelResponseBody /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("label_id"), JsonInclude] - public string? LabelId { get; private set; } + public string? LabelId { get; set; } /// /// The label image resource that was used to create a custom label image. @@ -184,32 +217,44 @@ public partial class CreateReturnLabelResponseBody /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. /// /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// small_flat_rate_box /// [JsonPropertyName("package_code"), JsonInclude] - public string? PackageCode { get; private set; } + public string? PackageCode { get; set; } /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("packages"), JsonInclude] - public List? Packages { get; private set; } + public List? Packages { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("paperless_download"), JsonInclude] - public PaperlessDownload? PaperlessDownload { get; private set; } + public PaperlessDownload? PaperlessDownload { get; set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("requested_comparison_amount"), JsonInclude] - public MonetaryValue? RequestedComparisonAmount { get; private set; } + public MonetaryValue? RequestedComparisonAmount { get; set; } /// /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. @@ -222,21 +267,27 @@ public partial class CreateReturnLabelResponseBody /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// usps_first_class_mail /// [JsonPropertyName("service_code"), JsonInclude] - public string? ServiceCode { get; private set; } + public string? ServiceCode { get; set; } /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date"), JsonInclude] - public DateTimeOffset? ShipDate { get; private set; } + public DateTimeOffset? ShipDate { get; set; } /// /// The shipment information used to generate the label @@ -249,24 +300,33 @@ public partial class CreateReturnLabelResponseBody /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipment_cost"), JsonInclude] - public MonetaryValue? ShipmentCost { get; private set; } + public MonetaryValue? ShipmentCost { get; set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// Gets or Sets Status /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("status"), JsonInclude] - public LabelStatus? Status { get; private set; } + public LabelStatus? Status { get; set; } /// /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. @@ -279,35 +339,47 @@ public partial class CreateReturnLabelResponseBody /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("trackable"), JsonInclude] - public bool? Trackable { get; private set; } + public bool? Trackable { get; set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. /// /// The tracking number for the package. Tracking number formats vary across carriers. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 782758401696 /// [JsonPropertyName("tracking_number"), JsonInclude] - public string? TrackingNumber { get; private set; } + public string? TrackingNumber { get; set; } /// /// The current status of the package, such as `in_transit` or `delivered` /// /// The current status of the package, such as `in_transit` or `delivered` + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tracking_status"), JsonInclude] - public TrackingStatus? TrackingStatus { get; private set; } + public TrackingStatus? TrackingStatus { get; set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url"), JsonInclude] - public string? TrackingUrl { get; private set; } + public string? TrackingUrl { get; set; } /// /// Gets or Sets ValidateAddress @@ -319,18 +391,24 @@ public partial class CreateReturnLabelResponseBody /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("voided"), JsonInclude] - public bool? Voided { get; private set; } + public bool? Voided { get; set; } /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("voided_at"), JsonInclude] - public DateTimeOffset? VoidedAt { get; private set; } + public DateTimeOffset? VoidedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs b/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs index 28271633..221a1121 100644 --- a/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs +++ b/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs @@ -39,8 +39,11 @@ public partial class CreateShipmentResponseBodyFields /// An array of errors that occurred while creating shipment. /// /// An array of errors that occurred while creating shipment. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("errors"), JsonInclude, Obsolete] - public List? Errors { get; private set; } + public List? Errors { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs b/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs index 82138812..83015a17 100644 --- a/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs +++ b/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs @@ -49,11 +49,14 @@ public partial class CreateWarehouseRequestBody /// Timestamp that indicates when the warehouse was created /// /// Timestamp that indicates when the warehouse was created + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2019-06-25T18:12:35.583Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// Designates which single warehouse is the default on the account @@ -73,11 +76,14 @@ public partial class CreateWarehouseRequestBody /// A string that uniquely identifies the warehouse /// /// A string that uniquely identifies the warehouse + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("warehouse_id"), JsonInclude] - public string? WarehouseId { get; private set; } + public string? WarehouseId { get; set; } /// diff --git a/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs b/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs index a0641429..94c4d242 100644 --- a/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs +++ b/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs @@ -32,11 +32,14 @@ public partial class CreateWarehouseResponseBody /// Timestamp that indicates when the warehouse was created /// /// Timestamp that indicates when the warehouse was created + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2019-06-25T18:12:35.583Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// Name of the warehouse @@ -66,11 +69,14 @@ public partial class CreateWarehouseResponseBody /// A string that uniquely identifies the warehouse /// /// A string that uniquely identifies the warehouse + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("warehouse_id"), JsonInclude] - public string? WarehouseId { get; private set; } + public string? WarehouseId { get; set; } /// /// Designates which single warehouse is the default on the account diff --git a/ShipEngineSDK/Model/CreateWebhookResponseBody.cs b/ShipEngineSDK/Model/CreateWebhookResponseBody.cs index a7387ce7..b33342b4 100644 --- a/ShipEngineSDK/Model/CreateWebhookResponseBody.cs +++ b/ShipEngineSDK/Model/CreateWebhookResponseBody.cs @@ -48,11 +48,14 @@ public partial class CreateWebhookResponseBody /// A string that uniquely identifies the webhook /// /// A string that uniquely identifies the webhook + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("webhook_id"), JsonInclude] - public string? WebhookId { get; private set; } + public string? WebhookId { get; set; } /// /// Array of custom webhook headers diff --git a/ShipEngineSDK/Model/CustomsItem.cs b/ShipEngineSDK/Model/CustomsItem.cs index af4a3dd5..c6677d48 100644 --- a/ShipEngineSDK/Model/CustomsItem.cs +++ b/ShipEngineSDK/Model/CustomsItem.cs @@ -32,11 +32,14 @@ public partial class CustomsItem /// A string that uniquely identifies the customs item /// /// A string that uniquely identifies the customs item + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("customs_item_id"), JsonInclude] - public string? CustomsItemId { get; private set; } + public string? CustomsItemId { get; set; } /// /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated diff --git a/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs b/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs index 31917652..11b50c0d 100644 --- a/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs +++ b/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs @@ -32,8 +32,11 @@ public partial class DeletePickupByIdResponseBody /// The errors associated with the failed API call /// /// The errors associated with the failed API call + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("errors"), JsonInclude] - public List? Errors { get; private set; } + public List? Errors { get; set; } /// /// Pickup Resource ID diff --git a/ShipEngineSDK/Model/DeprecatedManifest.cs b/ShipEngineSDK/Model/DeprecatedManifest.cs index d7ac4b7d..3c5a09b1 100644 --- a/ShipEngineSDK/Model/DeprecatedManifest.cs +++ b/ShipEngineSDK/Model/DeprecatedManifest.cs @@ -62,8 +62,11 @@ public partial class DeprecatedManifest /// An array of the label ids used in this manifest. /// /// An array of the label ids used in this manifest. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_ids"), JsonInclude, Obsolete] - public List? LabelIds { get; private set; } + public List? LabelIds { get; set; } /// /// Gets or Sets ManifestDownload @@ -95,11 +98,14 @@ public partial class DeprecatedManifest /// The number of shipments that are included in this manifest /// /// The number of shipments that are included in this manifest + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 100 /// [JsonPropertyName("shipments"), JsonInclude, Obsolete] - public int? Shipments { get; private set; } + public int? Shipments { get; set; } /// /// A string that uniquely identifies the submission diff --git a/ShipEngineSDK/Model/Error.cs b/ShipEngineSDK/Model/Error.cs index 7bda1a06..75435282 100644 --- a/ShipEngineSDK/Model/Error.cs +++ b/ShipEngineSDK/Model/Error.cs @@ -50,11 +50,14 @@ public partial class Error /// An error message associated with the failed API call /// /// An error message associated with the failed API call + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// Body of request cannot be null. /// [JsonPropertyName("message"), JsonInclude] - public string? Message { get; private set; } + public string? Message { get; set; } /// diff --git a/ShipEngineSDK/Model/ErrorResponseBody.cs b/ShipEngineSDK/Model/ErrorResponseBody.cs index 08735200..9ecf9021 100644 --- a/ShipEngineSDK/Model/ErrorResponseBody.cs +++ b/ShipEngineSDK/Model/ErrorResponseBody.cs @@ -32,8 +32,11 @@ public partial class ErrorResponseBody /// The errors associated with the failed API call /// /// The errors associated with the failed API call + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("errors"), JsonInclude] - public List? Errors { get; private set; } + public List? Errors { get; set; } /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur diff --git a/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs b/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs index 9cf4b452..392862e4 100644 --- a/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs +++ b/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs @@ -32,8 +32,11 @@ public partial class ErrorWithLabelIdResponseBody /// The errors associated with the failed API call /// /// The errors associated with the failed API call + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("errors"), JsonInclude] - public List? Errors { get; private set; } + public List? Errors { get; set; } /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur diff --git a/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs b/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs index 593753fe..782c88f4 100644 --- a/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs +++ b/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs @@ -92,11 +92,14 @@ public override bool CanConvert(Type typeToConvert) => /// The date and time that the image was created in ShipEngine. /// /// The date and time that the image was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The image type @@ -129,21 +132,27 @@ public override bool CanConvert(Type typeToConvert) => /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. /// /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// img_DtBXupDBxREpHnwEXhTfgK /// [JsonPropertyName("label_image_id"), JsonInclude] - public string? LabelImageId { get; private set; } + public string? LabelImageId { get; set; } /// /// The date and time that the image was modified in ShipEngine. /// /// The date and time that the image was modified in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at"), JsonInclude] - public DateTimeOffset? ModifiedAt { get; private set; } + public DateTimeOffset? ModifiedAt { get; set; } /// /// A human readable name for the image. diff --git a/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs b/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs index 415c5d24..8afaa155 100644 --- a/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs @@ -32,18 +32,24 @@ public partial class GetBatchByExternalIdResponseBody /// Link to batch errors endpoint /// /// Link to batch errors endpoint + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("batch_errors_url"), JsonInclude] - public OptionalLink? BatchErrorsUrl { get; private set; } + public OptionalLink? BatchErrorsUrl { get; set; } /// /// A string that uniquely identifies the batch /// /// A string that uniquely identifies the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("batch_id"), JsonInclude] - public string? BatchId { get; private set; } + public string? BatchId { get; set; } /// /// Link to batch labels query @@ -56,8 +62,11 @@ public partial class GetBatchByExternalIdResponseBody /// The batch number. /// /// The batch number. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("batch_number"), JsonInclude] - public string? BatchNumber { get; private set; } + public string? BatchNumber { get; set; } /// /// The batch shipments endpoint @@ -70,135 +79,183 @@ public partial class GetBatchByExternalIdResponseBody /// The number of labels generated in the batch /// /// The number of labels generated in the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 1 /// [JsonPropertyName("completed"), JsonInclude] - public int? Completed { get; private set; } + public int? Completed { get; set; } /// /// The total of errors, warnings, and completed properties /// /// The total of errors, warnings, and completed properties + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2 /// [JsonPropertyName("count"), JsonInclude] - public int? Count { get; private set; } + public int? Count { get; set; } /// /// The date and time the batch was created in ShipEngine /// /// The date and time the batch was created in ShipEngine + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The number of errors that occurred while generating the batch /// /// The number of errors that occurred while generating the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2 /// [JsonPropertyName("errors"), JsonInclude] - public int? Errors { get; private set; } + public int? Errors { get; set; } /// /// The form download for any customs that are needed /// /// The form download for any customs that are needed + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("form_download"), JsonInclude] - public OptionalLink? FormDownload { get; private set; } + public OptionalLink? FormDownload { get; set; } /// /// The number of forms for customs that are available for download /// /// The number of forms for customs that are available for download + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 3 /// [JsonPropertyName("forms"), JsonInclude] - public int? Forms { get; private set; } + public int? Forms { get; set; } /// /// The label download for the batch /// /// The label download for the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_download"), JsonInclude] - public LabelDownload? LabelDownload { get; private set; } + public LabelDownload? LabelDownload { get; set; } /// /// Gets or Sets LabelFormat /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_format"), JsonInclude] - public LabelFormat? LabelFormat { get; private set; } + public LabelFormat? LabelFormat { get; set; } /// /// label layout /// /// label layout + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_layout"), JsonInclude] - public LabelLayout? LabelLayout { get; private set; } + public LabelLayout? LabelLayout { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("paperless_download"), JsonInclude] - public PaperlessDownload? PaperlessDownload { get; private set; } + public PaperlessDownload? PaperlessDownload { get; set; } /// /// The errors associated with the failed API call /// /// The errors associated with the failed API call + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("process_errors"), JsonInclude] - public List? ProcessErrors { get; private set; } + public List? ProcessErrors { get; set; } /// /// Gets or Sets Status /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("status"), JsonInclude] - public BatchStatus? Status { get; private set; } + public BatchStatus? Status { get; set; } /// /// The number of warnings that occurred while generating the batch /// /// The number of warnings that occurred while generating the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 1 /// [JsonPropertyName("warnings"), JsonInclude] - public int? Warnings { get; private set; } + public int? Warnings { get; set; } /// /// Custom notes you can add for each created batch /// /// Custom notes you can add for each created batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// Batch for morning shipment /// [JsonPropertyName("batch_notes"), JsonInclude] - public string? BatchNotes { get; private set; } + public string? BatchNotes { get; set; } /// /// A string that uniquely identifies the external batch /// /// A string that uniquely identifies the external batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("external_batch_id"), JsonInclude] - public string? ExternalBatchId { get; private set; } + public string? ExternalBatchId { get; set; } /// /// The date and time the batch was processed in ShipEngine /// /// The date and time the batch was processed in ShipEngine + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("processed_at"), JsonInclude] - public DateTimeOffset? ProcessedAt { get; private set; } + public DateTimeOffset? ProcessedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs b/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs index a90a3a0c..3f220a68 100644 --- a/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs @@ -32,18 +32,24 @@ public partial class GetBatchByIdResponseBody /// Link to batch errors endpoint /// /// Link to batch errors endpoint + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("batch_errors_url"), JsonInclude] - public OptionalLink? BatchErrorsUrl { get; private set; } + public OptionalLink? BatchErrorsUrl { get; set; } /// /// A string that uniquely identifies the batch /// /// A string that uniquely identifies the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("batch_id"), JsonInclude] - public string? BatchId { get; private set; } + public string? BatchId { get; set; } /// /// Link to batch labels query @@ -56,8 +62,11 @@ public partial class GetBatchByIdResponseBody /// The batch number. /// /// The batch number. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("batch_number"), JsonInclude] - public string? BatchNumber { get; private set; } + public string? BatchNumber { get; set; } /// /// The batch shipments endpoint @@ -70,135 +79,183 @@ public partial class GetBatchByIdResponseBody /// The number of labels generated in the batch /// /// The number of labels generated in the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 1 /// [JsonPropertyName("completed"), JsonInclude] - public int? Completed { get; private set; } + public int? Completed { get; set; } /// /// The total of errors, warnings, and completed properties /// /// The total of errors, warnings, and completed properties + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2 /// [JsonPropertyName("count"), JsonInclude] - public int? Count { get; private set; } + public int? Count { get; set; } /// /// The date and time the batch was created in ShipEngine /// /// The date and time the batch was created in ShipEngine + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The number of errors that occurred while generating the batch /// /// The number of errors that occurred while generating the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2 /// [JsonPropertyName("errors"), JsonInclude] - public int? Errors { get; private set; } + public int? Errors { get; set; } /// /// The form download for any customs that are needed /// /// The form download for any customs that are needed + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("form_download"), JsonInclude] - public OptionalLink? FormDownload { get; private set; } + public OptionalLink? FormDownload { get; set; } /// /// The number of forms for customs that are available for download /// /// The number of forms for customs that are available for download + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 3 /// [JsonPropertyName("forms"), JsonInclude] - public int? Forms { get; private set; } + public int? Forms { get; set; } /// /// The label download for the batch /// /// The label download for the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_download"), JsonInclude] - public LabelDownload? LabelDownload { get; private set; } + public LabelDownload? LabelDownload { get; set; } /// /// Gets or Sets LabelFormat /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_format"), JsonInclude] - public LabelFormat? LabelFormat { get; private set; } + public LabelFormat? LabelFormat { get; set; } /// /// label layout /// /// label layout + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_layout"), JsonInclude] - public LabelLayout? LabelLayout { get; private set; } + public LabelLayout? LabelLayout { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("paperless_download"), JsonInclude] - public PaperlessDownload? PaperlessDownload { get; private set; } + public PaperlessDownload? PaperlessDownload { get; set; } /// /// The errors associated with the failed API call /// /// The errors associated with the failed API call + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("process_errors"), JsonInclude] - public List? ProcessErrors { get; private set; } + public List? ProcessErrors { get; set; } /// /// Gets or Sets Status /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("status"), JsonInclude] - public BatchStatus? Status { get; private set; } + public BatchStatus? Status { get; set; } /// /// The number of warnings that occurred while generating the batch /// /// The number of warnings that occurred while generating the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 1 /// [JsonPropertyName("warnings"), JsonInclude] - public int? Warnings { get; private set; } + public int? Warnings { get; set; } /// /// Custom notes you can add for each created batch /// /// Custom notes you can add for each created batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// Batch for morning shipment /// [JsonPropertyName("batch_notes"), JsonInclude] - public string? BatchNotes { get; private set; } + public string? BatchNotes { get; set; } /// /// A string that uniquely identifies the external batch /// /// A string that uniquely identifies the external batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("external_batch_id"), JsonInclude] - public string? ExternalBatchId { get; private set; } + public string? ExternalBatchId { get; set; } /// /// The date and time the batch was processed in ShipEngine /// /// The date and time the batch was processed in ShipEngine + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("processed_at"), JsonInclude] - public DateTimeOffset? ProcessedAt { get; private set; } + public DateTimeOffset? ProcessedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs b/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs index 4c249bae..d11dc0e3 100644 --- a/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs @@ -32,117 +32,159 @@ public partial class GetCarrierByIdResponseBody /// The account number that the carrier is connected to. /// /// The account number that the carrier is connected to. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// account_570827 /// [JsonPropertyName("account_number"), JsonInclude] - public string? AccountNumber { get; private set; } + public string? AccountNumber { get; set; } /// /// Current available balance /// /// Current available balance + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 3799.52 /// [JsonPropertyName("balance"), JsonInclude] - public double? Balance { get; private set; } + public double? Balance { get; set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// dhl_express /// [JsonPropertyName("carrier_code"), JsonInclude] - public string? CarrierCode { get; private set; } + public string? CarrierCode { get; set; } /// /// A string that uniquely identifies the carrier. /// /// A string that uniquely identifies the carrier. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// The carrier is disabled by the current ShipEngine account's billing plan. /// /// The carrier is disabled by the current ShipEngine account's billing plan. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("disabled_by_billing_plan"), JsonInclude] - public bool? DisabledByBillingPlan { get; private set; } + public bool? DisabledByBillingPlan { get; set; } /// /// Screen readable name /// /// Screen readable name + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// Stamps.com /// [JsonPropertyName("friendly_name"), JsonInclude] - public string? FriendlyName { get; private set; } + public string? FriendlyName { get; set; } /// /// Carrier supports multiple packages per shipment /// /// Carrier supports multiple packages per shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("has_multi_package_supporting_services"), JsonInclude] - public bool? HasMultiPackageSupportingServices { get; private set; } + public bool? HasMultiPackageSupportingServices { get; set; } /// /// Nickname given to the account when initially setting up the carrier. /// /// Nickname given to the account when initially setting up the carrier. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// ShipEngine Account - Stamps.com /// [JsonPropertyName("nickname"), JsonInclude] - public string? Nickname { get; private set; } + public string? Nickname { get; set; } /// /// A list of options that are available to that carrier /// /// A list of options that are available to that carrier + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("options"), JsonInclude] - public List? Options { get; private set; } + public List? Options { get; set; } /// /// A list of package types that are supported by the carrier /// /// A list of package types that are supported by the carrier + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("packages"), JsonInclude] - public List? Packages { get; private set; } + public List? Packages { get; set; } /// /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation /// /// Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("primary"), JsonInclude] - public bool? Primary { get; private set; } + public bool? Primary { get; set; } /// /// Indicates whether the carrier requires funding to use its services /// /// Indicates whether the carrier requires funding to use its services + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("requires_funded_amount"), JsonInclude] - public bool? RequiresFundedAmount { get; private set; } + public bool? RequiresFundedAmount { get; set; } /// /// A list of services that are offered by the carrier /// /// A list of services that are offered by the carrier + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("services"), JsonInclude] - public List? Services { get; private set; } + public List? Services { get; set; } /// /// The carrier supports adding custom label messages to an order. /// /// The carrier supports adding custom label messages to an order. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("supports_label_messages"), JsonInclude] - public bool? SupportsLabelMessages { get; private set; } + public bool? SupportsLabelMessages { get; set; } /// diff --git a/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs b/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs index 79a5aeac..e4b4fb2d 100644 --- a/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs @@ -32,8 +32,11 @@ public partial class GetCarrierOptionsResponseBody /// AN array of carrier options /// /// AN array of carrier options + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("options"), JsonInclude] - public List? Options { get; private set; } + public List? Options { get; set; } /// diff --git a/ShipEngineSDK/Model/GetCarriersResponseBody.cs b/ShipEngineSDK/Model/GetCarriersResponseBody.cs index 2b9ade8c..81f50d50 100644 --- a/ShipEngineSDK/Model/GetCarriersResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarriersResponseBody.cs @@ -32,15 +32,21 @@ public partial class GetCarriersResponseBody /// The carrier response body /// /// The carrier response body + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("carriers"), JsonInclude] - public List? Carriers { get; private set; } + public List? Carriers { get; set; } /// /// The errors associated with the failed API call /// /// The errors associated with the failed API call + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("errors"), JsonInclude] - public List? Errors { get; private set; } + public List? Errors { get; set; } /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur diff --git a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs index a947f009..99e9c245 100644 --- a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs @@ -32,38 +32,50 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// Additional information some carriers may provide by which to identify a given label in their system. /// /// Additional information some carriers may provide by which to identify a given label in their system. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("alternative_identifiers"), JsonInclude] - public List? AlternativeIdentifiers { get; private set; } + public List? AlternativeIdentifiers { get; set; } /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("batch_id"), JsonInclude] - public string? BatchId { get; private set; } + public string? BatchId { get; set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// dhl_express /// [JsonPropertyName("carrier_code"), JsonInclude] - public string? CarrierCode { get; private set; } + public string? CarrierCode { get; set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// The label charge event. @@ -76,11 +88,14 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// The date and time that the label was created in ShipEngine. /// /// The date and time that the label was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The display format that the label should be shown in. @@ -93,29 +108,41 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// 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. /// /// 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. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("form_download"), JsonInclude] - public Link? FormDownload { get; private set; } + public Link? FormDownload { get; set; } /// /// 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. /// /// 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. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("insurance_claim"), JsonInclude] - public Link? InsuranceClaim { get; private set; } + public Link? InsuranceClaim { get; set; } /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("insurance_cost"), JsonInclude] - public MonetaryValue? InsuranceCost { get; private set; } + public MonetaryValue? InsuranceCost { get; set; } /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("is_international"), JsonInclude] - public bool? IsInternational { get; private set; } + public bool? IsInternational { get; set; } /// /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. @@ -127,8 +154,11 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// Gets or Sets LabelDownload /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_download"), JsonInclude] - public LabelDownload? LabelDownload { get; private set; } + public LabelDownload? LabelDownload { get; set; } /// /// Gets or Sets LabelDownloadType @@ -147,11 +177,14 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("label_id"), JsonInclude] - public string? LabelId { get; private set; } + public string? LabelId { get; set; } /// /// The label image resource that was used to create a custom label image. @@ -184,32 +217,44 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. /// /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// small_flat_rate_box /// [JsonPropertyName("package_code"), JsonInclude] - public string? PackageCode { get; private set; } + public string? PackageCode { get; set; } /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("packages"), JsonInclude] - public List? Packages { get; private set; } + public List? Packages { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("paperless_download"), JsonInclude] - public PaperlessDownload? PaperlessDownload { get; private set; } + public PaperlessDownload? PaperlessDownload { get; set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("requested_comparison_amount"), JsonInclude] - public MonetaryValue? RequestedComparisonAmount { get; private set; } + public MonetaryValue? RequestedComparisonAmount { get; set; } /// /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. @@ -222,21 +267,27 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// usps_first_class_mail /// [JsonPropertyName("service_code"), JsonInclude] - public string? ServiceCode { get; private set; } + public string? ServiceCode { get; set; } /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date"), JsonInclude] - public DateTimeOffset? ShipDate { get; private set; } + public DateTimeOffset? ShipDate { get; set; } /// /// The shipment information used to generate the label @@ -249,24 +300,33 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipment_cost"), JsonInclude] - public MonetaryValue? ShipmentCost { get; private set; } + public MonetaryValue? ShipmentCost { get; set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// Gets or Sets Status /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("status"), JsonInclude] - public LabelStatus? Status { get; private set; } + public LabelStatus? Status { get; set; } /// /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. @@ -279,35 +339,47 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("trackable"), JsonInclude] - public bool? Trackable { get; private set; } + public bool? Trackable { get; set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. /// /// The tracking number for the package. Tracking number formats vary across carriers. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 782758401696 /// [JsonPropertyName("tracking_number"), JsonInclude] - public string? TrackingNumber { get; private set; } + public string? TrackingNumber { get; set; } /// /// The current status of the package, such as `in_transit` or `delivered` /// /// The current status of the package, such as `in_transit` or `delivered` + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tracking_status"), JsonInclude] - public TrackingStatus? TrackingStatus { get; private set; } + public TrackingStatus? TrackingStatus { get; set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url"), JsonInclude] - public string? TrackingUrl { get; private set; } + public string? TrackingUrl { get; set; } /// /// Gets or Sets ValidateAddress @@ -319,18 +391,24 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("voided"), JsonInclude] - public bool? Voided { get; private set; } + public bool? Voided { get; set; } /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("voided_at"), JsonInclude] - public DateTimeOffset? VoidedAt { get; private set; } + public DateTimeOffset? VoidedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs index c0ee4ccf..270b4886 100644 --- a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs @@ -32,38 +32,50 @@ public partial class GetLabelByIdResponseBody /// Additional information some carriers may provide by which to identify a given label in their system. /// /// Additional information some carriers may provide by which to identify a given label in their system. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("alternative_identifiers"), JsonInclude] - public List? AlternativeIdentifiers { get; private set; } + public List? AlternativeIdentifiers { get; set; } /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("batch_id"), JsonInclude] - public string? BatchId { get; private set; } + public string? BatchId { get; set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// dhl_express /// [JsonPropertyName("carrier_code"), JsonInclude] - public string? CarrierCode { get; private set; } + public string? CarrierCode { get; set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// The label charge event. @@ -76,11 +88,14 @@ public partial class GetLabelByIdResponseBody /// The date and time that the label was created in ShipEngine. /// /// The date and time that the label was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The display format that the label should be shown in. @@ -93,29 +108,41 @@ public partial class GetLabelByIdResponseBody /// 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. /// /// 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. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("form_download"), JsonInclude] - public Link? FormDownload { get; private set; } + public Link? FormDownload { get; set; } /// /// 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. /// /// 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. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("insurance_claim"), JsonInclude] - public Link? InsuranceClaim { get; private set; } + public Link? InsuranceClaim { get; set; } /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("insurance_cost"), JsonInclude] - public MonetaryValue? InsuranceCost { get; private set; } + public MonetaryValue? InsuranceCost { get; set; } /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("is_international"), JsonInclude] - public bool? IsInternational { get; private set; } + public bool? IsInternational { get; set; } /// /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. @@ -127,8 +154,11 @@ public partial class GetLabelByIdResponseBody /// /// Gets or Sets LabelDownload /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_download"), JsonInclude] - public LabelDownload? LabelDownload { get; private set; } + public LabelDownload? LabelDownload { get; set; } /// /// Gets or Sets LabelDownloadType @@ -147,11 +177,14 @@ public partial class GetLabelByIdResponseBody /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("label_id"), JsonInclude] - public string? LabelId { get; private set; } + public string? LabelId { get; set; } /// /// The label image resource that was used to create a custom label image. @@ -184,32 +217,44 @@ public partial class GetLabelByIdResponseBody /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. /// /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// small_flat_rate_box /// [JsonPropertyName("package_code"), JsonInclude] - public string? PackageCode { get; private set; } + public string? PackageCode { get; set; } /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("packages"), JsonInclude] - public List? Packages { get; private set; } + public List? Packages { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("paperless_download"), JsonInclude] - public PaperlessDownload? PaperlessDownload { get; private set; } + public PaperlessDownload? PaperlessDownload { get; set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("requested_comparison_amount"), JsonInclude] - public MonetaryValue? RequestedComparisonAmount { get; private set; } + public MonetaryValue? RequestedComparisonAmount { get; set; } /// /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. @@ -222,21 +267,27 @@ public partial class GetLabelByIdResponseBody /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// usps_first_class_mail /// [JsonPropertyName("service_code"), JsonInclude] - public string? ServiceCode { get; private set; } + public string? ServiceCode { get; set; } /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date"), JsonInclude] - public DateTimeOffset? ShipDate { get; private set; } + public DateTimeOffset? ShipDate { get; set; } /// /// The shipment information used to generate the label @@ -249,24 +300,33 @@ public partial class GetLabelByIdResponseBody /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipment_cost"), JsonInclude] - public MonetaryValue? ShipmentCost { get; private set; } + public MonetaryValue? ShipmentCost { get; set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// Gets or Sets Status /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("status"), JsonInclude] - public LabelStatus? Status { get; private set; } + public LabelStatus? Status { get; set; } /// /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. @@ -279,35 +339,47 @@ public partial class GetLabelByIdResponseBody /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("trackable"), JsonInclude] - public bool? Trackable { get; private set; } + public bool? Trackable { get; set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. /// /// The tracking number for the package. Tracking number formats vary across carriers. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 782758401696 /// [JsonPropertyName("tracking_number"), JsonInclude] - public string? TrackingNumber { get; private set; } + public string? TrackingNumber { get; set; } /// /// The current status of the package, such as `in_transit` or `delivered` /// /// The current status of the package, such as `in_transit` or `delivered` + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tracking_status"), JsonInclude] - public TrackingStatus? TrackingStatus { get; private set; } + public TrackingStatus? TrackingStatus { get; set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url"), JsonInclude] - public string? TrackingUrl { get; private set; } + public string? TrackingUrl { get; set; } /// /// Gets or Sets ValidateAddress @@ -319,18 +391,24 @@ public partial class GetLabelByIdResponseBody /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("voided"), JsonInclude] - public bool? Voided { get; private set; } + public bool? Voided { get; set; } /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("voided_at"), JsonInclude] - public DateTimeOffset? VoidedAt { get; private set; } + public DateTimeOffset? VoidedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs b/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs index 00bcd1d0..bb3f7069 100644 --- a/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs @@ -32,94 +32,124 @@ public partial class GetManifestByIdResponseBody /// A string that uniquely identifies the carrier /// /// A string that uniquely identifies the carrier + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// The date-time that the manifest was created /// /// The date-time that the manifest was created + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2019-07-12T13:37:39.050Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// A string that uniquely identifies the form /// /// A string that uniquely identifies the form + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("form_id"), JsonInclude] - public string? FormId { get; private set; } + public string? FormId { get; set; } /// /// An array of the label ids used in this manifest. /// /// An array of the label ids used in this manifest. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_ids"), JsonInclude] - public List? LabelIds { get; private set; } + public List? LabelIds { get; set; } /// /// Gets or Sets ManifestDownload /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("manifest_download"), JsonInclude] - public ManifestDownload? ManifestDownload { get; private set; } + public ManifestDownload? ManifestDownload { get; set; } /// /// A string that uniquely identifies the manifest /// /// A string that uniquely identifies the manifest + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("manifest_id"), JsonInclude] - public string? ManifestId { get; private set; } + public string? ManifestId { get; set; } /// /// The date-time that the manifests shipments will be picked up /// /// The date-time that the manifests shipments will be picked up + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2019-07-12T13:37:39.050Z /// [JsonPropertyName("ship_date"), JsonInclude] - public DateTimeOffset? ShipDate { get; private set; } + public DateTimeOffset? ShipDate { get; set; } /// /// The number of shipments that are included in this manifest /// /// The number of shipments that are included in this manifest + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 100 /// [JsonPropertyName("shipments"), JsonInclude] - public int? Shipments { get; private set; } + public int? Shipments { get; set; } /// /// A string that uniquely identifies the submission /// /// A string that uniquely identifies the submission + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 9475711899564878915476 /// [JsonPropertyName("submission_id"), JsonInclude] - public string? SubmissionId { get; private set; } + public string? SubmissionId { get; set; } /// /// A string that uniquely identifies the warehouse /// /// A string that uniquely identifies the warehouse + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("warehouse_id"), JsonInclude] - public string? WarehouseId { get; private set; } + public string? WarehouseId { get; set; } /// diff --git a/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs b/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs index 741d59f3..62a03adc 100644 --- a/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs @@ -32,11 +32,14 @@ public partial class GetPickupByIdResponseBody /// The carrier_id associated with the pickup /// /// The carrier_id associated with the pickup + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// Gets or Sets ContactDetails @@ -48,18 +51,24 @@ public partial class GetPickupByIdResponseBody /// The date and time that the pickup was created in ShipEngine. /// /// The date and time that the pickup was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The errors associated with the failed API call /// /// The errors associated with the failed API call + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("errors"), JsonInclude] - public List? Errors { get; private set; } + public List? Errors { get; set; } /// /// Label IDs that will be included in the pickup request @@ -71,18 +80,24 @@ public partial class GetPickupByIdResponseBody /// /// Gets or Sets PickupAddress /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("pickup_address"), JsonInclude] - public Address? PickupAddress { get; private set; } + public Address? PickupAddress { get; set; } /// /// Pickup Resource ID /// /// Pickup Resource ID + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// pik_3YcKU5zdtJuCqoeNwyqqbW /// [JsonPropertyName("pickup_id"), JsonInclude] - public string? PickupId { get; private set; } + public string? PickupId { get; set; } /// /// Gets or Sets PickupWindow @@ -104,31 +119,40 @@ public partial class GetPickupByIdResponseBody /// The warehouse_id associated with the pickup /// /// The warehouse_id associated with the pickup + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("warehouse_id"), JsonInclude] - public string? WarehouseId { get; private set; } + public string? WarehouseId { get; set; } /// /// The date and time that the pickup was cancelled in ShipEngine. /// /// The date and time that the pickup was cancelled in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("cancelled_at"), JsonInclude] - public DateTimeOffset? CancelledAt { get; private set; } + public DateTimeOffset? CancelledAt { get; set; } /// /// The carrier confirmation number for the scheduled pickup. /// /// The carrier confirmation number for the scheduled pickup. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 292513CL4A3 /// [JsonPropertyName("confirmation_number"), JsonInclude] - public string? ConfirmationNumber { get; private set; } + public string? ConfirmationNumber { get; set; } /// /// Used by some carriers to give special instructions for a package pickup @@ -141,8 +165,11 @@ public partial class GetPickupByIdResponseBody /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("pickup_windows"), JsonInclude] - public List? PickupWindows { get; private set; } + public List? PickupWindows { get; set; } /// diff --git a/ShipEngineSDK/Model/GetPickupsResponseBody.cs b/ShipEngineSDK/Model/GetPickupsResponseBody.cs index 8b2e81e9..02c83768 100644 --- a/ShipEngineSDK/Model/GetPickupsResponseBody.cs +++ b/ShipEngineSDK/Model/GetPickupsResponseBody.cs @@ -32,35 +32,47 @@ public partial class GetPickupsResponseBody /// The errors associated with the failed API call /// /// The errors associated with the failed API call + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("errors"), JsonInclude] - public List? Errors { get; private set; } + public List? Errors { get; set; } /// /// Helpful links to other pages of results /// /// Helpful links to other pages of results + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("links"), JsonInclude] - public PaginationLink? Links { get; private set; } + public PaginationLink? Links { get; set; } /// /// Current page of the list pickups results /// /// Current page of the list pickups results + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 3 /// [JsonPropertyName("page"), JsonInclude] - public int? Page { get; private set; } + public int? Page { get; set; } /// /// Total number of pages for list pickups results /// /// Total number of pages for list pickups results + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 4 /// [JsonPropertyName("pages"), JsonInclude] - public int? Pages { get; private set; } + public int? Pages { get; set; } /// /// An array of pickups associated with the user's account. @@ -83,11 +95,14 @@ public partial class GetPickupsResponseBody /// The total number of pickups returned /// /// The total number of pickups returned + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 3 /// [JsonPropertyName("total"), JsonInclude] - public long? Total { get; private set; } + public long? Total { get; set; } /// diff --git a/ShipEngineSDK/Model/GetRateByIdResponseBody.cs b/ShipEngineSDK/Model/GetRateByIdResponseBody.cs index 9044ef20..6511ded9 100644 --- a/ShipEngineSDK/Model/GetRateByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetRateByIdResponseBody.cs @@ -32,199 +32,277 @@ public partial class GetRateByIdResponseBody /// carrier code /// /// carrier code + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("carrier_code"), JsonInclude] - public string? CarrierCode { get; private set; } + public string? CarrierCode { get; set; } /// /// carrier friendly name /// /// carrier friendly name + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("carrier_friendly_name"), JsonInclude] - public string? CarrierFriendlyName { get; private set; } + public string? CarrierFriendlyName { get; set; } /// /// A string that uniquely identifies the carrier /// /// A string that uniquely identifies the carrier + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// carrier nickname /// /// carrier nickname + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("carrier_nickname"), JsonInclude] - public string? CarrierNickname { get; private set; } + public string? CarrierNickname { get; set; } /// /// The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price. /// /// The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("confirmation_amount"), JsonInclude] - public MonetaryValue? ConfirmationAmount { get; private set; } + public MonetaryValue? ConfirmationAmount { get; set; } /// /// The error messages /// /// The error messages + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("error_messages"), JsonInclude] - public List? ErrorMessages { get; private set; } + public List? ErrorMessages { get; set; } /// /// Indicates if the rate is guaranteed. /// /// Indicates if the rate is guaranteed. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("guaranteed_service"), JsonInclude] - public bool? GuaranteedService { get; private set; } + public bool? GuaranteedService { get; set; } /// /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. /// /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("insurance_amount"), JsonInclude] - public MonetaryValue? InsuranceAmount { get; private set; } + public MonetaryValue? InsuranceAmount { get; set; } /// /// Indicates if the rates been negotiated /// /// Indicates if the rates been negotiated + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("negotiated_rate"), JsonInclude] - public bool? NegotiatedRate { get; private set; } + public bool? NegotiatedRate { get; set; } /// /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. /// /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("other_amount"), JsonInclude] - public MonetaryValue? OtherAmount { get; private set; } + public MonetaryValue? OtherAmount { get; set; } /// /// A string that uniquely identifies the rate /// /// A string that uniquely identifies the rate + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("rate_id"), JsonInclude] - public string? RateId { get; private set; } + public string? RateId { get; set; } /// /// Gets or Sets RateType /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("rate_type"), JsonInclude] - public RateType? RateType { get; private set; } + public RateType? RateType { get; set; } /// /// service code for the rate /// /// service code for the rate + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("service_code"), JsonInclude] - public string? ServiceCode { get; private set; } + public string? ServiceCode { get; set; } /// /// service type /// /// service type + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("service_type"), JsonInclude] - public string? ServiceType { get; private set; } + public string? ServiceType { get; set; } /// /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. /// /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipping_amount"), JsonInclude] - public MonetaryValue? ShippingAmount { get; private set; } + public MonetaryValue? ShippingAmount { get; set; } /// /// Indicates if rate is trackable /// /// Indicates if rate is trackable + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("trackable"), JsonInclude] - public bool? Trackable { get; private set; } + public bool? Trackable { get; set; } /// /// Gets or Sets ValidationStatus /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("validation_status"), JsonInclude] - public ValidationStatus? ValidationStatus { get; private set; } + public ValidationStatus? ValidationStatus { get; set; } /// /// The warning messages /// /// The warning messages + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("warning_messages"), JsonInclude] - public List? WarningMessages { get; private set; } + public List? WarningMessages { get; set; } /// /// The carrier delivery days /// /// The carrier delivery days + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("carrier_delivery_days"), JsonInclude] - public string? CarrierDeliveryDays { get; private set; } + public string? CarrierDeliveryDays { get; set; } /// /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday /// /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 5 /// [JsonPropertyName("delivery_days"), JsonInclude] - public int? DeliveryDays { get; private set; } + public int? DeliveryDays { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T00:00Z /// [JsonPropertyName("estimated_delivery_date"), JsonInclude] - public DateTimeOffset? EstimatedDeliveryDate { get; private set; } + public DateTimeOffset? EstimatedDeliveryDate { get; set; } /// /// package type that this rate was estimated for /// /// package type that this rate was estimated for + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// package /// [JsonPropertyName("package_type"), JsonInclude] - public string? PackageType { get; private set; } + public string? PackageType { get; set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("requested_comparison_amount"), JsonInclude] - public MonetaryValue? RequestedComparisonAmount { get; private set; } + public MonetaryValue? RequestedComparisonAmount { get; set; } /// /// ship date /// /// ship date + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("ship_date"), JsonInclude] - public DateTimeOffset? ShipDate { get; private set; } + public DateTimeOffset? ShipDate { get; set; } /// /// Tariff and additional taxes associated with an international shipment. /// /// Tariff and additional taxes associated with an international shipment. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tax_amount"), JsonInclude] - public MonetaryValue? TaxAmount { get; private set; } + public MonetaryValue? TaxAmount { get; set; } /// /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location /// /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 6 /// [JsonPropertyName("zone"), JsonInclude] - public int? Zone { get; private set; } + public int? Zone { get; set; } /// diff --git a/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs b/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs index 9486ea6e..a2f18351 100644 --- a/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs @@ -56,11 +56,14 @@ public partial class GetShipmentByExternalIdResponseBody /// The date and time that the shipment was created in ShipEngine. /// /// The date and time that the shipment was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The insurance provider to use for any insured packages in the shipment. @@ -73,11 +76,14 @@ public partial class GetShipmentByExternalIdResponseBody /// The date and time that the shipment was created or last modified. /// /// The date and time that the shipment was created or last modified. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at"), JsonInclude] - public DateTimeOffset? ModifiedAt { get; private set; } + public DateTimeOffset? ModifiedAt { get; set; } /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. @@ -131,32 +137,44 @@ public partial class GetShipmentByExternalIdResponseBody /// A string that uniquely identifies the shipment /// /// A string that uniquely identifies the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// The current status of the shipment /// /// The current status of the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipment_status"), JsonInclude] - public ShipmentStatus? ShipmentStatus { get; private set; } + public ShipmentStatus? ShipmentStatus { get; set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tags"), JsonInclude] - public List? Tags { get; private set; } + public List? Tags { get; set; } /// /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("total_weight"), JsonInclude] - public Weight? TotalWeight { get; private set; } + public Weight? TotalWeight { get; set; } /// /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. diff --git a/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs b/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs index e560a275..a867b372 100644 --- a/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs @@ -56,11 +56,14 @@ public partial class GetShipmentByIdResponseBody /// The date and time that the shipment was created in ShipEngine. /// /// The date and time that the shipment was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The insurance provider to use for any insured packages in the shipment. @@ -73,11 +76,14 @@ public partial class GetShipmentByIdResponseBody /// The date and time that the shipment was created or last modified. /// /// The date and time that the shipment was created or last modified. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at"), JsonInclude] - public DateTimeOffset? ModifiedAt { get; private set; } + public DateTimeOffset? ModifiedAt { get; set; } /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. @@ -131,32 +137,44 @@ public partial class GetShipmentByIdResponseBody /// A string that uniquely identifies the shipment /// /// A string that uniquely identifies the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// The current status of the shipment /// /// The current status of the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipment_status"), JsonInclude] - public ShipmentStatus? ShipmentStatus { get; private set; } + public ShipmentStatus? ShipmentStatus { get; set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tags"), JsonInclude] - public List? Tags { get; private set; } + public List? Tags { get; set; } /// /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("total_weight"), JsonInclude] - public Weight? TotalWeight { get; private set; } + public Weight? TotalWeight { get; set; } /// /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. diff --git a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs index 564f1f5a..90451270 100644 --- a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs @@ -32,11 +32,14 @@ public partial class GetTrackingLogFromLabelResponseBody /// Carrier status code /// /// Carrier status code + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 1 /// [JsonPropertyName("carrier_status_code"), JsonInclude] - public string? CarrierStatusCode { get; private set; } + public string? CarrierStatusCode { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -52,8 +55,11 @@ public partial class GetTrackingLogFromLabelResponseBody /// The events that have occured during the lifetime of this tracking number. /// /// The events that have occured during the lifetime of this tracking number. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("events"), JsonInclude] - public List? Events { get; private set; } + public List? Events { get; set; } /// /// Gets or Sets StatusCode @@ -95,11 +101,14 @@ public partial class GetTrackingLogFromLabelResponseBody /// Carrier detail code /// /// Carrier detail code + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// OT /// [JsonPropertyName("carrier_detail_code"), JsonInclude] - public string? CarrierDetailCode { get; private set; } + public string? CarrierDetailCode { get; set; } /// /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. @@ -115,18 +124,24 @@ public partial class GetTrackingLogFromLabelResponseBody /// carrier status description /// /// carrier status description + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// Your item was delivered in or at the mailbox at 9:10 am on March /// [JsonPropertyName("carrier_status_description"), JsonInclude] - public string? CarrierStatusDescription { get; private set; } + public string? CarrierStatusDescription { get; set; } /// /// Exception description /// /// Exception description + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("exception_description"), JsonInclude] - public string? ExceptionDescription { get; private set; } + public string? ExceptionDescription { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -142,21 +157,27 @@ public partial class GetTrackingLogFromLabelResponseBody /// Status description /// /// Status description + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// Delivered /// [JsonPropertyName("status_description"), JsonInclude] - public string? StatusDescription { get; private set; } + public string? StatusDescription { get; set; } /// /// Carrier Tracking Url, if available /// /// Carrier Tracking Url, if available + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url"), JsonInclude] - public string? TrackingUrl { get; private set; } + public string? TrackingUrl { get; set; } /// diff --git a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs index a885e661..a2820a4e 100644 --- a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs @@ -42,11 +42,14 @@ public partial class GetTrackingLogResponseBody /// Carrier detail code /// /// Carrier detail code + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// OT /// [JsonPropertyName("carrier_detail_code"), JsonInclude] - public string? CarrierDetailCode { get; private set; } + public string? CarrierDetailCode { get; set; } /// /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. @@ -62,11 +65,14 @@ public partial class GetTrackingLogResponseBody /// Carrier status code /// /// Carrier status code + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 1 /// [JsonPropertyName("carrier_status_code"), JsonInclude] - public string? CarrierStatusCode { get; private set; } + public string? CarrierStatusCode { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -82,8 +88,11 @@ public partial class GetTrackingLogResponseBody /// The events that have occured during the lifetime of this tracking number. /// /// The events that have occured during the lifetime of this tracking number. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("events"), JsonInclude] - public List? Events { get; private set; } + public List? Events { get; set; } /// /// Gets or Sets StatusCode @@ -105,11 +114,14 @@ public partial class GetTrackingLogResponseBody /// Carrier Tracking Url, if available /// /// Carrier Tracking Url, if available + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url"), JsonInclude] - public string? TrackingUrl { get; private set; } + public string? TrackingUrl { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -125,18 +137,24 @@ public partial class GetTrackingLogResponseBody /// carrier status description /// /// carrier status description + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// Your item was delivered in or at the mailbox at 9:10 am on March /// [JsonPropertyName("carrier_status_description"), JsonInclude] - public string? CarrierStatusDescription { get; private set; } + public string? CarrierStatusDescription { get; set; } /// /// Exception description /// /// Exception description + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("exception_description"), JsonInclude] - public string? ExceptionDescription { get; private set; } + public string? ExceptionDescription { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -152,11 +170,14 @@ public partial class GetTrackingLogResponseBody /// Status description /// /// Status description + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// Delivered /// [JsonPropertyName("status_description"), JsonInclude] - public string? StatusDescription { get; private set; } + public string? StatusDescription { get; set; } /// diff --git a/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs b/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs index 3a16b565..84f63dbb 100644 --- a/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs @@ -32,11 +32,14 @@ public partial class GetWarehouseByIdResponseBody /// Timestamp that indicates when the warehouse was created /// /// Timestamp that indicates when the warehouse was created + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2019-06-25T18:12:35.583Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// Name of the warehouse @@ -66,11 +69,14 @@ public partial class GetWarehouseByIdResponseBody /// A string that uniquely identifies the warehouse /// /// A string that uniquely identifies the warehouse + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("warehouse_id"), JsonInclude] - public string? WarehouseId { get; private set; } + public string? WarehouseId { get; set; } /// /// Designates which single warehouse is the default on the account diff --git a/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs b/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs index cda5438f..47f73a7e 100644 --- a/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs @@ -48,11 +48,14 @@ public partial class GetWebhookByIdResponseBody /// A string that uniquely identifies the webhook /// /// A string that uniquely identifies the webhook + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("webhook_id"), JsonInclude] - public string? WebhookId { get; private set; } + public string? WebhookId { get; set; } /// /// Array of custom webhook headers diff --git a/ShipEngineSDK/Model/Label.cs b/ShipEngineSDK/Model/Label.cs index 3997b8b6..55ce281b 100644 --- a/ShipEngineSDK/Model/Label.cs +++ b/ShipEngineSDK/Model/Label.cs @@ -32,38 +32,50 @@ public partial class Label /// Additional information some carriers may provide by which to identify a given label in their system. /// /// Additional information some carriers may provide by which to identify a given label in their system. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("alternative_identifiers"), JsonInclude] - public List? AlternativeIdentifiers { get; private set; } + public List? AlternativeIdentifiers { get; set; } /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("batch_id"), JsonInclude] - public string? BatchId { get; private set; } + public string? BatchId { get; set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// dhl_express /// [JsonPropertyName("carrier_code"), JsonInclude] - public string? CarrierCode { get; private set; } + public string? CarrierCode { get; set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// The label charge event. @@ -76,11 +88,14 @@ public partial class Label /// The date and time that the label was created in ShipEngine. /// /// The date and time that the label was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The display format that the label should be shown in. @@ -93,29 +108,41 @@ public partial class Label /// 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. /// /// 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. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("form_download"), JsonInclude] - public Link? FormDownload { get; private set; } + public Link? FormDownload { get; set; } /// /// 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. /// /// 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. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("insurance_claim"), JsonInclude] - public Link? InsuranceClaim { get; private set; } + public Link? InsuranceClaim { get; set; } /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("insurance_cost"), JsonInclude] - public MonetaryValue? InsuranceCost { get; private set; } + public MonetaryValue? InsuranceCost { get; set; } /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("is_international"), JsonInclude] - public bool? IsInternational { get; private set; } + public bool? IsInternational { get; set; } /// /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. @@ -127,8 +154,11 @@ public partial class Label /// /// Gets or Sets LabelDownload /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_download"), JsonInclude] - public LabelDownload? LabelDownload { get; private set; } + public LabelDownload? LabelDownload { get; set; } /// /// Gets or Sets LabelDownloadType @@ -147,11 +177,14 @@ public partial class Label /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. /// /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("label_id"), JsonInclude] - public string? LabelId { get; private set; } + public string? LabelId { get; set; } /// /// The label image resource that was used to create a custom label image. @@ -184,32 +217,44 @@ public partial class Label /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. /// /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// small_flat_rate_box /// [JsonPropertyName("package_code"), JsonInclude] - public string? PackageCode { get; private set; } + public string? PackageCode { get; set; } /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("packages"), JsonInclude] - public List? Packages { get; private set; } + public List? Packages { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("paperless_download"), JsonInclude] - public PaperlessDownload? PaperlessDownload { get; private set; } + public PaperlessDownload? PaperlessDownload { get; set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("requested_comparison_amount"), JsonInclude] - public MonetaryValue? RequestedComparisonAmount { get; private set; } + public MonetaryValue? RequestedComparisonAmount { get; set; } /// /// An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. @@ -222,21 +267,27 @@ public partial class Label /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. /// /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// usps_first_class_mail /// [JsonPropertyName("service_code"), JsonInclude] - public string? ServiceCode { get; private set; } + public string? ServiceCode { get; set; } /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date"), JsonInclude] - public DateTimeOffset? ShipDate { get; private set; } + public DateTimeOffset? ShipDate { get; set; } /// /// The shipment information used to generate the label @@ -249,24 +300,33 @@ public partial class Label /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipment_cost"), JsonInclude] - public MonetaryValue? ShipmentCost { get; private set; } + public MonetaryValue? ShipmentCost { get; set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// Gets or Sets Status /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("status"), JsonInclude] - public LabelStatus? Status { get; private set; } + public LabelStatus? Status { get; set; } /// /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. @@ -279,35 +339,47 @@ public partial class Label /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("trackable"), JsonInclude] - public bool? Trackable { get; private set; } + public bool? Trackable { get; set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. /// /// The tracking number for the package. Tracking number formats vary across carriers. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 782758401696 /// [JsonPropertyName("tracking_number"), JsonInclude] - public string? TrackingNumber { get; private set; } + public string? TrackingNumber { get; set; } /// /// The current status of the package, such as `in_transit` or `delivered` /// /// The current status of the package, such as `in_transit` or `delivered` + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tracking_status"), JsonInclude] - public TrackingStatus? TrackingStatus { get; private set; } + public TrackingStatus? TrackingStatus { get; set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url"), JsonInclude] - public string? TrackingUrl { get; private set; } + public string? TrackingUrl { get; set; } /// /// Gets or Sets ValidateAddress @@ -319,18 +391,24 @@ public partial class Label /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("voided"), JsonInclude] - public bool? Voided { get; private set; } + public bool? Voided { get; set; } /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("voided_at"), JsonInclude] - public DateTimeOffset? VoidedAt { get; private set; } + public DateTimeOffset? VoidedAt { get; set; } /// diff --git a/ShipEngineSDK/Model/LabelPackagesInner.cs b/ShipEngineSDK/Model/LabelPackagesInner.cs index b0d5d283..5637f18e 100644 --- a/ShipEngineSDK/Model/LabelPackagesInner.cs +++ b/ShipEngineSDK/Model/LabelPackagesInner.cs @@ -39,8 +39,11 @@ public partial class LabelPackagesInner /// Alternative identifiers associated with this package. /// /// Alternative identifiers associated with this package. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("alternative_identifiers"), JsonInclude] - public List? AlternativeIdentifiers { get; private set; } + public List? AlternativeIdentifiers { get; set; } /// /// A short description of the package content. Required for shipments moving to, from, and through Mexico. @@ -70,8 +73,11 @@ public partial class LabelPackagesInner /// The form download for any customs that are needed /// /// The form download for any customs that are needed + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("form_download"), JsonInclude] - public OptionalLink? FormDownload { get; private set; } + public OptionalLink? FormDownload { get; set; } /// /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. @@ -84,8 +90,11 @@ public partial class LabelPackagesInner /// The label download for the package /// /// The label download for the package + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_download"), JsonInclude] - public LabelDownload? LabelDownload { get; private set; } + public LabelDownload? LabelDownload { get; set; } /// /// Gets or Sets LabelMessages @@ -117,8 +126,11 @@ public partial class LabelPackagesInner /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("paperless_download"), JsonInclude] - public PaperlessDownload? PaperlessDownload { get; private set; } + public PaperlessDownload? PaperlessDownload { get; set; } /// /// Details about products inside packages (Information provided would be used on custom documentation) @@ -131,18 +143,24 @@ public partial class LabelPackagesInner /// Package sequence /// /// Package sequence + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("sequence"), JsonInclude] - public int? Sequence { get; private set; } + public int? Sequence { get; set; } /// /// The tracking number for the package. The format depends on the carrier. /// /// The tracking number for the package. The format depends on the carrier. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 1Z932R800392060079 /// [JsonPropertyName("tracking_number"), JsonInclude] - public string? TrackingNumber { get; private set; } + public string? TrackingNumber { get; set; } /// diff --git a/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs b/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs index 57d99736..73d8a529 100644 --- a/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs +++ b/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs @@ -41,7 +41,7 @@ public class ListAccountImagesResponseBodyItem /// img_DtBXupDBxREpHnwEXhTfgK /// [JsonPropertyName("label_image_id"), JsonInclude] - public string? LabelImageId { get; private set; } + public string? LabelImageId { get; set; } /// /// A human readable name for the image. @@ -88,7 +88,7 @@ public class ListAccountImagesResponseBodyItem /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The date and time that the image was modified in ShipEngine. @@ -98,15 +98,18 @@ public class ListAccountImagesResponseBodyItem /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at"), JsonInclude] - public DateTimeOffset? ModifiedAt { get; private set; } + public DateTimeOffset? ModifiedAt { get; set; } } /// /// Image List /// /// Image List + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("images"), JsonInclude] - public List? Images { get; private set; } + public List? Images { get; set; } /// /// Gets or Sets Links diff --git a/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs b/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs index a557a1c0..ea3c309c 100644 --- a/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs +++ b/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs @@ -41,7 +41,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// img_DtBXupDBxREpHnwEXhTfgK /// [JsonPropertyName("label_image_id"), JsonInclude] - public string? LabelImageId { get; private set; } + public string? LabelImageId { get; set; } /// /// A human readable name for the image. @@ -88,7 +88,7 @@ public class ListAccountSettingsImagesResponseBodyItem /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The date and time that the image was modified in ShipEngine. @@ -98,15 +98,18 @@ public class ListAccountSettingsImagesResponseBodyItem /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at"), JsonInclude] - public DateTimeOffset? ModifiedAt { get; private set; } + public DateTimeOffset? ModifiedAt { get; set; } } /// /// Image List /// /// Image List + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("images"), JsonInclude] - public List? Images { get; private set; } + public List? Images { get; set; } /// /// Gets or Sets Links diff --git a/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs b/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs index 041d9d2a..7ef91ca8 100644 --- a/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs +++ b/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs @@ -32,14 +32,20 @@ public partial class ListBatchErrorsResponseBody /// The errors currently associated with the batch /// /// The errors currently associated with the batch + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("errors"), JsonInclude] - public List? Errors { get; private set; } + public List? Errors { get; set; } /// /// Gets or Sets Links /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("links"), JsonInclude] - public PaginationLink? Links { get; private set; } + public PaginationLink? Links { get; set; } /// diff --git a/ShipEngineSDK/Model/ListBatchesResponseBody.cs b/ShipEngineSDK/Model/ListBatchesResponseBody.cs index 7c1688c1..b3bfb4a6 100644 --- a/ShipEngineSDK/Model/ListBatchesResponseBody.cs +++ b/ShipEngineSDK/Model/ListBatchesResponseBody.cs @@ -32,44 +32,59 @@ public partial class ListBatchesResponseBody /// Batch List /// /// Batch List + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("batches"), JsonInclude] - public List? Batches { get; private set; } + public List? Batches { get; set; } /// /// Gets or Sets Links /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("links"), JsonInclude] - public PaginationLink? Links { get; private set; } + public PaginationLink? Links { get; set; } /// /// The page that is currently being read /// /// The page that is currently being read + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 1 /// [JsonPropertyName("page"), JsonInclude] - public int? Page { get; private set; } + public int? Page { get; set; } /// /// The total number of batch pages the API call returned /// /// The total number of batch pages the API call returned + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 10 /// [JsonPropertyName("pages"), JsonInclude] - public int? Pages { get; private set; } + public int? Pages { get; set; } /// /// The total number of batches the API call returned /// /// The total number of batches the API call returned + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 10 /// [JsonPropertyName("total"), JsonInclude] - public long? Total { get; private set; } + public long? Total { get; set; } /// diff --git a/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs b/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs index 378306aa..bd7ddc82 100644 --- a/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs +++ b/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs @@ -32,8 +32,11 @@ public partial class ListCarrierPackageTypesResponseBody /// An array of custom package types /// /// An array of custom package types + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("packages"), JsonInclude] - public List? Packages { get; private set; } + public List? Packages { get; set; } /// diff --git a/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs b/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs index 4a0a9fd6..3a8ce9e4 100644 --- a/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs +++ b/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs @@ -32,8 +32,11 @@ public partial class ListCarrierServicesResponseBody /// An array of services associated with the carrier /// /// An array of services associated with the carrier + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("services"), JsonInclude] - public List? Services { get; private set; } + public List? Services { get; set; } /// diff --git a/ShipEngineSDK/Model/ListCarriersResponseBody.cs b/ShipEngineSDK/Model/ListCarriersResponseBody.cs index 4bfe9dcd..3b2c6f10 100644 --- a/ShipEngineSDK/Model/ListCarriersResponseBody.cs +++ b/ShipEngineSDK/Model/ListCarriersResponseBody.cs @@ -32,8 +32,11 @@ public partial class ListCarriersResponseBody /// The carrier response body /// /// The carrier response body + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("carriers"), JsonInclude] - public List? Carriers { get; private set; } + public List? Carriers { get; set; } /// diff --git a/ShipEngineSDK/Model/ListLabelsResponseBody.cs b/ShipEngineSDK/Model/ListLabelsResponseBody.cs index 5e3179d5..a1ca3151 100644 --- a/ShipEngineSDK/Model/ListLabelsResponseBody.cs +++ b/ShipEngineSDK/Model/ListLabelsResponseBody.cs @@ -41,13 +41,13 @@ public class ListLabelsResponseBodyItem /// se-28529731 /// [JsonPropertyName("label_id"), JsonInclude] - public string? LabelId { get; private set; } + public string? LabelId { get; set; } /// /// Gets or Sets Status /// [JsonPropertyName("status"), JsonInclude] - public LabelStatus? Status { get; private set; } + public LabelStatus? Status { get; set; } /// /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) @@ -57,7 +57,7 @@ public class ListLabelsResponseBodyItem /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// The shipment information used to generate the label @@ -74,7 +74,7 @@ public class ListLabelsResponseBodyItem /// 2018-09-23T00:00Z /// [JsonPropertyName("ship_date"), JsonInclude] - public DateTimeOffset? ShipDate { get; private set; } + public DateTimeOffset? ShipDate { get; set; } /// /// The date and time that the label was created in ShipEngine. @@ -84,28 +84,28 @@ public class ListLabelsResponseBodyItem /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. /// /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. [JsonPropertyName("shipment_cost"), JsonInclude] - public MonetaryValue? ShipmentCost { get; private set; } + public MonetaryValue? ShipmentCost { get; set; } /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. /// /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. [JsonPropertyName("insurance_cost"), JsonInclude] - public MonetaryValue? InsuranceCost { get; private set; } + public MonetaryValue? InsuranceCost { get; set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. [JsonPropertyName("requested_comparison_amount"), JsonInclude] - public MonetaryValue? RequestedComparisonAmount { get; private set; } + public MonetaryValue? RequestedComparisonAmount { get; set; } /// /// The tracking number for the package. Tracking number formats vary across carriers. @@ -115,7 +115,7 @@ public class ListLabelsResponseBodyItem /// 782758401696 /// [JsonPropertyName("tracking_number"), JsonInclude] - public string? TrackingNumber { get; private set; } + public string? TrackingNumber { get; set; } /// /// Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. @@ -136,7 +136,7 @@ public class ListLabelsResponseBodyItem /// /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. [JsonPropertyName("is_international"), JsonInclude] - public bool? IsInternational { get; private set; } + public bool? IsInternational { get; set; } /// /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. @@ -146,7 +146,7 @@ public class ListLabelsResponseBodyItem /// se-28529731 /// [JsonPropertyName("batch_id"), JsonInclude] - public string? BatchId { get; private set; } + public string? BatchId { get; set; } /// /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label @@ -156,7 +156,7 @@ public class ListLabelsResponseBodyItem /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// The label charge event. @@ -183,7 +183,7 @@ public class ListLabelsResponseBodyItem /// usps_first_class_mail /// [JsonPropertyName("service_code"), JsonInclude] - public string? ServiceCode { get; private set; } + public string? ServiceCode { get; set; } /// /// Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. @@ -200,7 +200,7 @@ public class ListLabelsResponseBodyItem /// small_flat_rate_box /// [JsonPropertyName("package_code"), JsonInclude] - public string? PackageCode { get; private set; } + public string? PackageCode { get; set; } /// /// Gets or Sets ValidateAddress @@ -213,7 +213,7 @@ public class ListLabelsResponseBodyItem /// /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) [JsonPropertyName("voided"), JsonInclude] - public bool? Voided { get; private set; } + public bool? Voided { get; set; } /// /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided @@ -223,7 +223,7 @@ public class ListLabelsResponseBodyItem /// 2018-09-23T15:00Z /// [JsonPropertyName("voided_at"), JsonInclude] - public DateTimeOffset? VoidedAt { get; private set; } + public DateTimeOffset? VoidedAt { get; set; } /// /// Gets or Sets LabelDownloadType @@ -257,7 +257,7 @@ public class ListLabelsResponseBodyItem /// /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. [JsonPropertyName("trackable"), JsonInclude] - public bool? Trackable { get; private set; } + public bool? Trackable { get; set; } /// /// The label image resource that was used to create a custom label image. @@ -277,55 +277,55 @@ public class ListLabelsResponseBodyItem /// dhl_express /// [JsonPropertyName("carrier_code"), JsonInclude] - public string? CarrierCode { get; private set; } + public string? CarrierCode { get; set; } /// /// The current status of the package, such as `in_transit` or `delivered` /// /// The current status of the package, such as `in_transit` or `delivered` [JsonPropertyName("tracking_status"), JsonInclude] - public TrackingStatus? TrackingStatus { get; private set; } + public TrackingStatus? TrackingStatus { get; set; } /// /// Gets or Sets LabelDownload /// [JsonPropertyName("label_download"), JsonInclude] - public LabelDownload? LabelDownload { get; private set; } + public LabelDownload? LabelDownload { 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. /// /// 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. [JsonPropertyName("form_download"), JsonInclude] - public Link? FormDownload { get; private set; } + public Link? FormDownload { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. [JsonPropertyName("paperless_download"), JsonInclude] - public PaperlessDownload? PaperlessDownload { get; private set; } + public PaperlessDownload? PaperlessDownload { get; set; } /// /// 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. /// /// 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. [JsonPropertyName("insurance_claim"), JsonInclude] - public Link? InsuranceClaim { get; private set; } + public Link? InsuranceClaim { get; set; } /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. [JsonPropertyName("packages"), JsonInclude] - public List? Packages { get; private set; } + public List? Packages { get; set; } /// /// Additional information some carriers may provide by which to identify a given label in their system. /// /// Additional information some carriers may provide by which to identify a given label in their system. [JsonPropertyName("alternative_identifiers"), JsonInclude] - public List? AlternativeIdentifiers { get; private set; } + public List? AlternativeIdentifiers { get; set; } /// /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. @@ -335,7 +335,7 @@ public class ListLabelsResponseBodyItem /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url"), JsonInclude] - public string? TrackingUrl { get; private set; } + public string? TrackingUrl { get; set; } } /// diff --git a/ShipEngineSDK/Model/ListManifestsResponseBody.cs b/ShipEngineSDK/Model/ListManifestsResponseBody.cs index b396e0cb..fa6d674f 100644 --- a/ShipEngineSDK/Model/ListManifestsResponseBody.cs +++ b/ShipEngineSDK/Model/ListManifestsResponseBody.cs @@ -32,45 +32,60 @@ public partial class ListManifestsResponseBody /// Helpful links to other pages of results /// /// Helpful links to other pages of results + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("links"), JsonInclude] - public PaginationLink? Links { get; private set; } + public PaginationLink? Links { get; set; } /// /// The list of available manifests /// /// The list of available manifests + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("manifests"), JsonInclude] - public List? Manifests { get; private set; } + public List? Manifests { get; set; } /// /// Current page of the list manifests results /// /// Current page of the list manifests results + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 3 /// [JsonPropertyName("page"), JsonInclude] - public int? Page { get; private set; } + public int? Page { get; set; } /// /// Total number of pages for list manifests results /// /// Total number of pages for list manifests results + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 4 /// [JsonPropertyName("pages"), JsonInclude] - public int? Pages { get; private set; } + public int? Pages { get; set; } /// /// The total number of manifests returned /// /// The total number of manifests returned + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 3 /// [JsonPropertyName("total"), JsonInclude] - public long? Total { get; private set; } + public long? Total { get; set; } /// diff --git a/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs b/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs index cffeb2b6..c3e7da47 100644 --- a/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs +++ b/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs @@ -32,8 +32,11 @@ public partial class ListPackageTypesResponseBody /// An array of custom package types /// /// An array of custom package types + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("packages"), JsonInclude] - public List? Packages { get; private set; } + public List? Packages { get; set; } /// diff --git a/ShipEngineSDK/Model/ListPickupResponseBody.cs b/ShipEngineSDK/Model/ListPickupResponseBody.cs index 69e3d859..89942ebf 100644 --- a/ShipEngineSDK/Model/ListPickupResponseBody.cs +++ b/ShipEngineSDK/Model/ListPickupResponseBody.cs @@ -32,28 +32,37 @@ public partial class ListPickupResponseBody /// Helpful links to other pages of results /// /// Helpful links to other pages of results + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("links"), JsonInclude] - public PaginationLink? Links { get; private set; } + public PaginationLink? Links { get; set; } /// /// Current page of the list pickups results /// /// Current page of the list pickups results + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 3 /// [JsonPropertyName("page"), JsonInclude] - public int? Page { get; private set; } + public int? Page { get; set; } /// /// Total number of pages for list pickups results /// /// Total number of pages for list pickups results + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 4 /// [JsonPropertyName("pages"), JsonInclude] - public int? Pages { get; private set; } + public int? Pages { get; set; } /// /// An array of pickups associated with the user's account. @@ -66,11 +75,14 @@ public partial class ListPickupResponseBody /// The total number of pickups returned /// /// The total number of pickups returned + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 3 /// [JsonPropertyName("total"), JsonInclude] - public long? Total { get; private set; } + public long? Total { get; set; } /// diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBody.cs b/ShipEngineSDK/Model/ListServicePointsResponseBody.cs index ccad8e7e..51a28997 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBody.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBody.cs @@ -32,8 +32,11 @@ public partial class ListServicePointsResponseBody /// The errors associated with the failed API call /// /// The errors associated with the failed API call + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("errors"), JsonInclude] - public List? Errors { get; private set; } + public List? Errors { get; set; } /// /// The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html diff --git a/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs b/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs index 5e5c2d5b..d3091adc 100644 --- a/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs +++ b/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs @@ -48,41 +48,56 @@ public partial class ListShipmentRatesResponseBody /// An array of invalid shipment rates /// /// An array of invalid shipment rates + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("invalid_rates"), JsonInclude] - public List? InvalidRates { get; private set; } + public List? InvalidRates { get; set; } /// /// A string that uniquely identifies the rate request /// /// A string that uniquely identifies the rate request + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("rate_request_id"), JsonInclude] - public string? RateRequestId { get; private set; } + public string? RateRequestId { get; set; } /// /// An array of shipment rates /// /// An array of shipment rates + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("rates"), JsonInclude] - public List? Rates { get; private set; } + public List? Rates { get; set; } /// /// A string that uniquely identifies the shipment /// /// A string that uniquely identifies the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// Gets or Sets Status /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("status"), JsonInclude] - public RateResponseStatus? Status { get; private set; } + public RateResponseStatus? Status { get; set; } /// diff --git a/ShipEngineSDK/Model/ListShipmentsResponseBody.cs b/ShipEngineSDK/Model/ListShipmentsResponseBody.cs index cd18907a..d7830af7 100644 --- a/ShipEngineSDK/Model/ListShipmentsResponseBody.cs +++ b/ShipEngineSDK/Model/ListShipmentsResponseBody.cs @@ -31,37 +31,52 @@ public partial class ListShipmentsResponseBody /// /// Gets or Sets Links /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("links"), JsonInclude] - public PaginationLink? Links { get; private set; } + public PaginationLink? Links { get; set; } /// /// Gets or Sets Page /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("page"), JsonInclude] - public int? Page { get; private set; } + public int? Page { get; set; } /// /// Gets or Sets Pages /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("pages"), JsonInclude] - public int? Pages { get; private set; } + public int? Pages { get; set; } /// /// The list of shipments returned by the api call /// /// The list of shipments returned by the api call + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipments"), JsonInclude] - public List? Shipments { get; private set; } + public List? Shipments { get; set; } /// /// Total number of shipments returned by the api call /// /// Total number of shipments returned by the api call + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 1990 /// [JsonPropertyName("total"), JsonInclude] - public long? Total { get; private set; } + public long? Total { get; set; } /// diff --git a/ShipEngineSDK/Model/ListWarehousesResponseBody.cs b/ShipEngineSDK/Model/ListWarehousesResponseBody.cs index 4f3bc395..6a4967e6 100644 --- a/ShipEngineSDK/Model/ListWarehousesResponseBody.cs +++ b/ShipEngineSDK/Model/ListWarehousesResponseBody.cs @@ -32,8 +32,11 @@ public partial class ListWarehousesResponseBody /// The array of warehouses returned by the API call /// /// The array of warehouses returned by the API call + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("warehouses"), JsonInclude] - public List? Warehouses { get; private set; } + public List? Warehouses { get; set; } /// diff --git a/ShipEngineSDK/Model/Manifest.cs b/ShipEngineSDK/Model/Manifest.cs index 118698f2..f8d95170 100644 --- a/ShipEngineSDK/Model/Manifest.cs +++ b/ShipEngineSDK/Model/Manifest.cs @@ -32,94 +32,124 @@ public partial class Manifest /// A string that uniquely identifies the carrier /// /// A string that uniquely identifies the carrier + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// The date-time that the manifest was created /// /// The date-time that the manifest was created + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2019-07-12T13:37:39.050Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// A string that uniquely identifies the form /// /// A string that uniquely identifies the form + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("form_id"), JsonInclude] - public string? FormId { get; private set; } + public string? FormId { get; set; } /// /// An array of the label ids used in this manifest. /// /// An array of the label ids used in this manifest. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_ids"), JsonInclude] - public List? LabelIds { get; private set; } + public List? LabelIds { get; set; } /// /// Gets or Sets ManifestDownload /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("manifest_download"), JsonInclude] - public ManifestDownload? ManifestDownload { get; private set; } + public ManifestDownload? ManifestDownload { get; set; } /// /// A string that uniquely identifies the manifest /// /// A string that uniquely identifies the manifest + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("manifest_id"), JsonInclude] - public string? ManifestId { get; private set; } + public string? ManifestId { get; set; } /// /// The date-time that the manifests shipments will be picked up /// /// The date-time that the manifests shipments will be picked up + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2019-07-12T13:37:39.050Z /// [JsonPropertyName("ship_date"), JsonInclude] - public DateTimeOffset? ShipDate { get; private set; } + public DateTimeOffset? ShipDate { get; set; } /// /// The number of shipments that are included in this manifest /// /// The number of shipments that are included in this manifest + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 100 /// [JsonPropertyName("shipments"), JsonInclude] - public int? Shipments { get; private set; } + public int? Shipments { get; set; } /// /// A string that uniquely identifies the submission /// /// A string that uniquely identifies the submission + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 9475711899564878915476 /// [JsonPropertyName("submission_id"), JsonInclude] - public string? SubmissionId { get; private set; } + public string? SubmissionId { get; set; } /// /// A string that uniquely identifies the warehouse /// /// A string that uniquely identifies the warehouse + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("warehouse_id"), JsonInclude] - public string? WarehouseId { get; private set; } + public string? WarehouseId { get; set; } /// diff --git a/ShipEngineSDK/Model/ManifestRequest.cs b/ShipEngineSDK/Model/ManifestRequest.cs index fe193e46..7516b54c 100644 --- a/ShipEngineSDK/Model/ManifestRequest.cs +++ b/ShipEngineSDK/Model/ManifestRequest.cs @@ -32,11 +32,14 @@ public partial class ManifestRequest /// A string that uniquely identifies a manifest request /// /// A string that uniquely identifies a manifest request + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("manifest_request_id"), JsonInclude] - public string? ManifestRequestId { get; private set; } + public string? ManifestRequestId { get; set; } /// /// Gets or Sets Status diff --git a/ShipEngineSDK/Model/Package.cs b/ShipEngineSDK/Model/Package.cs index 0cee32c7..1b2c2a19 100644 --- a/ShipEngineSDK/Model/Package.cs +++ b/ShipEngineSDK/Model/Package.cs @@ -63,8 +63,11 @@ public partial class Package /// The form download for any customs that are needed /// /// The form download for any customs that are needed + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("form_download"), JsonInclude] - public OptionalLink? FormDownload { get; private set; } + public OptionalLink? FormDownload { get; set; } /// /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. @@ -77,8 +80,11 @@ public partial class Package /// The label download for the package /// /// The label download for the package + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("label_download"), JsonInclude] - public LabelDownload? LabelDownload { get; private set; } + public LabelDownload? LabelDownload { get; set; } /// /// Gets or Sets LabelMessages @@ -110,8 +116,11 @@ public partial class Package /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("paperless_download"), JsonInclude] - public PaperlessDownload? PaperlessDownload { get; private set; } + public PaperlessDownload? PaperlessDownload { get; set; } /// /// Details about products inside packages (Information provided would be used on custom documentation) @@ -124,18 +133,24 @@ public partial class Package /// Package sequence /// /// Package sequence + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("sequence"), JsonInclude] - public int? Sequence { get; private set; } + public int? Sequence { get; set; } /// /// The tracking number for the package. The format depends on the carrier. /// /// The tracking number for the package. The format depends on the carrier. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 1Z932R800392060079 /// [JsonPropertyName("tracking_number"), JsonInclude] - public string? TrackingNumber { get; private set; } + public string? TrackingNumber { get; set; } /// diff --git a/ShipEngineSDK/Model/PartialShipment.cs b/ShipEngineSDK/Model/PartialShipment.cs index e9ea90df..5877acdc 100644 --- a/ShipEngineSDK/Model/PartialShipment.cs +++ b/ShipEngineSDK/Model/PartialShipment.cs @@ -66,11 +66,14 @@ public partial class PartialShipment /// The date and time that the shipment was created in ShipEngine. /// /// The date and time that the shipment was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// Customs information. This is usually only needed for international shipments. @@ -118,11 +121,14 @@ public partial class PartialShipment /// The date and time that the shipment was created or last modified. /// /// The date and time that the shipment was created or last modified. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at"), JsonInclude] - public DateTimeOffset? ModifiedAt { get; private set; } + public DateTimeOffset? ModifiedAt { get; set; } /// /// Gets or Sets OrderSourceCode @@ -182,11 +188,14 @@ public partial class PartialShipment /// A string that uniquely identifies the shipment /// /// A string that uniquely identifies the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. @@ -199,8 +208,11 @@ public partial class PartialShipment /// The current status of the shipment /// /// The current status of the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipment_status"), JsonInclude] - public ShipmentStatus? ShipmentStatus { get; private set; } + public ShipmentStatus? ShipmentStatus { get; set; } /// /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment @@ -216,8 +228,11 @@ public partial class PartialShipment /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tags"), JsonInclude] - public List? Tags { get; private set; } + public List? Tags { get; set; } /// /// Gets or Sets TaxIdentifiers @@ -229,8 +244,11 @@ public partial class PartialShipment /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("total_weight"), JsonInclude] - public Weight? TotalWeight { get; private set; } + public Weight? TotalWeight { get; set; } /// /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. diff --git a/ShipEngineSDK/Model/Pickup.cs b/ShipEngineSDK/Model/Pickup.cs index 0fb48069..2f9d733d 100644 --- a/ShipEngineSDK/Model/Pickup.cs +++ b/ShipEngineSDK/Model/Pickup.cs @@ -32,31 +32,40 @@ public partial class Pickup /// The date and time that the pickup was cancelled in ShipEngine. /// /// The date and time that the pickup was cancelled in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("cancelled_at"), JsonInclude] - public DateTimeOffset? CancelledAt { get; private set; } + public DateTimeOffset? CancelledAt { get; set; } /// /// The carrier_id associated with the pickup /// /// The carrier_id associated with the pickup + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// The carrier confirmation number for the scheduled pickup. /// /// The carrier confirmation number for the scheduled pickup. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 292513CL4A3 /// [JsonPropertyName("confirmation_number"), JsonInclude] - public string? ConfirmationNumber { get; private set; } + public string? ConfirmationNumber { get; set; } /// /// Gets or Sets ContactDetails @@ -68,11 +77,14 @@ public partial class Pickup /// The date and time that the pickup was created in ShipEngine. /// /// The date and time that the pickup was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// Label IDs that will be included in the pickup request @@ -84,18 +96,24 @@ public partial class Pickup /// /// Gets or Sets PickupAddress /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("pickup_address"), JsonInclude] - public Address? PickupAddress { get; private set; } + public Address? PickupAddress { get; set; } /// /// Pickup Resource ID /// /// Pickup Resource ID + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// pik_3YcKU5zdtJuCqoeNwyqqbW /// [JsonPropertyName("pickup_id"), JsonInclude] - public string? PickupId { get; private set; } + public string? PickupId { get; set; } /// /// Used by some carriers to give special instructions for a package pickup @@ -114,18 +132,24 @@ public partial class Pickup /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("pickup_windows"), JsonInclude] - public List? PickupWindows { get; private set; } + public List? PickupWindows { get; set; } /// /// The warehouse_id associated with the pickup /// /// The warehouse_id associated with the pickup + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("warehouse_id"), JsonInclude] - public string? WarehouseId { get; private set; } + public string? WarehouseId { get; set; } /// diff --git a/ShipEngineSDK/Model/PickupResponseBody.cs b/ShipEngineSDK/Model/PickupResponseBody.cs index caa43a0f..0b1d373c 100644 --- a/ShipEngineSDK/Model/PickupResponseBody.cs +++ b/ShipEngineSDK/Model/PickupResponseBody.cs @@ -32,11 +32,14 @@ public partial class PickupResponseBody /// The carrier_id associated with the pickup /// /// The carrier_id associated with the pickup + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// Gets or Sets ContactDetails @@ -48,11 +51,14 @@ public partial class PickupResponseBody /// The date and time that the pickup was created in ShipEngine. /// /// The date and time that the pickup was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// Label IDs that will be included in the pickup request @@ -64,18 +70,24 @@ public partial class PickupResponseBody /// /// Gets or Sets PickupAddress /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("pickup_address"), JsonInclude] - public Address? PickupAddress { get; private set; } + public Address? PickupAddress { get; set; } /// /// Pickup Resource ID /// /// Pickup Resource ID + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// pik_3YcKU5zdtJuCqoeNwyqqbW /// [JsonPropertyName("pickup_id"), JsonInclude] - public string? PickupId { get; private set; } + public string? PickupId { get; set; } /// /// Gets or Sets PickupWindow @@ -87,31 +99,40 @@ public partial class PickupResponseBody /// The warehouse_id associated with the pickup /// /// The warehouse_id associated with the pickup + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("warehouse_id"), JsonInclude] - public string? WarehouseId { get; private set; } + public string? WarehouseId { get; set; } /// /// The date and time that the pickup was cancelled in ShipEngine. /// /// The date and time that the pickup was cancelled in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("cancelled_at"), JsonInclude] - public DateTimeOffset? CancelledAt { get; private set; } + public DateTimeOffset? CancelledAt { get; set; } /// /// The carrier confirmation number for the scheduled pickup. /// /// The carrier confirmation number for the scheduled pickup. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 292513CL4A3 /// [JsonPropertyName("confirmation_number"), JsonInclude] - public string? ConfirmationNumber { get; private set; } + public string? ConfirmationNumber { get; set; } /// /// Used by some carriers to give special instructions for a package pickup @@ -124,8 +145,11 @@ public partial class PickupResponseBody /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("pickup_windows"), JsonInclude] - public List? PickupWindows { get; private set; } + public List? PickupWindows { get; set; } /// diff --git a/ShipEngineSDK/Model/Rate.cs b/ShipEngineSDK/Model/Rate.cs index 564c113b..974ef022 100644 --- a/ShipEngineSDK/Model/Rate.cs +++ b/ShipEngineSDK/Model/Rate.cs @@ -32,199 +32,277 @@ public partial class Rate /// carrier code /// /// carrier code + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("carrier_code"), JsonInclude] - public string? CarrierCode { get; private set; } + public string? CarrierCode { get; set; } /// /// carrier friendly name /// /// carrier friendly name + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("carrier_friendly_name"), JsonInclude] - public string? CarrierFriendlyName { get; private set; } + public string? CarrierFriendlyName { get; set; } /// /// A string that uniquely identifies the carrier /// /// A string that uniquely identifies the carrier + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// carrier nickname /// /// carrier nickname + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("carrier_nickname"), JsonInclude] - public string? CarrierNickname { get; private set; } + public string? CarrierNickname { get; set; } /// /// The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price. /// /// The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("confirmation_amount"), JsonInclude] - public MonetaryValue? ConfirmationAmount { get; private set; } + public MonetaryValue? ConfirmationAmount { get; set; } /// /// The error messages /// /// The error messages + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("error_messages"), JsonInclude] - public List? ErrorMessages { get; private set; } + public List? ErrorMessages { get; set; } /// /// Indicates if the rate is guaranteed. /// /// Indicates if the rate is guaranteed. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("guaranteed_service"), JsonInclude] - public bool? GuaranteedService { get; private set; } + public bool? GuaranteedService { get; set; } /// /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. /// /// The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("insurance_amount"), JsonInclude] - public MonetaryValue? InsuranceAmount { get; private set; } + public MonetaryValue? InsuranceAmount { get; set; } /// /// Indicates if the rates been negotiated /// /// Indicates if the rates been negotiated + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("negotiated_rate"), JsonInclude] - public bool? NegotiatedRate { get; private set; } + public bool? NegotiatedRate { get; set; } /// /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. /// /// Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("other_amount"), JsonInclude] - public MonetaryValue? OtherAmount { get; private set; } + public MonetaryValue? OtherAmount { get; set; } /// /// A string that uniquely identifies the rate /// /// A string that uniquely identifies the rate + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("rate_id"), JsonInclude] - public string? RateId { get; private set; } + public string? RateId { get; set; } /// /// Gets or Sets RateType /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("rate_type"), JsonInclude] - public RateType? RateType { get; private set; } + public RateType? RateType { get; set; } /// /// service code for the rate /// /// service code for the rate + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("service_code"), JsonInclude] - public string? ServiceCode { get; private set; } + public string? ServiceCode { get; set; } /// /// service type /// /// service type + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("service_type"), JsonInclude] - public string? ServiceType { get; private set; } + public string? ServiceType { get; set; } /// /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. /// /// The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipping_amount"), JsonInclude] - public MonetaryValue? ShippingAmount { get; private set; } + public MonetaryValue? ShippingAmount { get; set; } /// /// Indicates if rate is trackable /// /// Indicates if rate is trackable + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("trackable"), JsonInclude] - public bool? Trackable { get; private set; } + public bool? Trackable { get; set; } /// /// Gets or Sets ValidationStatus /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("validation_status"), JsonInclude] - public ValidationStatus? ValidationStatus { get; private set; } + public ValidationStatus? ValidationStatus { get; set; } /// /// The warning messages /// /// The warning messages + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("warning_messages"), JsonInclude] - public List? WarningMessages { get; private set; } + public List? WarningMessages { get; set; } /// /// The carrier delivery days /// /// The carrier delivery days + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("carrier_delivery_days"), JsonInclude] - public string? CarrierDeliveryDays { get; private set; } + public string? CarrierDeliveryDays { get; set; } /// /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday /// /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 5 /// [JsonPropertyName("delivery_days"), JsonInclude] - public int? DeliveryDays { get; private set; } + public int? DeliveryDays { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T00:00Z /// [JsonPropertyName("estimated_delivery_date"), JsonInclude] - public DateTimeOffset? EstimatedDeliveryDate { get; private set; } + public DateTimeOffset? EstimatedDeliveryDate { get; set; } /// /// package type that this rate was estimated for /// /// package type that this rate was estimated for + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// package /// [JsonPropertyName("package_type"), JsonInclude] - public string? PackageType { get; private set; } + public string? PackageType { get; set; } /// /// The total shipping cost for the specified comparison_rate_type. /// /// The total shipping cost for the specified comparison_rate_type. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("requested_comparison_amount"), JsonInclude] - public MonetaryValue? RequestedComparisonAmount { get; private set; } + public MonetaryValue? RequestedComparisonAmount { get; set; } /// /// ship date /// /// ship date + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("ship_date"), JsonInclude] - public DateTimeOffset? ShipDate { get; private set; } + public DateTimeOffset? ShipDate { get; set; } /// /// Tariff and additional taxes associated with an international shipment. /// /// Tariff and additional taxes associated with an international shipment. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tax_amount"), JsonInclude] - public MonetaryValue? TaxAmount { get; private set; } + public MonetaryValue? TaxAmount { get; set; } /// /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location /// /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 6 /// [JsonPropertyName("zone"), JsonInclude] - public int? Zone { get; private set; } + public int? Zone { get; set; } /// diff --git a/ShipEngineSDK/Model/RateEstimate.cs b/ShipEngineSDK/Model/RateEstimate.cs index 5c040357..2f76b39c 100644 --- a/ShipEngineSDK/Model/RateEstimate.cs +++ b/ShipEngineSDK/Model/RateEstimate.cs @@ -32,182 +32,254 @@ public partial class RateEstimate /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. /// /// A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("carrier_code"), JsonInclude] - public string? CarrierCode { get; private set; } + public string? CarrierCode { get; set; } /// /// carrier friendly name /// /// carrier friendly name + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("carrier_friendly_name"), JsonInclude] - public string? CarrierFriendlyName { get; private set; } + public string? CarrierFriendlyName { get; set; } /// /// A string that uniquely identifies the carrier /// /// A string that uniquely identifies the carrier + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// carrier nickname /// /// carrier nickname + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("carrier_nickname"), JsonInclude] - public string? CarrierNickname { get; private set; } + public string? CarrierNickname { get; set; } /// /// The confirmation amount /// /// The confirmation amount + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("confirmation_amount"), JsonInclude] - public MonetaryValue? ConfirmationAmount { get; private set; } + public MonetaryValue? ConfirmationAmount { get; set; } /// /// The error messages /// /// The error messages + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("error_messages"), JsonInclude] - public List? ErrorMessages { get; private set; } + public List? ErrorMessages { get; set; } /// /// Indicates if the rate is guaranteed. /// /// Indicates if the rate is guaranteed. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("guaranteed_service"), JsonInclude] - public bool? GuaranteedService { get; private set; } + public bool? GuaranteedService { get; set; } /// /// The insurance amount /// /// The insurance amount + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("insurance_amount"), JsonInclude] - public MonetaryValue? InsuranceAmount { get; private set; } + public MonetaryValue? InsuranceAmount { get; set; } /// /// Indicates if the rates been negotiated /// /// Indicates if the rates been negotiated + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("negotiated_rate"), JsonInclude] - public bool? NegotiatedRate { get; private set; } + public bool? NegotiatedRate { get; set; } /// /// Any other charges associated with this rate /// /// Any other charges associated with this rate + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("other_amount"), JsonInclude] - public MonetaryValue? OtherAmount { get; private set; } + public MonetaryValue? OtherAmount { get; set; } /// /// Gets or Sets RateType /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("rate_type"), JsonInclude] - public RateType? RateType { get; private set; } + public RateType? RateType { get; set; } /// /// service code for the rate /// /// service code for the rate + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("service_code"), JsonInclude] - public string? ServiceCode { get; private set; } + public string? ServiceCode { get; set; } /// /// service type /// /// service type + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("service_type"), JsonInclude] - public string? ServiceType { get; private set; } + public string? ServiceType { get; set; } /// /// The shipping amount /// /// The shipping amount + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipping_amount"), JsonInclude] - public MonetaryValue? ShippingAmount { get; private set; } + public MonetaryValue? ShippingAmount { get; set; } /// /// Indicates if rate is trackable /// /// Indicates if rate is trackable + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("trackable"), JsonInclude] - public bool? Trackable { get; private set; } + public bool? Trackable { get; set; } /// /// Gets or Sets ValidationStatus /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("validation_status"), JsonInclude] - public ValidationStatus? ValidationStatus { get; private set; } + public ValidationStatus? ValidationStatus { get; set; } /// /// The warning messages /// /// The warning messages + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("warning_messages"), JsonInclude] - public List? WarningMessages { get; private set; } + public List? WarningMessages { get; set; } /// /// The carrier delivery days /// /// The carrier delivery days + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("carrier_delivery_days"), JsonInclude] - public string? CarrierDeliveryDays { get; private set; } + public string? CarrierDeliveryDays { get; set; } /// /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday /// /// The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 5 /// [JsonPropertyName("delivery_days"), JsonInclude] - public int? DeliveryDays { get; private set; } + public int? DeliveryDays { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T00:00Z /// [JsonPropertyName("estimated_delivery_date"), JsonInclude] - public DateTimeOffset? EstimatedDeliveryDate { get; private set; } + public DateTimeOffset? EstimatedDeliveryDate { get; set; } /// /// package type that this rate was estimated for /// /// package type that this rate was estimated for + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// package /// [JsonPropertyName("package_type"), JsonInclude] - public string? PackageType { get; private set; } + public string? PackageType { get; set; } /// /// ship date /// /// ship date + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("ship_date"), JsonInclude] - public DateTimeOffset? ShipDate { get; private set; } + public DateTimeOffset? ShipDate { get; set; } /// /// Tariff and additional taxes associated with an international shipment. /// /// Tariff and additional taxes associated with an international shipment. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tax_amount"), JsonInclude] - public MonetaryValue? TaxAmount { get; private set; } + public MonetaryValue? TaxAmount { get; set; } /// /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location /// /// Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 6 /// [JsonPropertyName("zone"), JsonInclude] - public int? Zone { get; private set; } + public int? Zone { get; set; } /// diff --git a/ShipEngineSDK/Model/RatesInformation.cs b/ShipEngineSDK/Model/RatesInformation.cs index 7f8f655a..56881f77 100644 --- a/ShipEngineSDK/Model/RatesInformation.cs +++ b/ShipEngineSDK/Model/RatesInformation.cs @@ -48,41 +48,56 @@ public partial class RatesInformation /// An array of invalid shipment rates /// /// An array of invalid shipment rates + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("invalid_rates"), JsonInclude] - public List? InvalidRates { get; private set; } + public List? InvalidRates { get; set; } /// /// A string that uniquely identifies the rate request /// /// A string that uniquely identifies the rate request + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("rate_request_id"), JsonInclude] - public string? RateRequestId { get; private set; } + public string? RateRequestId { get; set; } /// /// An array of shipment rates /// /// An array of shipment rates + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("rates"), JsonInclude] - public List? Rates { get; private set; } + public List? Rates { get; set; } /// /// A string that uniquely identifies the shipment /// /// A string that uniquely identifies the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// Gets or Sets Status /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("status"), JsonInclude] - public RateResponseStatus? Status { get; private set; } + public RateResponseStatus? Status { get; set; } /// diff --git a/ShipEngineSDK/Model/ResponseMessage.cs b/ShipEngineSDK/Model/ResponseMessage.cs index 0d7956ae..cd6784c0 100644 --- a/ShipEngineSDK/Model/ResponseMessage.cs +++ b/ShipEngineSDK/Model/ResponseMessage.cs @@ -31,24 +31,33 @@ public partial class ResponseMessage /// /// Gets or Sets Code /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("code"), JsonInclude] - public AddressValidationCode? Code { get; private set; } + public AddressValidationCode? Code { get; set; } /// /// Message explaining the address validation error /// /// Message explaining the address validation error + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// Invalid Postal Code /// [JsonPropertyName("message"), JsonInclude] - public string? Message { get; private set; } + public string? Message { get; set; } /// /// Gets or Sets Type /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("type"), JsonInclude] - public AddressValidationMessageType? Type { get; private set; } + public AddressValidationMessageType? Type { get; set; } /// /// Gets or Sets DetailCode diff --git a/ShipEngineSDK/Model/SchedulePickupRequestBody.cs b/ShipEngineSDK/Model/SchedulePickupRequestBody.cs index fc2e1d49..92833c56 100644 --- a/ShipEngineSDK/Model/SchedulePickupRequestBody.cs +++ b/ShipEngineSDK/Model/SchedulePickupRequestBody.cs @@ -51,57 +51,75 @@ public partial class SchedulePickupRequestBody /// The date and time that the pickup was cancelled in ShipEngine. /// /// The date and time that the pickup was cancelled in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("cancelled_at"), JsonInclude] - public DateTimeOffset? CancelledAt { get; private set; } + public DateTimeOffset? CancelledAt { get; set; } /// /// The carrier_id associated with the pickup /// /// The carrier_id associated with the pickup + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// The carrier confirmation number for the scheduled pickup. /// /// The carrier confirmation number for the scheduled pickup. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 292513CL4A3 /// [JsonPropertyName("confirmation_number"), JsonInclude] - public string? ConfirmationNumber { get; private set; } + public string? ConfirmationNumber { get; set; } /// /// The date and time that the pickup was created in ShipEngine. /// /// The date and time that the pickup was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// Gets or Sets PickupAddress /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("pickup_address"), JsonInclude] - public Address? PickupAddress { get; private set; } + public Address? PickupAddress { get; set; } /// /// Pickup Resource ID /// /// Pickup Resource ID + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// pik_3YcKU5zdtJuCqoeNwyqqbW /// [JsonPropertyName("pickup_id"), JsonInclude] - public string? PickupId { get; private set; } + public string? PickupId { get; set; } /// /// Used by some carriers to give special instructions for a package pickup @@ -114,18 +132,24 @@ public partial class SchedulePickupRequestBody /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("pickup_windows"), JsonInclude] - public List? PickupWindows { get; private set; } + public List? PickupWindows { get; set; } /// /// The warehouse_id associated with the pickup /// /// The warehouse_id associated with the pickup + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("warehouse_id"), JsonInclude] - public string? WarehouseId { get; private set; } + public string? WarehouseId { get; set; } /// diff --git a/ShipEngineSDK/Model/SchedulePickupResponseBody.cs b/ShipEngineSDK/Model/SchedulePickupResponseBody.cs index 291c66c3..eac56d12 100644 --- a/ShipEngineSDK/Model/SchedulePickupResponseBody.cs +++ b/ShipEngineSDK/Model/SchedulePickupResponseBody.cs @@ -32,8 +32,11 @@ public partial class SchedulePickupResponseBody /// The errors associated with the failed API call /// /// The errors associated with the failed API call + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("errors"), JsonInclude] - public List? Errors { get; private set; } + public List? Errors { get; set; } /// /// A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur @@ -49,31 +52,40 @@ public partial class SchedulePickupResponseBody /// The date and time that the pickup was cancelled in ShipEngine. /// /// The date and time that the pickup was cancelled in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("cancelled_at"), JsonInclude] - public DateTimeOffset? CancelledAt { get; private set; } + public DateTimeOffset? CancelledAt { get; set; } /// /// The carrier_id associated with the pickup /// /// The carrier_id associated with the pickup + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// The carrier confirmation number for the scheduled pickup. /// /// The carrier confirmation number for the scheduled pickup. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 292513CL4A3 /// [JsonPropertyName("confirmation_number"), JsonInclude] - public string? ConfirmationNumber { get; private set; } + public string? ConfirmationNumber { get; set; } /// /// Gets or Sets ContactDetails @@ -85,11 +97,14 @@ public partial class SchedulePickupResponseBody /// The date and time that the pickup was created in ShipEngine. /// /// The date and time that the pickup was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// Label IDs that will be included in the pickup request @@ -101,18 +116,24 @@ public partial class SchedulePickupResponseBody /// /// Gets or Sets PickupAddress /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("pickup_address"), JsonInclude] - public Address? PickupAddress { get; private set; } + public Address? PickupAddress { get; set; } /// /// Pickup Resource ID /// /// Pickup Resource ID + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// pik_3YcKU5zdtJuCqoeNwyqqbW /// [JsonPropertyName("pickup_id"), JsonInclude] - public string? PickupId { get; private set; } + public string? PickupId { get; set; } /// /// Used by some carriers to give special instructions for a package pickup @@ -131,18 +152,24 @@ public partial class SchedulePickupResponseBody /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. /// /// An array of available pickup windows. Carriers can return multiple times that they will pickup packages. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("pickup_windows"), JsonInclude] - public List? PickupWindows { get; private set; } + public List? PickupWindows { get; set; } /// /// The warehouse_id associated with the pickup /// /// The warehouse_id associated with the pickup + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("warehouse_id"), JsonInclude] - public string? WarehouseId { get; private set; } + public string? WarehouseId { get; set; } /// diff --git a/ShipEngineSDK/Model/Service.cs b/ShipEngineSDK/Model/Service.cs index 02a1ea89..15acc479 100644 --- a/ShipEngineSDK/Model/Service.cs +++ b/ShipEngineSDK/Model/Service.cs @@ -42,52 +42,70 @@ public partial class Service /// A string that uniquely identifies the carrier /// /// A string that uniquely identifies the carrier + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; private set; } + public string? CarrierId { get; set; } /// /// Supports domestic shipping /// /// Supports domestic shipping + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("domestic"), JsonInclude] - public bool? Domestic { get; private set; } + public bool? Domestic { get; set; } /// /// Supports international shipping. /// /// Supports international shipping. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("international"), JsonInclude] - public bool? International { get; private set; } + public bool? International { get; set; } /// /// Carrier supports multiple packages per shipment /// /// Carrier supports multiple packages per shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("is_multi_package_supported"), JsonInclude] - public bool? IsMultiPackageSupported { get; private set; } + public bool? IsMultiPackageSupported { get; set; } /// /// User friendly service name /// /// User friendly service name + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// USPS First Class Mail /// [JsonPropertyName("name"), JsonInclude] - public string? Name { get; private set; } + public string? Name { get; set; } /// /// service code /// /// service code + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// usps_media_mail /// [JsonPropertyName("service_code"), JsonInclude] - public string? ServiceCode { get; private set; } + public string? ServiceCode { get; set; } /// diff --git a/ShipEngineSDK/Model/Shipment.cs b/ShipEngineSDK/Model/Shipment.cs index 4a731fcd..c5374725 100644 --- a/ShipEngineSDK/Model/Shipment.cs +++ b/ShipEngineSDK/Model/Shipment.cs @@ -56,11 +56,14 @@ public partial class Shipment /// The date and time that the shipment was created in ShipEngine. /// /// The date and time that the shipment was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The insurance provider to use for any insured packages in the shipment. @@ -73,11 +76,14 @@ public partial class Shipment /// The date and time that the shipment was created or last modified. /// /// The date and time that the shipment was created or last modified. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at"), JsonInclude] - public DateTimeOffset? ModifiedAt { get; private set; } + public DateTimeOffset? ModifiedAt { get; set; } /// /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. @@ -131,32 +137,44 @@ public partial class Shipment /// A string that uniquely identifies the shipment /// /// A string that uniquely identifies the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// The current status of the shipment /// /// The current status of the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipment_status"), JsonInclude] - public ShipmentStatus? ShipmentStatus { get; private set; } + public ShipmentStatus? ShipmentStatus { get; set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tags"), JsonInclude] - public List? Tags { get; private set; } + public List? Tags { get; set; } /// /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("total_weight"), JsonInclude] - public Weight? TotalWeight { get; private set; } + public Weight? TotalWeight { get; set; } /// /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. diff --git a/ShipEngineSDK/Model/TrackEvent.cs b/ShipEngineSDK/Model/TrackEvent.cs index 62191243..487061ba 100644 --- a/ShipEngineSDK/Model/TrackEvent.cs +++ b/ShipEngineSDK/Model/TrackEvent.cs @@ -32,41 +32,53 @@ public partial class TrackEvent /// Carrier detail code /// /// Carrier detail code + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// OT /// [JsonPropertyName("carrier_detail_code"), JsonInclude] - public string? CarrierDetailCode { get; private set; } + public string? CarrierDetailCode { get; set; } /// /// Carrier status code /// /// Carrier status code + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 1 /// [JsonPropertyName("carrier_status_code"), JsonInclude] - public string? CarrierStatusCode { get; private set; } + public string? CarrierStatusCode { get; set; } /// /// carrier status description /// /// carrier status description + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// Your item was delivered in or at the mailbox at 9:10 am on March /// [JsonPropertyName("carrier_status_description"), JsonInclude] - public string? CarrierStatusDescription { get; private set; } + public string? CarrierStatusDescription { get; set; } /// /// City locality /// /// City locality + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// AUSTIN /// [JsonPropertyName("city_locality"), JsonInclude] - public string? CityLocality { get; private set; } + public string? CityLocality { get; set; } /// /// Timestamp for carrier event @@ -82,21 +94,27 @@ public partial class TrackEvent /// Postal code /// /// Postal code + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 78756 /// [JsonPropertyName("postal_code"), JsonInclude] - public string? PostalCode { get; private set; } + public string? PostalCode { get; set; } /// /// State province /// /// State province + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// TX /// [JsonPropertyName("state_province"), JsonInclude] - public string? StateProvince { get; private set; } + public string? StateProvince { get; set; } /// /// Gets or Sets StatusCode @@ -108,11 +126,14 @@ public partial class TrackEvent /// Event Status Description /// /// Event Status Description + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// In Transit /// [JsonPropertyName("status_description"), JsonInclude] - public string? StatusDescription { get; private set; } + public string? StatusDescription { get; set; } /// /// Carrier timestamp for the event, it is assumed to be the local time of where the event occurred. @@ -128,11 +149,14 @@ public partial class TrackEvent /// Company Name /// /// Company Name + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// Stamps.com /// [JsonPropertyName("company_name"), JsonInclude] - public string? CompanyName { get; private set; } + public string? CompanyName { get; set; } /// /// A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) @@ -148,11 +172,14 @@ public partial class TrackEvent /// Event description /// /// Event description + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// Delivered, In/At Mailbox /// [JsonPropertyName("description"), JsonInclude] - public string? Description { get; private set; } + public string? Description { get; set; } /// /// Event Code @@ -179,8 +206,11 @@ public partial class TrackEvent /// Signer information /// /// Signer information + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("signer"), JsonInclude] - public string? Signer { get; private set; } + public string? Signer { get; set; } /// diff --git a/ShipEngineSDK/Model/TrackingInformation.cs b/ShipEngineSDK/Model/TrackingInformation.cs index 4fcbb1c0..2639ca63 100644 --- a/ShipEngineSDK/Model/TrackingInformation.cs +++ b/ShipEngineSDK/Model/TrackingInformation.cs @@ -52,11 +52,14 @@ public partial class TrackingInformation /// Carrier detail code /// /// Carrier detail code + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// OT /// [JsonPropertyName("carrier_detail_code"), JsonInclude] - public string? CarrierDetailCode { get; private set; } + public string? CarrierDetailCode { get; set; } /// /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. @@ -72,21 +75,27 @@ public partial class TrackingInformation /// Carrier status code /// /// Carrier status code + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 1 /// [JsonPropertyName("carrier_status_code"), JsonInclude] - public string? CarrierStatusCode { get; private set; } + public string? CarrierStatusCode { get; set; } /// /// carrier status description /// /// carrier status description + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// Your item was delivered in or at the mailbox at 9:10 am on March /// [JsonPropertyName("carrier_status_description"), JsonInclude] - public string? CarrierStatusDescription { get; private set; } + public string? CarrierStatusDescription { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -102,15 +111,21 @@ public partial class TrackingInformation /// The events that have occured during the lifetime of this tracking number. /// /// The events that have occured during the lifetime of this tracking number. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("events"), JsonInclude] - public List? Events { get; private set; } + public List? Events { get; set; } /// /// Exception description /// /// Exception description + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("exception_description"), JsonInclude] - public string? ExceptionDescription { get; private set; } + public string? ExceptionDescription { get; set; } /// /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. @@ -132,11 +147,14 @@ public partial class TrackingInformation /// Status description /// /// Status description + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// Delivered /// [JsonPropertyName("status_description"), JsonInclude] - public string? StatusDescription { get; private set; } + public string? StatusDescription { get; set; } /// /// A tracking number for a package. The format depends on the carrier. @@ -152,11 +170,14 @@ public partial class TrackingInformation /// Carrier Tracking Url, if available /// /// Carrier Tracking Url, if available + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 /// [JsonPropertyName("tracking_url"), JsonInclude] - public string? TrackingUrl { get; private set; } + public string? TrackingUrl { get; set; } /// diff --git a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs index 652d9d69..b04ec59d 100644 --- a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs @@ -102,11 +102,14 @@ public override bool CanConvert(Type typeToConvert) => /// The date and time that the image was created in ShipEngine. /// /// The date and time that the image was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// The image type @@ -129,21 +132,27 @@ public override bool CanConvert(Type typeToConvert) => /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. /// /// A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// img_DtBXupDBxREpHnwEXhTfgK /// [JsonPropertyName("label_image_id"), JsonInclude] - public string? LabelImageId { get; private set; } + public string? LabelImageId { get; set; } /// /// The date and time that the image was modified in ShipEngine. /// /// The date and time that the image was modified in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at"), JsonInclude] - public DateTimeOffset? ModifiedAt { get; private set; } + public DateTimeOffset? ModifiedAt { get; set; } /// /// A human readable name for the image. diff --git a/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs b/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs index 22ddee4a..1b748f91 100644 --- a/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs @@ -80,11 +80,14 @@ public partial class UpdateShipmentRequestBody /// The date and time that the shipment was created in ShipEngine. /// /// The date and time that the shipment was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// Customs information. This is usually only needed for international shipments. @@ -132,11 +135,14 @@ public partial class UpdateShipmentRequestBody /// The date and time that the shipment was created or last modified. /// /// The date and time that the shipment was created or last modified. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at"), JsonInclude] - public DateTimeOffset? ModifiedAt { get; private set; } + public DateTimeOffset? ModifiedAt { get; set; } /// /// Gets or Sets OrderSourceCode @@ -182,11 +188,14 @@ public partial class UpdateShipmentRequestBody /// A string that uniquely identifies the shipment /// /// A string that uniquely identifies the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. @@ -199,8 +208,11 @@ public partial class UpdateShipmentRequestBody /// The current status of the shipment /// /// The current status of the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipment_status"), JsonInclude] - public ShipmentStatus? ShipmentStatus { get; private set; } + public ShipmentStatus? ShipmentStatus { get; set; } /// /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment @@ -216,8 +228,11 @@ public partial class UpdateShipmentRequestBody /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tags"), JsonInclude] - public List? Tags { get; private set; } + public List? Tags { get; set; } /// /// Gets or Sets TaxIdentifiers @@ -229,8 +244,11 @@ public partial class UpdateShipmentRequestBody /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("total_weight"), JsonInclude] - public Weight? TotalWeight { get; private set; } + public Weight? TotalWeight { get; set; } /// /// Gets or Sets ValidateAddress diff --git a/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs b/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs index fe95b9b1..b4c6ca12 100644 --- a/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs @@ -63,18 +63,24 @@ public partial class UpdateShipmentResponseBody /// The date and time that the shipment was created in ShipEngine. /// /// The date and time that the shipment was created in ShipEngine. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// An array of errors that occurred while creating shipment. /// /// An array of errors that occurred while creating shipment. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("errors"), JsonInclude, Obsolete] - public List? Errors { get; private set; } + public List? Errors { get; set; } /// /// The insurance provider to use for any insured packages in the shipment. @@ -135,32 +141,44 @@ public partial class UpdateShipmentResponseBody /// A string that uniquely identifies the shipment /// /// A string that uniquely identifies the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; private set; } + public string? ShipmentId { get; set; } /// /// The current status of the shipment /// /// The current status of the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("shipment_status"), JsonInclude] - public ShipmentStatus? ShipmentStatus { get; private set; } + public ShipmentStatus? ShipmentStatus { get; set; } /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. /// /// Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("tags"), JsonInclude] - public List? Tags { get; private set; } + public List? Tags { get; set; } /// /// The combined weight of all packages in the shipment /// /// The combined weight of all packages in the shipment + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("total_weight"), JsonInclude] - public Weight? TotalWeight { get; private set; } + public Weight? TotalWeight { get; set; } /// /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. @@ -211,11 +229,14 @@ public partial class UpdateShipmentResponseBody /// The date and time that the shipment was created or last modified. /// /// The date and time that the shipment was created or last modified. + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2018-09-23T15:00Z /// [JsonPropertyName("modified_at"), JsonInclude] - public DateTimeOffset? ModifiedAt { get; private set; } + public DateTimeOffset? ModifiedAt { get; set; } /// /// Gets or Sets OrderSourceCode diff --git a/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs b/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs index 335d8a80..bfec53e9 100644 --- a/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs @@ -49,11 +49,14 @@ public partial class UpdateWarehouseRequestBody /// Timestamp that indicates when the warehouse was created /// /// Timestamp that indicates when the warehouse was created + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2019-06-25T18:12:35.583Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// Designates which single warehouse is the default on the account @@ -73,11 +76,14 @@ public partial class UpdateWarehouseRequestBody /// A string that uniquely identifies the warehouse /// /// A string that uniquely identifies the warehouse + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("warehouse_id"), JsonInclude] - public string? WarehouseId { get; private set; } + public string? WarehouseId { get; set; } /// diff --git a/ShipEngineSDK/Model/VoidLabelResponseBody.cs b/ShipEngineSDK/Model/VoidLabelResponseBody.cs index d19a9d97..30a72722 100644 --- a/ShipEngineSDK/Model/VoidLabelResponseBody.cs +++ b/ShipEngineSDK/Model/VoidLabelResponseBody.cs @@ -32,27 +32,36 @@ public partial class VoidLabelResponseBody /// Indicates whether the attempt to void the label was successful /// /// Indicates whether the attempt to void the label was successful + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// false /// [JsonPropertyName("approved"), JsonInclude] - public bool? Approved { get; private set; } + public bool? Approved { get; set; } /// /// Gets or Sets Message /// + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// Unable to delete FedEx shipment. Unable to retrieve record from database. /// [JsonPropertyName("message"), JsonInclude] - public string? Message { get; private set; } + public string? Message { get; set; } /// /// Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later. /// /// Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later. + /// + /// This should not be used for input as it will be ignored on serialization. + /// [JsonPropertyName("reason_code"), JsonInclude] - public ReasonCode? ReasonCode { get; private set; } + public ReasonCode? ReasonCode { get; set; } /// diff --git a/ShipEngineSDK/Model/Warehouse.cs b/ShipEngineSDK/Model/Warehouse.cs index 0e1eb809..032a76b1 100644 --- a/ShipEngineSDK/Model/Warehouse.cs +++ b/ShipEngineSDK/Model/Warehouse.cs @@ -32,11 +32,14 @@ public partial class Warehouse /// Timestamp that indicates when the warehouse was created /// /// Timestamp that indicates when the warehouse was created + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// 2019-06-25T18:12:35.583Z /// [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; private set; } + public DateTimeOffset? CreatedAt { get; set; } /// /// Designates which single warehouse is the default on the account @@ -73,11 +76,14 @@ public partial class Warehouse /// A string that uniquely identifies the warehouse /// /// A string that uniquely identifies the warehouse + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("warehouse_id"), JsonInclude] - public string? WarehouseId { get; private set; } + public string? WarehouseId { get; set; } /// diff --git a/ShipEngineSDK/Model/Webhook.cs b/ShipEngineSDK/Model/Webhook.cs index 5021844c..4e901a90 100644 --- a/ShipEngineSDK/Model/Webhook.cs +++ b/ShipEngineSDK/Model/Webhook.cs @@ -55,11 +55,14 @@ public partial class Webhook /// A string that uniquely identifies the webhook /// /// A string that uniquely identifies the webhook + /// + /// This should not be used for input as it will be ignored on serialization. + /// /// /// se-28529731 /// [JsonPropertyName("webhook_id"), JsonInclude] - public string? WebhookId { get; private set; } + public string? WebhookId { get; set; } /// diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index f71bc131..a7038ef9 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-beta.3 + 3.0.0-beta.4 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET diff --git a/generation/templates/modelGeneric.mustache b/generation/templates/modelGeneric.mustache index 17ed6f7f..09fb94e2 100644 --- a/generation/templates/modelGeneric.mustache +++ b/generation/templates/modelGeneric.mustache @@ -41,6 +41,11 @@ {{#description}} /// {{.}} {{/description}} + {{#isReadOnly}} + /// + /// This should not be used for input as it will be ignored on serialization. + /// + {{/isReadOnly}} {{#example}} /// /// {{.}} @@ -77,8 +82,15 @@ {{/items.vars}} /// /// {{description}}{{^description}}Gets or Sets {{{name}}}{{/description}} - /// {{#description}} - /// {{.}}{{/description}} + /// + {{#description}} + /// {{.}} + {{/description}} + {{#isReadOnly}} + /// + /// This should not be used for input as it will be ignored on serialization. + /// + {{/isReadOnly}} {{#example}} /// /// {{.}} diff --git a/generation/templates/modelOneOf.mustache b/generation/templates/modelOneOf.mustache index 896dcb06..720448ac 100644 --- a/generation/templates/modelOneOf.mustache +++ b/generation/templates/modelOneOf.mustache @@ -36,6 +36,11 @@ {{#description}} /// {{.}} {{/description}} + {{#isReadOnly}} + /// + /// This should not be used for input as it will be ignored on serialization. + /// + {{/isReadOnly}} {{#example}} /// /// {{.}} @@ -50,8 +55,15 @@ {{^isEnum}} /// /// {{description}}{{^description}}Gets or Sets {{{name}}}{{/description}} - /// {{#description}} - /// {{.}}{{/description}} + /// + {{#description}} + /// {{.}} + {{/description}} + {{#isReadOnly}} + /// + /// This should not be used for input as it will be ignored on serialization. + /// + {{/isReadOnly}} {{#example}} /// /// {{.}} diff --git a/generation/templates/partial_getSet.mustache b/generation/templates/partial_getSet.mustache index 7609e35a..65a426a1 100644 --- a/generation/templates/partial_getSet.mustache +++ b/generation/templates/partial_getSet.mustache @@ -1 +1 @@ -{ get; {{#isReadOnly}}private {{/isReadOnly}}set; } \ No newline at end of file +{ get; set; } \ No newline at end of file diff --git a/openapitools.json b/openapitools.json index 89c8afe9..0bf912f3 100644 --- a/openapitools.json +++ b/openapitools.json @@ -14,7 +14,7 @@ "ignoreFileOverride": "./.openapi-generator-ignore", "library": "generichost", "additionalProperties": { - "packageVersion": "3.0.0-beta.3", + "packageVersion": "3.0.0-beta.4", "targetFramework": "netstandard2.0", "validatable": false, "sourceFolder": "", diff --git a/package.json b/package.json index 387b0600..5faaf70b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "shipengine-dotnet", - "version": "3.0.0-beta.3", + "version": "3.0.0-beta.4", "description": "Package primarily used to generate the API and models from OpenApi spec\"", "main": "index.js", "directories": { From 61b665aeff977dac4ed68b213d2699ee8024b0a4 Mon Sep 17 00:00:00 2001 From: Joshua Flanagan Date: Mon, 22 Jul 2024 17:18:29 -0500 Subject: [PATCH 13/42] Allow SDK to handle No Content (204) responses Previously, the SDK would throw an exception when trying to parse an empty string. Now we will return the empty string, if a string response is requested. If the caller was expecting a deserialized type, an exception will still be raised for no content. --- .../Helpers/MockShipEngineFixture.cs | 2 +- ShipEngineSDK.Test/ShipEngineClientTests.cs | 36 ++++++++++++++++++- ShipEngineSDK/ShipEngineClient.cs | 5 +++ 3 files changed, 41 insertions(+), 2 deletions(-) diff --git a/ShipEngineSDK.Test/Helpers/MockShipEngineFixture.cs b/ShipEngineSDK.Test/Helpers/MockShipEngineFixture.cs index 817545a1..6d4d6ba5 100644 --- a/ShipEngineSDK.Test/Helpers/MockShipEngineFixture.cs +++ b/ShipEngineSDK.Test/Helpers/MockShipEngineFixture.cs @@ -77,7 +77,7 @@ public string StubRequest(HttpMethod method, string path, HttpStatusCode status, { var requestId = Guid.NewGuid().ToString(); var responseMessage = new HttpResponseMessage(status); - responseMessage.Content = new StringContent(response); + responseMessage.Content = new StringContent(response ?? ""); responseMessage.Headers.Add("x-shipengine-requestid", requestId); responseMessage.Headers.Add("request-id", requestId); diff --git a/ShipEngineSDK.Test/ShipEngineClientTests.cs b/ShipEngineSDK.Test/ShipEngineClientTests.cs index d8d7d744..0024f1f7 100644 --- a/ShipEngineSDK.Test/ShipEngineClientTests.cs +++ b/ShipEngineSDK.Test/ShipEngineClientTests.cs @@ -167,7 +167,7 @@ public async Task SuccessResponseThatCannotBeParsedThrowsExceptionWithUnparsedRe } [Fact] - public async Task SuccessResponseWithNullContentThrowsShipEngineExceptionWithUnparsedResponse() + public async Task SuccessResponseWithNullStringContentThrowsShipEngineExceptionWithUnparsedResponse() { var config = new Config(apiKey: "test", timeout: TimeSpan.FromSeconds(0.5)); var mockShipEngineFixture = new MockShipEngineFixture(config); @@ -189,5 +189,39 @@ public async Task SuccessResponseWithNullContentThrowsShipEngineExceptionWithUnp Assert.Equal(responseBody, await ex.ResponseMessage.Content.ReadAsStringAsync()); Assert.Equal(requestId, ex.RequestId); } + + [Fact] + public async Task SuccessResponseWhenStringRequestedReturnsUnparsedString() + { + var config = new Config(apiKey: "test", timeout: TimeSpan.FromSeconds(0.5)); + var mockShipEngineFixture = new MockShipEngineFixture(config); + var shipengine = mockShipEngineFixture.ShipEngine; + + // this scenario is similar to unparseable JSON - except that it is valid JSON + var responseBody = @"The Response"; + mockShipEngineFixture.StubRequest(HttpMethod.Delete, "/v1/something", System.Net.HttpStatusCode.OK, + responseBody); + var result = await shipengine.SendHttpRequestAsync(HttpMethod.Delete, "/v1/something", "", + mockShipEngineFixture.HttpClient, config); + + Assert.Equal(responseBody, result); + } + + [Fact] + public async Task SuccessResponseWithNoContentCanBeReturnedIfStringRequested() + { + var config = new Config(apiKey: "test", timeout: TimeSpan.FromSeconds(0.5)); + var mockShipEngineFixture = new MockShipEngineFixture(config); + var shipengine = mockShipEngineFixture.ShipEngine; + + // this scenario is similar to unparseable JSON - except that it is valid JSON + string responseBody = null; + mockShipEngineFixture.StubRequest(HttpMethod.Delete, "/v1/something", System.Net.HttpStatusCode.OK, + responseBody); + var result = await shipengine.SendHttpRequestAsync(HttpMethod.Delete, "/v1/something", "", + mockShipEngineFixture.HttpClient, config); + + Assert.Null(responseBody); + } } } \ No newline at end of file diff --git a/ShipEngineSDK/ShipEngineClient.cs b/ShipEngineSDK/ShipEngineClient.cs index 85e38d35..3e69ac69 100644 --- a/ShipEngineSDK/ShipEngineClient.cs +++ b/ShipEngineSDK/ShipEngineClient.cs @@ -155,6 +155,11 @@ private async Task DeserializedResultOrThrow(HttpResponseMessage response) } T? result; + // If the caller asked for a string, return the response as-is. This can be useful for no content responses. + if (typeof(T).IsAssignableFrom(typeof(string))) + { + return (T)(object)(contentString ?? ""); + } try { result = JsonSerializer.Deserialize(contentString, JsonSerializerOptions); From f7cbdf85f6602892b3941fe367333daf057fd8b3 Mon Sep 17 00:00:00 2001 From: Joshua Flanagan Date: Mon, 22 Jul 2024 18:33:53 -0500 Subject: [PATCH 14/42] bump version for beta5 --- ShipEngineSDK/ShipEngineSDK.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index a7038ef9..8d750c0f 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-beta.4 + 3.0.0-beta.5 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET From a137a3fa42b4b8dbd0b373ac4622e4de47c10091 Mon Sep 17 00:00:00 2001 From: Joshua Flanagan Date: Tue, 23 Jul 2024 16:04:50 -0500 Subject: [PATCH 15/42] Remove version from generated files Including the version in every file causes every file to be modified any time the generator is run. This creates a large diff that obscures the actual changes. The version is already known in the generation/swagger.json file. Add warning that file is generated and should not be modified. --- ShipEngineSDK/Api/AccountApi.cs | 12 +++++------- ShipEngineSDK/Api/AddressesApi.cs | 12 +++++------- ShipEngineSDK/Api/BatchesApi.cs | 12 +++++------- ShipEngineSDK/Api/CarrierAccountsApi.cs | 12 +++++------- ShipEngineSDK/Api/CarriersApi.cs | 12 +++++------- ShipEngineSDK/Api/DownloadsApi.cs | 12 +++++------- ShipEngineSDK/Api/InsuranceApi.cs | 12 +++++------- ShipEngineSDK/Api/LabelsApi.cs | 12 +++++------- ShipEngineSDK/Api/ManifestsApi.cs | 12 +++++------- ShipEngineSDK/Api/PackagePickupsApi.cs | 12 +++++------- ShipEngineSDK/Api/PackageTypesApi.cs | 12 +++++------- ShipEngineSDK/Api/RatesApi.cs | 12 +++++------- ShipEngineSDK/Api/ServicePointsApi.cs | 12 +++++------- ShipEngineSDK/Api/ShipmentsApi.cs | 12 +++++------- ShipEngineSDK/Api/TagsApi.cs | 12 +++++------- ShipEngineSDK/Api/TokensApi.cs | 12 +++++------- ShipEngineSDK/Api/TrackingApi.cs | 12 +++++------- ShipEngineSDK/Api/WarehousesApi.cs | 12 +++++------- ShipEngineSDK/Api/WebhooksApi.cs | 12 +++++------- ShipEngineSDK/Model/AccountSettings.cs | 12 +++++------- ShipEngineSDK/Model/AccountSettingsImages.cs | 12 +++++------- .../Model/AddFundsToCarrierRequestBody.cs | 12 +++++------- .../Model/AddFundsToCarrierResponseBody.cs | 12 +++++------- .../Model/AddFundsToInsuranceRequestBody.cs | 12 +++++------- .../Model/AddFundsToInsuranceResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/AddToBatchRequestBody.cs | 12 +++++------- ShipEngineSDK/Model/Address.cs | 12 +++++------- .../Model/AddressResidentialIndicator.cs | 12 +++++------- ShipEngineSDK/Model/AddressToValidate.cs | 12 +++++------- .../Model/AddressValidatingShipment.cs | 12 +++++------- ShipEngineSDK/Model/AddressValidationCode.cs | 12 +++++------- .../Model/AddressValidationDetailCode.cs | 12 +++++------- .../Model/AddressValidationMessageType.cs | 12 +++++------- ShipEngineSDK/Model/AddressValidationResult.cs | 12 +++++------- ShipEngineSDK/Model/AddressValidationStatus.cs | 12 +++++------- ShipEngineSDK/Model/AdvancedShipmentOptions.cs | 12 +++++------- ...ncedShipmentOptionsDangerousGoodsContact.cs | 12 +++++------- .../AdvancedShipmentOptionsFedexFreight.cs | 12 +++++------- ShipEngineSDK/Model/AllowedIncoterms.cs | 12 +++++------- ShipEngineSDK/Model/AlternativeIdentifier.cs | 12 +++++------- ShipEngineSDK/Model/AlternativeIdentifiers.cs | 12 +++++------- .../Model/AncillaryServiceEndorsement.cs | 12 +++++------- ShipEngineSDK/Model/Batch.cs | 12 +++++------- ShipEngineSDK/Model/BatchResponseError.cs | 12 +++++------- ShipEngineSDK/Model/BatchStatus.cs | 12 +++++------- ShipEngineSDK/Model/BatchesSortBy.cs | 12 +++++------- ShipEngineSDK/Model/BillToParty.cs | 12 +++++------- ShipEngineSDK/Model/BulkRate.cs | 12 +++++------- .../Model/CalculateRatesRequestBody.cs | 12 +++++------- .../Model/CalculateRatesResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/Carrier.cs | 12 +++++------- ShipEngineSDK/Model/CarrierAdvancedOption.cs | 12 +++++------- ShipEngineSDK/Model/CarrierName.cs | 12 +++++------- ShipEngineSDK/Model/CarrierNameWithSettings.cs | 12 +++++------- ShipEngineSDK/Model/CollectOnDelivery.cs | 12 +++++------- .../Model/CollectOnDeliveryPaymentType.cs | 12 +++++------- .../Model/CompareBulkRatesRequestBody.cs | 12 +++++------- .../Model/ConnectAccessWorldwideRequestBody.cs | 12 +++++------- .../ConnectAmazonBuyShippingRequestBody.cs | 12 +++++------- ShipEngineSDK/Model/ConnectAmazonShippingUk.cs | 12 +++++------- ShipEngineSDK/Model/ConnectApcRequestBody.cs | 12 +++++------- .../Model/ConnectAsendiaRequestBody.cs | 12 +++++------- .../Model/ConnectAustraliaPostRequestBody.cs | 12 +++++------- .../Model/ConnectCanadaPostRequestBody.cs | 12 +++++------- .../Model/ConnectCarrierRequestBody.cs | 12 +++++------- .../Model/ConnectCarrierResponseBody.cs | 12 +++++------- .../Model/ConnectDhlEcommerceRequestBody.cs | 12 +++++------- .../Model/ConnectDhlExpressAuRequestBody.cs | 12 +++++------- .../Model/ConnectDhlExpressCaRequestBody.cs | 12 +++++------- .../Model/ConnectDhlExpressRequestBody.cs | 12 +++++------- .../Model/ConnectDhlExpressUkRequestBody.cs | 12 +++++------- ShipEngineSDK/Model/ConnectDpdRequestBody.cs | 12 +++++------- .../Model/ConnectEndiciaRequestBody.cs | 12 +++++------- ShipEngineSDK/Model/ConnectFedexRequestBody.cs | 12 +++++------- .../Model/ConnectFedexUkRequestBody.cs | 12 +++++------- .../Model/ConnectFirstmileRequestBody.cs | 12 +++++------- ShipEngineSDK/Model/ConnectImexRequestBody.cs | 12 +++++------- .../Model/ConnectInsurerRequestBody.cs | 12 +++++------- .../Model/ConnectLasershipRequestBody.cs | 12 +++++------- .../Model/ConnectNewgisticsRequestBody.cs | 12 +++++------- .../Model/ConnectOntracRequestBody.cs | 12 +++++------- .../Model/ConnectPurolatorRequestBody.cs | 12 +++++------- .../Model/ConnectRoyalMailRequestBody.cs | 12 +++++------- .../Model/ConnectRrDonnelleyRequestBody.cs | 12 +++++------- ShipEngineSDK/Model/ConnectSekoRequestBody.cs | 12 +++++------- .../Model/ConnectSendleRequestBody.cs | 12 +++++------- .../Model/ConnectStampsRequestBody.cs | 12 +++++------- ShipEngineSDK/Model/ConnectUpsRequestBody.cs | 12 +++++------- ShipEngineSDK/Model/ContactDetails.cs | 12 +++++------- .../CreateAccountSettingsImageRequestBody.cs | 12 +++++------- .../Model/CreateAndProcessBatchRequestBody.cs | 12 +++++------- ...eAndProcessBatchRequestBodyProcessLabels.cs | 12 +++++------- .../Model/CreateAndValidateShipment.cs | 12 +++++------- ShipEngineSDK/Model/CreateBatchRequest.cs | 12 +++++------- ShipEngineSDK/Model/CreateBatchRequestBody.cs | 12 +++++------- ShipEngineSDK/Model/CreateBatchResponseBody.cs | 12 +++++------- .../Model/CreateLabelFromRateRequestBody.cs | 12 +++++------- .../Model/CreateLabelFromRateResponseBody.cs | 12 +++++------- .../CreateLabelFromShipmentRequestBody.cs | 12 +++++------- .../CreateLabelFromShipmentResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/CreateLabelRequestBody.cs | 12 +++++------- ShipEngineSDK/Model/CreateLabelResponseBody.cs | 12 +++++------- .../Model/CreateManifestByObjectRequestBody.cs | 12 +++++------- .../Model/CreateManifestLabelIdsRequestBody.cs | 12 +++++------- .../Model/CreateManifestRequestBody.cs | 12 +++++------- .../Model/CreateManifestResponseBody.cs | 12 +++++------- .../Model/CreatePackageTypeRequestBody.cs | 12 +++++------- .../Model/CreatePackageTypeResponseBody.cs | 12 +++++------- .../Model/CreateReturnLabelRequestBody.cs | 12 +++++------- .../Model/CreateReturnLabelResponseBody.cs | 12 +++++------- .../Model/CreateShipmentResponseBodyFields.cs | 12 +++++------- .../Model/CreateShipmentsRequestBody.cs | 12 +++++------- .../Model/CreateShipmentsResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/CreateTagResponseBody.cs | 12 +++++------- .../Model/CreateWarehouseRequestBody.cs | 12 +++++------- .../Model/CreateWarehouseResponseBody.cs | 12 +++++------- .../Model/CreateWebhookRequestBody.cs | 12 +++++------- .../Model/CreateWebhookResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/CustomsItem.cs | 12 +++++------- ShipEngineSDK/Model/DangerousAmount.cs | 12 +++++------- ShipEngineSDK/Model/DangerousGoods.cs | 12 +++++------- ShipEngineSDK/Model/DefaultLabelLayout.cs | 12 +++++------- .../Model/DeletePickupByIdResponseBody.cs | 12 +++++------- .../Model/DeleteScheduledPickupResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/DeliveryConfirmation.cs | 12 +++++------- ShipEngineSDK/Model/DeprecatedManifest.cs | 12 +++++------- .../Model/DhlExpressAccountSettings.cs | 12 +++++------- .../Model/DhlExpressSettingsResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/DimensionUnit.cs | 12 +++++------- ShipEngineSDK/Model/Dimensions.cs | 12 +++++------- ShipEngineSDK/Model/DisplayScheme.cs | 12 +++++------- ShipEngineSDK/Model/Error.cs | 12 +++++------- ShipEngineSDK/Model/ErrorCode.cs | 12 +++++------- ShipEngineSDK/Model/ErrorResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/ErrorSource.cs | 12 +++++------- ShipEngineSDK/Model/ErrorType.cs | 12 +++++------- .../Model/ErrorWithLabelIdResponseBody.cs | 12 +++++------- .../Model/EstimateRatesRequestBody.cs | 12 +++++------- ShipEngineSDK/Model/FedexAccountSettings.cs | 12 +++++------- .../Model/FedexAccountSettingsRequestBody.cs | 12 +++++------- ShipEngineSDK/Model/FedexPickupType.cs | 12 +++++------- .../Model/FedexSettingsResponseBody.cs | 12 +++++------- .../GetAccountSettingsImagesResponseBody.cs | 12 +++++------- .../Model/GetAccountSettingsResponseBody.cs | 12 +++++------- .../Model/GetBatchByExternalIdResponseBody.cs | 12 +++++------- .../Model/GetBatchByIdResponseBody.cs | 12 +++++------- .../Model/GetCarrierByIdResponseBody.cs | 12 +++++------- .../Model/GetCarrierOptionsResponseBody.cs | 12 +++++------- .../Model/GetCarrierSettingsResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/GetCarriersResponseBody.cs | 12 +++++------- .../Model/GetInsuranceBalanceResponseBody.cs | 12 +++++------- ...GetLabelByExternalShipmentIdResponseBody.cs | 12 +++++------- .../Model/GetLabelByIdResponseBody.cs | 12 +++++------- .../Model/GetManifestByIdResponseBody.cs | 12 +++++------- .../Model/GetPackageTypeByIdResponseBody.cs | 12 +++++------- .../Model/GetPickupByIdResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/GetPickupsResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/GetRateByIdResponseBody.cs | 12 +++++------- .../Model/GetServicePointByIdResponseBody.cs | 12 +++++------- ...ServicePointByIdResponseBodyServicePoint.cs | 12 +++++------- ShipEngineSDK/Model/GetServicePointsRequest.cs | 12 +++++------- .../Model/GetServicePointsRequestBody.cs | 12 +++++------- .../GetServicePointsRequestBodyAddress.cs | 12 +++++------- ...etServicePointsRequestBodyProvidersInner.cs | 12 +++++------- .../GetServicePointsRequestBodyShipment.cs | 12 +++++------- .../GetShipmentByExternalIdResponseBody.cs | 12 +++++------- .../Model/GetShipmentByIdResponseBody.cs | 12 +++++------- .../GetTrackingLogFromLabelResponseBody.cs | 12 +++++------- .../Model/GetTrackingLogResponseBody.cs | 12 +++++------- .../Model/GetWarehouseByIdResponseBody.cs | 12 +++++------- .../Model/GetWebhookByIdResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/IdentifierType.cs | 12 +++++------- ShipEngineSDK/Model/ImporterOfRecords.cs | 12 +++++------- ShipEngineSDK/Model/InsuranceProvider.cs | 12 +++++------- .../Model/InternationalShipmentOptions.cs | 12 +++++------- .../Model/InvoiceAdditionalDetails.cs | 12 +++++------- ShipEngineSDK/Model/Label.cs | 12 +++++------- ShipEngineSDK/Model/LabelChargeEvent.cs | 12 +++++------- ShipEngineSDK/Model/LabelDownload.cs | 12 +++++------- ShipEngineSDK/Model/LabelDownloadType.cs | 12 +++++------- ShipEngineSDK/Model/LabelFormat.cs | 12 +++++------- ShipEngineSDK/Model/LabelLayout.cs | 12 +++++------- ShipEngineSDK/Model/LabelMessages.cs | 12 +++++------- ShipEngineSDK/Model/LabelPackagesInner.cs | 12 +++++------- ShipEngineSDK/Model/LabelStatus.cs | 12 +++++------- ShipEngineSDK/Model/Link.cs | 12 +++++------- .../Model/ListAccountImagesResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/ListAccountSettingsBody.cs | 12 +++++------- .../ListAccountSettingsImagesResponseBody.cs | 12 +++++------- .../Model/ListBatchErrorsResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/ListBatchesResponseBody.cs | 12 +++++------- .../ListCarrierPackageTypesResponseBody.cs | 12 +++++------- .../Model/ListCarrierServicesResponseBody.cs | 12 +++++------- .../Model/ListCarriersResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/ListLabelsResponseBody.cs | 12 +++++------- .../Model/ListManifestsResponseBody.cs | 12 +++++------- .../Model/ListPackageTypesResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/ListPickupResponseBody.cs | 12 +++++------- .../Model/ListServicePointsResponseBody.cs | 12 +++++------- ...vicePointsResponseBodyServicePointsInner.cs | 12 +++++------- ...seBodyServicePointsInnerHoursOfOperation.cs | 12 +++++------- ...cePointsInnerHoursOfOperationMondayInner.cs | 12 +++++------- .../Model/ListShipmentRatesResponseBody.cs | 12 +++++------- .../Model/ListShipmentsResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/ListTagsResponseBody.cs | 12 +++++------- .../Model/ListWarehousesResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/Manifest.cs | 12 +++++------- ShipEngineSDK/Model/ManifestDownload.cs | 12 +++++------- ShipEngineSDK/Model/ManifestRequest.cs | 12 +++++------- ShipEngineSDK/Model/ManifestRequestStatus.cs | 12 +++++------- ShipEngineSDK/Model/Manifests.cs | 12 +++++------- ShipEngineSDK/Model/ManifestsRequests.cs | 12 +++++------- ShipEngineSDK/Model/ModifyBatch.cs | 12 +++++------- ShipEngineSDK/Model/MonetaryValue.cs | 12 +++++------- ShipEngineSDK/Model/NonDelivery.cs | 12 +++++------- ShipEngineSDK/Model/OptionalLink.cs | 12 +++++------- ShipEngineSDK/Model/OrderSourceName.cs | 12 +++++------- ShipEngineSDK/Model/OriginType.cs | 12 +++++------- ShipEngineSDK/Model/Package.cs | 12 +++++------- ShipEngineSDK/Model/PackageContents.cs | 12 +++++------- ShipEngineSDK/Model/PackageType.cs | 12 +++++------- ShipEngineSDK/Model/PackagingGroup.cs | 12 +++++------- .../Model/PackagingInstructionSection.cs | 12 +++++------- ShipEngineSDK/Model/PagedListResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/PaginationLink.cs | 12 +++++------- ShipEngineSDK/Model/PaperlessDownload.cs | 12 +++++------- ShipEngineSDK/Model/ParseAddressRequestBody.cs | 12 +++++------- .../Model/ParseAddressResponseBody.cs | 12 +++++------- .../Model/ParseShipmentRequestBody.cs | 12 +++++------- .../Model/ParseShipmentResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/PartialAddress.cs | 12 +++++------- ShipEngineSDK/Model/PartialShipment.cs | 12 +++++------- ShipEngineSDK/Model/PartialShippingAddress.cs | 12 +++++------- .../Model/PartialShippingAddressTo.cs | 12 +++++------- ...PartialShippingAddressToGeolocationInner.cs | 12 +++++------- ShipEngineSDK/Model/PaymentAmount.cs | 12 +++++------- ShipEngineSDK/Model/Pickup.cs | 12 +++++------- ShipEngineSDK/Model/PickupResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/PickupWindow.cs | 12 +++++------- ShipEngineSDK/Model/PickupWindows.cs | 12 +++++------- ShipEngineSDK/Model/ProcessBatchRequestBody.cs | 12 +++++------- ShipEngineSDK/Model/Products.cs | 12 +++++------- .../Model/PurchaseLabelWithoutShipment.cs | 12 +++++------- ShipEngineSDK/Model/Rate.cs | 12 +++++------- ShipEngineSDK/Model/RateEstimate.cs | 12 +++++------- ShipEngineSDK/Model/RateEstimateByCarrierId.cs | 12 +++++------- .../Model/RateEstimateByCarrierIds.cs | 12 +++++------- ShipEngineSDK/Model/RateEstimateOptions.cs | 12 +++++------- ShipEngineSDK/Model/RateRequestBody.cs | 12 +++++------- .../Model/RateRequestByShipmentIds.cs | 12 +++++------- ShipEngineSDK/Model/RateRequestByShipments.cs | 12 +++++------- ShipEngineSDK/Model/RateRequestOptions.cs | 12 +++++------- ShipEngineSDK/Model/RateRequestRateOptions.cs | 12 +++++------- ShipEngineSDK/Model/RateResponse.cs | 12 +++++------- ShipEngineSDK/Model/RateResponseStatus.cs | 12 +++++------- ShipEngineSDK/Model/RateType.cs | 12 +++++------- ShipEngineSDK/Model/RatesInformation.cs | 12 +++++------- ShipEngineSDK/Model/ReasonCode.cs | 12 +++++------- ShipEngineSDK/Model/RecognizedEntity.cs | 12 +++++------- ShipEngineSDK/Model/Redirect.cs | 12 +++++------- ShipEngineSDK/Model/RegulationLevel.cs | 12 +++++------- .../Model/RemoveFromBatchRequestBody.cs | 12 +++++------- ShipEngineSDK/Model/ResponseMessage.cs | 12 +++++------- .../Model/SchedulePickupRequestBody.cs | 12 +++++------- .../Model/SchedulePickupResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/Service.cs | 12 +++++------- ShipEngineSDK/Model/Shipment.cs | 12 +++++------- ShipEngineSDK/Model/ShipmentIdRequest.cs | 12 +++++------- ShipEngineSDK/Model/ShipmentItem.cs | 12 +++++------- ShipEngineSDK/Model/ShipmentRequest.cs | 12 +++++------- ShipEngineSDK/Model/ShipmentStatus.cs | 12 +++++------- ShipEngineSDK/Model/ShipmentsSortBy.cs | 12 +++++------- ShipEngineSDK/Model/ShippingAddress.cs | 12 +++++------- ShipEngineSDK/Model/ShippingAddressTo.cs | 12 +++++------- ShipEngineSDK/Model/SmartPostHub.cs | 12 +++++------- ShipEngineSDK/Model/SortDir.cs | 12 +++++------- ShipEngineSDK/Model/StatusCode.cs | 12 +++++------- ShipEngineSDK/Model/Tag.cs | 12 +++++------- ShipEngineSDK/Model/TagShipmentResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/TaxIdentifier.cs | 12 +++++------- ShipEngineSDK/Model/TaxableEntityType.cs | 12 +++++------- .../TokensGetEphemeralTokenResponseBodyYaml.cs | 12 +++++------- ShipEngineSDK/Model/TrackEvent.cs | 12 +++++------- ShipEngineSDK/Model/TrackingInformation.cs | 12 +++++------- ShipEngineSDK/Model/TrackingStatus.cs | 12 +++++------- ShipEngineSDK/Model/TransportMean.cs | 12 +++++------- .../UpdateAccountSettingsImageRequestBody.cs | 12 +++++------- .../UpdateAmazonBuyShippingRequestBody.cs | 12 +++++------- .../Model/UpdateCarrierSettingsRequestBody.cs | 12 +++++------- .../UpdateDhlExpressSettingsRequestBody.cs | 12 +++++------- .../Model/UpdateFedexSettingsRequestBody.cs | 12 +++++------- .../UpdateNewgisticsSettingsRequestBody.cs | 12 +++++------- .../Model/UpdatePackageTypeRequestBody.cs | 12 +++++------- ShipEngineSDK/Model/UpdateShipmentFields.cs | 12 +++++------- .../Model/UpdateShipmentRequestBody.cs | 12 +++++------- .../Model/UpdateShipmentResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/UpdateShipmentsTags.cs | 12 +++++------- .../Model/UpdateShipmentsTagsRequestBody.cs | 12 +++++------- .../UpdateShipmentsTagsShipmentsTagsInner.cs | 12 +++++------- .../Model/UpdateUpsSettingsRequestBody.cs | 12 +++++------- .../Model/UpdateWarehouseRequestBody.cs | 12 +++++------- .../UpdateWarehouseSettingsRequestBody.cs | 12 +++++------- .../Model/UpdateWebhookRequestBody.cs | 12 +++++------- ShipEngineSDK/Model/UpsAccountSettings.cs | 12 +++++------- ShipEngineSDK/Model/UpsInvoice.cs | 12 +++++------- ShipEngineSDK/Model/UpsPickupType.cs | 12 +++++------- ShipEngineSDK/Model/UpsSettingsResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/ValidateAddress.cs | 12 +++++------- ShipEngineSDK/Model/ValidateShipmentFields.cs | 12 +++++------- ShipEngineSDK/Model/ValidationStatus.cs | 12 +++++------- ShipEngineSDK/Model/VoidLabelResponseBody.cs | 12 +++++------- ShipEngineSDK/Model/Warehouse.cs | 12 +++++------- ShipEngineSDK/Model/Webhook.cs | 12 +++++------- ShipEngineSDK/Model/WebhookEvent.cs | 12 +++++------- ShipEngineSDK/Model/WebhookHeader.cs | 12 +++++------- ShipEngineSDK/Model/Weight.cs | 12 +++++------- ShipEngineSDK/Model/WeightUnit.cs | 12 +++++------- generation/templates/partial_header.mustache | 18 +++++------------- 318 files changed, 1590 insertions(+), 2232 deletions(-) diff --git a/ShipEngineSDK/Api/AccountApi.cs b/ShipEngineSDK/Api/AccountApi.cs index 87b50977..d252b388 100644 --- a/ShipEngineSDK/Api/AccountApi.cs +++ b/ShipEngineSDK/Api/AccountApi.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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 ShipEngineSDK.Model; diff --git a/ShipEngineSDK/Api/AddressesApi.cs b/ShipEngineSDK/Api/AddressesApi.cs index 385afd1c..28dd3ad1 100644 --- a/ShipEngineSDK/Api/AddressesApi.cs +++ b/ShipEngineSDK/Api/AddressesApi.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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 ShipEngineSDK.Model; diff --git a/ShipEngineSDK/Api/BatchesApi.cs b/ShipEngineSDK/Api/BatchesApi.cs index e1baca55..e388d35a 100644 --- a/ShipEngineSDK/Api/BatchesApi.cs +++ b/ShipEngineSDK/Api/BatchesApi.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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 ShipEngineSDK.Model; diff --git a/ShipEngineSDK/Api/CarrierAccountsApi.cs b/ShipEngineSDK/Api/CarrierAccountsApi.cs index 6d213520..d3cf8cde 100644 --- a/ShipEngineSDK/Api/CarrierAccountsApi.cs +++ b/ShipEngineSDK/Api/CarrierAccountsApi.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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 ShipEngineSDK.Model; diff --git a/ShipEngineSDK/Api/CarriersApi.cs b/ShipEngineSDK/Api/CarriersApi.cs index 34f86704..51a144d2 100644 --- a/ShipEngineSDK/Api/CarriersApi.cs +++ b/ShipEngineSDK/Api/CarriersApi.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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 ShipEngineSDK.Model; diff --git a/ShipEngineSDK/Api/DownloadsApi.cs b/ShipEngineSDK/Api/DownloadsApi.cs index 0f657409..6a2d6e3b 100644 --- a/ShipEngineSDK/Api/DownloadsApi.cs +++ b/ShipEngineSDK/Api/DownloadsApi.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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 ShipEngineSDK.Model; diff --git a/ShipEngineSDK/Api/InsuranceApi.cs b/ShipEngineSDK/Api/InsuranceApi.cs index 482f3360..307b2ab0 100644 --- a/ShipEngineSDK/Api/InsuranceApi.cs +++ b/ShipEngineSDK/Api/InsuranceApi.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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 ShipEngineSDK.Model; diff --git a/ShipEngineSDK/Api/LabelsApi.cs b/ShipEngineSDK/Api/LabelsApi.cs index efa8016c..6717e400 100644 --- a/ShipEngineSDK/Api/LabelsApi.cs +++ b/ShipEngineSDK/Api/LabelsApi.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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 ShipEngineSDK.Model; diff --git a/ShipEngineSDK/Api/ManifestsApi.cs b/ShipEngineSDK/Api/ManifestsApi.cs index 06b4b5b0..8cd04cad 100644 --- a/ShipEngineSDK/Api/ManifestsApi.cs +++ b/ShipEngineSDK/Api/ManifestsApi.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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 ShipEngineSDK.Model; diff --git a/ShipEngineSDK/Api/PackagePickupsApi.cs b/ShipEngineSDK/Api/PackagePickupsApi.cs index 356fa53a..ecb7af04 100644 --- a/ShipEngineSDK/Api/PackagePickupsApi.cs +++ b/ShipEngineSDK/Api/PackagePickupsApi.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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 ShipEngineSDK.Model; diff --git a/ShipEngineSDK/Api/PackageTypesApi.cs b/ShipEngineSDK/Api/PackageTypesApi.cs index 5ffce8a0..77cb2586 100644 --- a/ShipEngineSDK/Api/PackageTypesApi.cs +++ b/ShipEngineSDK/Api/PackageTypesApi.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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 ShipEngineSDK.Model; diff --git a/ShipEngineSDK/Api/RatesApi.cs b/ShipEngineSDK/Api/RatesApi.cs index d4f5d82c..1dee183e 100644 --- a/ShipEngineSDK/Api/RatesApi.cs +++ b/ShipEngineSDK/Api/RatesApi.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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 ShipEngineSDK.Model; diff --git a/ShipEngineSDK/Api/ServicePointsApi.cs b/ShipEngineSDK/Api/ServicePointsApi.cs index 119614fa..6b5dd6ae 100644 --- a/ShipEngineSDK/Api/ServicePointsApi.cs +++ b/ShipEngineSDK/Api/ServicePointsApi.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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 ShipEngineSDK.Model; diff --git a/ShipEngineSDK/Api/ShipmentsApi.cs b/ShipEngineSDK/Api/ShipmentsApi.cs index 781ee63b..cc40dfe1 100644 --- a/ShipEngineSDK/Api/ShipmentsApi.cs +++ b/ShipEngineSDK/Api/ShipmentsApi.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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 ShipEngineSDK.Model; diff --git a/ShipEngineSDK/Api/TagsApi.cs b/ShipEngineSDK/Api/TagsApi.cs index 84723269..94031585 100644 --- a/ShipEngineSDK/Api/TagsApi.cs +++ b/ShipEngineSDK/Api/TagsApi.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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 ShipEngineSDK.Model; diff --git a/ShipEngineSDK/Api/TokensApi.cs b/ShipEngineSDK/Api/TokensApi.cs index cbb276cf..679e4c92 100644 --- a/ShipEngineSDK/Api/TokensApi.cs +++ b/ShipEngineSDK/Api/TokensApi.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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 ShipEngineSDK.Model; diff --git a/ShipEngineSDK/Api/TrackingApi.cs b/ShipEngineSDK/Api/TrackingApi.cs index bafaa75d..6e80832f 100644 --- a/ShipEngineSDK/Api/TrackingApi.cs +++ b/ShipEngineSDK/Api/TrackingApi.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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 ShipEngineSDK.Model; diff --git a/ShipEngineSDK/Api/WarehousesApi.cs b/ShipEngineSDK/Api/WarehousesApi.cs index a9bbb6a6..e13d4502 100644 --- a/ShipEngineSDK/Api/WarehousesApi.cs +++ b/ShipEngineSDK/Api/WarehousesApi.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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 ShipEngineSDK.Model; diff --git a/ShipEngineSDK/Api/WebhooksApi.cs b/ShipEngineSDK/Api/WebhooksApi.cs index c0d992f9..9c6c951d 100644 --- a/ShipEngineSDK/Api/WebhooksApi.cs +++ b/ShipEngineSDK/Api/WebhooksApi.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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 ShipEngineSDK.Model; diff --git a/ShipEngineSDK/Model/AccountSettings.cs b/ShipEngineSDK/Model/AccountSettings.cs index 0bd33f26..018320e2 100644 --- a/ShipEngineSDK/Model/AccountSettings.cs +++ b/ShipEngineSDK/Model/AccountSettings.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AccountSettingsImages.cs b/ShipEngineSDK/Model/AccountSettingsImages.cs index b7e01eb9..8fd68e12 100644 --- a/ShipEngineSDK/Model/AccountSettingsImages.cs +++ b/ShipEngineSDK/Model/AccountSettingsImages.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs b/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs index 43be557b..85f1a1c3 100644 --- a/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs +++ b/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs b/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs index cf28da28..802dc21f 100644 --- a/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs +++ b/ShipEngineSDK/Model/AddFundsToCarrierResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs b/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs index 4506da48..26f9382a 100644 --- a/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs +++ b/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs b/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs index 4c12ccc6..ea8438cd 100644 --- a/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs +++ b/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AddToBatchRequestBody.cs b/ShipEngineSDK/Model/AddToBatchRequestBody.cs index 78e8b206..25d63d7a 100644 --- a/ShipEngineSDK/Model/AddToBatchRequestBody.cs +++ b/ShipEngineSDK/Model/AddToBatchRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Address.cs b/ShipEngineSDK/Model/Address.cs index 089abb25..94615494 100644 --- a/ShipEngineSDK/Model/Address.cs +++ b/ShipEngineSDK/Model/Address.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AddressResidentialIndicator.cs b/ShipEngineSDK/Model/AddressResidentialIndicator.cs index 145fabb4..b8891f07 100644 --- a/ShipEngineSDK/Model/AddressResidentialIndicator.cs +++ b/ShipEngineSDK/Model/AddressResidentialIndicator.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AddressToValidate.cs b/ShipEngineSDK/Model/AddressToValidate.cs index 0871b482..96d380b9 100644 --- a/ShipEngineSDK/Model/AddressToValidate.cs +++ b/ShipEngineSDK/Model/AddressToValidate.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AddressValidatingShipment.cs b/ShipEngineSDK/Model/AddressValidatingShipment.cs index 8299ee07..0c0b5fa3 100644 --- a/ShipEngineSDK/Model/AddressValidatingShipment.cs +++ b/ShipEngineSDK/Model/AddressValidatingShipment.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AddressValidationCode.cs b/ShipEngineSDK/Model/AddressValidationCode.cs index a738d326..3ddaa93a 100644 --- a/ShipEngineSDK/Model/AddressValidationCode.cs +++ b/ShipEngineSDK/Model/AddressValidationCode.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AddressValidationDetailCode.cs b/ShipEngineSDK/Model/AddressValidationDetailCode.cs index e6107542..bf5b8d29 100644 --- a/ShipEngineSDK/Model/AddressValidationDetailCode.cs +++ b/ShipEngineSDK/Model/AddressValidationDetailCode.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AddressValidationMessageType.cs b/ShipEngineSDK/Model/AddressValidationMessageType.cs index d11085cb..e84c4ef6 100644 --- a/ShipEngineSDK/Model/AddressValidationMessageType.cs +++ b/ShipEngineSDK/Model/AddressValidationMessageType.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AddressValidationResult.cs b/ShipEngineSDK/Model/AddressValidationResult.cs index 16bc5c58..f6eb935d 100644 --- a/ShipEngineSDK/Model/AddressValidationResult.cs +++ b/ShipEngineSDK/Model/AddressValidationResult.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AddressValidationStatus.cs b/ShipEngineSDK/Model/AddressValidationStatus.cs index 6414d692..d27c78ca 100644 --- a/ShipEngineSDK/Model/AddressValidationStatus.cs +++ b/ShipEngineSDK/Model/AddressValidationStatus.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptions.cs b/ShipEngineSDK/Model/AdvancedShipmentOptions.cs index a190cb62..8738058d 100644 --- a/ShipEngineSDK/Model/AdvancedShipmentOptions.cs +++ b/ShipEngineSDK/Model/AdvancedShipmentOptions.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs b/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs index 42eb1b9d..bc81efcf 100644 --- a/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs +++ b/ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs b/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs index 2a9d97da..8bcb7c18 100644 --- a/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs +++ b/ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AllowedIncoterms.cs b/ShipEngineSDK/Model/AllowedIncoterms.cs index 020876ab..8394464f 100644 --- a/ShipEngineSDK/Model/AllowedIncoterms.cs +++ b/ShipEngineSDK/Model/AllowedIncoterms.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AlternativeIdentifier.cs b/ShipEngineSDK/Model/AlternativeIdentifier.cs index 400d1be5..69a7b098 100644 --- a/ShipEngineSDK/Model/AlternativeIdentifier.cs +++ b/ShipEngineSDK/Model/AlternativeIdentifier.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AlternativeIdentifiers.cs b/ShipEngineSDK/Model/AlternativeIdentifiers.cs index 62cc8c98..d55495df 100644 --- a/ShipEngineSDK/Model/AlternativeIdentifiers.cs +++ b/ShipEngineSDK/Model/AlternativeIdentifiers.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs b/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs index 204c7fa5..492d05ab 100644 --- a/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs +++ b/ShipEngineSDK/Model/AncillaryServiceEndorsement.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Batch.cs b/ShipEngineSDK/Model/Batch.cs index 35987266..efc26b74 100644 --- a/ShipEngineSDK/Model/Batch.cs +++ b/ShipEngineSDK/Model/Batch.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/BatchResponseError.cs b/ShipEngineSDK/Model/BatchResponseError.cs index 078838d3..70a3eae2 100644 --- a/ShipEngineSDK/Model/BatchResponseError.cs +++ b/ShipEngineSDK/Model/BatchResponseError.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/BatchStatus.cs b/ShipEngineSDK/Model/BatchStatus.cs index 0bf16b29..1225f025 100644 --- a/ShipEngineSDK/Model/BatchStatus.cs +++ b/ShipEngineSDK/Model/BatchStatus.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/BatchesSortBy.cs b/ShipEngineSDK/Model/BatchesSortBy.cs index c8c8d0de..2c924e6d 100644 --- a/ShipEngineSDK/Model/BatchesSortBy.cs +++ b/ShipEngineSDK/Model/BatchesSortBy.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/BillToParty.cs b/ShipEngineSDK/Model/BillToParty.cs index 6da594ab..5b0cd908 100644 --- a/ShipEngineSDK/Model/BillToParty.cs +++ b/ShipEngineSDK/Model/BillToParty.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/BulkRate.cs b/ShipEngineSDK/Model/BulkRate.cs index cd646c96..219c813f 100644 --- a/ShipEngineSDK/Model/BulkRate.cs +++ b/ShipEngineSDK/Model/BulkRate.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CalculateRatesRequestBody.cs b/ShipEngineSDK/Model/CalculateRatesRequestBody.cs index 39c399f5..0d070b76 100644 --- a/ShipEngineSDK/Model/CalculateRatesRequestBody.cs +++ b/ShipEngineSDK/Model/CalculateRatesRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CalculateRatesResponseBody.cs b/ShipEngineSDK/Model/CalculateRatesResponseBody.cs index d328db3b..75ea1a4b 100644 --- a/ShipEngineSDK/Model/CalculateRatesResponseBody.cs +++ b/ShipEngineSDK/Model/CalculateRatesResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Carrier.cs b/ShipEngineSDK/Model/Carrier.cs index 496943b3..3025ef5b 100644 --- a/ShipEngineSDK/Model/Carrier.cs +++ b/ShipEngineSDK/Model/Carrier.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CarrierAdvancedOption.cs b/ShipEngineSDK/Model/CarrierAdvancedOption.cs index 4bc111ce..cb357005 100644 --- a/ShipEngineSDK/Model/CarrierAdvancedOption.cs +++ b/ShipEngineSDK/Model/CarrierAdvancedOption.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CarrierName.cs b/ShipEngineSDK/Model/CarrierName.cs index f5bec1d7..702050b8 100644 --- a/ShipEngineSDK/Model/CarrierName.cs +++ b/ShipEngineSDK/Model/CarrierName.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CarrierNameWithSettings.cs b/ShipEngineSDK/Model/CarrierNameWithSettings.cs index 889c79a3..01148eb0 100644 --- a/ShipEngineSDK/Model/CarrierNameWithSettings.cs +++ b/ShipEngineSDK/Model/CarrierNameWithSettings.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CollectOnDelivery.cs b/ShipEngineSDK/Model/CollectOnDelivery.cs index d0d1739f..0b6bc352 100644 --- a/ShipEngineSDK/Model/CollectOnDelivery.cs +++ b/ShipEngineSDK/Model/CollectOnDelivery.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs b/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs index 70f39f82..0c3ec8e8 100644 --- a/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs +++ b/ShipEngineSDK/Model/CollectOnDeliveryPaymentType.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs b/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs index 49f63997..a3758451 100644 --- a/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs +++ b/ShipEngineSDK/Model/CompareBulkRatesRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs b/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs index f3e59df9..d866da41 100644 --- a/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAccessWorldwideRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs b/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs index 8096b718..3cbf6027 100644 --- a/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAmazonBuyShippingRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs b/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs index ade4cba8..72cb7ba5 100644 --- a/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs +++ b/ShipEngineSDK/Model/ConnectAmazonShippingUk.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectApcRequestBody.cs b/ShipEngineSDK/Model/ConnectApcRequestBody.cs index 97008eec..8139381d 100644 --- a/ShipEngineSDK/Model/ConnectApcRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectApcRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs b/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs index 62612540..bdad81c1 100644 --- a/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs b/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs index 906f73a1..cd4e12f1 100644 --- a/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAustraliaPostRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs b/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs index 0ed8c4fd..9b9b90c5 100644 --- a/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectCanadaPostRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs b/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs index 3cd52b83..bd245a71 100644 --- a/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs b/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs index e692c841..95b3f955 100644 --- a/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs +++ b/ShipEngineSDK/Model/ConnectCarrierResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs index e5c62316..985268ac 100644 --- a/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlEcommerceRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs index 149088a5..6d95e5f3 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressAuRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs index 9b95a696..13417ef9 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressCaRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs index 2d8aad21..6cb9c515 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs b/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs index 9766f1df..3826cf20 100644 --- a/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDhlExpressUkRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectDpdRequestBody.cs b/ShipEngineSDK/Model/ConnectDpdRequestBody.cs index 2be6e4a1..62822af1 100644 --- a/ShipEngineSDK/Model/ConnectDpdRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectDpdRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs b/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs index 8935e2f9..e1702904 100644 --- a/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectEndiciaRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectFedexRequestBody.cs b/ShipEngineSDK/Model/ConnectFedexRequestBody.cs index cedbc183..49781969 100644 --- a/ShipEngineSDK/Model/ConnectFedexRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectFedexRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs b/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs index 119234a5..c18f1b6c 100644 --- a/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectFedexUkRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs b/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs index 85b1e8d4..b8df1b40 100644 --- a/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectFirstmileRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectImexRequestBody.cs b/ShipEngineSDK/Model/ConnectImexRequestBody.cs index ed555a5f..1c13872e 100644 --- a/ShipEngineSDK/Model/ConnectImexRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectImexRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs b/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs index a2103cc9..18957631 100644 --- a/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectInsurerRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs b/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs index dcecb4dc..807514a0 100644 --- a/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs b/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs index 5473048b..ae61bae7 100644 --- a/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectNewgisticsRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectOntracRequestBody.cs b/ShipEngineSDK/Model/ConnectOntracRequestBody.cs index 57b2fa46..cc1c1686 100644 --- a/ShipEngineSDK/Model/ConnectOntracRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectOntracRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs b/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs index aa1e8c12..afdeaf84 100644 --- a/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectPurolatorRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs b/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs index c9265ca7..8d295c61 100644 --- a/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectRoyalMailRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs b/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs index 97c80d8e..b1fb142b 100644 --- a/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectRrDonnelleyRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectSekoRequestBody.cs b/ShipEngineSDK/Model/ConnectSekoRequestBody.cs index afae6d2e..801ce3f7 100644 --- a/ShipEngineSDK/Model/ConnectSekoRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectSekoRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectSendleRequestBody.cs b/ShipEngineSDK/Model/ConnectSendleRequestBody.cs index 531e5051..fc01ec6d 100644 --- a/ShipEngineSDK/Model/ConnectSendleRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectSendleRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectStampsRequestBody.cs b/ShipEngineSDK/Model/ConnectStampsRequestBody.cs index 04b63d49..527cce3d 100644 --- a/ShipEngineSDK/Model/ConnectStampsRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectStampsRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ConnectUpsRequestBody.cs b/ShipEngineSDK/Model/ConnectUpsRequestBody.cs index f2028414..759ceb70 100644 --- a/ShipEngineSDK/Model/ConnectUpsRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectUpsRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ContactDetails.cs b/ShipEngineSDK/Model/ContactDetails.cs index 5ae8de24..243cff25 100644 --- a/ShipEngineSDK/Model/ContactDetails.cs +++ b/ShipEngineSDK/Model/ContactDetails.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs index 0645b2a3..540a2ae6 100644 --- a/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/CreateAccountSettingsImageRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs index e4a5b7d2..9a6b277e 100644 --- a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs +++ b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs index e56b4fef..4f0b3c4e 100644 --- a/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs +++ b/ShipEngineSDK/Model/CreateAndProcessBatchRequestBodyProcessLabels.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateAndValidateShipment.cs b/ShipEngineSDK/Model/CreateAndValidateShipment.cs index 0aae5c46..c4809616 100644 --- a/ShipEngineSDK/Model/CreateAndValidateShipment.cs +++ b/ShipEngineSDK/Model/CreateAndValidateShipment.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateBatchRequest.cs b/ShipEngineSDK/Model/CreateBatchRequest.cs index 6ab9d8de..5f0bb15e 100644 --- a/ShipEngineSDK/Model/CreateBatchRequest.cs +++ b/ShipEngineSDK/Model/CreateBatchRequest.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateBatchRequestBody.cs b/ShipEngineSDK/Model/CreateBatchRequestBody.cs index c4c683bd..4a921453 100644 --- a/ShipEngineSDK/Model/CreateBatchRequestBody.cs +++ b/ShipEngineSDK/Model/CreateBatchRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateBatchResponseBody.cs b/ShipEngineSDK/Model/CreateBatchResponseBody.cs index d22c3517..63c54f0c 100644 --- a/ShipEngineSDK/Model/CreateBatchResponseBody.cs +++ b/ShipEngineSDK/Model/CreateBatchResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs b/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs index 59283a65..60d5bc5d 100644 --- a/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs index 20f7fafa..3695fd74 100644 --- a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs b/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs index 1ed5a112..31bcc2cb 100644 --- a/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromShipmentRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs index 16878523..9b73cd0f 100644 --- a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateLabelRequestBody.cs b/ShipEngineSDK/Model/CreateLabelRequestBody.cs index b9e77214..c374c517 100644 --- a/ShipEngineSDK/Model/CreateLabelRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateLabelResponseBody.cs b/ShipEngineSDK/Model/CreateLabelResponseBody.cs index 66941716..6668fae3 100644 --- a/ShipEngineSDK/Model/CreateLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs b/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs index 3cb36c6c..417690ad 100644 --- a/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs +++ b/ShipEngineSDK/Model/CreateManifestByObjectRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs b/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs index 6a51c641..3b73a9b5 100644 --- a/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs +++ b/ShipEngineSDK/Model/CreateManifestLabelIdsRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateManifestRequestBody.cs b/ShipEngineSDK/Model/CreateManifestRequestBody.cs index 135e33ab..4e3931b9 100644 --- a/ShipEngineSDK/Model/CreateManifestRequestBody.cs +++ b/ShipEngineSDK/Model/CreateManifestRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateManifestResponseBody.cs b/ShipEngineSDK/Model/CreateManifestResponseBody.cs index 845dea28..8ce26a57 100644 --- a/ShipEngineSDK/Model/CreateManifestResponseBody.cs +++ b/ShipEngineSDK/Model/CreateManifestResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs b/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs index ec05e75f..83e7dc67 100644 --- a/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs +++ b/ShipEngineSDK/Model/CreatePackageTypeRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs b/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs index 59e9065f..de3d75fe 100644 --- a/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs +++ b/ShipEngineSDK/Model/CreatePackageTypeResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs b/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs index 6e49a97b..76c78891 100644 --- a/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs +++ b/ShipEngineSDK/Model/CreateReturnLabelRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs index f495c654..a50e9ce1 100644 --- a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs b/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs index 221a1121..293f00e8 100644 --- a/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs +++ b/ShipEngineSDK/Model/CreateShipmentResponseBodyFields.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs b/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs index d4404413..00028939 100644 --- a/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs +++ b/ShipEngineSDK/Model/CreateShipmentsRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs b/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs index 6a7540d3..9fc26adf 100644 --- a/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs +++ b/ShipEngineSDK/Model/CreateShipmentsResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateTagResponseBody.cs b/ShipEngineSDK/Model/CreateTagResponseBody.cs index 9309b220..be7e513b 100644 --- a/ShipEngineSDK/Model/CreateTagResponseBody.cs +++ b/ShipEngineSDK/Model/CreateTagResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs b/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs index 83015a17..6b07d8e6 100644 --- a/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs +++ b/ShipEngineSDK/Model/CreateWarehouseRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs b/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs index 94c4d242..c32dc376 100644 --- a/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs +++ b/ShipEngineSDK/Model/CreateWarehouseResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateWebhookRequestBody.cs b/ShipEngineSDK/Model/CreateWebhookRequestBody.cs index ef766310..e3ecbce4 100644 --- a/ShipEngineSDK/Model/CreateWebhookRequestBody.cs +++ b/ShipEngineSDK/Model/CreateWebhookRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CreateWebhookResponseBody.cs b/ShipEngineSDK/Model/CreateWebhookResponseBody.cs index b33342b4..61e4343b 100644 --- a/ShipEngineSDK/Model/CreateWebhookResponseBody.cs +++ b/ShipEngineSDK/Model/CreateWebhookResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/CustomsItem.cs b/ShipEngineSDK/Model/CustomsItem.cs index c6677d48..4d796ec4 100644 --- a/ShipEngineSDK/Model/CustomsItem.cs +++ b/ShipEngineSDK/Model/CustomsItem.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/DangerousAmount.cs b/ShipEngineSDK/Model/DangerousAmount.cs index c813112a..3788e2a2 100644 --- a/ShipEngineSDK/Model/DangerousAmount.cs +++ b/ShipEngineSDK/Model/DangerousAmount.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/DangerousGoods.cs b/ShipEngineSDK/Model/DangerousGoods.cs index 0f4e2fb4..2e8e050f 100644 --- a/ShipEngineSDK/Model/DangerousGoods.cs +++ b/ShipEngineSDK/Model/DangerousGoods.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/DefaultLabelLayout.cs b/ShipEngineSDK/Model/DefaultLabelLayout.cs index 63c092b6..17bc92fb 100644 --- a/ShipEngineSDK/Model/DefaultLabelLayout.cs +++ b/ShipEngineSDK/Model/DefaultLabelLayout.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs b/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs index 11b50c0d..1f28f444 100644 --- a/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs +++ b/ShipEngineSDK/Model/DeletePickupByIdResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs b/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs index d758464d..c4c84bec 100644 --- a/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs +++ b/ShipEngineSDK/Model/DeleteScheduledPickupResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/DeliveryConfirmation.cs b/ShipEngineSDK/Model/DeliveryConfirmation.cs index 19028548..6bb36134 100644 --- a/ShipEngineSDK/Model/DeliveryConfirmation.cs +++ b/ShipEngineSDK/Model/DeliveryConfirmation.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/DeprecatedManifest.cs b/ShipEngineSDK/Model/DeprecatedManifest.cs index 3c5a09b1..0550eba1 100644 --- a/ShipEngineSDK/Model/DeprecatedManifest.cs +++ b/ShipEngineSDK/Model/DeprecatedManifest.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/DhlExpressAccountSettings.cs b/ShipEngineSDK/Model/DhlExpressAccountSettings.cs index d74406d0..66b04947 100644 --- a/ShipEngineSDK/Model/DhlExpressAccountSettings.cs +++ b/ShipEngineSDK/Model/DhlExpressAccountSettings.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs b/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs index 580228f8..b6cc170b 100644 --- a/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/DhlExpressSettingsResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/DimensionUnit.cs b/ShipEngineSDK/Model/DimensionUnit.cs index 638e29b4..33b5a1e6 100644 --- a/ShipEngineSDK/Model/DimensionUnit.cs +++ b/ShipEngineSDK/Model/DimensionUnit.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Dimensions.cs b/ShipEngineSDK/Model/Dimensions.cs index fe208ee2..aaedd9b9 100644 --- a/ShipEngineSDK/Model/Dimensions.cs +++ b/ShipEngineSDK/Model/Dimensions.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/DisplayScheme.cs b/ShipEngineSDK/Model/DisplayScheme.cs index 936cd521..605cbf5b 100644 --- a/ShipEngineSDK/Model/DisplayScheme.cs +++ b/ShipEngineSDK/Model/DisplayScheme.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Error.cs b/ShipEngineSDK/Model/Error.cs index 75435282..b261eab0 100644 --- a/ShipEngineSDK/Model/Error.cs +++ b/ShipEngineSDK/Model/Error.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ErrorCode.cs b/ShipEngineSDK/Model/ErrorCode.cs index 9bffb150..ed02899a 100644 --- a/ShipEngineSDK/Model/ErrorCode.cs +++ b/ShipEngineSDK/Model/ErrorCode.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ErrorResponseBody.cs b/ShipEngineSDK/Model/ErrorResponseBody.cs index 9ecf9021..a4c9449c 100644 --- a/ShipEngineSDK/Model/ErrorResponseBody.cs +++ b/ShipEngineSDK/Model/ErrorResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ErrorSource.cs b/ShipEngineSDK/Model/ErrorSource.cs index 20dfc373..4b3810c8 100644 --- a/ShipEngineSDK/Model/ErrorSource.cs +++ b/ShipEngineSDK/Model/ErrorSource.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ErrorType.cs b/ShipEngineSDK/Model/ErrorType.cs index 64498c7b..2c2b630d 100644 --- a/ShipEngineSDK/Model/ErrorType.cs +++ b/ShipEngineSDK/Model/ErrorType.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs b/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs index 392862e4..bb0fcce2 100644 --- a/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs +++ b/ShipEngineSDK/Model/ErrorWithLabelIdResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/EstimateRatesRequestBody.cs b/ShipEngineSDK/Model/EstimateRatesRequestBody.cs index 42638397..dbcfa134 100644 --- a/ShipEngineSDK/Model/EstimateRatesRequestBody.cs +++ b/ShipEngineSDK/Model/EstimateRatesRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/FedexAccountSettings.cs b/ShipEngineSDK/Model/FedexAccountSettings.cs index bb3434ab..f556d2d7 100644 --- a/ShipEngineSDK/Model/FedexAccountSettings.cs +++ b/ShipEngineSDK/Model/FedexAccountSettings.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs b/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs index 2cd039b4..47a12c62 100644 --- a/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/FedexAccountSettingsRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/FedexPickupType.cs b/ShipEngineSDK/Model/FedexPickupType.cs index c84fc1c4..3e80dae0 100644 --- a/ShipEngineSDK/Model/FedexPickupType.cs +++ b/ShipEngineSDK/Model/FedexPickupType.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/FedexSettingsResponseBody.cs b/ShipEngineSDK/Model/FedexSettingsResponseBody.cs index 677fcdb8..638947f1 100644 --- a/ShipEngineSDK/Model/FedexSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/FedexSettingsResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs b/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs index 782c88f4..1eba06d9 100644 --- a/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs +++ b/ShipEngineSDK/Model/GetAccountSettingsImagesResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetAccountSettingsResponseBody.cs b/ShipEngineSDK/Model/GetAccountSettingsResponseBody.cs index 5511ca70..37168562 100644 --- a/ShipEngineSDK/Model/GetAccountSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/GetAccountSettingsResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs b/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs index 8afaa155..48fc8e87 100644 --- a/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetBatchByExternalIdResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs b/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs index 3f220a68..1715b459 100644 --- a/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetBatchByIdResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs b/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs index d11dc0e3..272cc230 100644 --- a/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs b/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs index e4b4fb2d..ea9536a9 100644 --- a/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarrierOptionsResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs b/ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs index 96e89bb5..ed3fe212 100644 --- a/ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarrierSettingsResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetCarriersResponseBody.cs b/ShipEngineSDK/Model/GetCarriersResponseBody.cs index 81f50d50..04c04ab8 100644 --- a/ShipEngineSDK/Model/GetCarriersResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarriersResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs b/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs index 06a1f168..bf699890 100644 --- a/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs +++ b/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs index 99e9c245..4bafd7e7 100644 --- a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs index 270b4886..18c663b4 100644 --- a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs b/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs index bb3f7069..666963f9 100644 --- a/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetManifestByIdResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs b/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs index 4262fa10..ed0096d9 100644 --- a/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetPackageTypeByIdResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs b/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs index 62a03adc..34ce76be 100644 --- a/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetPickupByIdResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetPickupsResponseBody.cs b/ShipEngineSDK/Model/GetPickupsResponseBody.cs index 02c83768..e4759301 100644 --- a/ShipEngineSDK/Model/GetPickupsResponseBody.cs +++ b/ShipEngineSDK/Model/GetPickupsResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetRateByIdResponseBody.cs b/ShipEngineSDK/Model/GetRateByIdResponseBody.cs index 6511ded9..0585325e 100644 --- a/ShipEngineSDK/Model/GetRateByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetRateByIdResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs b/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs index e9f3af5a..91e7debf 100644 --- a/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetServicePointByIdResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs b/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs index 2e59315b..7c9abe42 100644 --- a/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs +++ b/ShipEngineSDK/Model/GetServicePointByIdResponseBodyServicePoint.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetServicePointsRequest.cs b/ShipEngineSDK/Model/GetServicePointsRequest.cs index 5fbb6462..8d8271a3 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequest.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequest.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBody.cs b/ShipEngineSDK/Model/GetServicePointsRequestBody.cs index 1052f074..df304211 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBody.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs index 26d910cc..c60bc791 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs index a8352939..3cc8e102 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs index 89b34fdf..6a071e0f 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs b/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs index a2f18351..26713565 100644 --- a/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs b/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs index a867b372..c8f3d322 100644 --- a/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs index 90451270..fec53dca 100644 --- a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs index a2820a4e..8461f2d9 100644 --- a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs b/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs index 84f63dbb..2937125f 100644 --- a/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetWarehouseByIdResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs b/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs index 47f73a7e..c9b1c7f7 100644 --- a/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetWebhookByIdResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/IdentifierType.cs b/ShipEngineSDK/Model/IdentifierType.cs index b3354a59..d8fa9643 100644 --- a/ShipEngineSDK/Model/IdentifierType.cs +++ b/ShipEngineSDK/Model/IdentifierType.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ImporterOfRecords.cs b/ShipEngineSDK/Model/ImporterOfRecords.cs index 34e06203..4bbca919 100644 --- a/ShipEngineSDK/Model/ImporterOfRecords.cs +++ b/ShipEngineSDK/Model/ImporterOfRecords.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/InsuranceProvider.cs b/ShipEngineSDK/Model/InsuranceProvider.cs index c5337613..1b55180b 100644 --- a/ShipEngineSDK/Model/InsuranceProvider.cs +++ b/ShipEngineSDK/Model/InsuranceProvider.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/InternationalShipmentOptions.cs b/ShipEngineSDK/Model/InternationalShipmentOptions.cs index c6db0831..a468bf7f 100644 --- a/ShipEngineSDK/Model/InternationalShipmentOptions.cs +++ b/ShipEngineSDK/Model/InternationalShipmentOptions.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs b/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs index 07a069b8..30c94227 100644 --- a/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs +++ b/ShipEngineSDK/Model/InvoiceAdditionalDetails.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Label.cs b/ShipEngineSDK/Model/Label.cs index 55ce281b..c0e07725 100644 --- a/ShipEngineSDK/Model/Label.cs +++ b/ShipEngineSDK/Model/Label.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/LabelChargeEvent.cs b/ShipEngineSDK/Model/LabelChargeEvent.cs index 74331da9..8068bf7f 100644 --- a/ShipEngineSDK/Model/LabelChargeEvent.cs +++ b/ShipEngineSDK/Model/LabelChargeEvent.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/LabelDownload.cs b/ShipEngineSDK/Model/LabelDownload.cs index 11ea846a..2f50ab4f 100644 --- a/ShipEngineSDK/Model/LabelDownload.cs +++ b/ShipEngineSDK/Model/LabelDownload.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/LabelDownloadType.cs b/ShipEngineSDK/Model/LabelDownloadType.cs index 6221bfa8..9a641f54 100644 --- a/ShipEngineSDK/Model/LabelDownloadType.cs +++ b/ShipEngineSDK/Model/LabelDownloadType.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/LabelFormat.cs b/ShipEngineSDK/Model/LabelFormat.cs index 00a609f9..19674a78 100644 --- a/ShipEngineSDK/Model/LabelFormat.cs +++ b/ShipEngineSDK/Model/LabelFormat.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/LabelLayout.cs b/ShipEngineSDK/Model/LabelLayout.cs index ec8211ad..5ccc0de3 100644 --- a/ShipEngineSDK/Model/LabelLayout.cs +++ b/ShipEngineSDK/Model/LabelLayout.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/LabelMessages.cs b/ShipEngineSDK/Model/LabelMessages.cs index f9f7a34e..029226c7 100644 --- a/ShipEngineSDK/Model/LabelMessages.cs +++ b/ShipEngineSDK/Model/LabelMessages.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/LabelPackagesInner.cs b/ShipEngineSDK/Model/LabelPackagesInner.cs index 5637f18e..8fe5731e 100644 --- a/ShipEngineSDK/Model/LabelPackagesInner.cs +++ b/ShipEngineSDK/Model/LabelPackagesInner.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/LabelStatus.cs b/ShipEngineSDK/Model/LabelStatus.cs index 6309224d..9a345304 100644 --- a/ShipEngineSDK/Model/LabelStatus.cs +++ b/ShipEngineSDK/Model/LabelStatus.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Link.cs b/ShipEngineSDK/Model/Link.cs index cc855ad0..5725f8a1 100644 --- a/ShipEngineSDK/Model/Link.cs +++ b/ShipEngineSDK/Model/Link.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs b/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs index 73d8a529..7eb2312d 100644 --- a/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs +++ b/ShipEngineSDK/Model/ListAccountImagesResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListAccountSettingsBody.cs b/ShipEngineSDK/Model/ListAccountSettingsBody.cs index 5466d742..1138a3e5 100644 --- a/ShipEngineSDK/Model/ListAccountSettingsBody.cs +++ b/ShipEngineSDK/Model/ListAccountSettingsBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs b/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs index ea3c309c..f65d70c2 100644 --- a/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs +++ b/ShipEngineSDK/Model/ListAccountSettingsImagesResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs b/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs index 7ef91ca8..239fb0ef 100644 --- a/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs +++ b/ShipEngineSDK/Model/ListBatchErrorsResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListBatchesResponseBody.cs b/ShipEngineSDK/Model/ListBatchesResponseBody.cs index b3bfb4a6..2b915dee 100644 --- a/ShipEngineSDK/Model/ListBatchesResponseBody.cs +++ b/ShipEngineSDK/Model/ListBatchesResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs b/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs index bd7ddc82..a00f6daa 100644 --- a/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs +++ b/ShipEngineSDK/Model/ListCarrierPackageTypesResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs b/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs index 3a8ce9e4..10f82859 100644 --- a/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs +++ b/ShipEngineSDK/Model/ListCarrierServicesResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListCarriersResponseBody.cs b/ShipEngineSDK/Model/ListCarriersResponseBody.cs index 3b2c6f10..e8f276bc 100644 --- a/ShipEngineSDK/Model/ListCarriersResponseBody.cs +++ b/ShipEngineSDK/Model/ListCarriersResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListLabelsResponseBody.cs b/ShipEngineSDK/Model/ListLabelsResponseBody.cs index a1ca3151..6a59afa8 100644 --- a/ShipEngineSDK/Model/ListLabelsResponseBody.cs +++ b/ShipEngineSDK/Model/ListLabelsResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListManifestsResponseBody.cs b/ShipEngineSDK/Model/ListManifestsResponseBody.cs index fa6d674f..5166dcc8 100644 --- a/ShipEngineSDK/Model/ListManifestsResponseBody.cs +++ b/ShipEngineSDK/Model/ListManifestsResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs b/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs index c3e7da47..6498238b 100644 --- a/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs +++ b/ShipEngineSDK/Model/ListPackageTypesResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListPickupResponseBody.cs b/ShipEngineSDK/Model/ListPickupResponseBody.cs index 89942ebf..433d6229 100644 --- a/ShipEngineSDK/Model/ListPickupResponseBody.cs +++ b/ShipEngineSDK/Model/ListPickupResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBody.cs b/ShipEngineSDK/Model/ListServicePointsResponseBody.cs index 51a28997..2b293515 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBody.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs index 8b63fcdf..88a3e33e 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInner.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs index 962e0668..2940d7d9 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs index 5adb3b54..0cd97c9a 100644 --- a/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs +++ b/ShipEngineSDK/Model/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs b/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs index d3091adc..4a9f4bd1 100644 --- a/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs +++ b/ShipEngineSDK/Model/ListShipmentRatesResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListShipmentsResponseBody.cs b/ShipEngineSDK/Model/ListShipmentsResponseBody.cs index d7830af7..05620e56 100644 --- a/ShipEngineSDK/Model/ListShipmentsResponseBody.cs +++ b/ShipEngineSDK/Model/ListShipmentsResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListTagsResponseBody.cs b/ShipEngineSDK/Model/ListTagsResponseBody.cs index 36446899..9faa6626 100644 --- a/ShipEngineSDK/Model/ListTagsResponseBody.cs +++ b/ShipEngineSDK/Model/ListTagsResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ListWarehousesResponseBody.cs b/ShipEngineSDK/Model/ListWarehousesResponseBody.cs index 6a4967e6..f8e8e3ec 100644 --- a/ShipEngineSDK/Model/ListWarehousesResponseBody.cs +++ b/ShipEngineSDK/Model/ListWarehousesResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Manifest.cs b/ShipEngineSDK/Model/Manifest.cs index f8d95170..45d26d95 100644 --- a/ShipEngineSDK/Model/Manifest.cs +++ b/ShipEngineSDK/Model/Manifest.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ManifestDownload.cs b/ShipEngineSDK/Model/ManifestDownload.cs index 5de10152..028aaa2f 100644 --- a/ShipEngineSDK/Model/ManifestDownload.cs +++ b/ShipEngineSDK/Model/ManifestDownload.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ManifestRequest.cs b/ShipEngineSDK/Model/ManifestRequest.cs index 7516b54c..47e10d1e 100644 --- a/ShipEngineSDK/Model/ManifestRequest.cs +++ b/ShipEngineSDK/Model/ManifestRequest.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ManifestRequestStatus.cs b/ShipEngineSDK/Model/ManifestRequestStatus.cs index bdf4cfbc..5f323de7 100644 --- a/ShipEngineSDK/Model/ManifestRequestStatus.cs +++ b/ShipEngineSDK/Model/ManifestRequestStatus.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Manifests.cs b/ShipEngineSDK/Model/Manifests.cs index 19642ed7..04edad39 100644 --- a/ShipEngineSDK/Model/Manifests.cs +++ b/ShipEngineSDK/Model/Manifests.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ManifestsRequests.cs b/ShipEngineSDK/Model/ManifestsRequests.cs index 2a029aee..e1b49477 100644 --- a/ShipEngineSDK/Model/ManifestsRequests.cs +++ b/ShipEngineSDK/Model/ManifestsRequests.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ModifyBatch.cs b/ShipEngineSDK/Model/ModifyBatch.cs index d026a6e3..f5d61c87 100644 --- a/ShipEngineSDK/Model/ModifyBatch.cs +++ b/ShipEngineSDK/Model/ModifyBatch.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/MonetaryValue.cs b/ShipEngineSDK/Model/MonetaryValue.cs index a3b54f7c..5368ea91 100644 --- a/ShipEngineSDK/Model/MonetaryValue.cs +++ b/ShipEngineSDK/Model/MonetaryValue.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/NonDelivery.cs b/ShipEngineSDK/Model/NonDelivery.cs index 352bdcfb..5ff5e880 100644 --- a/ShipEngineSDK/Model/NonDelivery.cs +++ b/ShipEngineSDK/Model/NonDelivery.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/OptionalLink.cs b/ShipEngineSDK/Model/OptionalLink.cs index 954aa527..62f451ff 100644 --- a/ShipEngineSDK/Model/OptionalLink.cs +++ b/ShipEngineSDK/Model/OptionalLink.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/OrderSourceName.cs b/ShipEngineSDK/Model/OrderSourceName.cs index 9720e3ac..f32697fd 100644 --- a/ShipEngineSDK/Model/OrderSourceName.cs +++ b/ShipEngineSDK/Model/OrderSourceName.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/OriginType.cs b/ShipEngineSDK/Model/OriginType.cs index 6e521ec5..8d2e25f7 100644 --- a/ShipEngineSDK/Model/OriginType.cs +++ b/ShipEngineSDK/Model/OriginType.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Package.cs b/ShipEngineSDK/Model/Package.cs index 1b2c2a19..c457672b 100644 --- a/ShipEngineSDK/Model/Package.cs +++ b/ShipEngineSDK/Model/Package.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/PackageContents.cs b/ShipEngineSDK/Model/PackageContents.cs index ea6b79cd..99ced021 100644 --- a/ShipEngineSDK/Model/PackageContents.cs +++ b/ShipEngineSDK/Model/PackageContents.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/PackageType.cs b/ShipEngineSDK/Model/PackageType.cs index 3976fa4f..89c34c8f 100644 --- a/ShipEngineSDK/Model/PackageType.cs +++ b/ShipEngineSDK/Model/PackageType.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/PackagingGroup.cs b/ShipEngineSDK/Model/PackagingGroup.cs index d3222849..fa541c04 100644 --- a/ShipEngineSDK/Model/PackagingGroup.cs +++ b/ShipEngineSDK/Model/PackagingGroup.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/PackagingInstructionSection.cs b/ShipEngineSDK/Model/PackagingInstructionSection.cs index a9b7a9d2..ca6157f4 100644 --- a/ShipEngineSDK/Model/PackagingInstructionSection.cs +++ b/ShipEngineSDK/Model/PackagingInstructionSection.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/PagedListResponseBody.cs b/ShipEngineSDK/Model/PagedListResponseBody.cs index 5788f827..a35cc1fa 100644 --- a/ShipEngineSDK/Model/PagedListResponseBody.cs +++ b/ShipEngineSDK/Model/PagedListResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/PaginationLink.cs b/ShipEngineSDK/Model/PaginationLink.cs index 2e5706f1..287327a9 100644 --- a/ShipEngineSDK/Model/PaginationLink.cs +++ b/ShipEngineSDK/Model/PaginationLink.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/PaperlessDownload.cs b/ShipEngineSDK/Model/PaperlessDownload.cs index 4701d74a..083b95ba 100644 --- a/ShipEngineSDK/Model/PaperlessDownload.cs +++ b/ShipEngineSDK/Model/PaperlessDownload.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ParseAddressRequestBody.cs b/ShipEngineSDK/Model/ParseAddressRequestBody.cs index 7520824b..ebfb01cc 100644 --- a/ShipEngineSDK/Model/ParseAddressRequestBody.cs +++ b/ShipEngineSDK/Model/ParseAddressRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ParseAddressResponseBody.cs b/ShipEngineSDK/Model/ParseAddressResponseBody.cs index 77b9b77b..8143977f 100644 --- a/ShipEngineSDK/Model/ParseAddressResponseBody.cs +++ b/ShipEngineSDK/Model/ParseAddressResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ParseShipmentRequestBody.cs b/ShipEngineSDK/Model/ParseShipmentRequestBody.cs index 5ca143e5..14cae779 100644 --- a/ShipEngineSDK/Model/ParseShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/ParseShipmentRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ParseShipmentResponseBody.cs b/ShipEngineSDK/Model/ParseShipmentResponseBody.cs index ac1d6234..f9917420 100644 --- a/ShipEngineSDK/Model/ParseShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/ParseShipmentResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/PartialAddress.cs b/ShipEngineSDK/Model/PartialAddress.cs index f673dec1..8de15927 100644 --- a/ShipEngineSDK/Model/PartialAddress.cs +++ b/ShipEngineSDK/Model/PartialAddress.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/PartialShipment.cs b/ShipEngineSDK/Model/PartialShipment.cs index 5877acdc..2c9acbe5 100644 --- a/ShipEngineSDK/Model/PartialShipment.cs +++ b/ShipEngineSDK/Model/PartialShipment.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/PartialShippingAddress.cs b/ShipEngineSDK/Model/PartialShippingAddress.cs index 8d88f6db..6b055968 100644 --- a/ShipEngineSDK/Model/PartialShippingAddress.cs +++ b/ShipEngineSDK/Model/PartialShippingAddress.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/PartialShippingAddressTo.cs b/ShipEngineSDK/Model/PartialShippingAddressTo.cs index f2a50ef9..cd10119e 100644 --- a/ShipEngineSDK/Model/PartialShippingAddressTo.cs +++ b/ShipEngineSDK/Model/PartialShippingAddressTo.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs b/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs index 9acec524..d0586207 100644 --- a/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs +++ b/ShipEngineSDK/Model/PartialShippingAddressToGeolocationInner.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/PaymentAmount.cs b/ShipEngineSDK/Model/PaymentAmount.cs index 1e91e777..e40d8ec0 100644 --- a/ShipEngineSDK/Model/PaymentAmount.cs +++ b/ShipEngineSDK/Model/PaymentAmount.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Pickup.cs b/ShipEngineSDK/Model/Pickup.cs index 2f9d733d..2b330507 100644 --- a/ShipEngineSDK/Model/Pickup.cs +++ b/ShipEngineSDK/Model/Pickup.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/PickupResponseBody.cs b/ShipEngineSDK/Model/PickupResponseBody.cs index 0b1d373c..f8107c03 100644 --- a/ShipEngineSDK/Model/PickupResponseBody.cs +++ b/ShipEngineSDK/Model/PickupResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/PickupWindow.cs b/ShipEngineSDK/Model/PickupWindow.cs index d21c8152..9917270c 100644 --- a/ShipEngineSDK/Model/PickupWindow.cs +++ b/ShipEngineSDK/Model/PickupWindow.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/PickupWindows.cs b/ShipEngineSDK/Model/PickupWindows.cs index d9236d22..e5599976 100644 --- a/ShipEngineSDK/Model/PickupWindows.cs +++ b/ShipEngineSDK/Model/PickupWindows.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ProcessBatchRequestBody.cs b/ShipEngineSDK/Model/ProcessBatchRequestBody.cs index 9a9f64ef..7d11ce1a 100644 --- a/ShipEngineSDK/Model/ProcessBatchRequestBody.cs +++ b/ShipEngineSDK/Model/ProcessBatchRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Products.cs b/ShipEngineSDK/Model/Products.cs index aefbc037..17db62b1 100644 --- a/ShipEngineSDK/Model/Products.cs +++ b/ShipEngineSDK/Model/Products.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs b/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs index 7d6929e6..db9d2516 100644 --- a/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs +++ b/ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Rate.cs b/ShipEngineSDK/Model/Rate.cs index 974ef022..6e221d3d 100644 --- a/ShipEngineSDK/Model/Rate.cs +++ b/ShipEngineSDK/Model/Rate.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/RateEstimate.cs b/ShipEngineSDK/Model/RateEstimate.cs index 2f76b39c..8b87ef1f 100644 --- a/ShipEngineSDK/Model/RateEstimate.cs +++ b/ShipEngineSDK/Model/RateEstimate.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/RateEstimateByCarrierId.cs b/ShipEngineSDK/Model/RateEstimateByCarrierId.cs index 3500cb8c..fbcceffa 100644 --- a/ShipEngineSDK/Model/RateEstimateByCarrierId.cs +++ b/ShipEngineSDK/Model/RateEstimateByCarrierId.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs b/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs index f079257e..f6da607c 100644 --- a/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs +++ b/ShipEngineSDK/Model/RateEstimateByCarrierIds.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/RateEstimateOptions.cs b/ShipEngineSDK/Model/RateEstimateOptions.cs index e46d61db..e3c6676c 100644 --- a/ShipEngineSDK/Model/RateEstimateOptions.cs +++ b/ShipEngineSDK/Model/RateEstimateOptions.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/RateRequestBody.cs b/ShipEngineSDK/Model/RateRequestBody.cs index 31d566a0..64142bed 100644 --- a/ShipEngineSDK/Model/RateRequestBody.cs +++ b/ShipEngineSDK/Model/RateRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/RateRequestByShipmentIds.cs b/ShipEngineSDK/Model/RateRequestByShipmentIds.cs index 9585ecc8..ed06ccd8 100644 --- a/ShipEngineSDK/Model/RateRequestByShipmentIds.cs +++ b/ShipEngineSDK/Model/RateRequestByShipmentIds.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/RateRequestByShipments.cs b/ShipEngineSDK/Model/RateRequestByShipments.cs index 3e2836a1..6855fa4f 100644 --- a/ShipEngineSDK/Model/RateRequestByShipments.cs +++ b/ShipEngineSDK/Model/RateRequestByShipments.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/RateRequestOptions.cs b/ShipEngineSDK/Model/RateRequestOptions.cs index e891ea5e..0f090d71 100644 --- a/ShipEngineSDK/Model/RateRequestOptions.cs +++ b/ShipEngineSDK/Model/RateRequestOptions.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/RateRequestRateOptions.cs b/ShipEngineSDK/Model/RateRequestRateOptions.cs index cb67a60c..d45f66d3 100644 --- a/ShipEngineSDK/Model/RateRequestRateOptions.cs +++ b/ShipEngineSDK/Model/RateRequestRateOptions.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/RateResponse.cs b/ShipEngineSDK/Model/RateResponse.cs index d15e9eb4..8049a324 100644 --- a/ShipEngineSDK/Model/RateResponse.cs +++ b/ShipEngineSDK/Model/RateResponse.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/RateResponseStatus.cs b/ShipEngineSDK/Model/RateResponseStatus.cs index 1cc871bf..45803811 100644 --- a/ShipEngineSDK/Model/RateResponseStatus.cs +++ b/ShipEngineSDK/Model/RateResponseStatus.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/RateType.cs b/ShipEngineSDK/Model/RateType.cs index aa07205f..344bf940 100644 --- a/ShipEngineSDK/Model/RateType.cs +++ b/ShipEngineSDK/Model/RateType.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/RatesInformation.cs b/ShipEngineSDK/Model/RatesInformation.cs index 56881f77..b805e02c 100644 --- a/ShipEngineSDK/Model/RatesInformation.cs +++ b/ShipEngineSDK/Model/RatesInformation.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ReasonCode.cs b/ShipEngineSDK/Model/ReasonCode.cs index 20cdc72f..0eaeace2 100644 --- a/ShipEngineSDK/Model/ReasonCode.cs +++ b/ShipEngineSDK/Model/ReasonCode.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/RecognizedEntity.cs b/ShipEngineSDK/Model/RecognizedEntity.cs index 406bfd3e..bf25169e 100644 --- a/ShipEngineSDK/Model/RecognizedEntity.cs +++ b/ShipEngineSDK/Model/RecognizedEntity.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Redirect.cs b/ShipEngineSDK/Model/Redirect.cs index 9f8d8dbf..f2ec2a26 100644 --- a/ShipEngineSDK/Model/Redirect.cs +++ b/ShipEngineSDK/Model/Redirect.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/RegulationLevel.cs b/ShipEngineSDK/Model/RegulationLevel.cs index 5a63c391..77681088 100644 --- a/ShipEngineSDK/Model/RegulationLevel.cs +++ b/ShipEngineSDK/Model/RegulationLevel.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs b/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs index 85f48838..430592da 100644 --- a/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs +++ b/ShipEngineSDK/Model/RemoveFromBatchRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ResponseMessage.cs b/ShipEngineSDK/Model/ResponseMessage.cs index cd6784c0..f559fa85 100644 --- a/ShipEngineSDK/Model/ResponseMessage.cs +++ b/ShipEngineSDK/Model/ResponseMessage.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/SchedulePickupRequestBody.cs b/ShipEngineSDK/Model/SchedulePickupRequestBody.cs index 92833c56..09b450ca 100644 --- a/ShipEngineSDK/Model/SchedulePickupRequestBody.cs +++ b/ShipEngineSDK/Model/SchedulePickupRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/SchedulePickupResponseBody.cs b/ShipEngineSDK/Model/SchedulePickupResponseBody.cs index eac56d12..3c7ae855 100644 --- a/ShipEngineSDK/Model/SchedulePickupResponseBody.cs +++ b/ShipEngineSDK/Model/SchedulePickupResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Service.cs b/ShipEngineSDK/Model/Service.cs index 15acc479..51826222 100644 --- a/ShipEngineSDK/Model/Service.cs +++ b/ShipEngineSDK/Model/Service.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Shipment.cs b/ShipEngineSDK/Model/Shipment.cs index c5374725..44c65996 100644 --- a/ShipEngineSDK/Model/Shipment.cs +++ b/ShipEngineSDK/Model/Shipment.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ShipmentIdRequest.cs b/ShipEngineSDK/Model/ShipmentIdRequest.cs index eb7abb9c..68ae4efb 100644 --- a/ShipEngineSDK/Model/ShipmentIdRequest.cs +++ b/ShipEngineSDK/Model/ShipmentIdRequest.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ShipmentItem.cs b/ShipEngineSDK/Model/ShipmentItem.cs index 20b74a79..e91a0a23 100644 --- a/ShipEngineSDK/Model/ShipmentItem.cs +++ b/ShipEngineSDK/Model/ShipmentItem.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ShipmentRequest.cs b/ShipEngineSDK/Model/ShipmentRequest.cs index f79b50c5..54c0f9ed 100644 --- a/ShipEngineSDK/Model/ShipmentRequest.cs +++ b/ShipEngineSDK/Model/ShipmentRequest.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ShipmentStatus.cs b/ShipEngineSDK/Model/ShipmentStatus.cs index 8a92886a..e8a9a24c 100644 --- a/ShipEngineSDK/Model/ShipmentStatus.cs +++ b/ShipEngineSDK/Model/ShipmentStatus.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ShipmentsSortBy.cs b/ShipEngineSDK/Model/ShipmentsSortBy.cs index 7acca9ca..c7a4c655 100644 --- a/ShipEngineSDK/Model/ShipmentsSortBy.cs +++ b/ShipEngineSDK/Model/ShipmentsSortBy.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ShippingAddress.cs b/ShipEngineSDK/Model/ShippingAddress.cs index 52cdd1bc..7a318328 100644 --- a/ShipEngineSDK/Model/ShippingAddress.cs +++ b/ShipEngineSDK/Model/ShippingAddress.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ShippingAddressTo.cs b/ShipEngineSDK/Model/ShippingAddressTo.cs index d8e2a210..837a413c 100644 --- a/ShipEngineSDK/Model/ShippingAddressTo.cs +++ b/ShipEngineSDK/Model/ShippingAddressTo.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/SmartPostHub.cs b/ShipEngineSDK/Model/SmartPostHub.cs index fec83ff7..3e64f76d 100644 --- a/ShipEngineSDK/Model/SmartPostHub.cs +++ b/ShipEngineSDK/Model/SmartPostHub.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/SortDir.cs b/ShipEngineSDK/Model/SortDir.cs index 7736282e..eb5b579d 100644 --- a/ShipEngineSDK/Model/SortDir.cs +++ b/ShipEngineSDK/Model/SortDir.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/StatusCode.cs b/ShipEngineSDK/Model/StatusCode.cs index 3643c7dd..ef490faf 100644 --- a/ShipEngineSDK/Model/StatusCode.cs +++ b/ShipEngineSDK/Model/StatusCode.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Tag.cs b/ShipEngineSDK/Model/Tag.cs index c53bf96e..2a551bd2 100644 --- a/ShipEngineSDK/Model/Tag.cs +++ b/ShipEngineSDK/Model/Tag.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/TagShipmentResponseBody.cs b/ShipEngineSDK/Model/TagShipmentResponseBody.cs index 95ac8cf6..38954cd8 100644 --- a/ShipEngineSDK/Model/TagShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/TagShipmentResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/TaxIdentifier.cs b/ShipEngineSDK/Model/TaxIdentifier.cs index cafe6228..3aac17b6 100644 --- a/ShipEngineSDK/Model/TaxIdentifier.cs +++ b/ShipEngineSDK/Model/TaxIdentifier.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/TaxableEntityType.cs b/ShipEngineSDK/Model/TaxableEntityType.cs index abe9b3c9..3e3a7780 100644 --- a/ShipEngineSDK/Model/TaxableEntityType.cs +++ b/ShipEngineSDK/Model/TaxableEntityType.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs b/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs index 721bc0bb..1c8991ae 100644 --- a/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs +++ b/ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/TrackEvent.cs b/ShipEngineSDK/Model/TrackEvent.cs index 487061ba..97ba9b49 100644 --- a/ShipEngineSDK/Model/TrackEvent.cs +++ b/ShipEngineSDK/Model/TrackEvent.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/TrackingInformation.cs b/ShipEngineSDK/Model/TrackingInformation.cs index 2639ca63..08ce7ae1 100644 --- a/ShipEngineSDK/Model/TrackingInformation.cs +++ b/ShipEngineSDK/Model/TrackingInformation.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/TrackingStatus.cs b/ShipEngineSDK/Model/TrackingStatus.cs index 735f7a64..1421a1a1 100644 --- a/ShipEngineSDK/Model/TrackingStatus.cs +++ b/ShipEngineSDK/Model/TrackingStatus.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/TransportMean.cs b/ShipEngineSDK/Model/TransportMean.cs index b5a6ad74..ae41b755 100644 --- a/ShipEngineSDK/Model/TransportMean.cs +++ b/ShipEngineSDK/Model/TransportMean.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs index b04ec59d..5d7341a0 100644 --- a/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateAccountSettingsImageRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs b/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs index dcf8e0ca..0fc41ccf 100644 --- a/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateAmazonBuyShippingRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs index 014abebc..554a34f1 100644 --- a/ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateCarrierSettingsRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs index d652d40f..a2e76f3b 100644 --- a/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateDhlExpressSettingsRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs index cc8807ec..e964ecb8 100644 --- a/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateFedexSettingsRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs index 3e3eb4ed..5fb4d3b5 100644 --- a/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateNewgisticsSettingsRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs b/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs index a87ae852..1eec8da0 100644 --- a/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs +++ b/ShipEngineSDK/Model/UpdatePackageTypeRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpdateShipmentFields.cs b/ShipEngineSDK/Model/UpdateShipmentFields.cs index 08fd33f0..56c76527 100644 --- a/ShipEngineSDK/Model/UpdateShipmentFields.cs +++ b/ShipEngineSDK/Model/UpdateShipmentFields.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs b/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs index 1b748f91..c34eff15 100644 --- a/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs b/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs index b4c6ca12..c34e9c50 100644 --- a/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpdateShipmentsTags.cs b/ShipEngineSDK/Model/UpdateShipmentsTags.cs index 6457d09e..e85d24e0 100644 --- a/ShipEngineSDK/Model/UpdateShipmentsTags.cs +++ b/ShipEngineSDK/Model/UpdateShipmentsTags.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs b/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs index 28a244f2..86135a27 100644 --- a/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentsTagsRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs b/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs index ed54af22..77040254 100644 --- a/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs +++ b/ShipEngineSDK/Model/UpdateShipmentsTagsShipmentsTagsInner.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs index b99ae615..3895dc5f 100644 --- a/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateUpsSettingsRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs b/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs index bfec53e9..edf388e8 100644 --- a/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateWarehouseRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpdateWarehouseSettingsRequestBody.cs b/ShipEngineSDK/Model/UpdateWarehouseSettingsRequestBody.cs index ff2cf9a3..2b214c07 100644 --- a/ShipEngineSDK/Model/UpdateWarehouseSettingsRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateWarehouseSettingsRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs b/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs index 34bd10b3..3989d3c8 100644 --- a/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateWebhookRequestBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpsAccountSettings.cs b/ShipEngineSDK/Model/UpsAccountSettings.cs index 17c5663d..6cad13d3 100644 --- a/ShipEngineSDK/Model/UpsAccountSettings.cs +++ b/ShipEngineSDK/Model/UpsAccountSettings.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpsInvoice.cs b/ShipEngineSDK/Model/UpsInvoice.cs index dec384b7..cc6b2d63 100644 --- a/ShipEngineSDK/Model/UpsInvoice.cs +++ b/ShipEngineSDK/Model/UpsInvoice.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpsPickupType.cs b/ShipEngineSDK/Model/UpsPickupType.cs index 1dfb0945..c782d825 100644 --- a/ShipEngineSDK/Model/UpsPickupType.cs +++ b/ShipEngineSDK/Model/UpsPickupType.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/UpsSettingsResponseBody.cs b/ShipEngineSDK/Model/UpsSettingsResponseBody.cs index 4378e7ea..bf720348 100644 --- a/ShipEngineSDK/Model/UpsSettingsResponseBody.cs +++ b/ShipEngineSDK/Model/UpsSettingsResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ValidateAddress.cs b/ShipEngineSDK/Model/ValidateAddress.cs index 2d187265..12d913a9 100644 --- a/ShipEngineSDK/Model/ValidateAddress.cs +++ b/ShipEngineSDK/Model/ValidateAddress.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ValidateShipmentFields.cs b/ShipEngineSDK/Model/ValidateShipmentFields.cs index 0c2d2d0f..23eea7e9 100644 --- a/ShipEngineSDK/Model/ValidateShipmentFields.cs +++ b/ShipEngineSDK/Model/ValidateShipmentFields.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/ValidationStatus.cs b/ShipEngineSDK/Model/ValidationStatus.cs index 685a19d7..4cb8b3a9 100644 --- a/ShipEngineSDK/Model/ValidationStatus.cs +++ b/ShipEngineSDK/Model/ValidationStatus.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/VoidLabelResponseBody.cs b/ShipEngineSDK/Model/VoidLabelResponseBody.cs index 30a72722..7791297c 100644 --- a/ShipEngineSDK/Model/VoidLabelResponseBody.cs +++ b/ShipEngineSDK/Model/VoidLabelResponseBody.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Warehouse.cs b/ShipEngineSDK/Model/Warehouse.cs index 032a76b1..ca5b9fdf 100644 --- a/ShipEngineSDK/Model/Warehouse.cs +++ b/ShipEngineSDK/Model/Warehouse.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Webhook.cs b/ShipEngineSDK/Model/Webhook.cs index 4e901a90..2978bd1b 100644 --- a/ShipEngineSDK/Model/Webhook.cs +++ b/ShipEngineSDK/Model/Webhook.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/WebhookEvent.cs b/ShipEngineSDK/Model/WebhookEvent.cs index b6cb343f..d57c9bac 100644 --- a/ShipEngineSDK/Model/WebhookEvent.cs +++ b/ShipEngineSDK/Model/WebhookEvent.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/WebhookHeader.cs b/ShipEngineSDK/Model/WebhookHeader.cs index 80d645ea..64eb2b89 100644 --- a/ShipEngineSDK/Model/WebhookHeader.cs +++ b/ShipEngineSDK/Model/WebhookHeader.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/Weight.cs b/ShipEngineSDK/Model/Weight.cs index b6e18fb5..b523acc0 100644 --- a/ShipEngineSDK/Model/Weight.cs +++ b/ShipEngineSDK/Model/Weight.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/ShipEngineSDK/Model/WeightUnit.cs b/ShipEngineSDK/Model/WeightUnit.cs index 93f28c00..14accf99 100644 --- a/ShipEngineSDK/Model/WeightUnit.cs +++ b/ShipEngineSDK/Model/WeightUnit.cs @@ -1,10 +1,8 @@ -/* - * ShipEngine API - * - * The version of the OpenAPI document: 1.1.202406212006 - * Contact: sales@shipengine.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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; diff --git a/generation/templates/partial_header.mustache b/generation/templates/partial_header.mustache index 7257ee65..f9c9a7df 100644 --- a/generation/templates/partial_header.mustache +++ b/generation/templates/partial_header.mustache @@ -1,13 +1,5 @@ -/* - {{#appName}} - * {{{.}}} - * - {{/appName}} - {{#version}} - * The version of the OpenAPI document: {{{.}}} - {{/version}} - {{#infoEmail}} - * Contact: {{{.}}} - {{/infoEmail}} - * Generated by: https://github.com/openapitools/openapi-generator.git - */ +// +// 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. From 9a7c90350088662c0c75473b19d14a642bac8fca Mon Sep 17 00:00:00 2001 From: Joshua Flanagan Date: Tue, 23 Jul 2024 16:13:06 -0500 Subject: [PATCH 16/42] Regenerated for spec 202407231507 --- .openapi-generator/FILES | 1 + ShipEngineSDK/Model/Carrier.cs | 14 + .../Model/ConnectLasershipRequestBody.cs | 44 +-- .../Model/GetCarrierByIdResponseBody.cs | 14 + ShipEngineSDK/Model/LabelPackage.cs | 226 ++++++++++++++ ShipEngineSDK/Model/LabelPackagesInner.cs | 65 +++- ShipEngineSDK/Model/ListLabelsResponseBody.cs | 2 +- ShipEngineSDK/Model/Package.cs | 60 ++-- ShipEngineSDK/Model/VoidLabelResponseBody.cs | 4 +- generation/swagger.json | 286 +++++++++++++----- 10 files changed, 558 insertions(+), 158 deletions(-) create mode 100644 ShipEngineSDK/Model/LabelPackage.cs diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 687f2d8b..64f9fdbc 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -181,6 +181,7 @@ ShipEngineSDK/Model/LabelDownloadType.cs ShipEngineSDK/Model/LabelFormat.cs ShipEngineSDK/Model/LabelLayout.cs ShipEngineSDK/Model/LabelMessages.cs +ShipEngineSDK/Model/LabelPackage.cs ShipEngineSDK/Model/LabelPackagesInner.cs ShipEngineSDK/Model/LabelStatus.cs ShipEngineSDK/Model/Link.cs diff --git a/ShipEngineSDK/Model/Carrier.cs b/ShipEngineSDK/Model/Carrier.cs index 3025ef5b..481b066f 100644 --- a/ShipEngineSDK/Model/Carrier.cs +++ b/ShipEngineSDK/Model/Carrier.cs @@ -101,6 +101,19 @@ public partial class Carrier [JsonPropertyName("friendly_name"), JsonInclude] public string? FriendlyName { get; set; } + /// + /// Funding source ID for the carrier + /// + /// Funding source ID for the carrier + /// + /// This should not be used for input as it will be ignored on serialization. + /// + /// + /// se-28529731 + /// + [JsonPropertyName("funding_source_id"), JsonInclude] + public string? FundingSourceId { get; set; } + /// /// Carrier supports multiple packages per shipment /// @@ -200,6 +213,7 @@ public override string ToString() sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" DisabledByBillingPlan: ").Append(DisabledByBillingPlan).Append("\n"); sb.Append(" FriendlyName: ").Append(FriendlyName).Append("\n"); + sb.Append(" FundingSourceId: ").Append(FundingSourceId).Append("\n"); sb.Append(" HasMultiPackageSupportingServices: ").Append(HasMultiPackageSupportingServices).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" Options: ").Append(Options).Append("\n"); diff --git a/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs b/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs index 807514a0..c4c9b930 100644 --- a/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectLasershipRequestBody.cs @@ -31,14 +31,14 @@ public partial class ConnectLasershipRequestBody /// /// Address [JsonPropertyName("Address"), JsonPropertyOrder(1)] - public required string Address { get; set; } + public required String Address { get; set; } /// /// City /// /// City [JsonPropertyName("City"), JsonPropertyOrder(2)] - public required string City { get; set; } + public required String City { get; set; } /// /// Customer Branch @@ -52,14 +52,14 @@ public partial class ConnectLasershipRequestBody /// /// Critical Entry Time (local time) [JsonPropertyName("lasership_critical_entry_time"), JsonPropertyOrder(4)] - public required string LasershipCriticalEntryTime { get; set; } + public required String LasershipCriticalEntryTime { get; set; } /// /// Critical Pull Time (local time) /// /// Critical Pull Time (local time) [JsonPropertyName("lasership_critical_pull_time"), JsonPropertyOrder(5)] - public required string LasershipCriticalPullTime { get; set; } + public required String LasershipCriticalPullTime { get; set; } /// /// Nickname @@ -73,14 +73,14 @@ public partial class ConnectLasershipRequestBody /// /// PostalCode [JsonPropertyName("PostalCode"), JsonPropertyOrder(7)] - public required string PostalCode { get; set; } + public required String PostalCode { get; set; } /// /// State /// /// State [JsonPropertyName("State"), JsonPropertyOrder(8)] - public required string State { get; set; } + public required String State { get; set; } /// /// Web Service ID (WSID) @@ -101,112 +101,112 @@ public partial class ConnectLasershipRequestBody /// /// Address2 [JsonPropertyName("Address2"), JsonPropertyOrder(11)] - public string? Address2 { get; set; } + public String? Address2 { get; set; } /// /// Set this to true if your shipments will always contain Alcohol /// /// Set this to true if your shipments will always contain Alcohol [JsonPropertyName("AttrAlcohol"), JsonPropertyOrder(12)] - public bool? AttrAlcohol { get; set; } + public Boolean? AttrAlcohol { get; set; } /// /// Set this to true if your shipments will always contain Controlled Substances /// /// Set this to true if your shipments will always contain Controlled Substances [JsonPropertyName("AttrControlledSubstance"), JsonPropertyOrder(13)] - public bool? AttrControlledSubstance { get; set; } + public Boolean? AttrControlledSubstance { get; set; } /// /// Set this to true if your shipments will always contain DryIce /// /// Set this to true if your shipments will always contain DryIce [JsonPropertyName("AttrDryIce"), JsonPropertyOrder(14)] - public bool? AttrDryIce { get; set; } + public Boolean? AttrDryIce { get; set; } /// /// Set this to true if your shipments will always contain Explosives /// /// Set this to true if your shipments will always contain Explosives [JsonPropertyName("AttrExplosive"), JsonPropertyOrder(15)] - public bool? AttrExplosive { get; set; } + public Boolean? AttrExplosive { get; set; } /// /// Set this to true if your shipments will always contain Hazmat /// /// Set this to true if your shipments will always contain Hazmat [JsonPropertyName("AttrHazmat"), JsonPropertyOrder(16)] - public bool? AttrHazmat { get; set; } + public Boolean? AttrHazmat { get; set; } /// /// Set this to true if your shipments will always use \"No Return To Sender\" /// /// Set this to true if your shipments will always use \"No Return To Sender\" [JsonPropertyName("AttrNoRTS"), JsonPropertyOrder(17)] - public bool? AttrNoRTS { get; set; } + public Boolean? AttrNoRTS { get; set; } /// /// Set this to true if your shipments will always be Perishable /// /// Set this to true if your shipments will always be Perishable [JsonPropertyName("AttrPerishable"), JsonPropertyOrder(18)] - public bool? AttrPerishable { get; set; } + public Boolean? AttrPerishable { get; set; } /// /// Set this to true if your shipments will always require Refrigeration /// /// Set this to true if your shipments will always require Refrigeration [JsonPropertyName("AttrRefrigerated"), JsonPropertyOrder(19)] - public bool? AttrRefrigerated { get; set; } + public Boolean? AttrRefrigerated { get; set; } /// /// Set this to true if your shipments will always require Two Persons /// /// Set this to true if your shipments will always require Two Persons [JsonPropertyName("AttrTwoPersons"), JsonPropertyOrder(20)] - public bool? AttrTwoPersons { get; set; } + public Boolean? AttrTwoPersons { get; set; } /// /// Country /// /// Country [JsonPropertyName("country"), JsonPropertyOrder(21)] - public string? Country { get; set; } + public String? Country { get; set; } /// /// Declare piece attributes separately for every shipment, overrides individual attribute below. /// /// Declare piece attributes separately for every shipment, overrides individual attribute below. [JsonPropertyName("declare_piece_attributes_separately_for_every_shipment"), JsonPropertyOrder(22)] - public bool? DeclarePieceAttributesSeparatelyForEveryShipment { get; set; } + public Boolean? DeclarePieceAttributesSeparatelyForEveryShipment { get; set; } /// /// Email /// /// Email [JsonPropertyName("Email"), JsonPropertyOrder(23)] - public string? Email { get; set; } + public String? Email { get; set; } /// /// Facility Code /// /// Facility Code [JsonPropertyName("facility_code"), JsonPropertyOrder(24)] - public string? FacilityCode { get; set; } + public String? FacilityCode { get; set; } /// /// Instructions /// /// Instructions [JsonPropertyName("instructions"), JsonPropertyOrder(25)] - public string? Instructions { get; set; } + public String? Instructions { get; set; } /// /// Phone /// /// Phone [JsonPropertyName("Phone"), JsonPropertyOrder(26)] - public string? Phone { get; set; } + public String? Phone { get; set; } /// diff --git a/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs b/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs index 272cc230..f8a91274 100644 --- a/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs @@ -101,6 +101,19 @@ public partial class GetCarrierByIdResponseBody [JsonPropertyName("friendly_name"), JsonInclude] public string? FriendlyName { get; set; } + /// + /// Funding source ID for the carrier + /// + /// Funding source ID for the carrier + /// + /// This should not be used for input as it will be ignored on serialization. + /// + /// + /// se-28529731 + /// + [JsonPropertyName("funding_source_id"), JsonInclude] + public string? FundingSourceId { get; set; } + /// /// Carrier supports multiple packages per shipment /// @@ -200,6 +213,7 @@ public override string ToString() sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" DisabledByBillingPlan: ").Append(DisabledByBillingPlan).Append("\n"); sb.Append(" FriendlyName: ").Append(FriendlyName).Append("\n"); + sb.Append(" FundingSourceId: ").Append(FundingSourceId).Append("\n"); sb.Append(" HasMultiPackageSupportingServices: ").Append(HasMultiPackageSupportingServices).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); sb.Append(" Options: ").Append(Options).Append("\n"); diff --git a/ShipEngineSDK/Model/LabelPackage.cs b/ShipEngineSDK/Model/LabelPackage.cs new file mode 100644 index 00000000..1b73723b --- /dev/null +++ b/ShipEngineSDK/Model/LabelPackage.cs @@ -0,0 +1,226 @@ +// +// 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 package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/) +/// +public partial class LabelPackage +{ + + /// + /// The package weight + /// + /// The package weight + [JsonPropertyName("weight"), JsonPropertyOrder(1)] + public required Weight Weight { get; set; } + + /// + /// A short description of the package content. Required for shipments moving to, from, and through Mexico. + /// + /// A short description of the package content. Required for shipments moving to, from, and through Mexico. + /// + /// Hand knitted wool socks + /// + [JsonPropertyName("content_description"), JsonPropertyOrder(2)] + public string? ContentDescription { get; set; } + + /// + /// The package dimensions + /// + /// The package dimensions + [JsonPropertyName("dimensions"), JsonPropertyOrder(3)] + public Dimensions? Dimensions { get; set; } + + /// + /// An external package id. + /// + /// An external package id. + [JsonPropertyName("external_package_id"), JsonPropertyOrder(4)] + public string? ExternalPackageId { get; set; } + + /// + /// The form download for any customs that are needed + /// + /// The form download for any customs that are needed + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("form_download"), JsonInclude] + public OptionalLink? FormDownload { get; set; } + + /// + /// Whether the package has form documents available for download + /// + /// Whether the package has form documents available for download + [JsonPropertyName("has_form_documents"), JsonPropertyOrder(6)] + public bool? HasFormDocuments { get; set; } + + /// + /// Whether the package has label documents available for download + /// + /// Whether the package has label documents available for download + [JsonPropertyName("has_label_documents"), JsonPropertyOrder(7)] + public bool? HasLabelDocuments { get; set; } + + /// + /// Whether the package has paperless documents available for download + /// + /// Whether the package has paperless documents available for download + [JsonPropertyName("has_paperless_label_documents"), JsonPropertyOrder(8)] + public bool? HasPaperlessLabelDocuments { get; set; } + + /// + /// Whether the package has QR code documents available for download + /// + /// Whether the package has QR code documents available for download + [JsonPropertyName("has_qr_code_documents"), JsonPropertyOrder(9)] + public bool? HasQrCodeDocuments { get; set; } + + /// + /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. + /// + /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. + [JsonPropertyName("insured_value"), JsonPropertyOrder(10)] + public MonetaryValue? InsuredValue { get; set; } + + /// + /// The label download for the package + /// + /// The label download for the package + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("label_download"), JsonInclude] + public LabelDownload? LabelDownload { get; set; } + + /// + /// Gets or Sets LabelMessages + /// + [JsonPropertyName("label_messages"), JsonPropertyOrder(12)] + public LabelMessages? LabelMessages { get; set; } + + /// + /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// + /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. + /// + /// small_flat_rate_box + /// + [JsonPropertyName("package_code"), JsonPropertyOrder(13)] + public string? PackageCode { get; set; } + + /// + /// The shipment package id + /// + /// The shipment package id + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("package_id"), JsonInclude] + public int? PackageId { get; set; } + + /// + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// + /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("paperless_download"), JsonInclude] + public PaperlessDownload? PaperlessDownload { get; set; } + + /// + /// The QR code download for the package + /// + /// The QR code download for the package + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("qr_code_download"), JsonInclude] + public OptionalLink? QrCodeDownload { get; set; } + + /// + /// Package sequence + /// + /// Package sequence + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("sequence"), JsonInclude] + public int? Sequence { get; set; } + + /// + /// The tracking number for the package. The format depends on the carrier. + /// + /// The tracking number for the package. The format depends on the carrier. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + /// + /// 1Z932R800392060079 + /// + [JsonPropertyName("tracking_number"), JsonInclude] + public string? TrackingNumber { 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 LabelPackage {\n"); +#pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" Weight: ").Append(Weight).Append("\n"); + sb.Append(" ContentDescription: ").Append(ContentDescription).Append("\n"); + sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); + sb.Append(" ExternalPackageId: ").Append(ExternalPackageId).Append("\n"); + sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); + sb.Append(" HasFormDocuments: ").Append(HasFormDocuments).Append("\n"); + sb.Append(" HasLabelDocuments: ").Append(HasLabelDocuments).Append("\n"); + sb.Append(" HasPaperlessLabelDocuments: ").Append(HasPaperlessLabelDocuments).Append("\n"); + sb.Append(" HasQrCodeDocuments: ").Append(HasQrCodeDocuments).Append("\n"); + sb.Append(" InsuredValue: ").Append(InsuredValue).Append("\n"); + sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); + sb.Append(" LabelMessages: ").Append(LabelMessages).Append("\n"); + sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); + sb.Append(" PackageId: ").Append(PackageId).Append("\n"); + sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" QrCodeDownload: ").Append(QrCodeDownload).Append("\n"); + sb.Append(" Sequence: ").Append(Sequence).Append("\n"); + sb.Append(" TrackingNumber: ").Append(TrackingNumber).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/LabelPackagesInner.cs b/ShipEngineSDK/Model/LabelPackagesInner.cs index 8fe5731e..b10b7129 100644 --- a/ShipEngineSDK/Model/LabelPackagesInner.cs +++ b/ShipEngineSDK/Model/LabelPackagesInner.cs @@ -77,11 +77,39 @@ public partial class LabelPackagesInner [JsonPropertyName("form_download"), JsonInclude] public OptionalLink? FormDownload { get; set; } + /// + /// Whether the package has form documents available for download + /// + /// Whether the package has form documents available for download + [JsonPropertyName("has_form_documents"), JsonPropertyOrder(7)] + public bool? HasFormDocuments { get; set; } + + /// + /// Whether the package has label documents available for download + /// + /// Whether the package has label documents available for download + [JsonPropertyName("has_label_documents"), JsonPropertyOrder(8)] + public bool? HasLabelDocuments { get; set; } + + /// + /// Whether the package has paperless documents available for download + /// + /// Whether the package has paperless documents available for download + [JsonPropertyName("has_paperless_label_documents"), JsonPropertyOrder(9)] + public bool? HasPaperlessLabelDocuments { get; set; } + + /// + /// Whether the package has QR code documents available for download + /// + /// Whether the package has QR code documents available for download + [JsonPropertyName("has_qr_code_documents"), JsonPropertyOrder(10)] + public bool? HasQrCodeDocuments { get; set; } + /// /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. /// /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. - [JsonPropertyName("insured_value"), JsonPropertyOrder(7)] + [JsonPropertyName("insured_value"), JsonPropertyOrder(11)] public MonetaryValue? InsuredValue { get; set; } /// @@ -97,7 +125,7 @@ public partial class LabelPackagesInner /// /// Gets or Sets LabelMessages /// - [JsonPropertyName("label_messages"), JsonPropertyOrder(9)] + [JsonPropertyName("label_messages"), JsonPropertyOrder(13)] public LabelMessages? LabelMessages { get; set; } /// @@ -107,18 +135,18 @@ public partial class LabelPackagesInner /// /// small_flat_rate_box /// - [JsonPropertyName("package_code"), JsonPropertyOrder(10)] + [JsonPropertyName("package_code"), JsonPropertyOrder(14)] public string? PackageCode { get; set; } /// - /// A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/) + /// The shipment package id /// - /// A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/) - /// - /// se-28529731 - /// - [JsonPropertyName("package_id"), JsonPropertyOrder(11)] - public string? PackageId { get; set; } + /// The shipment package id + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("package_id"), JsonInclude] + public int? PackageId { get; set; } /// /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. @@ -131,11 +159,14 @@ public partial class LabelPackagesInner public PaperlessDownload? PaperlessDownload { get; set; } /// - /// Details about products inside packages (Information provided would be used on custom documentation) + /// The QR code download for the package /// - /// Details about products inside packages (Information provided would be used on custom documentation) - [JsonPropertyName("products"), JsonPropertyOrder(13)] - public List? Products { get; set; } + /// The QR code download for the package + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("qr_code_download"), JsonInclude] + public OptionalLink? QrCodeDownload { get; set; } /// /// Package sequence @@ -176,13 +207,17 @@ public override string ToString() sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); sb.Append(" ExternalPackageId: ").Append(ExternalPackageId).Append("\n"); sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); + sb.Append(" HasFormDocuments: ").Append(HasFormDocuments).Append("\n"); + sb.Append(" HasLabelDocuments: ").Append(HasLabelDocuments).Append("\n"); + sb.Append(" HasPaperlessLabelDocuments: ").Append(HasPaperlessLabelDocuments).Append("\n"); + sb.Append(" HasQrCodeDocuments: ").Append(HasQrCodeDocuments).Append("\n"); sb.Append(" InsuredValue: ").Append(InsuredValue).Append("\n"); sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); sb.Append(" LabelMessages: ").Append(LabelMessages).Append("\n"); sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" PackageId: ").Append(PackageId).Append("\n"); sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); - sb.Append(" Products: ").Append(Products).Append("\n"); + sb.Append(" QrCodeDownload: ").Append(QrCodeDownload).Append("\n"); sb.Append(" Sequence: ").Append(Sequence).Append("\n"); sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete diff --git a/ShipEngineSDK/Model/ListLabelsResponseBody.cs b/ShipEngineSDK/Model/ListLabelsResponseBody.cs index 6a59afa8..95494c10 100644 --- a/ShipEngineSDK/Model/ListLabelsResponseBody.cs +++ b/ShipEngineSDK/Model/ListLabelsResponseBody.cs @@ -316,7 +316,7 @@ public class ListLabelsResponseBodyItem /// /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. [JsonPropertyName("packages"), JsonInclude] - public List? Packages { get; set; } + public List? Packages { get; set; } /// /// Additional information some carriers may provide by which to identify a given label in their system. diff --git a/ShipEngineSDK/Model/Package.cs b/ShipEngineSDK/Model/Package.cs index c457672b..855b7a10 100644 --- a/ShipEngineSDK/Model/Package.cs +++ b/ShipEngineSDK/Model/Package.cs @@ -21,7 +21,7 @@ namespace ShipEngineSDK.Model; /// -/// A package associated with a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/) +/// A package associated with a shipment /// public partial class Package { @@ -57,37 +57,17 @@ public partial class Package [JsonPropertyName("external_package_id"), JsonPropertyOrder(4)] public string? ExternalPackageId { get; set; } - /// - /// The form download for any customs that are needed - /// - /// The form download for any customs that are needed - /// - /// This should not be used for input as it will be ignored on serialization. - /// - [JsonPropertyName("form_download"), JsonInclude] - public OptionalLink? FormDownload { get; set; } - /// /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. /// /// The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. - [JsonPropertyName("insured_value"), JsonPropertyOrder(6)] + [JsonPropertyName("insured_value"), JsonPropertyOrder(5)] public MonetaryValue? InsuredValue { get; set; } - /// - /// The label download for the package - /// - /// The label download for the package - /// - /// This should not be used for input as it will be ignored on serialization. - /// - [JsonPropertyName("label_download"), JsonInclude] - public LabelDownload? LabelDownload { get; set; } - /// /// Gets or Sets LabelMessages /// - [JsonPropertyName("label_messages"), JsonPropertyOrder(8)] + [JsonPropertyName("label_messages"), JsonPropertyOrder(6)] public LabelMessages? LabelMessages { get; set; } /// @@ -97,7 +77,7 @@ public partial class Package /// /// small_flat_rate_box /// - [JsonPropertyName("package_code"), JsonPropertyOrder(9)] + [JsonPropertyName("package_code"), JsonPropertyOrder(7)] public string? PackageCode { get; set; } /// @@ -107,35 +87,35 @@ public partial class Package /// /// se-28529731 /// - [JsonPropertyName("package_id"), JsonPropertyOrder(10)] + [JsonPropertyName("package_id"), JsonPropertyOrder(8)] public string? PackageId { get; set; } /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + /// The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/) /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - [JsonPropertyName("paperless_download"), JsonInclude] - public PaperlessDownload? PaperlessDownload { get; set; } + /// The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/) + [JsonPropertyName("package_name"), JsonPropertyOrder(9)] + public string? PackageName { get; set; } /// /// Details about products inside packages (Information provided would be used on custom documentation) /// /// Details about products inside packages (Information provided would be used on custom documentation) - [JsonPropertyName("products"), JsonPropertyOrder(12)] + [JsonPropertyName("products"), JsonPropertyOrder(10)] public List? Products { get; set; } /// - /// Package sequence + /// A string that uniquely identifies this shipment package /// - /// Package sequence + /// A string that uniquely identifies this shipment package /// /// This should not be used for input as it will be ignored on serialization. /// - [JsonPropertyName("sequence"), JsonInclude] - public int? Sequence { get; set; } + /// + /// se-28529731 + /// + [JsonPropertyName("shipment_package_id"), JsonInclude] + public string? ShipmentPackageId { get; set; } /// /// The tracking number for the package. The format depends on the carrier. @@ -164,15 +144,13 @@ public override string ToString() sb.Append(" ContentDescription: ").Append(ContentDescription).Append("\n"); sb.Append(" Dimensions: ").Append(Dimensions).Append("\n"); sb.Append(" ExternalPackageId: ").Append(ExternalPackageId).Append("\n"); - sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); sb.Append(" InsuredValue: ").Append(InsuredValue).Append("\n"); - sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); sb.Append(" LabelMessages: ").Append(LabelMessages).Append("\n"); sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" PackageId: ").Append(PackageId).Append("\n"); - sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" PackageName: ").Append(PackageName).Append("\n"); sb.Append(" Products: ").Append(Products).Append("\n"); - sb.Append(" Sequence: ").Append(Sequence).Append("\n"); + sb.Append(" ShipmentPackageId: ").Append(ShipmentPackageId).Append("\n"); sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/VoidLabelResponseBody.cs b/ShipEngineSDK/Model/VoidLabelResponseBody.cs index 7791297c..ca95569c 100644 --- a/ShipEngineSDK/Model/VoidLabelResponseBody.cs +++ b/ShipEngineSDK/Model/VoidLabelResponseBody.cs @@ -52,9 +52,9 @@ public partial class VoidLabelResponseBody public string? Message { get; set; } /// - /// Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later. + /// Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later. /// - /// Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later. + /// Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later. /// /// This should not be used for input as it will be ignored on serialization. /// diff --git a/generation/swagger.json b/generation/swagger.json index 3cf16587..26ef9484 100644 --- a/generation/swagger.json +++ b/generation/swagger.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "ShipEngine API", - "version": "1.1.202406212006", + "version": "1.1.202407231507", "termsOfService": "https://www.shipengine.com/terms-of-service/", "x-logo": { "url": "https://shipengine.github.io/img/shipengine-logo-square.png", @@ -2141,7 +2141,7 @@ }, "/v1/labels": { "summary": "Print shipping labels", - "description": "Print shipping labels for any of the top global carriers in minutes—instead of weeks. Simply [connect your existing carrier accounts](https://www.shipengine.com/docs/carriers/setup/)\nin the API dashboard, and then [begin creating labels](https://www.shipengine.com/docs/shipping/use-a-carrier-service/).\n", + "description": "Print shipping labels for any of the top global carriers in minutes—instead of weeks. Simply [connect your existing carrier accounts](https://www.shipengine.com/docs/carriers/setup/)\nin the API dashboard, and then [begin creating labels](https://www.shipengine.com/docs/shipping/use-a-carrier-service/).\n", "get": { "summary": "List labels", "description": "This endpoint returns a list of labels that you've [created](https://www.shipengine.com/docs/labels/create-a-label/). You can optionally filter the results as well as control their sort order and the number of results returned at a time.\n\nBy default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want to get your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id`\n", @@ -7384,6 +7384,16 @@ "example": "Stamps.com", "description": "Screen readable name" }, + "funding_source_id": { + "readOnly": true, + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/se_id" + } + ], + "description": "Funding source ID for the carrier" + }, "primary": { "type": "boolean", "readOnly": true, @@ -8720,92 +8730,92 @@ "description": "Customer Branch" }, "Address": { - "type": "string", + "type": "string,", "description": "Address" }, "Address2": { - "type": "string", + "type": "string,", "description": "Address2" }, "PostalCode": { - "type": "string", + "type": "string,", "description": "PostalCode" }, "City": { - "type": "string", + "type": "string,", "description": "City" }, "State": { - "type": "string", + "type": "string,", "description": "State" }, "country": { - "type": "string", + "type": "string,", "description": "Country" }, "Phone": { - "type": "string", + "type": "string,", "description": "Phone" }, "Email": { - "type": "string", + "type": "string,", "description": "Email" }, "instructions": { - "type": "string", + "type": "string,", "description": "Instructions" }, "facility_code": { - "type": "string", + "type": "string,", "description": "Facility Code" }, "lasership_critical_pull_time": { - "type": "string", + "type": "string,", "description": "Critical Pull Time (local time)" }, "lasership_critical_entry_time": { - "type": "string", + "type": "string,", "description": "Critical Entry Time (local time)" }, "declare_piece_attributes_separately_for_every_shipment": { - "type": "boolean", + "type": "boolean,", "description": "Declare piece attributes separately for every shipment, overrides individual attribute below.", "default": false }, "AttrAlcohol": { - "type": "boolean", + "type": "boolean,", "description": "Set this to true if your shipments will always contain Alcohol" }, "AttrDryIce": { - "type": "boolean", + "type": "boolean,", "description": "Set this to true if your shipments will always contain DryIce" }, "AttrHazmat": { - "type": "boolean", + "type": "boolean,", "description": "Set this to true if your shipments will always contain Hazmat" }, "AttrTwoPersons": { - "type": "boolean", + "type": "boolean,", "description": "Set this to true if your shipments will always require Two Persons" }, "AttrExplosive": { - "type": "boolean", + "type": "boolean,", "description": "Set this to true if your shipments will always contain Explosives" }, "AttrControlledSubstance": { - "type": "boolean", + "type": "boolean,", "description": "Set this to true if your shipments will always contain Controlled Substances" }, "AttrRefrigerated": { - "type": "boolean", + "type": "boolean,", "description": "Set this to true if your shipments will always require Refrigeration" }, "AttrPerishable": { - "type": "boolean", + "type": "boolean,", "description": "Set this to true if your shipments will always be Perishable" }, "AttrNoRTS": { - "type": "boolean", + "type": "boolean,", "description": "Set this to true if your shipments will always use \"No Return To Sender\"" } } @@ -10126,7 +10136,7 @@ "items": { "allOf": [ { - "$ref": "#/components/schemas/package" + "$ref": "#/components/schemas/label_package" }, { "$ref": "#/components/schemas/alternative_identifiers" @@ -10492,7 +10502,7 @@ "items": { "allOf": [ { - "$ref": "#/components/schemas/package" + "$ref": "#/components/schemas/label_package" }, { "$ref": "#/components/schemas/alternative_identifiers" @@ -11676,12 +11686,21 @@ "package": { "title": "package", "type": "object", - "description": "A package associated with a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "description": "A package associated with a shipment\n", "required": [ "weight" ], "additionalProperties": false, "properties": { + "shipment_package_id": { + "allOf": [ + { + "$ref": "#/components/schemas/se_id" + } + ], + "readOnly": true, + "description": "A string that uniquely identifies this shipment package" + }, "package_id": { "allOf": [ { @@ -11698,13 +11717,9 @@ ], "description": "The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type.\n" }, - "content_description": { + "package_name": { "type": "string", - "minLength": 1, - "maxLength": 35, - "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", - "example": "Hand knitted wool socks", - "nullable": true + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" }, "weight": { "allOf": [ @@ -11736,15 +11751,6 @@ ], "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" }, - "tracking_number": { - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/tracking_number" - } - ], - "description": "The tracking number for the package. The format depends on the carrier.\n" - }, "label_messages": { "allOf": [ { @@ -11757,38 +11763,22 @@ "minLength": 1, "description": "An external package id." }, - "label_download": { - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/label_download" - } - ], - "description": "The label download for the package" - }, - "form_download": { - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/optional_link" - } - ], - "description": "The form download for any customs that are needed" - }, - "paperless_download": { + "tracking_number": { "readOnly": true, "allOf": [ { - "$ref": "#/components/schemas/paperless_download" + "$ref": "#/components/schemas/tracking_number" } ], - "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`." + "description": "The tracking number for the package. The format depends on the carrier.\n" }, - "sequence": { - "readOnly": true, - "format": "int32", - "type": "integer", - "description": "Package sequence" + "content_description": { + "type": "string", + "minLength": 1, + "maxLength": 35, + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "nullable": true }, "products": { "type": "array", @@ -11801,13 +11791,6 @@ } } }, - "tracking_number": { - "title": "tracking_number", - "type": "string", - "minLength": 1, - "example": "1Z932R800392060079", - "description": "A tracking number for a package. The format depends on the carrier." - }, "label_messages": { "title": "label_messages", "type": "object", @@ -11839,6 +11822,13 @@ } } }, + "tracking_number": { + "title": "tracking_number", + "type": "string", + "minLength": 1, + "example": "1Z932R800392060079", + "description": "A tracking number for a package. The format depends on the carrier." + }, "products": { "title": "products", "type": "object", @@ -12147,6 +12137,148 @@ ], "description": "The different statuses that can apply to a shipment." }, + "label_package": { + "title": "label_package", + "type": "object", + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "required": [ + "weight" + ], + "additionalProperties": false, + "properties": { + "package_id": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The shipment package id" + }, + "package_code": { + "allOf": [ + { + "$ref": "#/components/schemas/package_code" + } + ], + "description": "The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type.\n" + }, + "weight": { + "allOf": [ + { + "$ref": "#/components/schemas/weight" + } + ], + "description": "The package weight" + }, + "dimensions": { + "allOf": [ + { + "$ref": "#/components/schemas/dimensions" + } + ], + "description": "The package dimensions" + }, + "insured_value": { + "allOf": [ + { + "$ref": "#/components/schemas/monetary_value" + } + ], + "default": [ + { + "currency": "usd", + "amount": 0 + } + ], + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "tracking_number": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/tracking_number" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n" + }, + "label_download": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/label_download" + } + ], + "description": "The label download for the package" + }, + "form_download": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/optional_link" + } + ], + "description": "The form download for any customs that are needed" + }, + "qr_code_download": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/optional_link" + } + ], + "description": "The QR code download for the package" + }, + "paperless_download": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/paperless_download" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`." + }, + "label_messages": { + "allOf": [ + { + "$ref": "#/components/schemas/label_messages" + } + ] + }, + "external_package_id": { + "type": "string", + "minLength": 1, + "description": "An external package id." + }, + "content_description": { + "type": "string", + "minLength": 1, + "maxLength": 35, + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "nullable": true + }, + "sequence": { + "readOnly": true, + "format": "int32", + "type": "integer", + "description": "Package sequence" + }, + "has_label_documents": { + "type": "boolean", + "description": "Whether the package has label documents available for download" + }, + "has_form_documents": { + "type": "boolean", + "description": "Whether the package has form documents available for download" + }, + "has_qr_code_documents": { + "type": "boolean", + "description": "Whether the package has QR code documents available for download" + }, + "has_paperless_label_documents": { + "type": "boolean", + "description": "Whether the package has paperless documents available for download" + } + } + }, "alternative_identifiers": { "title": "alternative_identifiers", "type": "object", @@ -12752,7 +12884,7 @@ "$ref": "#/components/schemas/reason_code" } ], - "description": "Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later.", + "description": "Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later.", "example": "label_not_found_within_void_period" } } @@ -16162,7 +16294,7 @@ }, { "name": "labels", - "description": "Print shipping labels for any of the top global carriers in minutes—instead of weeks. Simply [connect your existing carrier accounts](https://www.shipengine.com/docs/carriers/setup/) in the API dashboard, and then [begin creating labels](https://www.shipengine.com/docs/shipping/use-a-carrier-service/).\n", + "description": "Print shipping labels for any of the top global carriers in minutes—instead of weeks. Simply [connect your existing carrier accounts](https://www.shipengine.com/docs/carriers/setup/) in the API dashboard, and then [begin creating labels](https://www.shipengine.com/docs/shipping/use-a-carrier-service/).\n", "externalDocs": { "url": "https://www.shipengine.com/docs/labels/create-a-label/", "description": "Follow this quick start guide to create your first shipping label with ShipEngine" From 2a1f889c5229f8aa1fa9dab283773056582ce9da Mon Sep 17 00:00:00 2001 From: Joshua Flanagan Date: Tue, 23 Jul 2024 16:19:06 -0500 Subject: [PATCH 17/42] Verify can deserialize create label response --- .../CreateLabelFromRateTest.cs | 43 +++++++++++++------ 1 file changed, 29 insertions(+), 14 deletions(-) diff --git a/ShipEngineSDK.Test/ShipEngineMethodTests/CreateLabelFromRateTest.cs b/ShipEngineSDK.Test/ShipEngineMethodTests/CreateLabelFromRateTest.cs index b7d05ec5..f0b8ea17 100644 --- a/ShipEngineSDK.Test/ShipEngineMethodTests/CreateLabelFromRateTest.cs +++ b/ShipEngineSDK.Test/ShipEngineMethodTests/CreateLabelFromRateTest.cs @@ -11,6 +11,8 @@ namespace ShipEngineTest { + using ShipEngineSDK.Model; + public class CreateLabelFromRateTest { @@ -24,10 +26,10 @@ public CreateLabelFromRateTest() Params = new Params() { RateId = "se-1234", - ValidateAddress = ValidateAddress.NoValidation, - LabelLayout = LabelLayout.Letter, - LabelFormat = LabelFormat.PDF, - LabelDownloadType = LabelDownloadType.Url + ValidateAddress = ShipEngineSDK.Common.Enums.ValidateAddress.NoValidation, + LabelLayout = ShipEngineSDK.Common.Enums.LabelLayout.Letter, + LabelFormat = ShipEngineSDK.Common.Enums.LabelFormat.PDF, + LabelDownloadType = ShipEngineSDK.CreateLabelFromRate.LabelDownloadType.Url }; TestUtils = new TestUtils(); @@ -46,7 +48,7 @@ public async Task ValidCreateLabelFromRateTest() var result = await mockShipEngineFixture.ShipEngine.CreateLabelFromRate(Params); Assert.Equal("se-80255646", result.LabelId); - Assert.Equal(LabelStatus.Completed, result.Status); + Assert.Equal(ShipEngineSDK.CreateLabelFromRate.LabelStatus.Completed, result.Status); Assert.Equal("se-153814671", result.ShipmentId); Assert.Equal("2021-08-27T00:00:00Z", result.ShipDate); Assert.Equal("2021-08-27T16:29:56.8779097Z", result.CreatedAt); @@ -68,13 +70,13 @@ public async Task ValidCreateLabelFromRateTest() Assert.Equal("package", result.PackageCode); Assert.False(result.Voided); Assert.Null(result.VoidedAt); - Assert.Equal(LabelFormat.PDF, result.LabelFormat); - Assert.Equal(DisplayScheme.Label, result.DisplayScheme); - Assert.Equal(LabelLayout.FourBySix, result.LabelLayout); + Assert.Equal(ShipEngineSDK.Common.Enums.LabelFormat.PDF, result.LabelFormat); + Assert.Equal(ShipEngineSDK.Common.Enums.DisplayScheme.Label, result.DisplayScheme); + Assert.Equal(ShipEngineSDK.Common.Enums.LabelLayout.FourBySix, result.LabelLayout); Assert.True(result.Trackable); Assert.Null(result.LabelImageId); Assert.Equal("ups", result.CarrierCode); - Assert.Equal(TrackingStatus.InTransit, result.TrackingStatus); + Assert.Equal(ShipEngineSDK.CreateLabelFromRate.TrackingStatus.InTransit, result.TrackingStatus); Assert.Equal("https://api.shipengine.com/v1/downloads/10/xJi-OIh8UU-_RBVmfA6dDw/label-80255646.pdf", result.LabelDownload.Pdf); Assert.Equal("https://api.shipengine.com/v1/downloads/10/xJi-OIh8UU-_RBVmfA6dDw/label-80255646.png", result.LabelDownload.Png); @@ -89,9 +91,9 @@ public async Task ValidCreateLabelFromRateTest() Assert.Equal("package", package.PackageCode); Assert.Equal(17.0, package.Weight.Value); - Assert.Equal(WeightUnit.Pound, package.Weight.Unit); + Assert.Equal(ShipEngineSDK.Common.Enums.WeightUnit.Pound, package.Weight.Unit); - Assert.Equal(DimensionUnit.Inch, package.Dimensions.Unit); + Assert.Equal(ShipEngineSDK.Common.Enums.DimensionUnit.Inch, package.Dimensions.Unit); Assert.Equal(36.0, package.Dimensions.Length); Assert.Equal(12.0, package.Dimensions.Width); Assert.Equal(24.0, package.Dimensions.Height); @@ -157,11 +159,24 @@ public async Task InvalidRetriesInMethodCall() var shipEngine = mockHandler.Object; var ex = await Assert.ThrowsAsync(async () => await shipEngine.CreateLabelFromRate(Params, methodConfig: new Config(apiKey: "12345", retries: -1))); - Assert.Equal(ErrorSource.Shipengine, ex.ErrorSource); - Assert.Equal(ErrorType.Validation, ex.ErrorType); - Assert.Equal(ErrorCode.InvalidFieldValue, ex.ErrorCode); + Assert.Equal(ShipEngineSDK.ErrorSource.Shipengine, ex.ErrorSource); + Assert.Equal(ShipEngineSDK.ErrorType.Validation, ex.ErrorType); + Assert.Equal(ShipEngineSDK.ErrorCode.InvalidFieldValue, ex.ErrorCode); Assert.Equal("Retries must be greater than zero.", ex.Message); Assert.Null(ex.RequestId); } + + + [Fact] + public void CanDeserializeLabelResponseWithGeneratedModel() + { + string json = File.ReadAllText(Path.Combine(Directory.GetCurrentDirectory(), "../../../HttpResponseMocks/CreateLabelFromRate200Response.json")); + + var response = JsonSerializer.Deserialize(json); + Assert.Equal("1Z63R0960332529481", response.TrackingNumber); + var package = Assert.Single(response.Packages); + Assert.Equal("https://api.shipengine.com/v1/downloads/10/2zzavkE0J0irTipDXRePHQ/labelpackage-85151459.pdf", package.LabelDownload.Pdf); + } + } } \ No newline at end of file From 872dbebd9fcfb0fa7fd35982f77fad6fddc93cfc Mon Sep 17 00:00:00 2001 From: Joshua Flanagan Date: Tue, 23 Jul 2024 16:27:40 -0500 Subject: [PATCH 18/42] Version 3.0.0-beta.6 --- ShipEngineSDK/ShipEngineSDK.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index 8d750c0f..2d4246f5 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-beta.5 + 3.0.0-beta.6 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET From 77381c43c8af26650a8272f218a2fc5a283d3899 Mon Sep 17 00:00:00 2001 From: Matt Burton Date: Wed, 24 Jul 2024 12:56:00 -0400 Subject: [PATCH 19/42] Regenerate from spec v1.19.1, version 3.0.0-beta.7 --- .../Model/GetTrackingLogFromLabelResponseBody.cs | 14 +++++++------- ShipEngineSDK/Model/GetTrackingLogResponseBody.cs | 14 +++++++------- ShipEngineSDK/Model/TrackingInformation.cs | 14 +++++++------- ShipEngineSDK/ShipEngineSDK.csproj | 2 +- generation/swagger.json | 11 +++++------ 5 files changed, 27 insertions(+), 28 deletions(-) diff --git a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs index fec53dca..aa96c375 100644 --- a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs @@ -109,14 +109,14 @@ public partial class GetTrackingLogFromLabelResponseBody public string? CarrierDetailCode { get; set; } /// - /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// - /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. - /// - /// se-28529731 - /// - [JsonPropertyName("carrier_id"), JsonPropertyOrder(9)] - public string? CarrierId { get; set; } + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("carrier_id"), JsonInclude] + public int? CarrierId { get; set; } /// /// carrier status description diff --git a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs index 8461f2d9..c0c839ff 100644 --- a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs @@ -50,14 +50,14 @@ public partial class GetTrackingLogResponseBody public string? CarrierDetailCode { get; set; } /// - /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// - /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. - /// - /// se-28529731 - /// - [JsonPropertyName("carrier_id"), JsonPropertyOrder(3)] - public required string CarrierId { get; set; } + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("carrier_id"), JsonInclude] + public int? CarrierId { get; set; } /// /// Carrier status code diff --git a/ShipEngineSDK/Model/TrackingInformation.cs b/ShipEngineSDK/Model/TrackingInformation.cs index 08ce7ae1..322d8ef2 100644 --- a/ShipEngineSDK/Model/TrackingInformation.cs +++ b/ShipEngineSDK/Model/TrackingInformation.cs @@ -60,14 +60,14 @@ public partial class TrackingInformation public string? CarrierDetailCode { get; set; } /// - /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label /// - /// A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. - /// - /// se-28529731 - /// - [JsonPropertyName("carrier_id"), JsonPropertyOrder(4)] - public string? CarrierId { get; set; } + /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("carrier_id"), JsonInclude] + public int? CarrierId { get; set; } /// /// Carrier status code diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index 2d4246f5..487ed5f4 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-beta.6 + 3.0.0-beta.7 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET diff --git a/generation/swagger.json b/generation/swagger.json index 26ef9484..d267c441 100644 --- a/generation/swagger.json +++ b/generation/swagger.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "ShipEngine API", - "version": "1.1.202407231507", + "version": "1.1.202407241607", "termsOfService": "https://www.shipengine.com/terms-of-service/", "x-logo": { "url": "https://shipengine.github.io/img/shipengine-logo-square.png", @@ -12631,11 +12631,10 @@ ] }, "carrier_id": { - "allOf": [ - { - "$ref": "#/components/schemas/se_id" - } - ] + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n" }, "status_description": { "type": "string", From f61a6ef9dc2290d1ac8f26658a5970171817a74c Mon Sep 17 00:00:00 2001 From: Matt Burton Date: Wed, 24 Jul 2024 16:38:52 -0400 Subject: [PATCH 20/42] Regenerate from spec v1.19.2, version 3.0.0-beta.8 --- ShipEngineSDK/Model/StatusCode.cs | 34 +++++++++++++++--------------- ShipEngineSDK/ShipEngineSDK.csproj | 2 +- generation/swagger.json | 18 ++++++++-------- 3 files changed, 27 insertions(+), 27 deletions(-) diff --git a/ShipEngineSDK/Model/StatusCode.cs b/ShipEngineSDK/Model/StatusCode.cs index ef490faf..c8b5d5cb 100644 --- a/ShipEngineSDK/Model/StatusCode.cs +++ b/ShipEngineSDK/Model/StatusCode.cs @@ -21,9 +21,9 @@ namespace ShipEngineSDK.Model; /// -/// The tracking status codes |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`un` | Unknown |`ac` | Accepted |`it` | In Transit |`de` | Delivered |`ex` | Exception |`at` | Delivery Attempt |`ny` | Not Yet In System +/// The tracking status codes |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`UN` | Unknown |`AC` | Accepted |`IT` | In Transit |`DE` | Delivered |`EX` | Exception |`AT` | Delivery Attempt |`NY` | Not Yet In System /// -/// The tracking status codes |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`un` | Unknown |`ac` | Accepted |`it` | In Transit |`de` | Delivered |`ex` | Exception |`at` | Delivery Attempt |`ny` | Not Yet In System +/// The tracking status codes |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`UN` | Unknown |`AC` | Accepted |`IT` | In Transit |`DE` | Delivered |`EX` | Exception |`AT` | Delivery Attempt |`NY` | Not Yet In System [JsonConverter(typeof(StatusCodeJsonConverter))] public class StatusCode { @@ -34,7 +34,7 @@ public class StatusCode /// internal StatusCode() { - _value = "un"; + _value = "UN"; } /// @@ -51,45 +51,45 @@ public StatusCode(string value) } /// - /// Enum Un for value: un + /// Enum UN for value: UN /// - public static StatusCode Un { get; } = new("un"); + public static StatusCode UN { get; } = new("UN"); /// - /// Enum Ac for value: ac + /// Enum AC for value: AC /// - public static StatusCode Ac { get; } = new("ac"); + public static StatusCode AC { get; } = new("AC"); /// - /// Enum It for value: it + /// Enum IT for value: IT /// - public static StatusCode It { get; } = new("it"); + public static StatusCode IT { get; } = new("IT"); /// - /// Enum De for value: de + /// Enum DE for value: DE /// - public static StatusCode De { get; } = new("de"); + public static StatusCode DE { get; } = new("DE"); /// - /// Enum Ex for value: ex + /// Enum EX for value: EX /// - public static StatusCode Ex { get; } = new("ex"); + public static StatusCode EX { get; } = new("EX"); /// - /// Enum At for value: at + /// Enum AT for value: AT /// - public static StatusCode At { get; } = new("at"); + public static StatusCode AT { get; } = new("AT"); /// - /// Enum Ny for value: ny + /// Enum NY for value: NY /// - public static StatusCode Ny { get; } = new("ny"); + public static StatusCode NY { get; } = new("NY"); /// diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index 487ed5f4..7490fdfe 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-beta.7 + 3.0.0-beta.8 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET diff --git a/generation/swagger.json b/generation/swagger.json index d267c441..2fd7de68 100644 --- a/generation/swagger.json +++ b/generation/swagger.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "ShipEngine API", - "version": "1.1.202407241607", + "version": "1.1.202407242007", "termsOfService": "https://www.shipengine.com/terms-of-service/", "x-logo": { "url": "https://shipengine.github.io/img/shipengine-logo-square.png", @@ -12705,16 +12705,16 @@ "readOnly": true, "title": "status_code", "enum": [ - "un", - "ac", - "it", - "de", - "ex", - "at", - "ny" + "UN", + "AC", + "IT", + "DE", + "EX", + "AT", + "NY" ], "type": "string", - "description": "The tracking status codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n|`un` | Unknown\n|`ac` | Accepted\n|`it` | In Transit\n|`de` | Delivered\n|`ex` | Exception\n|`at` | Delivery Attempt\n|`ny` | Not Yet In System\n" + "description": "The tracking status codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n|`UN` | Unknown\n|`AC` | Accepted\n|`IT` | In Transit\n|`DE` | Delivered\n|`EX` | Exception\n|`AT` | Delivery Attempt\n|`NY` | Not Yet In System\n" }, "track_event": { "title": "track_event", From b5347fc1af4c3a22263202a99a5aee4dcd35e6f1 Mon Sep 17 00:00:00 2001 From: Joshua Flanagan Date: Sun, 28 Jul 2024 15:06:18 -0500 Subject: [PATCH 21/42] Regenerate from 1.19.3 spec Convert doubles to decimals --- ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs | 2 +- .../Model/AddFundsToInsuranceRequestBody.cs | 2 +- .../Model/AddFundsToInsuranceResponseBody.cs | 2 +- ShipEngineSDK/Model/Carrier.cs | 2 +- ShipEngineSDK/Model/CustomsItem.cs | 2 +- ShipEngineSDK/Model/DangerousAmount.cs | 2 +- ShipEngineSDK/Model/Dimensions.cs | 6 +++--- ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs | 2 +- .../Model/GetInsuranceBalanceResponseBody.cs | 2 +- ShipEngineSDK/Model/MonetaryValue.cs | 2 +- ShipEngineSDK/Model/PaymentAmount.cs | 2 +- ShipEngineSDK/Model/Products.cs | 2 +- ShipEngineSDK/Model/UpsInvoice.cs | 2 +- ShipEngineSDK/Model/Weight.cs | 2 +- generation/swagger.json | 13 +------------ 15 files changed, 17 insertions(+), 28 deletions(-) diff --git a/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs b/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs index 85f1a1c3..6bfa7870 100644 --- a/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs +++ b/ShipEngineSDK/Model/AddFundsToCarrierRequestBody.cs @@ -31,7 +31,7 @@ public partial class AddFundsToCarrierRequestBody /// /// The monetary amount, in the specified currency. [JsonPropertyName("amount"), JsonPropertyOrder(1)] - public required double Amount { get; set; } + public required decimal Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html diff --git a/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs b/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs index 26f9382a..380bedc6 100644 --- a/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs +++ b/ShipEngineSDK/Model/AddFundsToInsuranceRequestBody.cs @@ -31,7 +31,7 @@ public partial class AddFundsToInsuranceRequestBody /// /// The monetary amount, in the specified currency. [JsonPropertyName("amount"), JsonPropertyOrder(1)] - public required double Amount { get; set; } + public required decimal Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html diff --git a/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs b/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs index ea8438cd..d526df71 100644 --- a/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs +++ b/ShipEngineSDK/Model/AddFundsToInsuranceResponseBody.cs @@ -31,7 +31,7 @@ public partial class AddFundsToInsuranceResponseBody /// /// The monetary amount, in the specified currency. [JsonPropertyName("amount"), JsonPropertyOrder(1)] - public required double Amount { get; set; } + public required decimal Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html diff --git a/ShipEngineSDK/Model/Carrier.cs b/ShipEngineSDK/Model/Carrier.cs index 481b066f..612ea9e3 100644 --- a/ShipEngineSDK/Model/Carrier.cs +++ b/ShipEngineSDK/Model/Carrier.cs @@ -50,7 +50,7 @@ public partial class Carrier /// 3799.52 /// [JsonPropertyName("balance"), JsonInclude] - public double? Balance { get; set; } + public decimal? Balance { get; set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. diff --git a/ShipEngineSDK/Model/CustomsItem.cs b/ShipEngineSDK/Model/CustomsItem.cs index 4d796ec4..d14bad8c 100644 --- a/ShipEngineSDK/Model/CustomsItem.cs +++ b/ShipEngineSDK/Model/CustomsItem.cs @@ -98,7 +98,7 @@ public partial class CustomsItem /// /// The monetary amount, in the specified currency. [JsonPropertyName("value"), JsonPropertyOrder(9)] - public double? Value { get; set; } + public decimal? Value { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html diff --git a/ShipEngineSDK/Model/DangerousAmount.cs b/ShipEngineSDK/Model/DangerousAmount.cs index 3788e2a2..b2588684 100644 --- a/ShipEngineSDK/Model/DangerousAmount.cs +++ b/ShipEngineSDK/Model/DangerousAmount.cs @@ -31,7 +31,7 @@ public partial class DangerousAmount /// /// The amount of dangerous goods. [JsonPropertyName("amount"), JsonPropertyOrder(1)] - public double? Amount { get; set; } + public decimal? Amount { get; set; } /// /// The unit of dangerous goods. diff --git a/ShipEngineSDK/Model/Dimensions.cs b/ShipEngineSDK/Model/Dimensions.cs index aaedd9b9..f73fc232 100644 --- a/ShipEngineSDK/Model/Dimensions.cs +++ b/ShipEngineSDK/Model/Dimensions.cs @@ -37,21 +37,21 @@ public partial class Dimensions /// /// The height of the package, in the specified unit [JsonPropertyName("height"), JsonPropertyOrder(2)] - public required double Height { get; set; } + public required decimal Height { get; set; } /// /// The length of the package, in the specified unit /// /// The length of the package, in the specified unit [JsonPropertyName("length"), JsonPropertyOrder(3)] - public required double Length { get; set; } + public required decimal Length { get; set; } /// /// The width of the package, in the specified unit /// /// The width of the package, in the specified unit [JsonPropertyName("width"), JsonPropertyOrder(4)] - public required double Width { get; set; } + public required decimal Width { get; set; } /// diff --git a/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs b/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs index f8a91274..f8fc36b3 100644 --- a/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetCarrierByIdResponseBody.cs @@ -50,7 +50,7 @@ public partial class GetCarrierByIdResponseBody /// 3799.52 /// [JsonPropertyName("balance"), JsonInclude] - public double? Balance { get; set; } + public decimal? Balance { get; set; } /// /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. diff --git a/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs b/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs index bf699890..aace6a71 100644 --- a/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs +++ b/ShipEngineSDK/Model/GetInsuranceBalanceResponseBody.cs @@ -31,7 +31,7 @@ public partial class GetInsuranceBalanceResponseBody /// /// The monetary amount, in the specified currency. [JsonPropertyName("amount"), JsonPropertyOrder(1)] - public required double Amount { get; set; } + public required decimal Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html diff --git a/ShipEngineSDK/Model/MonetaryValue.cs b/ShipEngineSDK/Model/MonetaryValue.cs index 5368ea91..13ecf290 100644 --- a/ShipEngineSDK/Model/MonetaryValue.cs +++ b/ShipEngineSDK/Model/MonetaryValue.cs @@ -31,7 +31,7 @@ public partial class MonetaryValue /// /// The monetary amount, in the specified currency. [JsonPropertyName("amount"), JsonPropertyOrder(1)] - public required double Amount { get; set; } + public required decimal Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html diff --git a/ShipEngineSDK/Model/PaymentAmount.cs b/ShipEngineSDK/Model/PaymentAmount.cs index e40d8ec0..02142a14 100644 --- a/ShipEngineSDK/Model/PaymentAmount.cs +++ b/ShipEngineSDK/Model/PaymentAmount.cs @@ -30,7 +30,7 @@ public partial class PaymentAmount /// Gets or Sets Amount /// [JsonPropertyName("amount"), JsonPropertyOrder(1)] - public double? Amount { get; set; } + public decimal? Amount { get; set; } /// /// The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html diff --git a/ShipEngineSDK/Model/Products.cs b/ShipEngineSDK/Model/Products.cs index 17db62b1..aa1a44d3 100644 --- a/ShipEngineSDK/Model/Products.cs +++ b/ShipEngineSDK/Model/Products.cs @@ -116,7 +116,7 @@ public partial class Products /// 0.2 /// [JsonPropertyName("vat_rate"), JsonPropertyOrder(12)] - public double? VatRate { get; set; } + public decimal? VatRate { get; set; } /// /// The item weight diff --git a/ShipEngineSDK/Model/UpsInvoice.cs b/ShipEngineSDK/Model/UpsInvoice.cs index cc6b2d63..18b19963 100644 --- a/ShipEngineSDK/Model/UpsInvoice.cs +++ b/ShipEngineSDK/Model/UpsInvoice.cs @@ -40,7 +40,7 @@ public partial class UpsInvoice /// Gets or Sets InvoiceAmount /// [JsonPropertyName("invoice_amount"), JsonPropertyOrder(2)] - public double? InvoiceAmount { get; set; } + public decimal? InvoiceAmount { get; set; } /// /// Gets or Sets InvoiceCurrencyCode diff --git a/ShipEngineSDK/Model/Weight.cs b/ShipEngineSDK/Model/Weight.cs index b523acc0..d4bcef5e 100644 --- a/ShipEngineSDK/Model/Weight.cs +++ b/ShipEngineSDK/Model/Weight.cs @@ -37,7 +37,7 @@ public partial class Weight /// /// The weight, in the specified unit [JsonPropertyName("value"), JsonPropertyOrder(2)] - public required double Value { get; set; } + public required decimal Value { get; set; } /// diff --git a/generation/swagger.json b/generation/swagger.json index 2fd7de68..9cb8d82e 100644 --- a/generation/swagger.json +++ b/generation/swagger.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "ShipEngine API", - "version": "1.1.202407242007", + "version": "1.1.202407281907", "termsOfService": "https://www.shipengine.com/terms-of-service/", "x-logo": { "url": "https://shipengine.github.io/img/shipengine-logo-square.png", @@ -7364,7 +7364,6 @@ }, "balance": { "type": "number", - "format": "double", "readOnly": true, "example": 3799.52, "minimum": 0, @@ -7594,21 +7593,18 @@ }, "length": { "type": "number", - "format": "double", "minimum": 0, "default": 0, "description": "The length of the package, in the specified unit" }, "width": { "type": "number", - "format": "double", "minimum": 0, "default": 0, "description": "The width of the package, in the specified unit" }, "height": { "type": "number", - "format": "double", "minimum": 0, "default": 0, "description": "The height of the package, in the specified unit" @@ -7693,7 +7689,6 @@ }, "amount": { "type": "number", - "format": "double", "minimum": 0, "description": "The monetary amount, in the specified currency." } @@ -9434,7 +9429,6 @@ }, "invoice_amount": { "type": "number", - "format": "double", "minimum": 0 }, "invoice_currency_code": { @@ -11338,7 +11332,6 @@ }, "value": { "type": "number", - "format": "double", "minimum": 0, "description": "The monetary amount, in the specified currency." }, @@ -11399,7 +11392,6 @@ "properties": { "value": { "type": "number", - "format": "double", "minimum": 0, "exclusiveMinimum": true, "description": "The weight, in the specified unit" @@ -11650,7 +11642,6 @@ }, "amount": { "minimum": 0, - "format": "double", "type": "number" } } @@ -11908,7 +11899,6 @@ }, "vat_rate": { "type": "number", - "format": "double", "description": "VAT rate applicable to the item", "nullable": true, "example": 0.2 @@ -12054,7 +12044,6 @@ "properties": { "amount": { "type": "number", - "format": "double", "minimum": 0, "default": 0, "description": "The amount of dangerous goods." From a8e56bc934c057ad7e238ad261cb43cf146c167e Mon Sep 17 00:00:00 2001 From: Joshua Flanagan Date: Sun, 28 Jul 2024 15:07:28 -0500 Subject: [PATCH 22/42] Version 3.0.0-beta.9 --- ShipEngineSDK/ShipEngineSDK.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index 7490fdfe..18d13c40 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-beta.8 + 3.0.0-beta.9 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET From 2765a54c0b9fe3e1b386991d3ab2e9f562738c3b Mon Sep 17 00:00:00 2001 From: Joe Pill Date: Mon, 22 Jul 2024 14:53:33 -0500 Subject: [PATCH 23/42] feat: modify request --- ShipEngineSDK/ShipEngine.cs | 11 +++++++++++ ShipEngineSDK/ShipEngineClient.cs | 6 ++++++ 2 files changed, 17 insertions(+) diff --git a/ShipEngineSDK/ShipEngine.cs b/ShipEngineSDK/ShipEngine.cs index cdf9a6e3..9440a8bd 100644 --- a/ShipEngineSDK/ShipEngine.cs +++ b/ShipEngineSDK/ShipEngine.cs @@ -227,6 +227,17 @@ public ShipEngine(Config config, HttpClient httpClient) : base() _client = httpClient; } + /// + /// Modifies the request before it is sent to the ShipEngine API + /// + /// + /// + public ShipEngine ModifyRequest(Action modifyRequest) + { + base.ModifyRequest = modifyRequest; + return this; + } + /// /// Dispose of the ShipEngine client /// diff --git a/ShipEngineSDK/ShipEngineClient.cs b/ShipEngineSDK/ShipEngineClient.cs index 3e69ac69..f69fb8a3 100644 --- a/ShipEngineSDK/ShipEngineClient.cs +++ b/ShipEngineSDK/ShipEngineClient.cs @@ -71,6 +71,11 @@ public class ShipEngineClient /// public CancellationToken CancellationToken { get; set; } + /// + /// Modifies the client request before it is sent + /// + public Action? ModifyRequest { get; set; } + /// /// Sets the HttpClient User agent, the json media type, and the API key to be used /// for all ShipEngine API calls unless overrwritten at the method level. @@ -230,6 +235,7 @@ public virtual async Task SendHttpRequestAsync(HttpMethod method, string p try { var request = BuildRequest(method, path, jsonContent); + ModifyRequest?.Invoke(request); response = await client.SendAsync(request, cancellationToken); var deserializedResult = await DeserializedResultOrThrow(response); From e99cb83350ac17579433f2adeb69885a04893896 Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Thu, 22 Aug 2024 15:00:53 -0500 Subject: [PATCH 24/42] Bump the version --- CHANGELOG.md | 6 ++++++ ShipEngineSDK/ShipEngineSDK.csproj | 2 +- openapitools.json | 2 +- package.json | 2 +- 4 files changed, 9 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4a881fb5..51d1b779 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -184,3 +184,9 @@ Updated nuget package dependencies ## Changed - Make setters on readonly properties public + +## 3.0.0-beta.10 + +## Changed + +- Allow requests to be modified before being sent diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index 18d13c40..c50708d3 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-beta.9 + 3.0.0-beta.10 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET diff --git a/openapitools.json b/openapitools.json index 0bf912f3..760b6517 100644 --- a/openapitools.json +++ b/openapitools.json @@ -14,7 +14,7 @@ "ignoreFileOverride": "./.openapi-generator-ignore", "library": "generichost", "additionalProperties": { - "packageVersion": "3.0.0-beta.4", + "packageVersion": "3.0.0-beta.10", "targetFramework": "netstandard2.0", "validatable": false, "sourceFolder": "", diff --git a/package.json b/package.json index 5faaf70b..a228c4b6 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "shipengine-dotnet", - "version": "3.0.0-beta.4", + "version": "3.0.0-beta.10", "description": "Package primarily used to generate the API and models from OpenApi spec\"", "main": "index.js", "directories": { From 0c7d4a393e610f5a47581e7d686be020941c3d56 Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Thu, 22 Aug 2024 15:09:14 -0500 Subject: [PATCH 25/42] Temporarily disable code coverage reporting since Coveralls is returning 500 errors --- .github/workflows/ci-cd.yaml | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/.github/workflows/ci-cd.yaml b/.github/workflows/ci-cd.yaml index 2bd66a02..f2345ef4 100644 --- a/.github/workflows/ci-cd.yaml +++ b/.github/workflows/ci-cd.yaml @@ -75,24 +75,24 @@ jobs: ls -Rlh ShipEngineSDK.Test/TestResults/*/coverage.info cat ShipEngineSDK.Test/TestResults/*/coverage.info > ShipEngineSDK.Test/TestResults/lcov.info - - name: Send code coverage results to Coveralls - uses: coverallsapp/github-action@v1.1.0 - with: - github-token: ${{ secrets.GITHUB_TOKEN }} - parallel: true - flag-name: run-${{ matrix.test_number }} - path-to-lcov: ShipEngineSDK.Test/TestResults/lcov.info - - coverage: - name: Code Coverage - needs: dot_net_core_test - runs-on: ubuntu-latest - steps: - - name: Coveralls Finished - uses: coverallsapp/github-action@master - with: - github-token: ${{ secrets.github_token }} - parallel-finished: true + # - name: Send code coverage results to Coveralls + # uses: coverallsapp/github-action@v1.1.0 + # with: + # github-token: ${{ secrets.GITHUB_TOKEN }} + # parallel: true + # flag-name: run-${{ matrix.test_number }} + # path-to-lcov: ShipEngineSDK.Test/TestResults/lcov.info + + # coverage: + # name: Code Coverage + # needs: dot_net_core_test + # runs-on: ubuntu-latest + # steps: + # - name: Coveralls Finished + # uses: coverallsapp/github-action@master + # with: + # github-token: ${{ secrets.github_token }} + # parallel-finished: true nuget-deploy: runs-on: ubuntu-latest From b4fee8b113eafccb0320139f43588ad29e4d8a8e Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Mon, 26 Aug 2024 10:50:29 -0500 Subject: [PATCH 26/42] Bump version --- CHANGELOG.md | 9 +++++++++ ShipEngineSDK/ShipEngineSDK.csproj | 2 +- openapitools.json | 2 +- package.json | 2 +- 4 files changed, 12 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ac9487d4..1e2a5592 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -210,3 +210,12 @@ Fixed handling of No Content responses ## Changed - Allow requests to be modified before being sent + +## 3.0.0-beta.11 + +## Changed + +- Added ability to scope request modifiers by using the `.WithRequestModifier()` method instead of the `.ModifyRequest` property. + This will allow consumers to modify a single request without affecting any other consumers of the client. It also allows for + multiple modifiers to be added. For example, a modifier could be added at the global level that applies to all requests and then + another modifier can be added for a single request. diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index c50708d3..309e5365 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-beta.10 + 3.0.0-beta.11 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET diff --git a/openapitools.json b/openapitools.json index 760b6517..9d3ae49f 100644 --- a/openapitools.json +++ b/openapitools.json @@ -14,7 +14,7 @@ "ignoreFileOverride": "./.openapi-generator-ignore", "library": "generichost", "additionalProperties": { - "packageVersion": "3.0.0-beta.10", + "packageVersion": "3.0.0-beta.11", "targetFramework": "netstandard2.0", "validatable": false, "sourceFolder": "", diff --git a/package.json b/package.json index a228c4b6..401d164c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "shipengine-dotnet", - "version": "3.0.0-beta.10", + "version": "3.0.0-beta.11", "description": "Package primarily used to generate the API and models from OpenApi spec\"", "main": "index.js", "directories": { From f0e0aa87187ae95f9020ad9e8db4ceac8d400cc6 Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Wed, 11 Sep 2024 08:12:01 -0500 Subject: [PATCH 27/42] Update SE API version --- .openapi-generator/FILES | 7 + CHANGELOG.md | 6 + .../Model/AdvancedShipmentOptions.cs | 7 + ...dShipmentOptionsWindsorFrameworkDetails.cs | 141 +++++ .../Model/ConnectAsendiaRequestBody.cs | 52 +- .../Model/ConnectCarrierRequestBody.cs | 2 +- ShipEngineSDK/Model/ConnectUpsRequestBody.cs | 20 +- .../Model/CreateLabelFromRateResponseBody.cs | 19 +- .../CreateLabelFromShipmentResponseBody.cs | 19 +- ShipEngineSDK/Model/CreateLabelRequestBody.cs | 21 +- .../Model/CreateLabelResponseBody.cs | 19 +- .../Model/CreateReturnLabelResponseBody.cs | 19 +- ...etLabelByExternalShipmentIdResponseBody.cs | 19 +- .../Model/GetLabelByIdResponseBody.cs | 19 +- .../Model/GetRateByIdResponseBody.cs | 11 + .../GetServicePointsRequestBodyShipment.cs | 10 +- ...ePointsRequestBodyShipmentPackagesInner.cs | 61 +++ .../GetTrackingLogFromLabelResponseBody.cs | 21 + .../Model/GetTrackingLogResponseBody.cs | 21 + ShipEngineSDK/Model/IdentifierType.cs | 10 +- ShipEngineSDK/Model/Label.cs | 19 +- ShipEngineSDK/Model/ListLabelsResponseBody.cs | 29 +- ShipEngineSDK/Model/Rate.cs | 11 + ShipEngineSDK/Model/RateDetail.cs | 107 ++++ ShipEngineSDK/Model/RateDetailAttributes.cs | 76 +++ ShipEngineSDK/Model/RateDetailType.cs | 212 ++++++++ ShipEngineSDK/Model/StatusDetailCode.cs | 512 ++++++++++++++++++ ShipEngineSDK/Model/TaxType.cs | 86 +++ ShipEngineSDK/Model/TrackEvent.cs | 21 + ShipEngineSDK/Model/TrackingInformation.cs | 23 +- ShipEngineSDK/ShipEngineSDK.csproj | 2 +- generation/swagger.json | 347 +++++++++++- openapitools.json | 2 +- package.json | 2 +- 34 files changed, 1872 insertions(+), 81 deletions(-) create mode 100644 ShipEngineSDK/Model/AdvancedShipmentOptionsWindsorFrameworkDetails.cs create mode 100644 ShipEngineSDK/Model/GetServicePointsRequestBodyShipmentPackagesInner.cs create mode 100644 ShipEngineSDK/Model/RateDetail.cs create mode 100644 ShipEngineSDK/Model/RateDetailAttributes.cs create mode 100644 ShipEngineSDK/Model/RateDetailType.cs create mode 100644 ShipEngineSDK/Model/StatusDetailCode.cs create mode 100644 ShipEngineSDK/Model/TaxType.cs diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 64f9fdbc..4a283927 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -36,6 +36,7 @@ ShipEngineSDK/Model/AddressValidationStatus.cs ShipEngineSDK/Model/AdvancedShipmentOptions.cs ShipEngineSDK/Model/AdvancedShipmentOptionsDangerousGoodsContact.cs ShipEngineSDK/Model/AdvancedShipmentOptionsFedexFreight.cs +ShipEngineSDK/Model/AdvancedShipmentOptionsWindsorFrameworkDetails.cs ShipEngineSDK/Model/AllowedIncoterms.cs ShipEngineSDK/Model/AlternativeIdentifier.cs ShipEngineSDK/Model/AlternativeIdentifiers.cs @@ -163,6 +164,7 @@ ShipEngineSDK/Model/GetServicePointsRequestBody.cs ShipEngineSDK/Model/GetServicePointsRequestBodyAddress.cs ShipEngineSDK/Model/GetServicePointsRequestBodyProvidersInner.cs ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs +ShipEngineSDK/Model/GetServicePointsRequestBodyShipmentPackagesInner.cs ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs @@ -243,6 +245,9 @@ ShipEngineSDK/Model/ProcessBatchRequestBody.cs ShipEngineSDK/Model/Products.cs ShipEngineSDK/Model/PurchaseLabelWithoutShipment.cs ShipEngineSDK/Model/Rate.cs +ShipEngineSDK/Model/RateDetail.cs +ShipEngineSDK/Model/RateDetailAttributes.cs +ShipEngineSDK/Model/RateDetailType.cs ShipEngineSDK/Model/RateEstimate.cs ShipEngineSDK/Model/RateEstimateByCarrierId.cs ShipEngineSDK/Model/RateEstimateByCarrierIds.cs @@ -276,9 +281,11 @@ ShipEngineSDK/Model/ShippingAddressTo.cs ShipEngineSDK/Model/SmartPostHub.cs ShipEngineSDK/Model/SortDir.cs ShipEngineSDK/Model/StatusCode.cs +ShipEngineSDK/Model/StatusDetailCode.cs ShipEngineSDK/Model/Tag.cs ShipEngineSDK/Model/TagShipmentResponseBody.cs ShipEngineSDK/Model/TaxIdentifier.cs +ShipEngineSDK/Model/TaxType.cs ShipEngineSDK/Model/TaxableEntityType.cs ShipEngineSDK/Model/TokensGetEphemeralTokenResponseBodyYaml.cs ShipEngineSDK/Model/TrackEvent.cs diff --git a/CHANGELOG.md b/CHANGELOG.md index 1e2a5592..b130026c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -219,3 +219,9 @@ Fixed handling of No Content responses This will allow consumers to modify a single request without affecting any other consumers of the client. It also allows for multiple modifiers to be added. For example, a modifier could be added at the global level that applies to all requests and then another modifier can be added for a single request. + +## 3.0.0-beta.12 + +## Changed + +- Updated to ShipEngine API 1.1.202409060709 diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptions.cs b/ShipEngineSDK/Model/AdvancedShipmentOptions.cs index 8738058d..e6e2e7e3 100644 --- a/ShipEngineSDK/Model/AdvancedShipmentOptions.cs +++ b/ShipEngineSDK/Model/AdvancedShipmentOptions.cs @@ -188,6 +188,12 @@ public partial class AdvancedShipmentOptions [JsonPropertyName("use_ups_ground_freight_pricing"), JsonPropertyOrder(23)] public bool? UseUpsGroundFreightPricing { get; set; } + /// + /// Gets or Sets WindsorFrameworkDetails + /// + [JsonPropertyName("windsor_framework_details"), JsonPropertyOrder(24)] + public AdvancedShipmentOptionsWindsorFrameworkDetails? WindsorFrameworkDetails { get; set; } + /// /// Returns the string presentation of the object @@ -221,6 +227,7 @@ public override string ToString() sb.Append(" ShipperRelease: ").Append(ShipperRelease).Append("\n"); sb.Append(" ThirdPartyConsignee: ").Append(ThirdPartyConsignee).Append("\n"); sb.Append(" UseUpsGroundFreightPricing: ").Append(UseUpsGroundFreightPricing).Append("\n"); + sb.Append(" WindsorFrameworkDetails: ").Append(WindsorFrameworkDetails).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptionsWindsorFrameworkDetails.cs b/ShipEngineSDK/Model/AdvancedShipmentOptionsWindsorFrameworkDetails.cs new file mode 100644 index 00000000..a996440d --- /dev/null +++ b/ShipEngineSDK/Model/AdvancedShipmentOptionsWindsorFrameworkDetails.cs @@ -0,0 +1,141 @@ +// +// 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; + +/// +/// The Windsor framework is a new regulation in the UK that simplifies customs procedures for goods moved from the UK mainland to Northern Ireland. +/// +public partial class AdvancedShipmentOptionsWindsorFrameworkDetails +{ + /// + /// An indicator that will tell the carrier and HMRC the type of movement for the shipment. + /// + /// An indicator that will tell the carrier and HMRC the type of movement for the shipment. + [JsonConverter(typeof(MovementIndicatorEnumJsonConverter))] + public class MovementIndicatorEnum + { + private readonly string _value; + + /// + /// Create a new instance of MovementIndicatorEnum with a predefined value. + /// + internal MovementIndicatorEnum() + { + _value = "c2c"; + } + + /// + /// Create a new instance of MovementIndicatorEnum with a custom value. + /// + /// The value of the MovementIndicatorEnum + /// + /// 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 MovementIndicatorEnum(string value) + { + _value = value; + } + + /// + /// Enum C2c for value: c2c + /// + public static MovementIndicatorEnum C2c { get; } = new("c2c"); + + + /// + /// Enum B2c for value: b2c + /// + public static MovementIndicatorEnum B2c { get; } = new("b2c"); + + + /// + /// Enum C2b for value: c2b + /// + public static MovementIndicatorEnum C2b { get; } = new("c2b"); + + + /// + /// Enum B2b for value: b2b + /// + public static MovementIndicatorEnum B2b { get; } = new("b2b"); + + + /// + /// Get a string representation of the current value + /// + public override string ToString() => _value; + } + + internal class MovementIndicatorEnumJsonConverter : JsonConverter + { + public override MovementIndicatorEnum? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new MovementIndicatorEnum(reader.GetString()!) : null; + + public override void Write(Utf8JsonWriter writer, MovementIndicatorEnum value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(MovementIndicatorEnum); + } + + + /// + /// An indicator that will tell the carrier and HMRC the type of movement for the shipment. + /// + /// An indicator that will tell the carrier and HMRC the type of movement for the shipment. + [JsonPropertyName("movement_indicator"), JsonPropertyOrder(1)] + public MovementIndicatorEnum? MovementIndicator { get; set; } + + /// + /// An indicator that allows a shipper to declare the shipment as not-at-risk. + /// + /// An indicator that allows a shipper to declare the shipment as not-at-risk. + [JsonPropertyName("not_at_risk"), JsonPropertyOrder(2)] + public bool? NotAtRisk { 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 AdvancedShipmentOptionsWindsorFrameworkDetails {\n"); +#pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" MovementIndicator: ").Append(MovementIndicator).Append("\n"); + sb.Append(" NotAtRisk: ").Append(NotAtRisk).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/ConnectAsendiaRequestBody.cs b/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs index bdad81c1..c991fa3c 100644 --- a/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectAsendiaRequestBody.cs @@ -34,18 +34,11 @@ public partial class ConnectAsendiaRequestBody public required string AccountNumber { get; set; } /// - /// FTP password + /// Asendia api_key /// - /// FTP password - [JsonPropertyName("ftp_password"), JsonPropertyOrder(2)] - public required string FtpPassword { get; set; } - - /// - /// FTP username - /// - /// FTP username - [JsonPropertyName("ftp_username"), JsonPropertyOrder(3)] - public required string FtpUsername { get; set; } + /// Asendia api_key + [JsonPropertyName("api_key"), JsonPropertyOrder(2)] + public required string ApiKey { get; set; } /// /// The nickname of the Asendia account @@ -54,9 +47,37 @@ public partial class ConnectAsendiaRequestBody /// /// Asendia account /// - [JsonPropertyName("nickname"), JsonPropertyOrder(4)] + [JsonPropertyName("nickname"), JsonPropertyOrder(3)] public required string Nickname { get; set; } + /// + /// Asendia password + /// + /// Asendia password + [JsonPropertyName("password"), JsonPropertyOrder(4)] + public required string Password { get; set; } + + /// + /// Asendia processing location, one of: 'MIA', 'JFK', 'ORD', 'PHL', 'SFO', 'LAX', 'SLC', 'TOR', 'BUF', 'CAL' + /// + /// Asendia processing location, one of: 'MIA', 'JFK', 'ORD', 'PHL', 'SFO', 'LAX', 'SLC', 'TOR', 'BUF', 'CAL' + [JsonPropertyName("processing_location"), JsonPropertyOrder(5)] + public required string ProcessingLocation { get; set; } + + /// + /// Asendia username + /// + /// Asendia username + [JsonPropertyName("username"), JsonPropertyOrder(6)] + public required string Username { get; set; } + + /// + /// Asendia sub account number + /// + /// Asendia sub account number + [JsonPropertyName("sub_account_number"), JsonPropertyOrder(7)] + public string? SubAccountNumber { get; set; } + /// /// Returns the string presentation of the object @@ -68,9 +89,12 @@ public override string ToString() sb.Append("class ConnectAsendiaRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); - sb.Append(" FtpPassword: ").Append(FtpPassword).Append("\n"); - sb.Append(" FtpUsername: ").Append(FtpUsername).Append("\n"); + sb.Append(" ApiKey: ").Append(ApiKey).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); + sb.Append(" Password: ").Append(Password).Append("\n"); + sb.Append(" ProcessingLocation: ").Append(ProcessingLocation).Append("\n"); + sb.Append(" Username: ").Append(Username).Append("\n"); + sb.Append(" SubAccountNumber: ").Append(SubAccountNumber).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs b/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs index bd245a71..0adc92ae 100644 --- a/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectCarrierRequestBody.cs @@ -780,7 +780,7 @@ public override string ToJson() public class ConnectCarrierRequestBodyJsonConverter : JsonConverter { private static readonly HashSet OneOfTypes = [typeof(ConnectAccessWorldwideRequestBody), typeof(ConnectAmazonBuyShippingRequestBody), typeof(ConnectAmazonShippingUk), typeof(ConnectApcRequestBody), typeof(ConnectAsendiaRequestBody), typeof(ConnectAustraliaPostRequestBody), typeof(ConnectCanadaPostRequestBody), typeof(ConnectDhlEcommerceRequestBody), typeof(ConnectDhlExpressRequestBody), typeof(ConnectDhlExpressAuRequestBody), typeof(ConnectDhlExpressCaRequestBody), typeof(ConnectDhlExpressUkRequestBody), typeof(ConnectDpdRequestBody), typeof(ConnectEndiciaRequestBody), typeof(ConnectFedexRequestBody), typeof(ConnectFedexUkRequestBody), typeof(ConnectFirstmileRequestBody), typeof(ConnectImexRequestBody), typeof(ConnectLasershipRequestBody), typeof(ConnectNewgisticsRequestBody), typeof(ConnectOntracRequestBody), typeof(ConnectPurolatorRequestBody), typeof(ConnectRoyalMailRequestBody), typeof(ConnectRrDonnelleyRequestBody), typeof(ConnectSekoRequestBody), typeof(ConnectSendleRequestBody), typeof(ConnectStampsRequestBody), typeof(ConnectUpsRequestBody)]; - private static readonly HashSet MandatoryFields = ["AccessKey", "Account", "AccountNumber", "ActivationKey", "Address", "Address1", "AgreeToEula", "ApiKey", "ApiSecret", "AuthCode", "City", "ClientId", "ContactName", "ContractId", "CountryCode", "CustomerBranch", "DistributionCenter", "Email", "FirstName", "FtpPassword", "FtpUsername", "InductionSite", "LasershipCriticalEntryTime", "LasershipCriticalPullTime", "LastName", "MailerId", "MerchantSellerId", "MwsAuthToken", "Nickname", "Passphrase", "Password", "Phone", "PickupNumber", "PostalCode", "SendleId", "SiteId", "State", "Username", "WebServicesId", "WebServicesKey"]; + private static readonly HashSet MandatoryFields = ["AccessKey", "Account", "AccountCountryCode", "AccountNumber", "AccountPostalCode", "ActivationKey", "Address", "Address1", "AgreeToEula", "ApiKey", "ApiSecret", "AuthCode", "City", "ClientId", "ContactName", "ContractId", "CountryCode", "CustomerBranch", "DistributionCenter", "Email", "FirstName", "InductionSite", "LasershipCriticalEntryTime", "LasershipCriticalPullTime", "LastName", "MailerId", "MerchantSellerId", "MwsAuthToken", "Nickname", "Passphrase", "Password", "Phone", "PickupNumber", "PostalCode", "ProcessingLocation", "SendleId", "SiteId", "State", "Username", "WebServicesId", "WebServicesKey"]; private static readonly JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) { TypeInfoResolver = new DefaultJsonTypeInfoResolver diff --git a/ShipEngineSDK/Model/ConnectUpsRequestBody.cs b/ShipEngineSDK/Model/ConnectUpsRequestBody.cs index 759ceb70..a7f69380 100644 --- a/ShipEngineSDK/Model/ConnectUpsRequestBody.cs +++ b/ShipEngineSDK/Model/ConnectUpsRequestBody.cs @@ -26,18 +26,32 @@ namespace ShipEngineSDK.Model; public partial class ConnectUpsRequestBody { + /// + /// Account Country Code + /// + /// Account Country Code + [JsonPropertyName("account_country_code"), JsonPropertyOrder(1)] + public required string AccountCountryCode { get; set; } + /// /// Account number /// /// Account number - [JsonPropertyName("account_number"), JsonPropertyOrder(1)] + [JsonPropertyName("account_number"), JsonPropertyOrder(2)] public required string AccountNumber { get; set; } + /// + /// Account Postal Code + /// + /// Account Postal Code + [JsonPropertyName("account_postal_code"), JsonPropertyOrder(3)] + public required string AccountPostalCode { get; set; } + /// /// Nickname /// /// Nickname - [JsonPropertyName("nickname"), JsonPropertyOrder(2)] + [JsonPropertyName("nickname"), JsonPropertyOrder(4)] public required string Nickname { get; set; } @@ -50,7 +64,9 @@ public override string ToString() var sb = new StringBuilder(); sb.Append("class ConnectUpsRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" AccountCountryCode: ").Append(AccountCountryCode).Append("\n"); sb.Append(" AccountNumber: ").Append(AccountNumber).Append("\n"); + sb.Append(" AccountPostalCode: ").Append(AccountPostalCode).Append("\n"); sb.Append(" Nickname: ").Append(Nickname).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs index 3695fd74..aa3bf100 100644 --- a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs @@ -244,6 +244,16 @@ public partial class CreateLabelFromRateResponseBody [JsonPropertyName("paperless_download"), JsonInclude] public PaperlessDownload? PaperlessDownload { get; set; } + /// + /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. + /// + /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("rate_details"), JsonInclude] + public List? RateDetails { get; set; } + /// /// The total shipping cost for the specified comparison_rate_type. /// @@ -258,7 +268,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(24)] + [JsonPropertyName("rma_number"), JsonPropertyOrder(25)] public string? RmaNumber { get; set; } /// @@ -291,7 +301,7 @@ public partial class CreateLabelFromRateResponseBody /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(27), JsonWriteOnly] + [JsonPropertyName("shipment"), JsonPropertyOrder(28), JsonWriteOnly] public Shipment? Shipment { get; set; } /// @@ -330,7 +340,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(31), JsonWriteOnly, Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(32), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -382,7 +392,7 @@ public partial class CreateLabelFromRateResponseBody /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(36), JsonWriteOnly] + [JsonPropertyName("validate_address"), JsonPropertyOrder(37), JsonWriteOnly] public ValidateAddress? ValidateAddress { get; set; } /// @@ -440,6 +450,7 @@ public override string ToString() sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" RateDetails: ").Append(RateDetails).Append("\n"); sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs index 9b73cd0f..b43bf953 100644 --- a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs @@ -244,6 +244,16 @@ public partial class CreateLabelFromShipmentResponseBody [JsonPropertyName("paperless_download"), JsonInclude] public PaperlessDownload? PaperlessDownload { get; set; } + /// + /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. + /// + /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("rate_details"), JsonInclude] + public List? RateDetails { get; set; } + /// /// The total shipping cost for the specified comparison_rate_type. /// @@ -258,7 +268,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(24)] + [JsonPropertyName("rma_number"), JsonPropertyOrder(25)] public string? RmaNumber { get; set; } /// @@ -291,7 +301,7 @@ public partial class CreateLabelFromShipmentResponseBody /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(27), JsonWriteOnly] + [JsonPropertyName("shipment"), JsonPropertyOrder(28), JsonWriteOnly] public Shipment? Shipment { get; set; } /// @@ -330,7 +340,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(31), JsonWriteOnly, Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(32), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -382,7 +392,7 @@ public partial class CreateLabelFromShipmentResponseBody /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(36), JsonWriteOnly] + [JsonPropertyName("validate_address"), JsonPropertyOrder(37), JsonWriteOnly] public ValidateAddress? ValidateAddress { get; set; } /// @@ -440,6 +450,7 @@ public override string ToString() sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" RateDetails: ").Append(RateDetails).Append("\n"); sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateLabelRequestBody.cs b/ShipEngineSDK/Model/CreateLabelRequestBody.cs index c374c517..e9309ee1 100644 --- a/ShipEngineSDK/Model/CreateLabelRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelRequestBody.cs @@ -251,6 +251,16 @@ public partial class CreateLabelRequestBody [JsonPropertyName("paperless_download"), JsonInclude] public PaperlessDownload? PaperlessDownload { get; set; } + /// + /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. + /// + /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("rate_details"), JsonInclude] + public List? RateDetails { get; set; } + /// /// The total shipping cost for the specified comparison_rate_type. /// @@ -265,7 +275,7 @@ public partial class CreateLabelRequestBody /// 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 CreateLabelRequestBody /// /// 614940 /// - [JsonPropertyName("ship_from_service_point_id"), JsonPropertyOrder(28)] + [JsonPropertyName("ship_from_service_point_id"), JsonPropertyOrder(29)] public string? ShipFromServicePointId { get; set; } /// @@ -311,7 +321,7 @@ public partial class CreateLabelRequestBody /// /// 614940 /// - [JsonPropertyName("ship_to_service_point_id"), JsonPropertyOrder(29)] + [JsonPropertyName("ship_to_service_point_id"), JsonPropertyOrder(30)] public string? ShipToServicePointId { get; set; } /// @@ -350,7 +360,7 @@ public partial class CreateLabelRequestBody /// 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(33), JsonWriteOnly, Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(34), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -402,7 +412,7 @@ public partial class CreateLabelRequestBody /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(38), JsonWriteOnly] + [JsonPropertyName("validate_address"), JsonPropertyOrder(39), JsonWriteOnly] public ValidateAddress? ValidateAddress { get; set; } /// @@ -461,6 +471,7 @@ public override string ToString() sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" RateDetails: ").Append(RateDetails).Append("\n"); sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateLabelResponseBody.cs b/ShipEngineSDK/Model/CreateLabelResponseBody.cs index 6668fae3..8d549c38 100644 --- a/ShipEngineSDK/Model/CreateLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelResponseBody.cs @@ -345,6 +345,16 @@ public partial class CreateLabelResponseBody [JsonPropertyName("paperless_download"), JsonInclude] public PaperlessDownload? PaperlessDownload { get; set; } + /// + /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. + /// + /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("rate_details"), JsonInclude] + public List? RateDetails { get; set; } + /// /// The total shipping cost for the specified comparison_rate_type. /// @@ -359,21 +369,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(33)] + [JsonPropertyName("rma_number"), JsonPropertyOrder(34)] 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(34), JsonWriteOnly] + [JsonPropertyName("shipment"), JsonPropertyOrder(35), 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(35), JsonWriteOnly, Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(36), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -392,7 +402,7 @@ public partial class CreateLabelResponseBody /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(37), JsonWriteOnly] + [JsonPropertyName("validate_address"), JsonPropertyOrder(38), JsonWriteOnly] public ValidateAddress? ValidateAddress { get; set; } /// @@ -449,6 +459,7 @@ public override string ToString() sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); sb.Append(" OutboundLabelId: ").Append(OutboundLabelId).Append("\n"); sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" RateDetails: ").Append(RateDetails).Append("\n"); sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); sb.Append(" Shipment: ").Append(Shipment).Append("\n"); diff --git a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs index a50e9ce1..ed23526b 100644 --- a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs @@ -244,6 +244,16 @@ public partial class CreateReturnLabelResponseBody [JsonPropertyName("paperless_download"), JsonInclude] public PaperlessDownload? PaperlessDownload { get; set; } + /// + /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. + /// + /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("rate_details"), JsonInclude] + public List? RateDetails { get; set; } + /// /// The total shipping cost for the specified comparison_rate_type. /// @@ -258,7 +268,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(24)] + [JsonPropertyName("rma_number"), JsonPropertyOrder(25)] public string? RmaNumber { get; set; } /// @@ -291,7 +301,7 @@ public partial class CreateReturnLabelResponseBody /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(27), JsonWriteOnly] + [JsonPropertyName("shipment"), JsonPropertyOrder(28), JsonWriteOnly] public Shipment? Shipment { get; set; } /// @@ -330,7 +340,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(31), JsonWriteOnly, Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(32), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -382,7 +392,7 @@ public partial class CreateReturnLabelResponseBody /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(36), JsonWriteOnly] + [JsonPropertyName("validate_address"), JsonPropertyOrder(37), JsonWriteOnly] public ValidateAddress? ValidateAddress { get; set; } /// @@ -440,6 +450,7 @@ public override string ToString() sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" RateDetails: ").Append(RateDetails).Append("\n"); sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); diff --git a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs index 4bafd7e7..2256b28a 100644 --- a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs @@ -244,6 +244,16 @@ public partial class GetLabelByExternalShipmentIdResponseBody [JsonPropertyName("paperless_download"), JsonInclude] public PaperlessDownload? PaperlessDownload { get; set; } + /// + /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. + /// + /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("rate_details"), JsonInclude] + public List? RateDetails { get; set; } + /// /// The total shipping cost for the specified comparison_rate_type. /// @@ -258,7 +268,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(24)] + [JsonPropertyName("rma_number"), JsonPropertyOrder(25)] public string? RmaNumber { get; set; } /// @@ -291,7 +301,7 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(27), JsonWriteOnly] + [JsonPropertyName("shipment"), JsonPropertyOrder(28), JsonWriteOnly] public Shipment? Shipment { get; set; } /// @@ -330,7 +340,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(31), JsonWriteOnly, Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(32), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -382,7 +392,7 @@ public partial class GetLabelByExternalShipmentIdResponseBody /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(36), JsonWriteOnly] + [JsonPropertyName("validate_address"), JsonPropertyOrder(37), JsonWriteOnly] public ValidateAddress? ValidateAddress { get; set; } /// @@ -440,6 +450,7 @@ public override string ToString() sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" RateDetails: ").Append(RateDetails).Append("\n"); sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); diff --git a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs index 18c663b4..e6669317 100644 --- a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs @@ -244,6 +244,16 @@ public partial class GetLabelByIdResponseBody [JsonPropertyName("paperless_download"), JsonInclude] public PaperlessDownload? PaperlessDownload { get; set; } + /// + /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. + /// + /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("rate_details"), JsonInclude] + public List? RateDetails { get; set; } + /// /// The total shipping cost for the specified comparison_rate_type. /// @@ -258,7 +268,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(24)] + [JsonPropertyName("rma_number"), JsonPropertyOrder(25)] public string? RmaNumber { get; set; } /// @@ -291,7 +301,7 @@ public partial class GetLabelByIdResponseBody /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(27), JsonWriteOnly] + [JsonPropertyName("shipment"), JsonPropertyOrder(28), JsonWriteOnly] public Shipment? Shipment { get; set; } /// @@ -330,7 +340,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(31), JsonWriteOnly, Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(32), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -382,7 +392,7 @@ public partial class GetLabelByIdResponseBody /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(36), JsonWriteOnly] + [JsonPropertyName("validate_address"), JsonPropertyOrder(37), JsonWriteOnly] public ValidateAddress? ValidateAddress { get; set; } /// @@ -440,6 +450,7 @@ public override string ToString() sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" RateDetails: ").Append(RateDetails).Append("\n"); sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); diff --git a/ShipEngineSDK/Model/GetRateByIdResponseBody.cs b/ShipEngineSDK/Model/GetRateByIdResponseBody.cs index 0585325e..396209c5 100644 --- a/ShipEngineSDK/Model/GetRateByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetRateByIdResponseBody.cs @@ -259,6 +259,16 @@ public partial class GetRateByIdResponseBody [JsonPropertyName("package_type"), JsonInclude] public string? PackageType { get; set; } + /// + /// A list of rate details that are associated with this rate. This is useful for displaying a breakdown of the rate to the user. + /// + /// A list of rate details that are associated with this rate. This is useful for displaying a breakdown of the rate to the user. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("rate_details"), JsonInclude] + public List? RateDetails { get; set; } + /// /// The total shipping cost for the specified comparison_rate_type. /// @@ -334,6 +344,7 @@ public override string ToString() sb.Append(" DeliveryDays: ").Append(DeliveryDays).Append("\n"); sb.Append(" EstimatedDeliveryDate: ").Append(EstimatedDeliveryDate).Append("\n"); sb.Append(" PackageType: ").Append(PackageType).Append("\n"); + sb.Append(" RateDetails: ").Append(RateDetails).Append("\n"); sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); sb.Append(" TaxAmount: ").Append(TaxAmount).Append("\n"); diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs index 6a071e0f..2736c47c 100644 --- a/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyShipment.cs @@ -26,11 +26,18 @@ namespace ShipEngineSDK.Model; public partial class GetServicePointsRequestBodyShipment { + /// + /// An array of package dimensions + /// + /// An array of package dimensions + [JsonPropertyName("packages"), JsonPropertyOrder(1)] + public List? Packages { get; set; } + /// /// Shipment total weight /// /// Shipment total weight - [JsonPropertyName("total_weight"), JsonPropertyOrder(1)] + [JsonPropertyName("total_weight"), JsonPropertyOrder(2)] public Weight? TotalWeight { get; set; } @@ -43,6 +50,7 @@ public override string ToString() var sb = new StringBuilder(); sb.Append("class GetServicePointsRequestBodyShipment {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" TotalWeight: ").Append(TotalWeight).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/GetServicePointsRequestBodyShipmentPackagesInner.cs b/ShipEngineSDK/Model/GetServicePointsRequestBodyShipmentPackagesInner.cs new file mode 100644 index 00000000..f3461eca --- /dev/null +++ b/ShipEngineSDK/Model/GetServicePointsRequestBodyShipmentPackagesInner.cs @@ -0,0 +1,61 @@ +// +// 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; + +/// +/// GetServicePointsRequestBodyShipmentPackagesInner +/// +public partial class GetServicePointsRequestBodyShipmentPackagesInner +{ + + /// + /// The package dimensions + /// + /// The package dimensions + [JsonPropertyName("dimensions"), JsonPropertyOrder(1)] + public Dimensions? Dimensions { 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 GetServicePointsRequestBodyShipmentPackagesInner {\n"); +#pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" Dimensions: ").Append(Dimensions).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/GetTrackingLogFromLabelResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs index aa96c375..6db25932 100644 --- a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs @@ -164,6 +164,25 @@ public partial class GetTrackingLogFromLabelResponseBody [JsonPropertyName("status_description"), JsonInclude] public string? StatusDescription { get; set; } + /// + /// Gets or Sets StatusDetailCode + /// + [JsonPropertyName("status_detail_code"), JsonPropertyOrder(14)] + public StatusDetailCode? StatusDetailCode { get; set; } + + /// + /// Status detail description + /// + /// Status detail description + /// + /// This should not be used for input as it will be ignored on serialization. + /// + /// + /// Your shipment has been delivered. + /// + [JsonPropertyName("status_detail_description"), JsonInclude] + public string? StatusDetailDescription { get; set; } + /// /// Carrier Tracking Url, if available /// @@ -200,6 +219,8 @@ public override string ToString() sb.Append(" ExceptionDescription: ").Append(ExceptionDescription).Append("\n"); sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); sb.Append(" StatusDescription: ").Append(StatusDescription).Append("\n"); + sb.Append(" StatusDetailCode: ").Append(StatusDetailCode).Append("\n"); + sb.Append(" StatusDetailDescription: ").Append(StatusDetailDescription).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); diff --git a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs index c0c839ff..608e77d2 100644 --- a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs @@ -177,6 +177,25 @@ public partial class GetTrackingLogResponseBody [JsonPropertyName("status_description"), JsonInclude] public string? StatusDescription { get; set; } + /// + /// Gets or Sets StatusDetailCode + /// + [JsonPropertyName("status_detail_code"), JsonPropertyOrder(15)] + public StatusDetailCode? StatusDetailCode { get; set; } + + /// + /// Status detail description + /// + /// Status detail description + /// + /// This should not be used for input as it will be ignored on serialization. + /// + /// + /// Your shipment has been delivered. + /// + [JsonPropertyName("status_detail_description"), JsonInclude] + public string? StatusDetailDescription { get; set; } + /// /// Returns the string presentation of the object @@ -201,6 +220,8 @@ public override string ToString() sb.Append(" ExceptionDescription: ").Append(ExceptionDescription).Append("\n"); sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); sb.Append(" StatusDescription: ").Append(StatusDescription).Append("\n"); + sb.Append(" StatusDetailCode: ").Append(StatusDetailCode).Append("\n"); + sb.Append(" StatusDetailDescription: ").Append(StatusDetailDescription).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/IdentifierType.cs b/ShipEngineSDK/Model/IdentifierType.cs index d8fa9643..936f95c6 100644 --- a/ShipEngineSDK/Model/IdentifierType.cs +++ b/ShipEngineSDK/Model/IdentifierType.cs @@ -21,9 +21,9 @@ namespace ShipEngineSDK.Model; /// -/// Tax identifier type for customs declaration |Pickup Type | Description |- -- -- -- -- -- -- --|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`vat` | The tax identifier is a Value Added Tax. |`eori` | The tax identifier is an Economic Operators Registration and Identification Number (EORI). |`ssn` | The tax identifier is a Social Security Number. |`ein` | The tax identifier is an Employer Identification Number (EIN). |`tin` | The tax identifier is a Tax Identification Number (TIN). |`ioss` | The tax identifier is an Import One-Stop Shop (IOSS). |`pan` | The tax identifier is a Permanent Account Number (PAN). |`voec` | The tax identifier is a Norwegian VAT On E-Commerce(VOEC). |`pccc` | The tax identifier is a Personal Customs Clearance Code (PCCC). |`oss` | The tax identifier is an One-Stop Shop (OSS). |`passport` | The tax identifier is a Passport Number. |`abn` | The tax identifier is an Australian Business Number. +/// Tax identifier type for customs declaration |Pickup Type | Description |- -- -- -- -- -- -- --|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`vat` | The tax identifier is a Value Added Tax. |`eori` | The tax identifier is an Economic Operators Registration and Identification Number (EORI). |`ssn` | The tax identifier is a Social Security Number. |`ein` | The tax identifier is an Employer Identification Number (EIN). |`tin` | The tax identifier is a Tax Identification Number (TIN). |`ioss` | The tax identifier is an Import One-Stop Shop (IOSS). |`pan` | The tax identifier is a Permanent Account Number (PAN). |`voec` | The tax identifier is a Norwegian VAT On E-Commerce(VOEC). |`pccc` | The tax identifier is a Personal Customs Clearance Code (PCCC). |`oss` | The tax identifier is an One-Stop Shop (OSS). |`passport` | The tax identifier is a Passport Number. |`abn` | The tax identifier is an Australian Business Number. |`ukims` | The tax identifier is an UK Internal Market Scheme number. /// -/// Tax identifier type for customs declaration |Pickup Type | Description |- -- -- -- -- -- -- --|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`vat` | The tax identifier is a Value Added Tax. |`eori` | The tax identifier is an Economic Operators Registration and Identification Number (EORI). |`ssn` | The tax identifier is a Social Security Number. |`ein` | The tax identifier is an Employer Identification Number (EIN). |`tin` | The tax identifier is a Tax Identification Number (TIN). |`ioss` | The tax identifier is an Import One-Stop Shop (IOSS). |`pan` | The tax identifier is a Permanent Account Number (PAN). |`voec` | The tax identifier is a Norwegian VAT On E-Commerce(VOEC). |`pccc` | The tax identifier is a Personal Customs Clearance Code (PCCC). |`oss` | The tax identifier is an One-Stop Shop (OSS). |`passport` | The tax identifier is a Passport Number. |`abn` | The tax identifier is an Australian Business Number. +/// Tax identifier type for customs declaration |Pickup Type | Description |- -- -- -- -- -- -- --|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`vat` | The tax identifier is a Value Added Tax. |`eori` | The tax identifier is an Economic Operators Registration and Identification Number (EORI). |`ssn` | The tax identifier is a Social Security Number. |`ein` | The tax identifier is an Employer Identification Number (EIN). |`tin` | The tax identifier is a Tax Identification Number (TIN). |`ioss` | The tax identifier is an Import One-Stop Shop (IOSS). |`pan` | The tax identifier is a Permanent Account Number (PAN). |`voec` | The tax identifier is a Norwegian VAT On E-Commerce(VOEC). |`pccc` | The tax identifier is a Personal Customs Clearance Code (PCCC). |`oss` | The tax identifier is an One-Stop Shop (OSS). |`passport` | The tax identifier is a Passport Number. |`abn` | The tax identifier is an Australian Business Number. |`ukims` | The tax identifier is an UK Internal Market Scheme number. [JsonConverter(typeof(IdentifierTypeJsonConverter))] public class IdentifierType { @@ -122,6 +122,12 @@ public IdentifierType(string value) public static IdentifierType Abn { get; } = new("abn"); + /// + /// Enum Ukims for value: ukims + /// + public static IdentifierType Ukims { get; } = new("ukims"); + + /// /// Get a string representation of the current value /// diff --git a/ShipEngineSDK/Model/Label.cs b/ShipEngineSDK/Model/Label.cs index c0e07725..6f613d5c 100644 --- a/ShipEngineSDK/Model/Label.cs +++ b/ShipEngineSDK/Model/Label.cs @@ -244,6 +244,16 @@ public partial class Label [JsonPropertyName("paperless_download"), JsonInclude] public PaperlessDownload? PaperlessDownload { get; set; } + /// + /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. + /// + /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("rate_details"), JsonInclude] + public List? RateDetails { get; set; } + /// /// The total shipping cost for the specified comparison_rate_type. /// @@ -258,7 +268,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(24)] + [JsonPropertyName("rma_number"), JsonPropertyOrder(25)] public string? RmaNumber { get; set; } /// @@ -291,7 +301,7 @@ public partial class Label /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(27), JsonWriteOnly] + [JsonPropertyName("shipment"), JsonPropertyOrder(28), JsonWriteOnly] public Shipment? Shipment { get; set; } /// @@ -330,7 +340,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(31), JsonWriteOnly, Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(32), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -382,7 +392,7 @@ public partial class Label /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(36), JsonWriteOnly] + [JsonPropertyName("validate_address"), JsonPropertyOrder(37), JsonWriteOnly] public ValidateAddress? ValidateAddress { get; set; } /// @@ -440,6 +450,7 @@ public override string ToString() sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); sb.Append(" Packages: ").Append(Packages).Append("\n"); sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); + sb.Append(" RateDetails: ").Append(RateDetails).Append("\n"); sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); diff --git a/ShipEngineSDK/Model/ListLabelsResponseBody.cs b/ShipEngineSDK/Model/ListLabelsResponseBody.cs index 95494c10..d19a275c 100644 --- a/ShipEngineSDK/Model/ListLabelsResponseBody.cs +++ b/ShipEngineSDK/Model/ListLabelsResponseBody.cs @@ -105,6 +105,13 @@ public class ListLabelsResponseBodyItem [JsonPropertyName("requested_comparison_amount"), JsonInclude] public MonetaryValue? RequestedComparisonAmount { get; set; } + /// + /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. + /// + /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. + [JsonPropertyName("rate_details"), JsonInclude] + public List? RateDetails { get; set; } + /// /// The tracking number for the package. Tracking number formats vary across carriers. /// @@ -119,14 +126,14 @@ public class ListLabelsResponseBodyItem /// 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(11)] + [JsonPropertyName("is_return_label"), JsonPropertyOrder(12)] public bool? IsReturnLabel { get; set; } /// /// 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(12)] + [JsonPropertyName("rma_number"), JsonPropertyOrder(13)] public string? RmaNumber { get; set; } /// @@ -160,7 +167,7 @@ public class ListLabelsResponseBodyItem /// The label charge event. /// /// The label charge event. - [JsonPropertyName("charge_event"), JsonPropertyOrder(16)] + [JsonPropertyName("charge_event"), JsonPropertyOrder(17)] public LabelChargeEvent? ChargeEvent { get; set; } /// @@ -170,7 +177,7 @@ public class ListLabelsResponseBodyItem /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(17), JsonWriteOnly] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(18), JsonWriteOnly] public string? OutboundLabelId { get; set; } /// @@ -187,7 +194,7 @@ public class ListLabelsResponseBodyItem /// 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(19), JsonWriteOnly, Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(20), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } /// @@ -203,7 +210,7 @@ public class ListLabelsResponseBodyItem /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(21), JsonWriteOnly] + [JsonPropertyName("validate_address"), JsonPropertyOrder(22), JsonWriteOnly] public ValidateAddress? ValidateAddress { get; set; } /// @@ -226,28 +233,28 @@ public class ListLabelsResponseBodyItem /// /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(24), JsonWriteOnly] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(25), 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(25)] + [JsonPropertyName("label_format"), JsonPropertyOrder(26)] public LabelFormat? LabelFormat { get; set; } /// /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme"), JsonPropertyOrder(26)] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(27)] public DisplayScheme? DisplayScheme { 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(27)] + [JsonPropertyName("label_layout"), JsonPropertyOrder(28)] public LabelLayout? LabelLayout { get; set; } /// @@ -264,7 +271,7 @@ public class ListLabelsResponseBodyItem /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id"), JsonPropertyOrder(29)] + [JsonPropertyName("label_image_id"), JsonPropertyOrder(30)] public string? LabelImageId { get; set; } /// diff --git a/ShipEngineSDK/Model/Rate.cs b/ShipEngineSDK/Model/Rate.cs index 6e221d3d..08804abb 100644 --- a/ShipEngineSDK/Model/Rate.cs +++ b/ShipEngineSDK/Model/Rate.cs @@ -259,6 +259,16 @@ public partial class Rate [JsonPropertyName("package_type"), JsonInclude] public string? PackageType { get; set; } + /// + /// A list of rate details that are associated with this rate. This is useful for displaying a breakdown of the rate to the user. + /// + /// A list of rate details that are associated with this rate. This is useful for displaying a breakdown of the rate to the user. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + [JsonPropertyName("rate_details"), JsonInclude] + public List? RateDetails { get; set; } + /// /// The total shipping cost for the specified comparison_rate_type. /// @@ -334,6 +344,7 @@ public override string ToString() sb.Append(" DeliveryDays: ").Append(DeliveryDays).Append("\n"); sb.Append(" EstimatedDeliveryDate: ").Append(EstimatedDeliveryDate).Append("\n"); sb.Append(" PackageType: ").Append(PackageType).Append("\n"); + sb.Append(" RateDetails: ").Append(RateDetails).Append("\n"); sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); sb.Append(" TaxAmount: ").Append(TaxAmount).Append("\n"); diff --git a/ShipEngineSDK/Model/RateDetail.cs b/ShipEngineSDK/Model/RateDetail.cs new file mode 100644 index 00000000..7872a782 --- /dev/null +++ b/ShipEngineSDK/Model/RateDetail.cs @@ -0,0 +1,107 @@ +// +// 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; + +/// +/// Represents detailed information about a shipping cost +/// +public partial class RateDetail +{ + + /// + /// Gets or Sets Amount + /// + [JsonPropertyName("amount"), JsonPropertyOrder(1)] + public MonetaryValue? Amount { get; set; } + + /// + /// The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance + /// + /// The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance + [JsonPropertyName("billing_source"), JsonPropertyOrder(2)] + public string? BillingSource { get; set; } + + /// + /// A rate detail code defined by a carrier + /// + /// A rate detail code defined by a carrier + [JsonPropertyName("carrier_billing_code"), JsonPropertyOrder(3)] + public string? CarrierBillingCode { get; set; } + + /// + /// A rate detail description defined by a carrier + /// + /// A rate detail description defined by a carrier + [JsonPropertyName("carrier_description"), JsonPropertyOrder(4)] + public string? CarrierDescription { get; set; } + + /// + /// Contains any additional information + /// + /// Contains any additional information + [JsonPropertyName("carrier_memo"), JsonPropertyOrder(5)] + public string? CarrierMemo { get; set; } + + /// + /// If applicable, contains additional data about a rate detail of a specific type, e.g. VAT + /// + /// If applicable, contains additional data about a rate detail of a specific type, e.g. VAT + [JsonPropertyName("rate_detail_attributes"), JsonPropertyOrder(6)] + public RateDetailAttributes? RateDetailAttributes { get; set; } + + /// + /// Gets or Sets RateDetailType + /// + [JsonPropertyName("rate_detail_type"), JsonPropertyOrder(7)] + public RateDetailType? RateDetailType { 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 RateDetail {\n"); +#pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" Amount: ").Append(Amount).Append("\n"); + sb.Append(" BillingSource: ").Append(BillingSource).Append("\n"); + sb.Append(" CarrierBillingCode: ").Append(CarrierBillingCode).Append("\n"); + sb.Append(" CarrierDescription: ").Append(CarrierDescription).Append("\n"); + sb.Append(" CarrierMemo: ").Append(CarrierMemo).Append("\n"); + sb.Append(" RateDetailAttributes: ").Append(RateDetailAttributes).Append("\n"); + sb.Append(" RateDetailType: ").Append(RateDetailType).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/RateDetailAttributes.cs b/ShipEngineSDK/Model/RateDetailAttributes.cs new file mode 100644 index 00000000..c5e860c6 --- /dev/null +++ b/ShipEngineSDK/Model/RateDetailAttributes.cs @@ -0,0 +1,76 @@ +// +// 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; + +/// +/// Represents detailed information about a tax (e.g. VAT) contained in a shipping cost. +/// +public partial class RateDetailAttributes +{ + + /// + /// Code for a specific tax type + /// + /// Code for a specific tax type + [JsonPropertyName("tax_code"), JsonPropertyOrder(1)] + public string? TaxCode { get; set; } + + /// + /// Tax percentage, e.g. 20 for 20%, added to the shipping cost + /// + /// Tax percentage, e.g. 20 for 20%, added to the shipping cost + [JsonPropertyName("tax_percentage"), JsonPropertyOrder(2)] + public decimal? TaxPercentage { get; set; } + + /// + /// Gets or Sets TaxType + /// + [JsonPropertyName("tax_type"), JsonPropertyOrder(3)] + public TaxType? TaxType { 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 RateDetailAttributes {\n"); +#pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" TaxCode: ").Append(TaxCode).Append("\n"); + sb.Append(" TaxPercentage: ").Append(TaxPercentage).Append("\n"); + sb.Append(" TaxType: ").Append(TaxType).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/RateDetailType.cs b/ShipEngineSDK/Model/RateDetailType.cs new file mode 100644 index 00000000..28231ba7 --- /dev/null +++ b/ShipEngineSDK/Model/RateDetailType.cs @@ -0,0 +1,212 @@ +// +// 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; + +/// +/// The possible rate detail type values +/// +/// The possible rate detail type values +[JsonConverter(typeof(RateDetailTypeJsonConverter))] +public class RateDetailType +{ + private readonly string _value; + + /// + /// Create a new instance of RateDetailType with a predefined value. + /// + internal RateDetailType() + { + _value = "uncategorized"; + } + + /// + /// Create a new instance of RateDetailType with a custom value. + /// + /// The value of the RateDetailType + /// + /// 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 RateDetailType(string value) + { + _value = value; + } + + /// + /// Enum Uncategorized for value: uncategorized + /// + public static RateDetailType Uncategorized { get; } = new("uncategorized"); + + + /// + /// Enum Shipping for value: shipping + /// + public static RateDetailType Shipping { get; } = new("shipping"); + + + /// + /// Enum Insurance for value: insurance + /// + public static RateDetailType Insurance { get; } = new("insurance"); + + + /// + /// Enum Confirmation for value: confirmation + /// + public static RateDetailType Confirmation { get; } = new("confirmation"); + + + /// + /// Enum Discount for value: discount + /// + public static RateDetailType Discount { get; } = new("discount"); + + + /// + /// Enum FuelCharge for value: fuel_charge + /// + public static RateDetailType FuelCharge { get; } = new("fuel_charge"); + + + /// + /// Enum AdditionalFees for value: additional_fees + /// + public static RateDetailType AdditionalFees { get; } = new("additional_fees"); + + + /// + /// Enum Tariff for value: tariff + /// + public static RateDetailType Tariff { get; } = new("tariff"); + + + /// + /// Enum Tax for value: tax + /// + public static RateDetailType Tax { get; } = new("tax"); + + + /// + /// Enum Delivery for value: delivery + /// + public static RateDetailType Delivery { get; } = new("delivery"); + + + /// + /// Enum Handling for value: handling + /// + public static RateDetailType Handling { get; } = new("handling"); + + + /// + /// Enum SpecialGoods for value: special_goods + /// + public static RateDetailType SpecialGoods { get; } = new("special_goods"); + + + /// + /// Enum Pickup for value: pickup + /// + public static RateDetailType Pickup { get; } = new("pickup"); + + + /// + /// Enum LocationFee for value: location_fee + /// + public static RateDetailType LocationFee { get; } = new("location_fee"); + + + /// + /// Enum Oversize for value: oversize + /// + public static RateDetailType Oversize { get; } = new("oversize"); + + + /// + /// Enum Returns for value: returns + /// + public static RateDetailType Returns { get; } = new("returns"); + + + /// + /// Enum Notifications for value: notifications + /// + public static RateDetailType Notifications { get; } = new("notifications"); + + + /// + /// Enum Tip for value: tip + /// + public static RateDetailType Tip { get; } = new("tip"); + + + /// + /// Enum DutiesAndTaxes for value: duties_and_taxes + /// + public static RateDetailType DutiesAndTaxes { get; } = new("duties_and_taxes"); + + + /// + /// Enum BrokerageFee for value: brokerage_fee + /// + public static RateDetailType BrokerageFee { get; } = new("brokerage_fee"); + + + /// + /// Enum AdminFee for value: admin_fee + /// + public static RateDetailType AdminFee { get; } = new("admin_fee"); + + + /// + /// Enum Adjustment for value: adjustment + /// + public static RateDetailType Adjustment { get; } = new("adjustment"); + + + /// + /// Get a string representation of the current value + /// + public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is RateDetailType other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); +} + +internal class RateDetailTypeJsonConverter : JsonConverter +{ + public override RateDetailType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new RateDetailType(reader.GetString()!) : null; + + public override void Write(Utf8JsonWriter writer, RateDetailType value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(RateDetailType); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/StatusDetailCode.cs b/ShipEngineSDK/Model/StatusDetailCode.cs new file mode 100644 index 00000000..18d21b81 --- /dev/null +++ b/ShipEngineSDK/Model/StatusDetailCode.cs @@ -0,0 +1,512 @@ +// +// 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; + +/// +/// The tracking status detail codes |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- | `COLLECTION_FAILED` | Shipment pickup failed. The delivery company will try again soon. | `AWAITING_DESPATCH` | Your shipment is ready to go and is waiting for pickup. | `COLLECTION_REQUESTED` | Your shipment pickup has been scheduled. | `DESPATCHED` | Your shipment has been handed over to the carrier or dropped off at collection point. It will soon start its journey. | `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system. | `NOT_YET_RECEIVED_BY_CARRIER` | The sender couldn't hand over your shipment. The delivery company will try to collect it again. | `COLLECTION_MADE` | Your shipment has been picked up by the carrier. | `ATTEMPTED_DELIVERY` | Delivery attempt failed. Please check the carrier's instructions for next steps. | `ATTEMPTED_DELIVERY_2ND` | Second delivery attempt failed. Please check the carrier's instructions for next steps. | `ATTEMPTED_DELIVERY_3RD` | Third delivery attempt failed. Please check the carrier's instructions for next steps. | `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please check carrier instructions. | `COD_AMOUNT_PAID` | Cash on delivery payment received. | `CUSTOMER_CARDED` | Delivery attempt failed. Please check for delivery instructions left by the carrier. | `CUSTOMER_IDENTIFICATION_FAILED` | There was a recipient identification issue. Please check carrier instructions. | `INVALID_METHOD_OF_PAYMENT` | Delivery failed due to incorrect payment. Please check carrier instructions. | `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | Delivery couldn't be completed due to issues with accessing address. Please follow carrier instructions. | `OUT_FOR_DELIVERY` | Your shipment is out for delivery. | `DELIVERED` | Your shipment has been delivered. | `DELIVERED_DAMAGED` | Your shipment was delivered but arrived damaged. | `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest. | `DELIVERED_SPECIFIED_SAFE_PLACE` | Your shipment has been left in your designated safe place. | `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your shipment was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details. | `DELIVERED_TO_NEIGHBOUR` | Your shipment was delivered to your neighbor. | `DELIVERED_TO_PO_BOX` | Your shipment was delivered to your PO Box. | `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the collection point. | `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery. | `PROOF_OF_DELIVERY` | Delivery confirmed. | `CANCELLED` | Your shipment has been cancelled. | `CANCELLED_BEFORE_DESPATCH` | Your shipment was cancelled before pickup. Contact the sender if unexpected. | `CUSTOMER_MOVED` | Recipient not at address. Your shipment is being returned. | `HAZARDOUS_PROHIBITED` | Your parcel contained a prohibited item and is being returned. Contact the sender. | `NOT_COLLECTED_FROM_PICKUP_POINT` | Shipment not collected from the pickup point. Your parcel is being returned to the sender. | `NOT_DELIVERED` | Delivery attempts failed. Your parcel is being returned to the sender. | `NOT_DELIVERED_ADDRESSEE_DECEASED` | Delivery not possible due to recipient's passing. | `PARCEL_DAMAGED` | Your parcel was damaged and can't be delivered. It's being returned. Contact the sender. | `PARCEL_DISPOSED` | Shipment was disposed of. Contact the sender for details. | `PARCEL_LOST` | Your parcel is lost. Contact the sender for next steps. | `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | Shipment is too large/heavy for delivery. Being returned. Contact sender. | `REFUSED_BY_CUSTOMER` | Delivery refused. Shipment being returned. Contact the sender. | `RETURN_TO_SENDER` | Your shipment is being returned to the sender. Contact them for details. | `ADDRESS_QUERY` | There's an issue with your delivery address. This may cause a delay or return. Contact sender or carrier. | `CARRIER_DELAYS` | There's a delivery delay. We'll update you when there's more info. | `CUSTOMS_CLEARED` | Your shipment has passed customs clearance. | `CUSTOMS_PROCESSING` | Your shipment is going through customs. | `DELAYED_NOT_CARRIER` | Unexpected delivery delay. We'll update you soon. | `DELIVERY_ARRANGED_WITH_RECIPIENT` | Delivery arranged by recipient. | `HELD_BY_CARRIER` | Your shipment is on hold due to a carrier issue. We'll update you soon. | `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your shipment is held by carrier due to customs issues. We'll update you. | `HELD_BY_CUSTOMS` | Your shipment is held in customs. We'll update you. | `HELD_BY_EXPORT_CUSTOMS` | Your shipment is held in export customs. We'll update you. | `HELD_BY_IMPORT_CUSTOMS` | Your shipment is held in import customs. We'll update you. | `HUB_SCAN_OUT` | Your shipment is at the main delivery depot. | `IN_TRANSIT` | Your shipment is on its way between depots. | `INCORRECT_DECLARATION` | Incorrect shipment dimensions. Delivery may be delayed or returned. We'll update you. | `INFORMATION` | The carrier has shared additional shipment information. | `MISSORTED` | Your shipment was missorted. There might be a delivery delay. We'll update you. | `PARCEL_OVER_LABELLED` | Your shipment was over labelled by the delivery company to improve processing. | `PARCEL_REPACKED` | Your shipment packaging was damaged. It's being repacked. This might delay delivery. | `PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL` | You've received an email with a shipment update. | `PARCEL_UPDATE_NOTIFICATION_VIA_SMS` | You've received a text message with a shipment update. | `RECEIVED_BY_CARRIER` | Your shipment has been received by the carrier. | `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your shipment is at the local delivery depot, ready for delivery. | `ROUTING_ERROR` | Your shipment was sent to the wrong place. There might be a delay. | `SUB_CONTRACTOR_EVENT` | Your shipment is with the local delivery partner. | `SUB_CONTRACTOR_RECEIVED` | Your shipment has been received by the local delivery partner. | `RECD_BY_CARRIER_NO_ELEC_ADVICE` | There's a system issue with your shipment. Tracking updates might be delayed. | `AWAITING_ELECTRONIC_ADVICE` | Your tracking number is ready. Your shipment is waiting to be registered in the carrier system and scheduled for pickup. | `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your shipment is ready for pickup at the specified location. | `COLLECT_AT_LOCAL_PO` | Your shipment has been redirected to the local post office for pickup. Check carrier instructions. | `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your shipment is being held for pickup. Check carrier instructions. | `DELIVERED_TO_LOCKER_COLLECTION_POINT` | Your shipment has been delivered to your locker. | `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates. +/// +/// The tracking status detail codes |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- | `COLLECTION_FAILED` | Shipment pickup failed. The delivery company will try again soon. | `AWAITING_DESPATCH` | Your shipment is ready to go and is waiting for pickup. | `COLLECTION_REQUESTED` | Your shipment pickup has been scheduled. | `DESPATCHED` | Your shipment has been handed over to the carrier or dropped off at collection point. It will soon start its journey. | `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system. | `NOT_YET_RECEIVED_BY_CARRIER` | The sender couldn't hand over your shipment. The delivery company will try to collect it again. | `COLLECTION_MADE` | Your shipment has been picked up by the carrier. | `ATTEMPTED_DELIVERY` | Delivery attempt failed. Please check the carrier's instructions for next steps. | `ATTEMPTED_DELIVERY_2ND` | Second delivery attempt failed. Please check the carrier's instructions for next steps. | `ATTEMPTED_DELIVERY_3RD` | Third delivery attempt failed. Please check the carrier's instructions for next steps. | `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please check carrier instructions. | `COD_AMOUNT_PAID` | Cash on delivery payment received. | `CUSTOMER_CARDED` | Delivery attempt failed. Please check for delivery instructions left by the carrier. | `CUSTOMER_IDENTIFICATION_FAILED` | There was a recipient identification issue. Please check carrier instructions. | `INVALID_METHOD_OF_PAYMENT` | Delivery failed due to incorrect payment. Please check carrier instructions. | `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | Delivery couldn't be completed due to issues with accessing address. Please follow carrier instructions. | `OUT_FOR_DELIVERY` | Your shipment is out for delivery. | `DELIVERED` | Your shipment has been delivered. | `DELIVERED_DAMAGED` | Your shipment was delivered but arrived damaged. | `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest. | `DELIVERED_SPECIFIED_SAFE_PLACE` | Your shipment has been left in your designated safe place. | `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your shipment was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details. | `DELIVERED_TO_NEIGHBOUR` | Your shipment was delivered to your neighbor. | `DELIVERED_TO_PO_BOX` | Your shipment was delivered to your PO Box. | `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the collection point. | `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery. | `PROOF_OF_DELIVERY` | Delivery confirmed. | `CANCELLED` | Your shipment has been cancelled. | `CANCELLED_BEFORE_DESPATCH` | Your shipment was cancelled before pickup. Contact the sender if unexpected. | `CUSTOMER_MOVED` | Recipient not at address. Your shipment is being returned. | `HAZARDOUS_PROHIBITED` | Your parcel contained a prohibited item and is being returned. Contact the sender. | `NOT_COLLECTED_FROM_PICKUP_POINT` | Shipment not collected from the pickup point. Your parcel is being returned to the sender. | `NOT_DELIVERED` | Delivery attempts failed. Your parcel is being returned to the sender. | `NOT_DELIVERED_ADDRESSEE_DECEASED` | Delivery not possible due to recipient's passing. | `PARCEL_DAMAGED` | Your parcel was damaged and can't be delivered. It's being returned. Contact the sender. | `PARCEL_DISPOSED` | Shipment was disposed of. Contact the sender for details. | `PARCEL_LOST` | Your parcel is lost. Contact the sender for next steps. | `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | Shipment is too large/heavy for delivery. Being returned. Contact sender. | `REFUSED_BY_CUSTOMER` | Delivery refused. Shipment being returned. Contact the sender. | `RETURN_TO_SENDER` | Your shipment is being returned to the sender. Contact them for details. | `ADDRESS_QUERY` | There's an issue with your delivery address. This may cause a delay or return. Contact sender or carrier. | `CARRIER_DELAYS` | There's a delivery delay. We'll update you when there's more info. | `CUSTOMS_CLEARED` | Your shipment has passed customs clearance. | `CUSTOMS_PROCESSING` | Your shipment is going through customs. | `DELAYED_NOT_CARRIER` | Unexpected delivery delay. We'll update you soon. | `DELIVERY_ARRANGED_WITH_RECIPIENT` | Delivery arranged by recipient. | `HELD_BY_CARRIER` | Your shipment is on hold due to a carrier issue. We'll update you soon. | `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your shipment is held by carrier due to customs issues. We'll update you. | `HELD_BY_CUSTOMS` | Your shipment is held in customs. We'll update you. | `HELD_BY_EXPORT_CUSTOMS` | Your shipment is held in export customs. We'll update you. | `HELD_BY_IMPORT_CUSTOMS` | Your shipment is held in import customs. We'll update you. | `HUB_SCAN_OUT` | Your shipment is at the main delivery depot. | `IN_TRANSIT` | Your shipment is on its way between depots. | `INCORRECT_DECLARATION` | Incorrect shipment dimensions. Delivery may be delayed or returned. We'll update you. | `INFORMATION` | The carrier has shared additional shipment information. | `MISSORTED` | Your shipment was missorted. There might be a delivery delay. We'll update you. | `PARCEL_OVER_LABELLED` | Your shipment was over labelled by the delivery company to improve processing. | `PARCEL_REPACKED` | Your shipment packaging was damaged. It's being repacked. This might delay delivery. | `PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL` | You've received an email with a shipment update. | `PARCEL_UPDATE_NOTIFICATION_VIA_SMS` | You've received a text message with a shipment update. | `RECEIVED_BY_CARRIER` | Your shipment has been received by the carrier. | `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your shipment is at the local delivery depot, ready for delivery. | `ROUTING_ERROR` | Your shipment was sent to the wrong place. There might be a delay. | `SUB_CONTRACTOR_EVENT` | Your shipment is with the local delivery partner. | `SUB_CONTRACTOR_RECEIVED` | Your shipment has been received by the local delivery partner. | `RECD_BY_CARRIER_NO_ELEC_ADVICE` | There's a system issue with your shipment. Tracking updates might be delayed. | `AWAITING_ELECTRONIC_ADVICE` | Your tracking number is ready. Your shipment is waiting to be registered in the carrier system and scheduled for pickup. | `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your shipment is ready for pickup at the specified location. | `COLLECT_AT_LOCAL_PO` | Your shipment has been redirected to the local post office for pickup. Check carrier instructions. | `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your shipment is being held for pickup. Check carrier instructions. | `DELIVERED_TO_LOCKER_COLLECTION_POINT` | Your shipment has been delivered to your locker. | `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates. +[JsonConverter(typeof(StatusDetailCodeJsonConverter))] +public class StatusDetailCode +{ + private readonly string _value; + + /// + /// Create a new instance of StatusDetailCode with a predefined value. + /// + internal StatusDetailCode() + { + _value = "COLLECTION_FAILED"; + } + + /// + /// Create a new instance of StatusDetailCode with a custom value. + /// + /// The value of the StatusDetailCode + /// + /// 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 StatusDetailCode(string value) + { + _value = value; + } + + /// + /// Enum COLLECTIONFAILED for value: COLLECTION_FAILED + /// + public static StatusDetailCode COLLECTIONFAILED { get; } = new("COLLECTION_FAILED"); + + + /// + /// Enum AWAITINGDESPATCH for value: AWAITING_DESPATCH + /// + public static StatusDetailCode AWAITINGDESPATCH { get; } = new("AWAITING_DESPATCH"); + + + /// + /// Enum COLLECTIONREQUESTED for value: COLLECTION_REQUESTED + /// + public static StatusDetailCode COLLECTIONREQUESTED { get; } = new("COLLECTION_REQUESTED"); + + + /// + /// Enum DESPATCHED for value: DESPATCHED + /// + public static StatusDetailCode DESPATCHED { get; } = new("DESPATCHED"); + + + /// + /// Enum ELECADVICERECDBYCARRIER for value: ELEC_ADVICE_RECD_BY_CARRIER + /// + public static StatusDetailCode ELECADVICERECDBYCARRIER { get; } = new("ELEC_ADVICE_RECD_BY_CARRIER"); + + + /// + /// Enum NOTYETRECEIVEDBYCARRIER for value: NOT_YET_RECEIVED_BY_CARRIER + /// + public static StatusDetailCode NOTYETRECEIVEDBYCARRIER { get; } = new("NOT_YET_RECEIVED_BY_CARRIER"); + + + /// + /// Enum COLLECTIONMADE for value: COLLECTION_MADE + /// + public static StatusDetailCode COLLECTIONMADE { get; } = new("COLLECTION_MADE"); + + + /// + /// Enum ATTEMPTEDDELIVERY for value: ATTEMPTED_DELIVERY + /// + public static StatusDetailCode ATTEMPTEDDELIVERY { get; } = new("ATTEMPTED_DELIVERY"); + + + /// + /// Enum ATTEMPTEDDELIVERY2ND for value: ATTEMPTED_DELIVERY_2ND + /// + public static StatusDetailCode ATTEMPTEDDELIVERY2ND { get; } = new("ATTEMPTED_DELIVERY_2ND"); + + + /// + /// Enum ATTEMPTEDDELIVERY3RD for value: ATTEMPTED_DELIVERY_3RD + /// + public static StatusDetailCode ATTEMPTEDDELIVERY3RD { get; } = new("ATTEMPTED_DELIVERY_3RD"); + + + /// + /// Enum CODAMOUNTNOTPAID for value: COD_AMOUNT_NOT_PAID + /// + public static StatusDetailCode CODAMOUNTNOTPAID { get; } = new("COD_AMOUNT_NOT_PAID"); + + + /// + /// Enum CODAMOUNTPAID for value: COD_AMOUNT_PAID + /// + public static StatusDetailCode CODAMOUNTPAID { get; } = new("COD_AMOUNT_PAID"); + + + /// + /// Enum CUSTOMERCARDED for value: CUSTOMER_CARDED + /// + public static StatusDetailCode CUSTOMERCARDED { get; } = new("CUSTOMER_CARDED"); + + + /// + /// Enum CUSTOMERIDENTIFICATIONFAILED for value: CUSTOMER_IDENTIFICATION_FAILED + /// + public static StatusDetailCode CUSTOMERIDENTIFICATIONFAILED { get; } = new("CUSTOMER_IDENTIFICATION_FAILED"); + + + /// + /// Enum INVALIDMETHODOFPAYMENT for value: INVALID_METHOD_OF_PAYMENT + /// + public static StatusDetailCode INVALIDMETHODOFPAYMENT { get; } = new("INVALID_METHOD_OF_PAYMENT"); + + + /// + /// Enum NOACCESSTORECIPIENTSADDRESS for value: NO_ACCESS_TO_RECIPIENTS_ADDRESS + /// + public static StatusDetailCode NOACCESSTORECIPIENTSADDRESS { get; } = new("NO_ACCESS_TO_RECIPIENTS_ADDRESS"); + + + /// + /// Enum OUTFORDELIVERY for value: OUT_FOR_DELIVERY + /// + public static StatusDetailCode OUTFORDELIVERY { get; } = new("OUT_FOR_DELIVERY"); + + + /// + /// Enum DELIVERED for value: DELIVERED + /// + public static StatusDetailCode DELIVERED { get; } = new("DELIVERED"); + + + /// + /// Enum DELIVEREDDAMAGED for value: DELIVERED_DAMAGED + /// + public static StatusDetailCode DELIVEREDDAMAGED { get; } = new("DELIVERED_DAMAGED"); + + + /// + /// Enum DELIVEREDINPART for value: DELIVERED_IN_PART + /// + public static StatusDetailCode DELIVEREDINPART { get; } = new("DELIVERED_IN_PART"); + + + /// + /// Enum DELIVEREDSPECIFIEDSAFEPLACE for value: DELIVERED_SPECIFIED_SAFE_PLACE + /// + public static StatusDetailCode DELIVEREDSPECIFIEDSAFEPLACE { get; } = new("DELIVERED_SPECIFIED_SAFE_PLACE"); + + + /// + /// Enum DELIVEREDTOALTERNATIVEDELIVERYLOCATION for value: DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION + /// + public static StatusDetailCode DELIVEREDTOALTERNATIVEDELIVERYLOCATION { get; } = new("DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION"); + + + /// + /// Enum DELIVEREDTONEIGHBOUR for value: DELIVERED_TO_NEIGHBOUR + /// + public static StatusDetailCode DELIVEREDTONEIGHBOUR { get; } = new("DELIVERED_TO_NEIGHBOUR"); + + + /// + /// Enum DELIVEREDTOPOBOX for value: DELIVERED_TO_PO_BOX + /// + public static StatusDetailCode DELIVEREDTOPOBOX { get; } = new("DELIVERED_TO_PO_BOX"); + + + /// + /// Enum PARCELCOLLECTEDFROMPICKUPPOINT for value: PARCEL_COLLECTED_FROM_PICKUP_POINT + /// + public static StatusDetailCode PARCELCOLLECTEDFROMPICKUPPOINT { get; } = new("PARCEL_COLLECTED_FROM_PICKUP_POINT"); + + + /// + /// Enum POSTTRANSITSTATUS for value: POST_TRANSIT_STATUS + /// + public static StatusDetailCode POSTTRANSITSTATUS { get; } = new("POST_TRANSIT_STATUS"); + + + /// + /// Enum PROOFOFDELIVERY for value: PROOF_OF_DELIVERY + /// + public static StatusDetailCode PROOFOFDELIVERY { get; } = new("PROOF_OF_DELIVERY"); + + + /// + /// Enum CANCELLED for value: CANCELLED + /// + public static StatusDetailCode CANCELLED { get; } = new("CANCELLED"); + + + /// + /// Enum CANCELLEDBEFOREDESPATCH for value: CANCELLED_BEFORE_DESPATCH + /// + public static StatusDetailCode CANCELLEDBEFOREDESPATCH { get; } = new("CANCELLED_BEFORE_DESPATCH"); + + + /// + /// Enum CUSTOMERMOVED for value: CUSTOMER_MOVED + /// + public static StatusDetailCode CUSTOMERMOVED { get; } = new("CUSTOMER_MOVED"); + + + /// + /// Enum HAZARDOUSPROHIBITED for value: HAZARDOUS_PROHIBITED + /// + public static StatusDetailCode HAZARDOUSPROHIBITED { get; } = new("HAZARDOUS_PROHIBITED"); + + + /// + /// Enum NOTCOLLECTEDFROMPICKUPPOINT for value: NOT_COLLECTED_FROM_PICKUP_POINT + /// + public static StatusDetailCode NOTCOLLECTEDFROMPICKUPPOINT { get; } = new("NOT_COLLECTED_FROM_PICKUP_POINT"); + + + /// + /// Enum NOTDELIVERED for value: NOT_DELIVERED + /// + public static StatusDetailCode NOTDELIVERED { get; } = new("NOT_DELIVERED"); + + + /// + /// Enum NOTDELIVEREDADDRESSEEDECEASED for value: NOT_DELIVERED_ADDRESSEE_DECEASED + /// + public static StatusDetailCode NOTDELIVEREDADDRESSEEDECEASED { get; } = new("NOT_DELIVERED_ADDRESSEE_DECEASED"); + + + /// + /// Enum PARCELDAMAGED for value: PARCEL_DAMAGED + /// + public static StatusDetailCode PARCELDAMAGED { get; } = new("PARCEL_DAMAGED"); + + + /// + /// Enum PARCELDISPOSED for value: PARCEL_DISPOSED + /// + public static StatusDetailCode PARCELDISPOSED { get; } = new("PARCEL_DISPOSED"); + + + /// + /// Enum PARCELLOST for value: PARCEL_LOST + /// + public static StatusDetailCode PARCELLOST { get; } = new("PARCEL_LOST"); + + + /// + /// Enum PARCELOUTSIDEOFSERVICECAPABILITY for value: PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY + /// + public static StatusDetailCode PARCELOUTSIDEOFSERVICECAPABILITY { get; } = new("PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY"); + + + /// + /// Enum REFUSEDBYCUSTOMER for value: REFUSED_BY_CUSTOMER + /// + public static StatusDetailCode REFUSEDBYCUSTOMER { get; } = new("REFUSED_BY_CUSTOMER"); + + + /// + /// Enum RETURNTOSENDER for value: RETURN_TO_SENDER + /// + public static StatusDetailCode RETURNTOSENDER { get; } = new("RETURN_TO_SENDER"); + + + /// + /// Enum ADDRESSQUERY for value: ADDRESS_QUERY + /// + public static StatusDetailCode ADDRESSQUERY { get; } = new("ADDRESS_QUERY"); + + + /// + /// Enum CARRIERDELAYS for value: CARRIER_DELAYS + /// + public static StatusDetailCode CARRIERDELAYS { get; } = new("CARRIER_DELAYS"); + + + /// + /// Enum CUSTOMSCLEARED for value: CUSTOMS_CLEARED + /// + public static StatusDetailCode CUSTOMSCLEARED { get; } = new("CUSTOMS_CLEARED"); + + + /// + /// Enum CUSTOMSPROCESSING for value: CUSTOMS_PROCESSING + /// + public static StatusDetailCode CUSTOMSPROCESSING { get; } = new("CUSTOMS_PROCESSING"); + + + /// + /// Enum DELAYEDNOTCARRIER for value: DELAYED_NOT_CARRIER + /// + public static StatusDetailCode DELAYEDNOTCARRIER { get; } = new("DELAYED_NOT_CARRIER"); + + + /// + /// Enum DELIVERYARRANGEDWITHRECIPIENT for value: DELIVERY_ARRANGED_WITH_RECIPIENT + /// + public static StatusDetailCode DELIVERYARRANGEDWITHRECIPIENT { get; } = new("DELIVERY_ARRANGED_WITH_RECIPIENT"); + + + /// + /// Enum HELDBYCARRIER for value: HELD_BY_CARRIER + /// + public static StatusDetailCode HELDBYCARRIER { get; } = new("HELD_BY_CARRIER"); + + + /// + /// Enum HELDBYCARRIERFORCLEARANCEPREPROCESSING for value: HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING + /// + public static StatusDetailCode HELDBYCARRIERFORCLEARANCEPREPROCESSING { get; } = new("HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING"); + + + /// + /// Enum HELDBYCUSTOMS for value: HELD_BY_CUSTOMS + /// + public static StatusDetailCode HELDBYCUSTOMS { get; } = new("HELD_BY_CUSTOMS"); + + + /// + /// Enum HELDBYEXPORTCUSTOMS for value: HELD_BY_EXPORT_CUSTOMS + /// + public static StatusDetailCode HELDBYEXPORTCUSTOMS { get; } = new("HELD_BY_EXPORT_CUSTOMS"); + + + /// + /// Enum HELDBYIMPORTCUSTOMS for value: HELD_BY_IMPORT_CUSTOMS + /// + public static StatusDetailCode HELDBYIMPORTCUSTOMS { get; } = new("HELD_BY_IMPORT_CUSTOMS"); + + + /// + /// Enum HUBSCANOUT for value: HUB_SCAN_OUT + /// + public static StatusDetailCode HUBSCANOUT { get; } = new("HUB_SCAN_OUT"); + + + /// + /// Enum INTRANSIT for value: IN_TRANSIT + /// + public static StatusDetailCode INTRANSIT { get; } = new("IN_TRANSIT"); + + + /// + /// Enum INCORRECTDECLARATION for value: INCORRECT_DECLARATION + /// + public static StatusDetailCode INCORRECTDECLARATION { get; } = new("INCORRECT_DECLARATION"); + + + /// + /// Enum INFORMATION for value: INFORMATION + /// + public static StatusDetailCode INFORMATION { get; } = new("INFORMATION"); + + + /// + /// Enum MISSORTED for value: MISSORTED + /// + public static StatusDetailCode MISSORTED { get; } = new("MISSORTED"); + + + /// + /// Enum PARCELOVERLABELLED for value: PARCEL_OVER_LABELLED + /// + public static StatusDetailCode PARCELOVERLABELLED { get; } = new("PARCEL_OVER_LABELLED"); + + + /// + /// Enum PARCELREPACKED for value: PARCEL_REPACKED + /// + public static StatusDetailCode PARCELREPACKED { get; } = new("PARCEL_REPACKED"); + + + /// + /// Enum PARCELUPDATENOTIFICATIONVIAEMAIL for value: PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL + /// + public static StatusDetailCode PARCELUPDATENOTIFICATIONVIAEMAIL { get; } = new("PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL"); + + + /// + /// Enum PARCELUPDATENOTIFICATIONVIASMS for value: PARCEL_UPDATE_NOTIFICATION_VIA_SMS + /// + public static StatusDetailCode PARCELUPDATENOTIFICATIONVIASMS { get; } = new("PARCEL_UPDATE_NOTIFICATION_VIA_SMS"); + + + /// + /// Enum RECEIVEDBYCARRIER for value: RECEIVED_BY_CARRIER + /// + public static StatusDetailCode RECEIVEDBYCARRIER { get; } = new("RECEIVED_BY_CARRIER"); + + + /// + /// Enum RECEIVEDLOCALDELIVERYDEPOT for value: RECEIVED_LOCAL_DELIVERY_DEPOT + /// + public static StatusDetailCode RECEIVEDLOCALDELIVERYDEPOT { get; } = new("RECEIVED_LOCAL_DELIVERY_DEPOT"); + + + /// + /// Enum ROUTINGERROR for value: ROUTING_ERROR + /// + public static StatusDetailCode ROUTINGERROR { get; } = new("ROUTING_ERROR"); + + + /// + /// Enum SUBCONTRACTOREVENT for value: SUB_CONTRACTOR_EVENT + /// + public static StatusDetailCode SUBCONTRACTOREVENT { get; } = new("SUB_CONTRACTOR_EVENT"); + + + /// + /// Enum SUBCONTRACTORRECEIVED for value: SUB_CONTRACTOR_RECEIVED + /// + public static StatusDetailCode SUBCONTRACTORRECEIVED { get; } = new("SUB_CONTRACTOR_RECEIVED"); + + + /// + /// Enum RECDBYCARRIERNOELECADVICE for value: RECD_BY_CARRIER_NO_ELEC_ADVICE + /// + public static StatusDetailCode RECDBYCARRIERNOELECADVICE { get; } = new("RECD_BY_CARRIER_NO_ELEC_ADVICE"); + + + /// + /// Enum AWAITINGELECTRONICADVICE for value: AWAITING_ELECTRONIC_ADVICE + /// + public static StatusDetailCode AWAITINGELECTRONICADVICE { get; } = new("AWAITING_ELECTRONIC_ADVICE"); + + + /// + /// Enum AWAITINGCOLLECTIONFROMPICKUPPOINT for value: AWAITING_COLLECTION_FROM_PICKUP_POINT + /// + public static StatusDetailCode AWAITINGCOLLECTIONFROMPICKUPPOINT { get; } = new("AWAITING_COLLECTION_FROM_PICKUP_POINT"); + + + /// + /// Enum COLLECTATLOCALPO for value: COLLECT_AT_LOCAL_PO + /// + public static StatusDetailCode COLLECTATLOCALPO { get; } = new("COLLECT_AT_LOCAL_PO"); + + + /// + /// Enum CUSTOMERTOCOLLECTFROMCARRIER for value: CUSTOMER_TO_COLLECT_FROM_CARRIER + /// + public static StatusDetailCode CUSTOMERTOCOLLECTFROMCARRIER { get; } = new("CUSTOMER_TO_COLLECT_FROM_CARRIER"); + + + /// + /// Enum DELIVEREDTOLOCKERCOLLECTIONPOINT for value: DELIVERED_TO_LOCKER_COLLECTION_POINT + /// + public static StatusDetailCode DELIVEREDTOLOCKERCOLLECTIONPOINT { get; } = new("DELIVERED_TO_LOCKER_COLLECTION_POINT"); + + + /// + /// Enum CARRIERSTATUSNOTMAPPED for value: CARRIER_STATUS_NOT_MAPPED + /// + public static StatusDetailCode CARRIERSTATUSNOTMAPPED { get; } = new("CARRIER_STATUS_NOT_MAPPED"); + + + /// + /// Get a string representation of the current value + /// + public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is StatusDetailCode other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); +} + +internal class StatusDetailCodeJsonConverter : JsonConverter +{ + public override StatusDetailCode? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new StatusDetailCode(reader.GetString()!) : null; + + public override void Write(Utf8JsonWriter writer, StatusDetailCode value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(StatusDetailCode); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/TaxType.cs b/ShipEngineSDK/Model/TaxType.cs new file mode 100644 index 00000000..80aef2f2 --- /dev/null +++ b/ShipEngineSDK/Model/TaxType.cs @@ -0,0 +1,86 @@ +// +// 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; + +/// +/// Type of a tax added to shipping cost +/// +/// Type of a tax added to shipping cost +[JsonConverter(typeof(TaxTypeJsonConverter))] +public class TaxType +{ + private readonly string _value; + + /// + /// Create a new instance of TaxType with a predefined value. + /// + internal TaxType() + { + _value = "vat"; + } + + /// + /// Create a new instance of TaxType with a custom value. + /// + /// The value of the TaxType + /// + /// 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 TaxType(string value) + { + _value = value; + } + + /// + /// Enum Vat for value: vat + /// + public static TaxType Vat { get; } = new("vat"); + + + /// + /// Get a string representation of the current value + /// + public override string ToString() => _value; + + /// + /// Get whether this instance is equal to another instance + /// + public override bool Equals(object? obj) => + obj is TaxType other && _value == other._value; + + /// + /// Get the hash code of the object + /// + public override int GetHashCode() => _value.GetHashCode(); +} + +internal class TaxTypeJsonConverter : JsonConverter +{ + public override TaxType? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + reader.TokenType == JsonTokenType.String ? new TaxType(reader.GetString()!) : null; + + public override void Write(Utf8JsonWriter writer, TaxType value, JsonSerializerOptions options) => + writer.WriteStringValue(value.ToString()); + + public override bool CanConvert(Type typeToConvert) => + typeToConvert == typeof(TaxType); +} \ No newline at end of file diff --git a/ShipEngineSDK/Model/TrackEvent.cs b/ShipEngineSDK/Model/TrackEvent.cs index 97ba9b49..701ae614 100644 --- a/ShipEngineSDK/Model/TrackEvent.cs +++ b/ShipEngineSDK/Model/TrackEvent.cs @@ -210,6 +210,25 @@ public partial class TrackEvent [JsonPropertyName("signer"), JsonInclude] public string? Signer { get; set; } + /// + /// Gets or Sets StatusDetailCode + /// + [JsonPropertyName("status_detail_code"), JsonPropertyOrder(18)] + public StatusDetailCode? StatusDetailCode { get; set; } + + /// + /// Event Status Detail Description + /// + /// Event Status Detail Description + /// + /// This should not be used for input as it will be ignored on serialization. + /// + /// + /// Your shipment is on its way between depots. + /// + [JsonPropertyName("status_detail_description"), JsonInclude] + public string? StatusDetailDescription { get; set; } + /// /// Returns the string presentation of the object @@ -237,6 +256,8 @@ public override string ToString() sb.Append(" Latitude: ").Append(Latitude).Append("\n"); sb.Append(" Longitude: ").Append(Longitude).Append("\n"); sb.Append(" Signer: ").Append(Signer).Append("\n"); + sb.Append(" StatusDetailCode: ").Append(StatusDetailCode).Append("\n"); + sb.Append(" StatusDetailDescription: ").Append(StatusDetailDescription).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/TrackingInformation.cs b/ShipEngineSDK/Model/TrackingInformation.cs index 322d8ef2..7280cbeb 100644 --- a/ShipEngineSDK/Model/TrackingInformation.cs +++ b/ShipEngineSDK/Model/TrackingInformation.cs @@ -154,6 +154,25 @@ public partial class TrackingInformation [JsonPropertyName("status_description"), JsonInclude] public string? StatusDescription { get; set; } + /// + /// Gets or Sets StatusDetailCode + /// + [JsonPropertyName("status_detail_code"), JsonPropertyOrder(13)] + public StatusDetailCode? StatusDetailCode { get; set; } + + /// + /// Status detail description + /// + /// Status detail description + /// + /// This should not be used for input as it will be ignored on serialization. + /// + /// + /// Your shipment has been delivered. + /// + [JsonPropertyName("status_detail_description"), JsonInclude] + public string? StatusDetailDescription { get; set; } + /// /// A tracking number for a package. The format depends on the carrier. /// @@ -161,7 +180,7 @@ public partial class TrackingInformation /// /// 1Z932R800392060079 /// - [JsonPropertyName("tracking_number"), JsonPropertyOrder(13)] + [JsonPropertyName("tracking_number"), JsonPropertyOrder(15)] public string? TrackingNumber { get; set; } /// @@ -199,6 +218,8 @@ public override string ToString() sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); sb.Append(" StatusCode: ").Append(StatusCode).Append("\n"); sb.Append(" StatusDescription: ").Append(StatusDescription).Append("\n"); + sb.Append(" StatusDetailCode: ").Append(StatusDetailCode).Append("\n"); + sb.Append(" StatusDetailDescription: ").Append(StatusDetailDescription).Append("\n"); sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index 309e5365..8f12b479 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-beta.11 + 3.0.0-beta.12 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET diff --git a/generation/swagger.json b/generation/swagger.json index 9cb8d82e..00962162 100644 --- a/generation/swagger.json +++ b/generation/swagger.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "ShipEngine API", - "version": "1.1.202407281907", + "version": "1.1.202409060709", "termsOfService": "https://www.shipengine.com/terms-of-service/", "x-logo": { "url": "https://shipengine.github.io/img/shipengine-logo-square.png", @@ -8042,8 +8042,10 @@ "required": [ "nickname", "account_number", - "ftp_username", - "ftp_password" + "username", + "password", + "api_key", + "processing_location" ], "additionalProperties": false, "properties": { @@ -8058,15 +8060,30 @@ "minLength": 1, "description": "Asendia account number" }, - "ftp_username": { + "username": { "type": "string", "minLength": 1, - "description": "FTP username" + "description": "Asendia username" }, - "ftp_password": { + "password": { "type": "string", "minLength": 1, - "description": "FTP password" + "description": "Asendia password" + }, + "api_key": { + "type": "string", + "minLength": 1, + "description": "Asendia api_key" + }, + "processing_location": { + "type": "string", + "minLength": 1, + "description": "Asendia processing location, one of: 'MIA', 'JFK', 'ORD', 'PHL', 'SFO', 'LAX', 'SLC', 'TOR', 'BUF', 'CAL'" + }, + "sub_account_number": { + "type": "string", + "minLength": 1, + "description": "Asendia sub account number" } } }, @@ -9101,7 +9118,9 @@ "description": "A UPS account information request body. The location header from this call should be used to redirect to UPS for sign in.", "required": [ "nickname", - "account_number" + "account_number", + "account_postal_code", + "account_country_code" ], "additionalProperties": false, "properties": { @@ -9114,6 +9133,16 @@ "type": "string", "minLength": 1, "description": "Account number" + }, + "account_postal_code": { + "type": "string", + "minLength": 1, + "description": "Account Postal Code" + }, + "account_country_code": { + "type": "string", + "minLength": 1, + "description": "Account Country Code" } } }, @@ -9912,6 +9941,18 @@ ], "description": "The total shipping cost for the specified comparison_rate_type.\n" }, + "rate_details": { + "readOnly": true, + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/rate_detail" + } + ] + } + }, "tracking_number": { "type": "string", "minLength": 1, @@ -10278,6 +10319,18 @@ ], "description": "The total shipping cost for the specified comparison_rate_type.\n" }, + "rate_details": { + "readOnly": true, + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/rate_detail" + } + ] + } + }, "tracking_number": { "type": "string", "minLength": 1, @@ -10941,9 +10994,10 @@ "pccc", "oss", "passport", - "abn" + "abn", + "ukims" ], - "description": "Tax identifier type for customs declaration\n\n|Pickup Type | Description\n|---------------|-----------------------------------------\n|`vat` | The tax identifier is a Value Added Tax.\n|`eori` | The tax identifier is an Economic Operators Registration and Identification Number (EORI).\n|`ssn` | The tax identifier is a Social Security Number.\n|`ein` | The tax identifier is an Employer Identification Number (EIN).\n|`tin` | The tax identifier is a Tax Identification Number (TIN).\n|`ioss` | The tax identifier is an Import One-Stop Shop (IOSS).\n|`pan` | The tax identifier is a Permanent Account Number (PAN).\n|`voec` | The tax identifier is a Norwegian VAT On E-Commerce(VOEC).\n|`pccc` | The tax identifier is a Personal Customs Clearance Code (PCCC).\n|`oss` | The tax identifier is an One-Stop Shop (OSS).\n|`passport` | The tax identifier is a Passport Number.\n|`abn` | The tax identifier is an Australian Business Number.\n" + "description": "Tax identifier type for customs declaration\n\n|Pickup Type | Description\n|---------------|-----------------------------------------\n|`vat` | The tax identifier is a Value Added Tax.\n|`eori` | The tax identifier is an Economic Operators Registration and Identification Number (EORI).\n|`ssn` | The tax identifier is a Social Security Number.\n|`ein` | The tax identifier is an Employer Identification Number (EIN).\n|`tin` | The tax identifier is a Tax Identification Number (TIN).\n|`ioss` | The tax identifier is an Import One-Stop Shop (IOSS).\n|`pan` | The tax identifier is a Permanent Account Number (PAN).\n|`voec` | The tax identifier is a Norwegian VAT On E-Commerce(VOEC).\n|`pccc` | The tax identifier is a Personal Customs Clearance Code (PCCC).\n|`oss` | The tax identifier is an One-Stop Shop (OSS).\n|`passport` | The tax identifier is a Passport Number.\n|`abn` | The tax identifier is an Australian Business Number.\n|`ukims` | The tax identifier is an UK Internal Market Scheme number.\n" }, "date": { "title": "date", @@ -11580,6 +11634,26 @@ "description": "Phone number of the contact" } } + }, + "windsor_framework_details": { + "type": "object", + "description": "The Windsor framework is a new regulation in the UK that simplifies customs procedures for goods moved from the UK mainland to Northern Ireland.", + "properties": { + "movement_indicator": { + "type": "string", + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ] + }, + "not_at_risk": { + "type": "boolean", + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk." + } + } } } }, @@ -12086,6 +12160,112 @@ "excepted_quantity" ] }, + "rate_detail": { + "title": "rate_detail", + "type": "object", + "description": "Represents detailed information about a shipping cost\n", + "additionalProperties": false, + "properties": { + "rate_detail_type": { + "allOf": [ + { + "$ref": "#/components/schemas/rate_detail_type" + } + ] + }, + "carrier_description": { + "type": "string", + "description": "A rate detail description defined by a carrier" + }, + "carrier_billing_code": { + "type": "string", + "description": "A rate detail code defined by a carrier" + }, + "carrier_memo": { + "type": "string", + "description": "Contains any additional information" + }, + "amount": { + "allOf": [ + { + "$ref": "#/components/schemas/monetary_value" + } + ] + }, + "rate_detail_attributes": { + "allOf": [ + { + "$ref": "#/components/schemas/rate_detail_attributes" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "billing_source": { + "type": "string", + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance" + } + } + }, + "rate_detail_type": { + "title": "rate_detail_type", + "type": "string", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "description": "The possible rate detail type values" + }, + "rate_detail_attributes": { + "title": "rate_detail_attributes", + "type": "object", + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "additionalProperties": false, + "properties": { + "tax_type": { + "allOf": [ + { + "$ref": "#/components/schemas/tax_type" + } + ] + }, + "tax_code": { + "type": "string", + "description": "Code for a specific tax type" + }, + "tax_percentage": { + "type": "number", + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost" + } + } + }, + "tax_type": { + "title": "tax_type", + "type": "string", + "enum": [ + "vat" + ], + "description": "Type of a tax added to shipping cost" + }, "label_charge_event": { "title": "label_charge_event", "type": "string", @@ -12610,7 +12790,16 @@ { "$ref": "#/components/schemas/status_code" } - ] + ], + "example": "DE" + }, + "status_detail_code": { + "allOf": [ + { + "$ref": "#/components/schemas/status_detail_code" + } + ], + "example": "DELIVERED" }, "carrier_code": { "allOf": [ @@ -12632,6 +12821,13 @@ "minLength": 0, "description": "Status description" }, + "status_detail_description": { + "type": "string", + "readOnly": true, + "example": "Your shipment has been delivered.", + "minLength": 0, + "description": "Status detail description" + }, "carrier_status_code": { "type": "string", "readOnly": true, @@ -12705,6 +12901,86 @@ "type": "string", "description": "The tracking status codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n|`UN` | Unknown\n|`AC` | Accepted\n|`IT` | In Transit\n|`DE` | Delivered\n|`EX` | Exception\n|`AT` | Delivery Attempt\n|`NY` | Not Yet In System\n" }, + "status_detail_code": { + "readOnly": true, + "title": "status_detail_code", + "enum": [ + "COLLECTION_FAILED", + "AWAITING_DESPATCH", + "COLLECTION_REQUESTED", + "DESPATCHED", + "ELEC_ADVICE_RECD_BY_CARRIER", + "NOT_YET_RECEIVED_BY_CARRIER", + "COLLECTION_MADE", + "ATTEMPTED_DELIVERY", + "ATTEMPTED_DELIVERY_2ND", + "ATTEMPTED_DELIVERY_3RD", + "COD_AMOUNT_NOT_PAID", + "COD_AMOUNT_PAID", + "CUSTOMER_CARDED", + "CUSTOMER_IDENTIFICATION_FAILED", + "INVALID_METHOD_OF_PAYMENT", + "NO_ACCESS_TO_RECIPIENTS_ADDRESS", + "OUT_FOR_DELIVERY", + "DELIVERED", + "DELIVERED_DAMAGED", + "DELIVERED_IN_PART", + "DELIVERED_SPECIFIED_SAFE_PLACE", + "DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION", + "DELIVERED_TO_NEIGHBOUR", + "DELIVERED_TO_PO_BOX", + "PARCEL_COLLECTED_FROM_PICKUP_POINT", + "POST_TRANSIT_STATUS", + "PROOF_OF_DELIVERY", + "CANCELLED", + "CANCELLED_BEFORE_DESPATCH", + "CUSTOMER_MOVED", + "HAZARDOUS_PROHIBITED", + "NOT_COLLECTED_FROM_PICKUP_POINT", + "NOT_DELIVERED", + "NOT_DELIVERED_ADDRESSEE_DECEASED", + "PARCEL_DAMAGED", + "PARCEL_DISPOSED", + "PARCEL_LOST", + "PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY", + "REFUSED_BY_CUSTOMER", + "RETURN_TO_SENDER", + "ADDRESS_QUERY", + "CARRIER_DELAYS", + "CUSTOMS_CLEARED", + "CUSTOMS_PROCESSING", + "DELAYED_NOT_CARRIER", + "DELIVERY_ARRANGED_WITH_RECIPIENT", + "HELD_BY_CARRIER", + "HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING", + "HELD_BY_CUSTOMS", + "HELD_BY_EXPORT_CUSTOMS", + "HELD_BY_IMPORT_CUSTOMS", + "HUB_SCAN_OUT", + "IN_TRANSIT", + "INCORRECT_DECLARATION", + "INFORMATION", + "MISSORTED", + "PARCEL_OVER_LABELLED", + "PARCEL_REPACKED", + "PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL", + "PARCEL_UPDATE_NOTIFICATION_VIA_SMS", + "RECEIVED_BY_CARRIER", + "RECEIVED_LOCAL_DELIVERY_DEPOT", + "ROUTING_ERROR", + "SUB_CONTRACTOR_EVENT", + "SUB_CONTRACTOR_RECEIVED", + "RECD_BY_CARRIER_NO_ELEC_ADVICE", + "AWAITING_ELECTRONIC_ADVICE", + "AWAITING_COLLECTION_FROM_PICKUP_POINT", + "COLLECT_AT_LOCAL_PO", + "CUSTOMER_TO_COLLECT_FROM_CARRIER", + "DELIVERED_TO_LOCKER_COLLECTION_POINT", + "CARRIER_STATUS_NOT_MAPPED" + ], + "type": "string", + "description": "The tracking status detail codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n| `COLLECTION_FAILED` | Shipment pickup failed. The delivery company will try again soon.\n| `AWAITING_DESPATCH` | Your shipment is ready to go and is waiting for pickup.\n| `COLLECTION_REQUESTED` | Your shipment pickup has been scheduled.\n| `DESPATCHED` | Your shipment has been handed over to the carrier or dropped off at collection point. It will soon start its journey.\n| `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system.\n| `NOT_YET_RECEIVED_BY_CARRIER` | The sender couldn't hand over your shipment. The delivery company will try to collect it again.\n| `COLLECTION_MADE` | Your shipment has been picked up by the carrier.\n| `ATTEMPTED_DELIVERY` | Delivery attempt failed. Please check the carrier's instructions for next steps.\n| `ATTEMPTED_DELIVERY_2ND` | Second delivery attempt failed. Please check the carrier's instructions for next steps.\n| `ATTEMPTED_DELIVERY_3RD` | Third delivery attempt failed. Please check the carrier's instructions for next steps.\n| `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please check carrier instructions.\n| `COD_AMOUNT_PAID` | Cash on delivery payment received.\n| `CUSTOMER_CARDED` | Delivery attempt failed. Please check for delivery instructions left by the carrier.\n| `CUSTOMER_IDENTIFICATION_FAILED` | There was a recipient identification issue. Please check carrier instructions.\n| `INVALID_METHOD_OF_PAYMENT` | Delivery failed due to incorrect payment. Please check carrier instructions.\n| `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | Delivery couldn't be completed due to issues with accessing address. Please follow carrier instructions.\n| `OUT_FOR_DELIVERY` | Your shipment is out for delivery.\n| `DELIVERED` | Your shipment has been delivered.\n| `DELIVERED_DAMAGED` | Your shipment was delivered but arrived damaged.\n| `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest.\n| `DELIVERED_SPECIFIED_SAFE_PLACE` | Your shipment has been left in your designated safe place.\n| `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your shipment was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details.\n| `DELIVERED_TO_NEIGHBOUR` | Your shipment was delivered to your neighbor.\n| `DELIVERED_TO_PO_BOX` | Your shipment was delivered to your PO Box.\n| `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the collection point.\n| `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery.\n| `PROOF_OF_DELIVERY` | Delivery confirmed.\n| `CANCELLED` | Your shipment has been cancelled.\n| `CANCELLED_BEFORE_DESPATCH` | Your shipment was cancelled before pickup. Contact the sender if unexpected.\n| `CUSTOMER_MOVED` | Recipient not at address. Your shipment is being returned.\n| `HAZARDOUS_PROHIBITED` | Your parcel contained a prohibited item and is being returned. Contact the sender.\n| `NOT_COLLECTED_FROM_PICKUP_POINT` | Shipment not collected from the pickup point. Your parcel is being returned to the sender.\n| `NOT_DELIVERED` | Delivery attempts failed. Your parcel is being returned to the sender.\n| `NOT_DELIVERED_ADDRESSEE_DECEASED` | Delivery not possible due to recipient's passing.\n| `PARCEL_DAMAGED` | Your parcel was damaged and can't be delivered. It's being returned. Contact the sender.\n| `PARCEL_DISPOSED` | Shipment was disposed of. Contact the sender for details.\n| `PARCEL_LOST` | Your parcel is lost. Contact the sender for next steps.\n| `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | Shipment is too large/heavy for delivery. Being returned. Contact sender.\n| `REFUSED_BY_CUSTOMER` | Delivery refused. Shipment being returned. Contact the sender.\n| `RETURN_TO_SENDER` | Your shipment is being returned to the sender. Contact them for details.\n| `ADDRESS_QUERY` | There's an issue with your delivery address. This may cause a delay or return. Contact sender or carrier.\n| `CARRIER_DELAYS` | There's a delivery delay. We'll update you when there's more info.\n| `CUSTOMS_CLEARED` | Your shipment has passed customs clearance.\n| `CUSTOMS_PROCESSING` | Your shipment is going through customs.\n| `DELAYED_NOT_CARRIER` | Unexpected delivery delay. We'll update you soon.\n| `DELIVERY_ARRANGED_WITH_RECIPIENT` | Delivery arranged by recipient.\n| `HELD_BY_CARRIER` | Your shipment is on hold due to a carrier issue. We'll update you soon.\n| `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your shipment is held by carrier due to customs issues. We'll update you.\n| `HELD_BY_CUSTOMS` | Your shipment is held in customs. We'll update you.\n| `HELD_BY_EXPORT_CUSTOMS` | Your shipment is held in export customs. We'll update you.\n| `HELD_BY_IMPORT_CUSTOMS` | Your shipment is held in import customs. We'll update you.\n| `HUB_SCAN_OUT` | Your shipment is at the main delivery depot.\n| `IN_TRANSIT` | Your shipment is on its way between depots.\n| `INCORRECT_DECLARATION` | Incorrect shipment dimensions. Delivery may be delayed or returned. We'll update you.\n| `INFORMATION` | The carrier has shared additional shipment information.\n| `MISSORTED` | Your shipment was missorted. There might be a delivery delay. We'll update you.\n| `PARCEL_OVER_LABELLED` | Your shipment was over labelled by the delivery company to improve processing.\n| `PARCEL_REPACKED` | Your shipment packaging was damaged. It's being repacked. This might delay delivery.\n| `PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL` | You've received an email with a shipment update.\n| `PARCEL_UPDATE_NOTIFICATION_VIA_SMS` | You've received a text message with a shipment update.\n| `RECEIVED_BY_CARRIER` | Your shipment has been received by the carrier.\n| `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your shipment is at the local delivery depot, ready for delivery.\n| `ROUTING_ERROR` | Your shipment was sent to the wrong place. There might be a delay.\n| `SUB_CONTRACTOR_EVENT` | Your shipment is with the local delivery partner.\n| `SUB_CONTRACTOR_RECEIVED` | Your shipment has been received by the local delivery partner.\n| `RECD_BY_CARRIER_NO_ELEC_ADVICE` | There's a system issue with your shipment. Tracking updates might be delayed.\n| `AWAITING_ELECTRONIC_ADVICE` | Your tracking number is ready. Your shipment is waiting to be registered in the carrier system and scheduled for pickup.\n| `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your shipment is ready for pickup at the specified location.\n| `COLLECT_AT_LOCAL_PO` | Your shipment has been redirected to the local post office for pickup. Check carrier instructions.\n| `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your shipment is being held for pickup. Check carrier instructions.\n| `DELIVERED_TO_LOCKER_COLLECTION_POINT` | Your shipment has been delivered to your locker.\n| `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates.\n" + }, "track_event": { "title": "track_event", "type": "object", @@ -12803,7 +13079,16 @@ { "$ref": "#/components/schemas/status_code" } - ] + ], + "example": "IT" + }, + "status_detail_code": { + "allOf": [ + { + "$ref": "#/components/schemas/status_detail_code" + } + ], + "example": "IN_TRANSIT" }, "status_description": { "type": "string", @@ -12812,6 +13097,13 @@ "example": "In Transit", "description": "Event Status Description" }, + "status_detail_description": { + "type": "string", + "readOnly": true, + "minLength": 0, + "example": "Your shipment is on its way between depots.", + "description": "Event Status Detail Description" + }, "carrier_status_code": { "type": "string", "readOnly": true, @@ -14204,6 +14496,18 @@ ], "description": "Tariff and additional taxes associated with an international shipment." }, + "rate_details": { + "readOnly": true, + "description": "A list of rate details that are associated with this rate. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/rate_detail" + } + ] + } + }, "zone": { "type": "integer", "format": "int32", @@ -15043,6 +15347,23 @@ } ], "description": "Shipment total weight" + }, + "packages": { + "type": "array", + "description": "An array of package dimensions", + "items": { + "type": "object", + "properties": { + "dimensions": { + "allOf": [ + { + "$ref": "#/components/schemas/dimensions" + } + ], + "description": "The package dimensions" + } + } + } } } } @@ -16262,7 +16583,7 @@ }, { "name": "carrier_accounts", - "description": "carrier accounts\n", + "description": "A carrier account is a connection to a shipping carrier that allows you to create labels, track packages, and more. You can connect your own carrier accounts to ShipEngine, or use one of our built-in carrier accounts. [Learn more about carrier accounts here.](https://www.shipengine.com/docs/carriers/setup/)\n", "x-displayName": "Carrier Accounts" }, { diff --git a/openapitools.json b/openapitools.json index 9d3ae49f..f0926ab5 100644 --- a/openapitools.json +++ b/openapitools.json @@ -14,7 +14,7 @@ "ignoreFileOverride": "./.openapi-generator-ignore", "library": "generichost", "additionalProperties": { - "packageVersion": "3.0.0-beta.11", + "packageVersion": "3.0.0-beta.12", "targetFramework": "netstandard2.0", "validatable": false, "sourceFolder": "", diff --git a/package.json b/package.json index 401d164c..5460c402 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "shipengine-dotnet", - "version": "3.0.0-beta.11", + "version": "3.0.0-beta.12", "description": "Package primarily used to generate the API and models from OpenApi spec\"", "main": "index.js", "directories": { From c8b1523e207a604b5dd9e75fe26c56d1f683f11f Mon Sep 17 00:00:00 2001 From: Matt Burton Date: Thu, 3 Oct 2024 17:44:13 -0400 Subject: [PATCH 28/42] Regenerate from spec v1.20.5, version 3.0.0-beta.13 --- .../Model/AdvancedShipmentOptions.cs | 71 ++++++++++++++----- ShipEngineSDK/Model/ErrorCode.cs | 48 +++++++++++++ .../GetTrackingLogFromLabelResponseBody.cs | 30 ++++---- .../Model/GetTrackingLogResponseBody.cs | 28 ++++---- ShipEngineSDK/Model/StatusCode.cs | 10 ++- ShipEngineSDK/ShipEngineSDK.csproj | 2 +- generation/swagger.json | 40 +++++++++-- 7 files changed, 172 insertions(+), 57 deletions(-) diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptions.cs b/ShipEngineSDK/Model/AdvancedShipmentOptions.cs index e6e2e7e3..2ceff18b 100644 --- a/ShipEngineSDK/Model/AdvancedShipmentOptions.cs +++ b/ShipEngineSDK/Model/AdvancedShipmentOptions.cs @@ -64,78 +64,88 @@ public partial class AdvancedShipmentOptions [JsonPropertyName("bill_to_postal_code"), JsonPropertyOrder(5)] public string? BillToPostalCode { get; set; } + /// + /// certificate number. + /// + /// certificate number. + /// + /// 784515 + /// + [JsonPropertyName("certificate_number"), JsonPropertyOrder(6)] + public string? CertificateNumber { get; set; } + /// /// Gets or Sets CollectOnDelivery /// - [JsonPropertyName("collect_on_delivery"), JsonPropertyOrder(6)] + [JsonPropertyName("collect_on_delivery"), JsonPropertyOrder(7)] public CollectOnDelivery? CollectOnDelivery { get; set; } /// /// Indicates that the shipment contains alcohol. /// /// Indicates that the shipment contains alcohol. - [JsonPropertyName("contains_alcohol"), JsonPropertyOrder(7)] + [JsonPropertyName("contains_alcohol"), JsonPropertyOrder(8)] public bool? ContainsAlcohol { get; set; } /// /// An arbitrary field that can be used to store information about the shipment. /// /// An arbitrary field that can be used to store information about the shipment. - [JsonPropertyName("custom_field1"), JsonPropertyOrder(8)] + [JsonPropertyName("custom_field1"), JsonPropertyOrder(9)] public string? CustomField1 { get; set; } /// /// An arbitrary field that can be used to store information about the shipment. /// /// An arbitrary field that can be used to store information about the shipment. - [JsonPropertyName("custom_field2"), JsonPropertyOrder(9)] + [JsonPropertyName("custom_field2"), JsonPropertyOrder(10)] public string? CustomField2 { get; set; } /// /// An arbitrary field that can be used to store information about the shipment. /// /// An arbitrary field that can be used to store information about the shipment. - [JsonPropertyName("custom_field3"), JsonPropertyOrder(10)] + [JsonPropertyName("custom_field3"), JsonPropertyOrder(11)] public string? CustomField3 { get; set; } /// /// Indicates if the Dangerous goods are present in the shipment /// /// Indicates if the Dangerous goods are present in the shipment - [JsonPropertyName("dangerous_goods"), JsonPropertyOrder(11)] + [JsonPropertyName("dangerous_goods"), JsonPropertyOrder(12)] public bool? DangerousGoods { get; set; } /// /// Gets or Sets DangerousGoodsContact /// - [JsonPropertyName("dangerous_goods_contact"), JsonPropertyOrder(12)] + [JsonPropertyName("dangerous_goods_contact"), JsonPropertyOrder(13)] public AdvancedShipmentOptionsDangerousGoodsContact? DangerousGoodsContact { get; set; } /// /// Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express. /// /// Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express. - [JsonPropertyName("delivered_duty_paid"), JsonPropertyOrder(13)] + [JsonPropertyName("delivered_duty_paid"), JsonPropertyOrder(14)] public bool? DeliveredDutyPaid { get; set; } /// /// Indicates if the shipment contain dry ice /// /// Indicates if the shipment contain dry ice - [JsonPropertyName("dry_ice"), JsonPropertyOrder(14)] + [JsonPropertyName("dry_ice"), JsonPropertyOrder(15)] public bool? DryIce { get; set; } /// /// The weight of the dry ice in the shipment /// /// The weight of the dry ice in the shipment - [JsonPropertyName("dry_ice_weight"), JsonPropertyOrder(15)] + [JsonPropertyName("dry_ice_weight"), JsonPropertyOrder(16)] public Weight? DryIceWeight { get; set; } /// /// Gets or Sets FedexFreight /// - [JsonPropertyName("fedex_freight"), JsonPropertyOrder(16)] + [JsonPropertyName("fedex_freight"), JsonPropertyOrder(17)] public AdvancedShipmentOptionsFedexFreight? FedexFreight { get; set; } /// @@ -145,53 +155,73 @@ public partial class AdvancedShipmentOptions /// /// 77.5 /// - [JsonPropertyName("freight_class"), JsonPropertyOrder(17)] + [JsonPropertyName("freight_class"), JsonPropertyOrder(18)] public string? FreightClass { get; set; } + /// + /// invoice number. + /// + /// invoice number. + /// + /// IOC56888 + /// + [JsonPropertyName("invoice_number"), JsonPropertyOrder(19)] + public string? InvoiceNumber { get; set; } + + /// + /// license number. + /// + /// license number. + /// + /// 514785 + /// + [JsonPropertyName("license_number"), JsonPropertyOrder(20)] + public string? LicenseNumber { get; set; } + /// /// Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details. /// /// Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details. - [JsonPropertyName("non_machinable"), JsonPropertyOrder(18)] + [JsonPropertyName("non_machinable"), JsonPropertyOrder(21)] public bool? NonMachinable { get; set; } /// /// Gets or Sets OriginType /// - [JsonPropertyName("origin_type"), JsonPropertyOrder(19)] + [JsonPropertyName("origin_type"), JsonPropertyOrder(22)] public OriginType? OriginType { get; set; } /// /// Enables Saturday delivery, if supported by the carrier. /// /// Enables Saturday delivery, if supported by the carrier. - [JsonPropertyName("saturday_delivery"), JsonPropertyOrder(20)] + [JsonPropertyName("saturday_delivery"), JsonPropertyOrder(23)] public bool? SaturdayDelivery { get; set; } /// /// Gets or Sets ShipperRelease /// - [JsonPropertyName("shipper_release"), JsonPropertyOrder(21)] + [JsonPropertyName("shipper_release"), JsonPropertyOrder(24)] public bool? ShipperRelease { get; set; } /// /// Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached /// /// Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached - [JsonPropertyName("third_party_consignee"), JsonPropertyOrder(22)] + [JsonPropertyName("third_party_consignee"), JsonPropertyOrder(25)] public bool? ThirdPartyConsignee { get; set; } /// /// Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified. /// /// Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified. - [JsonPropertyName("use_ups_ground_freight_pricing"), JsonPropertyOrder(23)] + [JsonPropertyName("use_ups_ground_freight_pricing"), JsonPropertyOrder(26)] public bool? UseUpsGroundFreightPricing { get; set; } /// /// Gets or Sets WindsorFrameworkDetails /// - [JsonPropertyName("windsor_framework_details"), JsonPropertyOrder(24)] + [JsonPropertyName("windsor_framework_details"), JsonPropertyOrder(27)] public AdvancedShipmentOptionsWindsorFrameworkDetails? WindsorFrameworkDetails { get; set; } @@ -209,6 +239,7 @@ public override string ToString() sb.Append(" BillToCountryCode: ").Append(BillToCountryCode).Append("\n"); sb.Append(" BillToParty: ").Append(BillToParty).Append("\n"); sb.Append(" BillToPostalCode: ").Append(BillToPostalCode).Append("\n"); + sb.Append(" CertificateNumber: ").Append(CertificateNumber).Append("\n"); sb.Append(" CollectOnDelivery: ").Append(CollectOnDelivery).Append("\n"); sb.Append(" ContainsAlcohol: ").Append(ContainsAlcohol).Append("\n"); sb.Append(" CustomField1: ").Append(CustomField1).Append("\n"); @@ -221,6 +252,8 @@ public override string ToString() sb.Append(" DryIceWeight: ").Append(DryIceWeight).Append("\n"); sb.Append(" FedexFreight: ").Append(FedexFreight).Append("\n"); sb.Append(" FreightClass: ").Append(FreightClass).Append("\n"); + sb.Append(" InvoiceNumber: ").Append(InvoiceNumber).Append("\n"); + sb.Append(" LicenseNumber: ").Append(LicenseNumber).Append("\n"); sb.Append(" NonMachinable: ").Append(NonMachinable).Append("\n"); sb.Append(" OriginType: ").Append(OriginType).Append("\n"); sb.Append(" SaturdayDelivery: ").Append(SaturdayDelivery).Append("\n"); diff --git a/ShipEngineSDK/Model/ErrorCode.cs b/ShipEngineSDK/Model/ErrorCode.cs index ed02899a..47bae8f4 100644 --- a/ShipEngineSDK/Model/ErrorCode.cs +++ b/ShipEngineSDK/Model/ErrorCode.cs @@ -308,6 +308,54 @@ public ErrorCode(string value) public static ErrorCode NoRatesReturned { get; } = new("no_rates_returned"); + /// + /// Enum FileNotFound for value: file_not_found + /// + public static ErrorCode FileNotFound { get; } = new("file_not_found"); + + + /// + /// Enum ShippingRuleNotFound for value: shipping_rule_not_found + /// + public static ErrorCode ShippingRuleNotFound { get; } = new("shipping_rule_not_found"); + + + /// + /// Enum ServiceNotDetermined for value: service_not_determined + /// + public static ErrorCode ServiceNotDetermined { get; } = new("service_not_determined"); + + + /// + /// Enum NoRatesReturned2 for value: no_rates_returned + /// + public static ErrorCode NoRatesReturned2 { get; } = new("no_rates_returned"); + + + /// + /// Enum FundingSourceRegistrationInProgress for value: funding_source_registration_in_progress + /// + public static ErrorCode FundingSourceRegistrationInProgress { get; } = new("funding_source_registration_in_progress"); + + + /// + /// Enum InsuranceFailure for value: insurance_failure + /// + public static ErrorCode InsuranceFailure { get; } = new("insurance_failure"); + + + /// + /// Enum FundingSourceMissingConfiguration for value: funding_source_missing_configuration + /// + public static ErrorCode FundingSourceMissingConfiguration { get; } = new("funding_source_missing_configuration"); + + + /// + /// Enum FundingSourceError for value: funding_source_error + /// + public static ErrorCode FundingSourceError { get; } = new("funding_source_error"); + + /// /// Get a string representation of the current value /// diff --git a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs index 6db25932..027d4294 100644 --- a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs @@ -39,16 +39,6 @@ public partial class GetTrackingLogFromLabelResponseBody [JsonPropertyName("carrier_status_code"), JsonInclude] public string? CarrierStatusCode { get; set; } - /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. - /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("estimated_delivery_date"), JsonPropertyOrder(2)] - public required DateTimeOffset EstimatedDeliveryDate { get; set; } - /// /// The events that have occured during the lifetime of this tracking number. /// @@ -62,7 +52,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// /// Gets or Sets StatusCode /// - [JsonPropertyName("status_code"), JsonPropertyOrder(4)] + [JsonPropertyName("status_code"), JsonPropertyOrder(3)] public required StatusCode StatusCode { get; set; } /// @@ -72,7 +62,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// /// 1Z932R800392060079 /// - [JsonPropertyName("tracking_number"), JsonPropertyOrder(5)] + [JsonPropertyName("tracking_number"), JsonPropertyOrder(4)] public required string TrackingNumber { get; set; } /// @@ -82,7 +72,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("actual_delivery_date"), JsonPropertyOrder(6)] + [JsonPropertyName("actual_delivery_date"), JsonPropertyOrder(5)] public DateTimeOffset? ActualDeliveryDate { get; set; } /// @@ -92,7 +82,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// /// dhl_express /// - [JsonPropertyName("carrier_code"), JsonPropertyOrder(7)] + [JsonPropertyName("carrier_code"), JsonPropertyOrder(6)] public string? CarrierCode { get; set; } /// @@ -131,6 +121,16 @@ public partial class GetTrackingLogFromLabelResponseBody [JsonPropertyName("carrier_status_description"), JsonInclude] public string? CarrierStatusDescription { get; set; } + /// + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. + /// + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("estimated_delivery_date"), JsonPropertyOrder(10)] + public DateTimeOffset? EstimatedDeliveryDate { get; set; } + /// /// Exception description /// @@ -207,7 +207,6 @@ public override string ToString() sb.Append("class GetTrackingLogFromLabelResponseBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" CarrierStatusCode: ").Append(CarrierStatusCode).Append("\n"); - sb.Append(" EstimatedDeliveryDate: ").Append(EstimatedDeliveryDate).Append("\n"); sb.Append(" Events: ").Append(Events).Append("\n"); sb.Append(" StatusCode: ").Append(StatusCode).Append("\n"); sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); @@ -216,6 +215,7 @@ public override string ToString() sb.Append(" CarrierDetailCode: ").Append(CarrierDetailCode).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" CarrierStatusDescription: ").Append(CarrierStatusDescription).Append("\n"); + sb.Append(" EstimatedDeliveryDate: ").Append(EstimatedDeliveryDate).Append("\n"); sb.Append(" ExceptionDescription: ").Append(ExceptionDescription).Append("\n"); sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); sb.Append(" StatusDescription: ").Append(StatusDescription).Append("\n"); diff --git a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs index 608e77d2..23832b0c 100644 --- a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs @@ -72,16 +72,6 @@ public partial class GetTrackingLogResponseBody [JsonPropertyName("carrier_status_code"), JsonInclude] public string? CarrierStatusCode { get; set; } - /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. - /// - /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("estimated_delivery_date"), JsonPropertyOrder(5)] - public required DateTimeOffset EstimatedDeliveryDate { get; set; } - /// /// The events that have occured during the lifetime of this tracking number. /// @@ -95,7 +85,7 @@ public partial class GetTrackingLogResponseBody /// /// Gets or Sets StatusCode /// - [JsonPropertyName("status_code"), JsonPropertyOrder(7)] + [JsonPropertyName("status_code"), JsonPropertyOrder(6)] public required StatusCode StatusCode { get; set; } /// @@ -105,7 +95,7 @@ public partial class GetTrackingLogResponseBody /// /// 1Z932R800392060079 /// - [JsonPropertyName("tracking_number"), JsonPropertyOrder(8)] + [JsonPropertyName("tracking_number"), JsonPropertyOrder(7)] public required string TrackingNumber { get; set; } /// @@ -128,7 +118,7 @@ public partial class GetTrackingLogResponseBody /// /// 2018-09-23T15:00Z /// - [JsonPropertyName("actual_delivery_date"), JsonPropertyOrder(10)] + [JsonPropertyName("actual_delivery_date"), JsonPropertyOrder(9)] public DateTimeOffset? ActualDeliveryDate { get; set; } /// @@ -144,6 +134,16 @@ public partial class GetTrackingLogResponseBody [JsonPropertyName("carrier_status_description"), JsonInclude] public string? CarrierStatusDescription { get; set; } + /// + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. + /// + /// An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. + /// + /// 2018-09-23T15:00Z + /// + [JsonPropertyName("estimated_delivery_date"), JsonPropertyOrder(11)] + public DateTimeOffset? EstimatedDeliveryDate { get; set; } + /// /// Exception description /// @@ -210,13 +210,13 @@ public override string ToString() sb.Append(" CarrierDetailCode: ").Append(CarrierDetailCode).Append("\n"); sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" CarrierStatusCode: ").Append(CarrierStatusCode).Append("\n"); - sb.Append(" EstimatedDeliveryDate: ").Append(EstimatedDeliveryDate).Append("\n"); sb.Append(" Events: ").Append(Events).Append("\n"); sb.Append(" StatusCode: ").Append(StatusCode).Append("\n"); sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); sb.Append(" ActualDeliveryDate: ").Append(ActualDeliveryDate).Append("\n"); sb.Append(" CarrierStatusDescription: ").Append(CarrierStatusDescription).Append("\n"); + sb.Append(" EstimatedDeliveryDate: ").Append(EstimatedDeliveryDate).Append("\n"); sb.Append(" ExceptionDescription: ").Append(ExceptionDescription).Append("\n"); sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); sb.Append(" StatusDescription: ").Append(StatusDescription).Append("\n"); diff --git a/ShipEngineSDK/Model/StatusCode.cs b/ShipEngineSDK/Model/StatusCode.cs index c8b5d5cb..abf7fde2 100644 --- a/ShipEngineSDK/Model/StatusCode.cs +++ b/ShipEngineSDK/Model/StatusCode.cs @@ -21,9 +21,9 @@ namespace ShipEngineSDK.Model; /// -/// The tracking status codes |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`UN` | Unknown |`AC` | Accepted |`IT` | In Transit |`DE` | Delivered |`EX` | Exception |`AT` | Delivery Attempt |`NY` | Not Yet In System +/// The tracking status codes |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`UN` | Unknown |`AC` | Accepted |`IT` | In Transit |`DE` | Delivered |`EX` | Exception |`AT` | Delivery Attempt |`NY` | Not Yet In System |`SP` | Delivered To Collection Location /// -/// The tracking status codes |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`UN` | Unknown |`AC` | Accepted |`IT` | In Transit |`DE` | Delivered |`EX` | Exception |`AT` | Delivery Attempt |`NY` | Not Yet In System +/// The tracking status codes |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`UN` | Unknown |`AC` | Accepted |`IT` | In Transit |`DE` | Delivered |`EX` | Exception |`AT` | Delivery Attempt |`NY` | Not Yet In System |`SP` | Delivered To Collection Location [JsonConverter(typeof(StatusCodeJsonConverter))] public class StatusCode { @@ -92,6 +92,12 @@ public StatusCode(string value) public static StatusCode NY { get; } = new("NY"); + /// + /// Enum SP for value: SP + /// + public static StatusCode SP { get; } = new("SP"); + + /// /// Get a string representation of the current value /// diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index 8f12b479..3c5bc56e 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-beta.12 + 3.0.0-beta.13 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET diff --git a/generation/swagger.json b/generation/swagger.json index 00962162..a078b172 100644 --- a/generation/swagger.json +++ b/generation/swagger.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "ShipEngine API", - "version": "1.1.202409060709", + "version": "1.1.202410032110", "termsOfService": "https://www.shipengine.com/terms-of-service/", "x-logo": { "url": "https://shipengine.github.io/img/shipengine-logo-square.png", @@ -5691,7 +5691,15 @@ "incompatible_paired_labels", "invalid_charge_event", "invalid_object", - "no_rates_returned" + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" ], "description": "The error code specified for the failed API Call" }, @@ -11654,6 +11662,27 @@ "description": "An indicator that allows a shipper to declare the shipment as not-at-risk." } } + }, + "license_number": { + "type": "string", + "nullable": true, + "default": null, + "example": 514785, + "description": "license number." + }, + "invoice_number": { + "type": "string", + "nullable": true, + "default": null, + "example": "IOC56888", + "description": "invoice number." + }, + "certificate_number": { + "type": "string", + "nullable": true, + "default": null, + "example": 784515, + "description": "certificate number." } } }, @@ -12756,7 +12785,6 @@ "tracking_number", "status_code", "carrier_status_code", - "estimated_delivery_date", "events" ], "additionalProperties": false, @@ -12896,10 +12924,11 @@ "DE", "EX", "AT", - "NY" + "NY", + "SP" ], "type": "string", - "description": "The tracking status codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n|`UN` | Unknown\n|`AC` | Accepted\n|`IT` | In Transit\n|`DE` | Delivered\n|`EX` | Exception\n|`AT` | Delivery Attempt\n|`NY` | Not Yet In System\n" + "description": "The tracking status codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n|`UN` | Unknown\n|`AC` | Accepted\n|`IT` | In Transit\n|`DE` | Delivered\n|`EX` | Exception\n|`AT` | Delivery Attempt\n|`NY` | Not Yet In System\n|`SP` | Delivered To Collection Location\n" }, "status_detail_code": { "readOnly": true, @@ -16342,7 +16371,6 @@ "carrier_id", "carrier_detail_code", "carrier_status_code", - "estimated_delivery_date", "events" ], "additionalProperties": false, From ef486d532b56cbb34fe7c7373eb8b77c3fe5753d Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Tue, 8 Oct 2024 10:36:17 -0500 Subject: [PATCH 29/42] Add optional error properties --- CHANGELOG.md | 7 ++++ ShipEngineSDK/Model/Error.cs | 42 ++++++++++++++++++++++ ShipEngineSDK/ShipEngineSDK.csproj | 2 +- generation/swagger.json | 58 +++++++++++++++++++++--------- openapitools.json | 2 +- package.json | 2 +- 6 files changed, 93 insertions(+), 20 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b130026c..fb6244d4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -225,3 +225,10 @@ Fixed handling of No Content responses ## Changed - Updated to ShipEngine API 1.1.202409060709 + +## 3.0.0-beta.14 + +## Changed + +- Updated to ShipEngine API 1.1.202410081510 +- Add optional error properties, like field_name diff --git a/ShipEngineSDK/Model/Error.cs b/ShipEngineSDK/Model/Error.cs index b261eab0..c513a4e0 100644 --- a/ShipEngineSDK/Model/Error.cs +++ b/ShipEngineSDK/Model/Error.cs @@ -57,6 +57,45 @@ public partial class Error [JsonPropertyName("message"), JsonInclude] public string? Message { get; set; } + /// + /// The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + /// + /// dhl_express + /// + [JsonPropertyName("carrier_code"), JsonInclude] + public string? CarrierCode { get; set; } + + /// + /// A string that uniquely identifies the carrier that generated the error. + /// + /// A string that uniquely identifies the carrier that generated the error. + /// + /// This should not be used for input as it will be ignored on serialization. + /// + /// + /// se-28529731 + /// + [JsonPropertyName("carrier_id"), JsonInclude] + public string? CarrierId { get; set; } + + /// + /// The name of the field that caused the error + /// + /// The name of the field that caused the error + /// + /// This should not be used for input as it will be ignored on serialization. + /// + /// + /// shipment.ship_to.phone_number + /// + [JsonPropertyName("field_name"), JsonInclude] + public string? FieldName { get; set; } + /// /// Returns the string presentation of the object @@ -71,6 +110,9 @@ public override string ToString() sb.Append(" ErrorSource: ").Append(ErrorSource).Append("\n"); sb.Append(" ErrorType: ").Append(ErrorType).Append("\n"); sb.Append(" Message: ").Append(Message).Append("\n"); + sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); + sb.Append(" FieldName: ").Append(FieldName).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index 3c5bc56e..f5e06a20 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-beta.13 + 3.0.0-beta.14 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET diff --git a/generation/swagger.json b/generation/swagger.json index a078b172..76983ee1 100644 --- a/generation/swagger.json +++ b/generation/swagger.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "ShipEngine API", - "version": "1.1.202410032110", + "version": "1.1.202410081510", "termsOfService": "https://www.shipengine.com/terms-of-service/", "x-logo": { "url": "https://shipengine.github.io/img/shipengine-logo-square.png", @@ -5619,6 +5619,30 @@ "example": "Body of request cannot be null.", "minLength": 1, "description": "An error message associated with the failed API call" + }, + "carrier_id": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/se_id" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error." + }, + "carrier_code": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/carrier_code" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n" + }, + "field_name": { + "type": "string", + "readOnly": true, + "example": "shipment.ship_to.phone_number", + "description": "The name of the field that caused the error" } } }, @@ -5703,6 +5727,22 @@ ], "description": "The error code specified for the failed API Call" }, + "se_id": { + "title": "se_id", + "type": "string", + "minLength": 1, + "maxLength": 25, + "pattern": "^se(-[a-z0-9]+)+$", + "example": "se-28529731", + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc." + }, + "carrier_code": { + "title": "carrier_code", + "type": "string", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "example": "dhl_express", + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n" + }, "list_account_settings_images_response_body": { "title": "list_account_settings_images_response_body", "allOf": [ @@ -6876,15 +6916,6 @@ ], "description": "The possible file formats in which shipping labels can be downloaded. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats.\n\n|Label Format | Supported Carriers\n|--------------|-----------------------------------\n|`pdf` | All carriers\n|`png` | `fedex`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n" }, - "se_id": { - "title": "se_id", - "type": "string", - "minLength": 1, - "maxLength": 25, - "pattern": "^se(-[a-z0-9]+)+$", - "example": "se-28529731", - "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc." - }, "label_download": { "title": "label_download", "type": "object", @@ -7462,13 +7493,6 @@ } } }, - "carrier_code": { - "title": "carrier_code", - "type": "string", - "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", - "example": "dhl_express", - "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n" - }, "service": { "title": "service", "type": "object", diff --git a/openapitools.json b/openapitools.json index f0926ab5..96e27773 100644 --- a/openapitools.json +++ b/openapitools.json @@ -14,7 +14,7 @@ "ignoreFileOverride": "./.openapi-generator-ignore", "library": "generichost", "additionalProperties": { - "packageVersion": "3.0.0-beta.12", + "packageVersion": "3.0.0-beta.14", "targetFramework": "netstandard2.0", "validatable": false, "sourceFolder": "", diff --git a/package.json b/package.json index 5460c402..2cbe71e0 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "shipengine-dotnet", - "version": "3.0.0-beta.12", + "version": "3.0.0-beta.14", "description": "Package primarily used to generate the API and models from OpenApi spec\"", "main": "index.js", "directories": { From e4146a5f2ec7a11327760858ccc839c02e48f2ce Mon Sep 17 00:00:00 2001 From: Joshua Flanagan Date: Wed, 9 Oct 2024 17:44:17 -0500 Subject: [PATCH 30/42] Updated for latest spec Allow arbitrary values in advanced_options. Fix properties that were incorrectly marked as required. --- .openapi-generator/FILES | 3 + ShipEngineSDK.Test/SerializationTests.cs | 43 +- ShipEngineSDK/Model/Address.cs | 76 +- .../Model/AdvancedShipmentOptions.cs | 7 + .../Model/CalculateRatesRequestBody.cs | 26 +- ShipEngineSDK/Model/CreateLabelRequestBody.cs | 361 +--- ShipEngineSDK/Model/LabelRequest.cs | 153 ++ ShipEngineSDK/Model/RateShipmentRequest.cs | 61 + ShipEngineSDK/Model/ShipmentRequest.cs | 188 ++- ShipEngineSDK/Model/ShippingAddress.cs | 78 +- ShipEngineSDK/Model/ShippingAddressFrom.cs | 190 +++ ShipEngineSDK/Model/ShippingAddressTo.cs | 80 +- generation/swagger.json | 1450 ++++++++++------- 13 files changed, 1628 insertions(+), 1088 deletions(-) create mode 100644 ShipEngineSDK/Model/LabelRequest.cs create mode 100644 ShipEngineSDK/Model/RateShipmentRequest.cs create mode 100644 ShipEngineSDK/Model/ShippingAddressFrom.cs diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 4a283927..baf157d5 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -185,6 +185,7 @@ ShipEngineSDK/Model/LabelLayout.cs ShipEngineSDK/Model/LabelMessages.cs ShipEngineSDK/Model/LabelPackage.cs ShipEngineSDK/Model/LabelPackagesInner.cs +ShipEngineSDK/Model/LabelRequest.cs ShipEngineSDK/Model/LabelStatus.cs ShipEngineSDK/Model/Link.cs ShipEngineSDK/Model/ListAccountImagesResponseBody.cs @@ -259,6 +260,7 @@ ShipEngineSDK/Model/RateRequestOptions.cs ShipEngineSDK/Model/RateRequestRateOptions.cs ShipEngineSDK/Model/RateResponse.cs ShipEngineSDK/Model/RateResponseStatus.cs +ShipEngineSDK/Model/RateShipmentRequest.cs ShipEngineSDK/Model/RateType.cs ShipEngineSDK/Model/RatesInformation.cs ShipEngineSDK/Model/ReasonCode.cs @@ -277,6 +279,7 @@ ShipEngineSDK/Model/ShipmentRequest.cs ShipEngineSDK/Model/ShipmentStatus.cs ShipEngineSDK/Model/ShipmentsSortBy.cs ShipEngineSDK/Model/ShippingAddress.cs +ShipEngineSDK/Model/ShippingAddressFrom.cs ShipEngineSDK/Model/ShippingAddressTo.cs ShipEngineSDK/Model/SmartPostHub.cs ShipEngineSDK/Model/SortDir.cs diff --git a/ShipEngineSDK.Test/SerializationTests.cs b/ShipEngineSDK.Test/SerializationTests.cs index b4200f3c..519b652c 100644 --- a/ShipEngineSDK.Test/SerializationTests.cs +++ b/ShipEngineSDK.Test/SerializationTests.cs @@ -144,7 +144,7 @@ public void WhenSerializing_ItShouldSerializeShipmentId() [Fact] public void WhenSerializing_ItShouldSerializeShipment() { - var body = new CalculateRatesRequestBody(new ShipmentRequest + var body = new CalculateRatesRequestBody(new RateShipmentRequest { Shipment = new AddressValidatingShipment { @@ -183,37 +183,14 @@ public void WhenSerializing_ItShouldSerializeShipment() var result = JsonSerializer.Serialize(body, ShipEngineClient.JsonSerializerOptions); - Assert.Equal(@"{ - ""rate_options"": { - ""carrier_ids"": [ - ""se-99999"" - ] - }, - ""shipment"": { - ""carrier_id"": ""se-88888"", - ""service_code"": ""overnight"", - ""ship_from"": { - ""address_line1"": ""123 Main St."", - ""address_residential_indicator"": ""no"", - ""city_locality"": ""St. Louis"", - ""country_code"": ""US"", - ""name"": ""John Doe"", - ""phone"": ""314-555-1234"", - ""postal_code"": ""63102"", - ""state_province"": ""MO"" - }, - ""ship_to"": { - ""address_line1"": ""456 Central"", - ""address_residential_indicator"": ""yes"", - ""city_locality"": ""St. Louis"", - ""country_code"": ""US"", - ""name"": ""Jane Doe"", - ""phone"": ""314-555-5678"", - ""postal_code"": ""63033"", - ""state_province"": ""MO"" - } - } -}", result); + // spot check some properties on the serialized value. + // comparing the serialized value to a string is too brittle, as order and indentation can change + var parsed = JsonDocument.Parse(result).RootElement; + var shipment = parsed.GetProperty("shipment"); + Assert.Equal("se-88888", shipment.GetProperty("carrier_id").GetString()); + Assert.Equal("overnight", shipment.GetProperty("service_code").GetString()); + Assert.Equal("123 Main St.", shipment.GetProperty("ship_from").GetProperty("address_line1").GetString()); + Assert.Equal("456 Central", shipment.GetProperty("ship_to").GetProperty("address_line1").GetString()); } [Fact] @@ -250,7 +227,7 @@ public void WhenDeserializing_ItShouldDeserializeShipment() var result = JsonSerializer.Deserialize(json, ShipEngineClient.JsonSerializerOptions); - Assert.NotNull(result.GetShipmentRequest()); + Assert.NotNull(result.GetRateShipmentRequest()); Assert.Contains("se-99999", result.RateOptions.CarrierIds); } } diff --git a/ShipEngineSDK/Model/Address.cs b/ShipEngineSDK/Model/Address.cs index 94615494..aae5a6a3 100644 --- a/ShipEngineSDK/Model/Address.cs +++ b/ShipEngineSDK/Model/Address.cs @@ -36,13 +36,6 @@ public partial class Address [JsonPropertyName("address_line1"), JsonPropertyOrder(1)] public required string AddressLine1 { get; set; } - /// - /// Indicates whether this is a residential address. - /// - /// Indicates whether this is a residential address. - [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(2)] - public required AddressResidentialIndicator AddressResidentialIndicator { get; set; } - /// /// The name of the city or locality /// @@ -50,19 +43,9 @@ public partial class Address /// /// Winnipeg /// - [JsonPropertyName("city_locality"), JsonPropertyOrder(3)] + [JsonPropertyName("city_locality"), JsonPropertyOrder(2)] public required string CityLocality { get; set; } - /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) - /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) - /// - /// CA - /// - [JsonPropertyName("country_code"), JsonPropertyOrder(4)] - public required string CountryCode { get; set; } - /// /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. /// @@ -70,19 +53,9 @@ public partial class Address /// /// John Doe /// - [JsonPropertyName("name"), JsonPropertyOrder(5)] + [JsonPropertyName("name"), JsonPropertyOrder(3)] public required string Name { get; set; } - /// - /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. - /// - /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. - /// - /// +1 204-253-9411 ext. 123 - /// - [JsonPropertyName("phone"), JsonPropertyOrder(6)] - public required string Phone { get; set; } - /// /// postal code /// @@ -90,7 +63,7 @@ public partial class Address /// /// 78756-3717 /// - [JsonPropertyName("postal_code"), JsonPropertyOrder(7)] + [JsonPropertyName("postal_code"), JsonPropertyOrder(4)] public required string PostalCode { get; set; } /// @@ -100,7 +73,7 @@ public partial class Address /// /// Manitoba /// - [JsonPropertyName("state_province"), JsonPropertyOrder(8)] + [JsonPropertyName("state_province"), JsonPropertyOrder(5)] public required string StateProvince { get; set; } /// @@ -110,7 +83,7 @@ public partial class Address /// /// Unit 408 /// - [JsonPropertyName("address_line2"), JsonPropertyOrder(9)] + [JsonPropertyName("address_line2"), JsonPropertyOrder(6)] public string? AddressLine2 { get; set; } /// @@ -120,9 +93,16 @@ public partial class Address /// /// Building #7 /// - [JsonPropertyName("address_line3"), JsonPropertyOrder(10)] + [JsonPropertyName("address_line3"), JsonPropertyOrder(7)] public string? AddressLine3 { get; set; } + /// + /// Indicates whether this is a residential address. + /// + /// Indicates whether this is a residential address. + [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(8)] + public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } + /// /// If this is a business address, then the company name should be specified here. /// @@ -130,9 +110,19 @@ public partial class Address /// /// The Home Depot /// - [JsonPropertyName("company_name"), JsonPropertyOrder(11)] + [JsonPropertyName("company_name"), JsonPropertyOrder(9)] public string? CompanyName { get; set; } + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// CA + /// + [JsonPropertyName("country_code"), JsonPropertyOrder(10)] + public string? CountryCode { get; set; } + /// /// Email for the address owner. /// @@ -140,9 +130,19 @@ public partial class Address /// /// example@example.com /// - [JsonPropertyName("email"), JsonPropertyOrder(12)] + [JsonPropertyName("email"), JsonPropertyOrder(11)] public string? Email { get; set; } + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// +1 204-253-9411 ext. 123 + /// + [JsonPropertyName("phone"), JsonPropertyOrder(12)] + public string? Phone { get; set; } + /// /// Returns the string presentation of the object @@ -154,17 +154,17 @@ public override string ToString() sb.Append("class Address {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); - sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); - sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Phone: ").Append(Phone).Append("\n"); sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); + sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/AdvancedShipmentOptions.cs b/ShipEngineSDK/Model/AdvancedShipmentOptions.cs index 2ceff18b..387528a5 100644 --- a/ShipEngineSDK/Model/AdvancedShipmentOptions.cs +++ b/ShipEngineSDK/Model/AdvancedShipmentOptions.cs @@ -224,6 +224,12 @@ public partial class AdvancedShipmentOptions [JsonPropertyName("windsor_framework_details"), JsonPropertyOrder(27)] public AdvancedShipmentOptionsWindsorFrameworkDetails? WindsorFrameworkDetails { get; set; } + /// + /// Gets or Sets additional properties + /// + [JsonExtensionData] + public IDictionary AdditionalProperties { get; set; } = new Dictionary(); + /// /// Returns the string presentation of the object @@ -261,6 +267,7 @@ public override string ToString() sb.Append(" ThirdPartyConsignee: ").Append(ThirdPartyConsignee).Append("\n"); sb.Append(" UseUpsGroundFreightPricing: ").Append(UseUpsGroundFreightPricing).Append("\n"); sb.Append(" WindsorFrameworkDetails: ").Append(WindsorFrameworkDetails).Append("\n"); + sb.Append(" AdditionalProperties: ").Append(AdditionalProperties).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/CalculateRatesRequestBody.cs b/ShipEngineSDK/Model/CalculateRatesRequestBody.cs index 0d070b76..87c19cdb 100644 --- a/ShipEngineSDK/Model/CalculateRatesRequestBody.cs +++ b/ShipEngineSDK/Model/CalculateRatesRequestBody.cs @@ -50,10 +50,10 @@ public CalculateRatesRequestBody(ShipmentIdRequest actualInstance) : base("oneOf /// /// Initializes a new instance of the class - /// with the class + /// with the class /// - /// An instance of ShipmentRequest. - public CalculateRatesRequestBody(ShipmentRequest actualInstance) : base("oneOf") + /// An instance of RateShipmentRequest. + public CalculateRatesRequestBody(RateShipmentRequest actualInstance) : base("oneOf") { this.IsNullable = false; _actualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null."); @@ -77,13 +77,13 @@ public override Object ActualInstance { this._actualInstance = value; } - else if (value.GetType() == typeof(ShipmentRequest)) + else if (value.GetType() == typeof(RateShipmentRequest)) { this._actualInstance = value; } else { - throw new ArgumentException("Invalid instance found. Must be the following types: ShipmentIdRequest, ShipmentRequest"); + throw new ArgumentException("Invalid instance found. Must be the following types: ShipmentIdRequest, RateShipmentRequest"); } } } @@ -99,13 +99,13 @@ public ShipmentIdRequest GetShipmentIdRequest() } /// - /// Get the actual instance of `ShipmentRequest`. If the actual instance is not `ShipmentRequest`, + /// Get the actual instance of `RateShipmentRequest`. If the actual instance is not `RateShipmentRequest`, /// the InvalidClassException will be thrown /// - /// An instance of ShipmentRequest - public ShipmentRequest GetShipmentRequest() + /// An instance of RateShipmentRequest + public RateShipmentRequest GetRateShipmentRequest() { - return (ShipmentRequest)this.ActualInstance; + return (RateShipmentRequest)this.ActualInstance; } /// @@ -138,7 +138,7 @@ public override string ToJson() /// public class CalculateRatesRequestBodyJsonConverter : JsonConverter { - private static readonly HashSet OneOfTypes = [typeof(ShipmentIdRequest), typeof(ShipmentRequest)]; + private static readonly HashSet OneOfTypes = [typeof(ShipmentIdRequest), typeof(RateShipmentRequest)]; private static readonly HashSet MandatoryFields = ["Shipment", "ShipmentId"]; private static readonly JsonSerializerOptions DeserializingOptions = new(AbstractOpenAPISchema.SerializerSettings) { @@ -236,18 +236,18 @@ public override void Write(Utf8JsonWriter writer, CalculateRatesRequestBody valu try { - newCalculateRatesRequestBody = new CalculateRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!) + newCalculateRatesRequestBody = new CalculateRatesRequestBody(jsonDoc.Deserialize(DeserializingOptions)!) { RateOptions = rateOptions, }; - matchedTypes.Add("ShipmentRequest"); + matchedTypes.Add("RateShipmentRequest"); match++; } catch (Exception exception) { // deserialization failed, try the next one - System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into ShipmentRequest: {1}", jsonDoc, exception); + System.Diagnostics.Debug.WriteLine("Failed to deserialize `{0}` into RateShipmentRequest: {1}", jsonDoc, exception); } if (match == 0) diff --git a/ShipEngineSDK/Model/CreateLabelRequestBody.cs b/ShipEngineSDK/Model/CreateLabelRequestBody.cs index e9309ee1..759dccb0 100644 --- a/ShipEngineSDK/Model/CreateLabelRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelRequestBody.cs @@ -30,167 +30,43 @@ public partial class CreateLabelRequestBody /// The shipment information used to generate the label /// /// The shipment information used to generate the label - [JsonPropertyName("shipment"), JsonPropertyOrder(1), JsonWriteOnly] - public required Shipment Shipment { get; set; } - - /// - /// Additional information some carriers may provide by which to identify a given label in their system. - /// - /// Additional information some carriers may provide by which to identify a given label in their system. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - [JsonPropertyName("alternative_identifiers"), JsonInclude] - public List? AlternativeIdentifiers { get; set; } - - /// - /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. - /// - /// If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - /// - /// se-28529731 - /// - [JsonPropertyName("batch_id"), JsonInclude] - public string? BatchId { get; set; } - - /// - /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. - /// - /// The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - /// - /// dhl_express - /// - [JsonPropertyName("carrier_code"), JsonInclude] - public string? CarrierCode { get; set; } - - /// - /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label - /// - /// The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label - /// - /// This should not be used for input as it will be ignored on serialization. - /// - /// - /// se-28529731 - /// - [JsonPropertyName("carrier_id"), JsonInclude] - public string? CarrierId { get; set; } + [JsonPropertyName("shipment"), JsonPropertyOrder(1)] + public required ShipmentRequest Shipment { get; set; } /// /// The label charge event. /// /// The label charge event. - [JsonPropertyName("charge_event"), JsonPropertyOrder(6)] + [JsonPropertyName("charge_event"), JsonPropertyOrder(2)] public LabelChargeEvent? ChargeEvent { get; set; } - /// - /// The date and time that the label was created in ShipEngine. - /// - /// The date and time that the label was created in ShipEngine. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("created_at"), JsonInclude] - public DateTimeOffset? CreatedAt { get; set; } - /// /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme"), JsonPropertyOrder(8)] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(3)] public DisplayScheme? DisplayScheme { 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. - /// - /// 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. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - [JsonPropertyName("form_download"), JsonInclude] - public Link? FormDownload { get; set; } - - /// - /// 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. - /// - /// 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. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - [JsonPropertyName("insurance_claim"), JsonInclude] - public Link? InsuranceClaim { get; set; } - - /// - /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. - /// - /// The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - [JsonPropertyName("insurance_cost"), JsonInclude] - public MonetaryValue? InsuranceCost { get; set; } - - /// - /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. - /// - /// Indicates whether this is an international shipment. That is, the originating country and destination country are different. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - [JsonPropertyName("is_international"), JsonInclude] - public bool? IsInternational { get; set; } - /// /// 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(13)] + [JsonPropertyName("is_return_label"), JsonPropertyOrder(4)] public bool? IsReturnLabel { get; set; } - /// - /// Gets or Sets LabelDownload - /// - /// - /// This should not be used for input as it will be ignored on serialization. - /// - [JsonPropertyName("label_download"), JsonInclude] - public LabelDownload? LabelDownload { get; set; } - /// /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(15), JsonWriteOnly] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(5), 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(16)] + [JsonPropertyName("label_format"), JsonPropertyOrder(6)] public LabelFormat? LabelFormat { get; set; } - /// - /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. - /// - /// A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - /// - /// se-28529731 - /// - [JsonPropertyName("label_id"), JsonInclude] - public string? LabelId { get; set; } - /// /// The label image resource that was used to create a custom label image. /// @@ -198,14 +74,14 @@ public partial class CreateLabelRequestBody /// /// img_DtBXupDBxREpHnwEXhTfgK /// - [JsonPropertyName("label_image_id"), JsonPropertyOrder(18)] + [JsonPropertyName("label_image_id"), JsonPropertyOrder(7)] 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(19)] + [JsonPropertyName("label_layout"), JsonPropertyOrder(8)] public LabelLayout? LabelLayout { get; set; } /// @@ -215,95 +91,16 @@ public partial class CreateLabelRequestBody /// /// se-28529731 /// - [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(20), JsonWriteOnly] + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(9), JsonWriteOnly] public string? OutboundLabelId { get; set; } - /// - /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. - /// - /// The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - /// - /// small_flat_rate_box - /// - [JsonPropertyName("package_code"), JsonInclude] - public string? PackageCode { get; set; } - - /// - /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. - /// - /// The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - [JsonPropertyName("packages"), JsonInclude] - public List? Packages { get; set; } - - /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - /// - /// The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - [JsonPropertyName("paperless_download"), JsonInclude] - public PaperlessDownload? PaperlessDownload { get; set; } - - /// - /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. - /// - /// A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - [JsonPropertyName("rate_details"), JsonInclude] - public List? RateDetails { get; set; } - - /// - /// The total shipping cost for the specified comparison_rate_type. - /// - /// The total shipping cost for the specified comparison_rate_type. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - [JsonPropertyName("requested_comparison_amount"), JsonInclude] - public MonetaryValue? RequestedComparisonAmount { get; set; } - /// /// 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(26)] + [JsonPropertyName("rma_number"), JsonPropertyOrder(10)] public string? RmaNumber { get; set; } - /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. - /// - /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - /// - /// usps_first_class_mail - /// - [JsonPropertyName("service_code"), JsonInclude] - public string? ServiceCode { get; set; } - - /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. - /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - /// - /// 2018-09-23T00:00Z - /// - [JsonPropertyName("ship_date"), JsonInclude] - public DateTimeOffset? ShipDate { get; set; } - /// /// A unique identifier for a carrier drop off point where a merchant plans to deliver packages. This will take precedence over a shipment's ship from address. /// @@ -311,7 +108,7 @@ public partial class CreateLabelRequestBody /// /// 614940 /// - [JsonPropertyName("ship_from_service_point_id"), JsonPropertyOrder(29)] + [JsonPropertyName("ship_from_service_point_id"), JsonPropertyOrder(11)] public string? ShipFromServicePointId { get; set; } /// @@ -321,123 +118,22 @@ public partial class CreateLabelRequestBody /// /// 614940 /// - [JsonPropertyName("ship_to_service_point_id"), JsonPropertyOrder(30)] + [JsonPropertyName("ship_to_service_point_id"), JsonPropertyOrder(12)] public string? ShipToServicePointId { get; set; } - /// - /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - /// - /// The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - [JsonPropertyName("shipment_cost"), JsonInclude] - public MonetaryValue? ShipmentCost { get; set; } - - /// - /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) - /// - /// The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) - /// - /// This should not be used for input as it will be ignored on serialization. - /// - /// - /// se-28529731 - /// - [JsonPropertyName("shipment_id"), JsonInclude] - public string? ShipmentId { get; set; } - - /// - /// Gets or Sets Status - /// - /// - /// This should not be used for input as it will be ignored on serialization. - /// - [JsonPropertyName("status"), JsonInclude] - public LabelStatus? Status { 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(34), JsonWriteOnly, Obsolete] + [JsonPropertyName("test_label"), JsonPropertyOrder(13), JsonWriteOnly, Obsolete] public bool? TestLabel { get; set; } - /// - /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. - /// - /// Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - [JsonPropertyName("trackable"), JsonInclude] - public bool? Trackable { get; set; } - - /// - /// The tracking number for the package. Tracking number formats vary across carriers. - /// - /// The tracking number for the package. Tracking number formats vary across carriers. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - /// - /// 782758401696 - /// - [JsonPropertyName("tracking_number"), JsonInclude] - public string? TrackingNumber { get; set; } - - /// - /// The current status of the package, such as `in_transit` or `delivered` - /// - /// The current status of the package, such as `in_transit` or `delivered` - /// - /// This should not be used for input as it will be ignored on serialization. - /// - [JsonPropertyName("tracking_status"), JsonInclude] - public TrackingStatus? TrackingStatus { get; set; } - - /// - /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. - /// - /// The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. - /// - /// This should not be used for input as it will be ignored on serialization. - /// - /// - /// https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234 - /// - [JsonPropertyName("tracking_url"), JsonInclude] - public string? TrackingUrl { get; set; } - /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(39), JsonWriteOnly] + [JsonPropertyName("validate_address"), JsonPropertyOrder(14), JsonWriteOnly] public ValidateAddress? ValidateAddress { get; set; } - /// - /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) - /// - /// Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) - /// - /// This should not be used for input as it will be ignored on serialization. - /// - [JsonPropertyName("voided"), JsonInclude] - public bool? Voided { get; set; } - - /// - /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided - /// - /// The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided - /// - /// This should not be used for input as it will be ignored on serialization. - /// - /// - /// 2018-09-23T15:00Z - /// - [JsonPropertyName("voided_at"), JsonInclude] - public DateTimeOffset? VoidedAt { get; set; } - /// /// Returns the string presentation of the object @@ -449,46 +145,19 @@ public override string ToString() sb.Append("class CreateLabelRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" Shipment: ").Append(Shipment).Append("\n"); - sb.Append(" AlternativeIdentifiers: ").Append(AlternativeIdentifiers).Append("\n"); - sb.Append(" BatchId: ").Append(BatchId).Append("\n"); - sb.Append(" CarrierCode: ").Append(CarrierCode).Append("\n"); - sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); - sb.Append(" FormDownload: ").Append(FormDownload).Append("\n"); - sb.Append(" InsuranceClaim: ").Append(InsuranceClaim).Append("\n"); - sb.Append(" InsuranceCost: ").Append(InsuranceCost).Append("\n"); - sb.Append(" IsInternational: ").Append(IsInternational).Append("\n"); sb.Append(" IsReturnLabel: ").Append(IsReturnLabel).Append("\n"); - sb.Append(" LabelDownload: ").Append(LabelDownload).Append("\n"); sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); - sb.Append(" LabelId: ").Append(LabelId).Append("\n"); sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); sb.Append(" OutboundLabelId: ").Append(OutboundLabelId).Append("\n"); - sb.Append(" PackageCode: ").Append(PackageCode).Append("\n"); - sb.Append(" Packages: ").Append(Packages).Append("\n"); - sb.Append(" PaperlessDownload: ").Append(PaperlessDownload).Append("\n"); - sb.Append(" RateDetails: ").Append(RateDetails).Append("\n"); - sb.Append(" RequestedComparisonAmount: ").Append(RequestedComparisonAmount).Append("\n"); sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); - sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); - sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); sb.Append(" ShipFromServicePointId: ").Append(ShipFromServicePointId).Append("\n"); sb.Append(" ShipToServicePointId: ").Append(ShipToServicePointId).Append("\n"); - sb.Append(" ShipmentCost: ").Append(ShipmentCost).Append("\n"); - sb.Append(" ShipmentId: ").Append(ShipmentId).Append("\n"); - sb.Append(" Status: ").Append(Status).Append("\n"); sb.Append(" TestLabel: ").Append(TestLabel).Append("\n"); - sb.Append(" Trackable: ").Append(Trackable).Append("\n"); - sb.Append(" TrackingNumber: ").Append(TrackingNumber).Append("\n"); - sb.Append(" TrackingStatus: ").Append(TrackingStatus).Append("\n"); - sb.Append(" TrackingUrl: ").Append(TrackingUrl).Append("\n"); sb.Append(" ValidateAddress: ").Append(ValidateAddress).Append("\n"); - sb.Append(" Voided: ").Append(Voided).Append("\n"); - sb.Append(" VoidedAt: ").Append(VoidedAt).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/LabelRequest.cs b/ShipEngineSDK/Model/LabelRequest.cs new file mode 100644 index 00000000..85c5eed5 --- /dev/null +++ b/ShipEngineSDK/Model/LabelRequest.cs @@ -0,0 +1,153 @@ +// +// 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 label represents the physical sticker that you affix to a package to ship it. ShipEngine makes it easy for you to [create labels](https://www.shipengine.com/docs/labels/create-a-label/) and then download them in PDF, PNG, or ZPL format so you can print them. +/// +public partial class LabelRequest +{ + + /// + /// The label charge event. + /// + /// The label charge event. + [JsonPropertyName("charge_event"), JsonPropertyOrder(1)] + public LabelChargeEvent? ChargeEvent { get; set; } + + /// + /// The display format that the label should be shown in. + /// + /// The display format that the label should be shown in. + [JsonPropertyName("display_scheme"), JsonPropertyOrder(2)] + public DisplayScheme? DisplayScheme { get; set; } + + /// + /// 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(3)] + public bool? IsReturnLabel { get; set; } + + /// + /// Gets or Sets LabelDownloadType + /// + [JsonPropertyName("label_download_type"), JsonPropertyOrder(4), 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(5)] + public LabelFormat? LabelFormat { get; set; } + + /// + /// The label image resource that was used to create a custom label image. + /// + /// The label image resource that was used to create a custom label image. + /// + /// img_DtBXupDBxREpHnwEXhTfgK + /// + [JsonPropertyName("label_image_id"), JsonPropertyOrder(6)] + 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(7)] + public LabelLayout? LabelLayout { get; set; } + + /// + /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. + /// + /// The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. + /// + /// se-28529731 + /// + [JsonPropertyName("outbound_label_id"), JsonPropertyOrder(8), JsonWriteOnly] + public string? OutboundLabelId { get; set; } + + /// + /// 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(9)] + public string? RmaNumber { get; set; } + + /// + /// The shipment information used to generate the label + /// + /// The shipment information used to generate the label + [JsonPropertyName("shipment"), JsonPropertyOrder(10)] + public ShipmentRequest? 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(11), JsonWriteOnly, Obsolete] + public bool? TestLabel { get; set; } + + /// + /// Gets or Sets ValidateAddress + /// + [JsonPropertyName("validate_address"), JsonPropertyOrder(12), JsonWriteOnly] + public ValidateAddress? ValidateAddress { 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 LabelRequest {\n"); +#pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" ChargeEvent: ").Append(ChargeEvent).Append("\n"); + sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); + sb.Append(" IsReturnLabel: ").Append(IsReturnLabel).Append("\n"); + sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); + sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); + sb.Append(" LabelImageId: ").Append(LabelImageId).Append("\n"); + sb.Append(" LabelLayout: ").Append(LabelLayout).Append("\n"); + sb.Append(" OutboundLabelId: ").Append(OutboundLabelId).Append("\n"); + sb.Append(" RmaNumber: ").Append(RmaNumber).Append("\n"); + sb.Append(" Shipment: ").Append(Shipment).Append("\n"); + sb.Append(" TestLabel: ").Append(TestLabel).Append("\n"); + sb.Append(" ValidateAddress: ").Append(ValidateAddress).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/RateShipmentRequest.cs b/ShipEngineSDK/Model/RateShipmentRequest.cs new file mode 100644 index 00000000..44a78444 --- /dev/null +++ b/ShipEngineSDK/Model/RateShipmentRequest.cs @@ -0,0 +1,61 @@ +// +// 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; + +/// +/// RateShipmentRequest +/// +public partial class RateShipmentRequest +{ + + /// + /// The shipment object + /// + /// The shipment object + [JsonPropertyName("shipment"), JsonPropertyOrder(1)] + public AddressValidatingShipment? Shipment { 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 RateShipmentRequest {\n"); +#pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" Shipment: ").Append(Shipment).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/ShipmentRequest.cs b/ShipEngineSDK/Model/ShipmentRequest.cs index 54c0f9ed..bb387a51 100644 --- a/ShipEngineSDK/Model/ShipmentRequest.cs +++ b/ShipEngineSDK/Model/ShipmentRequest.cs @@ -21,17 +21,173 @@ namespace ShipEngineSDK.Model; /// -/// ShipmentRequest +/// The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight. > **Note:** Either `ship_from` or `warehouse_id` must be set. /// public partial class ShipmentRequest { /// - /// The shipment object + /// The carrier account that is billed for the shipping charges /// - /// The shipment object - [JsonPropertyName("shipment"), JsonPropertyOrder(1)] - public AddressValidatingShipment? Shipment { get; set; } + /// The carrier account that is billed for the shipping charges + /// + /// se-28529731 + /// + [JsonPropertyName("carrier_id"), JsonPropertyOrder(1)] + public required string CarrierId { get; set; } + + /// + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + /// + /// The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. + [JsonPropertyName("packages"), JsonPropertyOrder(2)] + public required List Packages { get; set; } + + /// + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. + /// + /// usps_first_class_mail + /// + [JsonPropertyName("service_code"), JsonPropertyOrder(3)] + public required string ServiceCode { get; set; } + + /// + /// The recipient's mailing address + /// + /// The recipient's mailing address + [JsonPropertyName("ship_to"), JsonPropertyOrder(4)] + public required ShippingAddressTo ShipTo { get; set; } + + /// + /// Advanced shipment options. These are entirely optional. + /// + /// Advanced shipment options. These are entirely optional. + [JsonPropertyName("advanced_options"), JsonPropertyOrder(5)] + public AdvancedShipmentOptions? AdvancedOptions { get; set; } + + /// + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// + /// Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. + /// + /// retail + /// + [JsonPropertyName("comparison_rate_type"), JsonPropertyOrder(6)] + public string? ComparisonRateType { 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"), JsonPropertyOrder(7)] + public DeliveryConfirmation? Confirmation { get; set; } + + /// + /// Customs information. This is usually only needed for international shipments. + /// + /// Customs information. This is usually only needed for international shipments. + [JsonPropertyName("customs"), JsonPropertyOrder(8)] + public InternationalShipmentOptions? Customs { get; set; } + + /// + /// ID that the Order Source assigned + /// + /// ID that the Order Source assigned + [JsonPropertyName("external_order_id"), JsonPropertyOrder(9)] + public string? ExternalOrderId { get; set; } + + /// + /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. + /// + /// A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. + [JsonPropertyName("external_shipment_id"), JsonPropertyOrder(10)] + public string? ExternalShipmentId { get; set; } + + /// + /// The insurance provider to use for any insured packages in the shipment. + /// + /// The insurance provider to use for any insured packages in the shipment. + [JsonPropertyName("insurance_provider"), JsonPropertyOrder(11)] + public InsuranceProvider? InsuranceProvider { get; set; } + + /// + /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. + /// + /// An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. + [JsonPropertyName("is_return"), JsonPropertyOrder(12)] + public bool? IsReturn { get; set; } + + /// + /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources + /// + /// Describe the packages included in this shipment as related to potential metadata that was imported from external order sources + [JsonPropertyName("items"), JsonPropertyOrder(13)] + public List? Items { get; set; } + + /// + /// Gets or Sets OrderSourceCode + /// + [JsonPropertyName("order_source_code"), JsonPropertyOrder(14)] + public OrderSourceName? OrderSourceCode { get; set; } + + /// + /// The return address for this shipment. Defaults to the `ship_from` address. + /// + /// The return address for this shipment. Defaults to the `ship_from` address. + [JsonPropertyName("return_to"), JsonPropertyOrder(15)] + public ShippingAddress? ReturnTo { get; set; } + + /// + /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// + /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// + /// 2018-09-23T00:00Z + /// + [JsonPropertyName("ship_date"), JsonPropertyOrder(16)] + public DateTimeOffset? ShipDate { get; set; } + + /// + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. + /// + /// The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. + [JsonPropertyName("ship_from"), JsonPropertyOrder(17)] + public ShippingAddressFrom? ShipFrom { get; set; } + + /// + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. + /// + /// A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. + [JsonPropertyName("shipment_number"), JsonPropertyOrder(18)] + public string? ShipmentNumber { get; set; } + + /// + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// + /// ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment + /// + /// se-28529731 + /// + [JsonPropertyName("shipping_rule_id"), JsonPropertyOrder(19)] + public string? ShippingRuleId { get; set; } + + /// + /// Gets or Sets TaxIdentifiers + /// + [JsonPropertyName("tax_identifiers"), JsonPropertyOrder(20)] + public List? TaxIdentifiers { get; set; } + + /// + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// + /// The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. + /// + /// se-28529731 + /// + [JsonPropertyName("warehouse_id"), JsonPropertyOrder(21)] + public string? WarehouseId { get; set; } /// @@ -43,7 +199,27 @@ public override string ToString() var sb = new StringBuilder(); sb.Append("class ShipmentRequest {\n"); #pragma warning disable CS0612 // Type or member is obsolete - sb.Append(" Shipment: ").Append(Shipment).Append("\n"); + sb.Append(" CarrierId: ").Append(CarrierId).Append("\n"); + sb.Append(" Packages: ").Append(Packages).Append("\n"); + sb.Append(" ServiceCode: ").Append(ServiceCode).Append("\n"); + sb.Append(" ShipTo: ").Append(ShipTo).Append("\n"); + sb.Append(" AdvancedOptions: ").Append(AdvancedOptions).Append("\n"); + sb.Append(" ComparisonRateType: ").Append(ComparisonRateType).Append("\n"); + sb.Append(" Confirmation: ").Append(Confirmation).Append("\n"); + sb.Append(" Customs: ").Append(Customs).Append("\n"); + sb.Append(" ExternalOrderId: ").Append(ExternalOrderId).Append("\n"); + sb.Append(" ExternalShipmentId: ").Append(ExternalShipmentId).Append("\n"); + sb.Append(" InsuranceProvider: ").Append(InsuranceProvider).Append("\n"); + sb.Append(" IsReturn: ").Append(IsReturn).Append("\n"); + sb.Append(" Items: ").Append(Items).Append("\n"); + sb.Append(" OrderSourceCode: ").Append(OrderSourceCode).Append("\n"); + sb.Append(" ReturnTo: ").Append(ReturnTo).Append("\n"); + sb.Append(" ShipDate: ").Append(ShipDate).Append("\n"); + sb.Append(" ShipFrom: ").Append(ShipFrom).Append("\n"); + sb.Append(" ShipmentNumber: ").Append(ShipmentNumber).Append("\n"); + sb.Append(" ShippingRuleId: ").Append(ShippingRuleId).Append("\n"); + sb.Append(" TaxIdentifiers: ").Append(TaxIdentifiers).Append("\n"); + sb.Append(" WarehouseId: ").Append(WarehouseId).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ShippingAddress.cs b/ShipEngineSDK/Model/ShippingAddress.cs index 7a318328..e2d5e938 100644 --- a/ShipEngineSDK/Model/ShippingAddress.cs +++ b/ShipEngineSDK/Model/ShippingAddress.cs @@ -36,13 +36,6 @@ public partial class ShippingAddress [JsonPropertyName("address_line1"), JsonPropertyOrder(1)] public required string AddressLine1 { get; set; } - /// - /// Indicates whether this is a residential address. - /// - /// Indicates whether this is a residential address. - [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(2)] - public required AddressResidentialIndicator AddressResidentialIndicator { get; set; } - /// /// The name of the city or locality /// @@ -50,19 +43,9 @@ public partial class ShippingAddress /// /// Winnipeg /// - [JsonPropertyName("city_locality"), JsonPropertyOrder(3)] + [JsonPropertyName("city_locality"), JsonPropertyOrder(2)] public required string CityLocality { get; set; } - /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) - /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) - /// - /// CA - /// - [JsonPropertyName("country_code"), JsonPropertyOrder(4)] - public required string CountryCode { get; set; } - /// /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. /// @@ -70,19 +53,9 @@ public partial class ShippingAddress /// /// John Doe /// - [JsonPropertyName("name"), JsonPropertyOrder(5)] + [JsonPropertyName("name"), JsonPropertyOrder(3)] public required string Name { get; set; } - /// - /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. - /// - /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. - /// - /// +1 204-253-9411 ext. 123 - /// - [JsonPropertyName("phone"), JsonPropertyOrder(6)] - public required string Phone { get; set; } - /// /// postal code /// @@ -90,7 +63,7 @@ public partial class ShippingAddress /// /// 78756-3717 /// - [JsonPropertyName("postal_code"), JsonPropertyOrder(7)] + [JsonPropertyName("postal_code"), JsonPropertyOrder(4)] public required string PostalCode { get; set; } /// @@ -100,7 +73,7 @@ public partial class ShippingAddress /// /// Manitoba /// - [JsonPropertyName("state_province"), JsonPropertyOrder(8)] + [JsonPropertyName("state_province"), JsonPropertyOrder(5)] public required string StateProvince { get; set; } /// @@ -110,7 +83,7 @@ public partial class ShippingAddress /// /// Unit 408 /// - [JsonPropertyName("address_line2"), JsonPropertyOrder(9)] + [JsonPropertyName("address_line2"), JsonPropertyOrder(6)] public string? AddressLine2 { get; set; } /// @@ -120,9 +93,16 @@ public partial class ShippingAddress /// /// Building #7 /// - [JsonPropertyName("address_line3"), JsonPropertyOrder(10)] + [JsonPropertyName("address_line3"), JsonPropertyOrder(7)] public string? AddressLine3 { get; set; } + /// + /// Indicates whether this is a residential address. + /// + /// Indicates whether this is a residential address. + [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(8)] + public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } + /// /// If this is a business address, then the company name should be specified here. /// @@ -130,9 +110,19 @@ public partial class ShippingAddress /// /// The Home Depot /// - [JsonPropertyName("company_name"), JsonPropertyOrder(11)] + [JsonPropertyName("company_name"), JsonPropertyOrder(9)] public string? CompanyName { get; set; } + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// CA + /// + [JsonPropertyName("country_code"), JsonPropertyOrder(10)] + public string? CountryCode { get; set; } + /// /// Email for the address owner. /// @@ -140,16 +130,26 @@ public partial class ShippingAddress /// /// example@example.com /// - [JsonPropertyName("email"), JsonPropertyOrder(12)] + [JsonPropertyName("email"), JsonPropertyOrder(11)] public string? Email { get; set; } /// /// Additional text about how to handle the shipment at this address. /// /// Additional text about how to handle the shipment at this address. - [JsonPropertyName("instructions"), JsonPropertyOrder(13)] + [JsonPropertyName("instructions"), JsonPropertyOrder(12)] public string? Instructions { get; set; } + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// +1 204-253-9411 ext. 123 + /// + [JsonPropertyName("phone"), JsonPropertyOrder(13)] + public string? Phone { get; set; } + /// /// Returns the string presentation of the object @@ -161,18 +161,18 @@ public override string ToString() sb.Append("class ShippingAddress {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); - sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); - sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Phone: ").Append(Phone).Append("\n"); sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); + sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); sb.Append(" Email: ").Append(Email).Append("\n"); sb.Append(" Instructions: ").Append(Instructions).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/ShipEngineSDK/Model/ShippingAddressFrom.cs b/ShipEngineSDK/Model/ShippingAddressFrom.cs new file mode 100644 index 00000000..43f5da0e --- /dev/null +++ b/ShipEngineSDK/Model/ShippingAddressFrom.cs @@ -0,0 +1,190 @@ +// +// 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; + +/// +/// ShippingAddressFrom +/// +public partial class ShippingAddressFrom +{ + + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. + /// + /// 1999 Bishop Grandin Blvd. + /// + [JsonPropertyName("address_line1"), JsonPropertyOrder(1)] + public required string AddressLine1 { get; set; } + + /// + /// The name of the city or locality + /// + /// The name of the city or locality + /// + /// Winnipeg + /// + [JsonPropertyName("city_locality"), JsonPropertyOrder(2)] + public required string CityLocality { get; set; } + + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// CA + /// + [JsonPropertyName("country_code"), JsonPropertyOrder(3)] + public required string CountryCode { get; set; } + + /// + /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. + /// + /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. + /// + /// John Doe + /// + [JsonPropertyName("name"), JsonPropertyOrder(4)] + public required string Name { get; set; } + + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// +1 204-253-9411 ext. 123 + /// + [JsonPropertyName("phone"), JsonPropertyOrder(5)] + public required string Phone { get; set; } + + /// + /// postal code + /// + /// postal code + /// + /// 78756-3717 + /// + [JsonPropertyName("postal_code"), JsonPropertyOrder(6)] + public required string PostalCode { get; set; } + + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. + /// + /// Manitoba + /// + [JsonPropertyName("state_province"), JsonPropertyOrder(7)] + public required string StateProvince { get; set; } + + /// + /// The second line of the street address. For some addresses, this line may not be needed. + /// + /// The second line of the street address. For some addresses, this line may not be needed. + /// + /// Unit 408 + /// + [JsonPropertyName("address_line2"), JsonPropertyOrder(8)] + public string? AddressLine2 { get; set; } + + /// + /// The third line of the street address. For some addresses, this line may not be needed. + /// + /// The third line of the street address. For some addresses, this line may not be needed. + /// + /// Building #7 + /// + [JsonPropertyName("address_line3"), JsonPropertyOrder(9)] + public string? AddressLine3 { get; set; } + + /// + /// Indicates whether this is a residential address. + /// + /// Indicates whether this is a residential address. + [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(10)] + public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } + + /// + /// If this is a business address, then the company name should be specified here. + /// + /// If this is a business address, then the company name should be specified here. + /// + /// The Home Depot + /// + [JsonPropertyName("company_name"), JsonPropertyOrder(11)] + public string? CompanyName { get; set; } + + /// + /// Email for the address owner. + /// + /// Email for the address owner. + /// + /// example@example.com + /// + [JsonPropertyName("email"), JsonPropertyOrder(12)] + public string? Email { get; set; } + + /// + /// Additional text about how to handle the shipment at this address. + /// + /// Additional text about how to handle the shipment at this address. + [JsonPropertyName("instructions"), JsonPropertyOrder(13)] + public string? Instructions { 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 ShippingAddressFrom {\n"); +#pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); + sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); + sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); + sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); + sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); + sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); + sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); + sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" Email: ").Append(Email).Append("\n"); + sb.Append(" Instructions: ").Append(Instructions).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/ShippingAddressTo.cs b/ShipEngineSDK/Model/ShippingAddressTo.cs index 837a413c..a5b2db68 100644 --- a/ShipEngineSDK/Model/ShippingAddressTo.cs +++ b/ShipEngineSDK/Model/ShippingAddressTo.cs @@ -36,13 +36,6 @@ public partial class ShippingAddressTo [JsonPropertyName("address_line1"), JsonPropertyOrder(1)] public required string AddressLine1 { get; set; } - /// - /// Indicates whether this is a residential address. - /// - /// Indicates whether this is a residential address. - [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(2)] - public required AddressResidentialIndicator AddressResidentialIndicator { get; set; } - /// /// The name of the city or locality /// @@ -50,19 +43,9 @@ public partial class ShippingAddressTo /// /// Winnipeg /// - [JsonPropertyName("city_locality"), JsonPropertyOrder(3)] + [JsonPropertyName("city_locality"), JsonPropertyOrder(2)] public required string CityLocality { get; set; } - /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) - /// - /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) - /// - /// CA - /// - [JsonPropertyName("country_code"), JsonPropertyOrder(4)] - public required string CountryCode { get; set; } - /// /// The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. /// @@ -70,19 +53,9 @@ public partial class ShippingAddressTo /// /// John Doe /// - [JsonPropertyName("name"), JsonPropertyOrder(5)] + [JsonPropertyName("name"), JsonPropertyOrder(3)] public required string Name { get; set; } - /// - /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. - /// - /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. - /// - /// +1 204-253-9411 ext. 123 - /// - [JsonPropertyName("phone"), JsonPropertyOrder(6)] - public required string Phone { get; set; } - /// /// postal code /// @@ -90,7 +63,7 @@ public partial class ShippingAddressTo /// /// 78756-3717 /// - [JsonPropertyName("postal_code"), JsonPropertyOrder(7)] + [JsonPropertyName("postal_code"), JsonPropertyOrder(4)] public required string PostalCode { get; set; } /// @@ -100,7 +73,7 @@ public partial class ShippingAddressTo /// /// Manitoba /// - [JsonPropertyName("state_province"), JsonPropertyOrder(8)] + [JsonPropertyName("state_province"), JsonPropertyOrder(5)] public required string StateProvince { get; set; } /// @@ -110,7 +83,7 @@ public partial class ShippingAddressTo /// /// Unit 408 /// - [JsonPropertyName("address_line2"), JsonPropertyOrder(9)] + [JsonPropertyName("address_line2"), JsonPropertyOrder(6)] public string? AddressLine2 { get; set; } /// @@ -120,9 +93,16 @@ public partial class ShippingAddressTo /// /// Building #7 /// - [JsonPropertyName("address_line3"), JsonPropertyOrder(10)] + [JsonPropertyName("address_line3"), JsonPropertyOrder(7)] public string? AddressLine3 { get; set; } + /// + /// Indicates whether this is a residential address. + /// + /// Indicates whether this is a residential address. + [JsonPropertyName("address_residential_indicator"), JsonPropertyOrder(8)] + public AddressResidentialIndicator? AddressResidentialIndicator { get; set; } + /// /// If this is a business address, then the company name should be specified here. /// @@ -130,9 +110,19 @@ public partial class ShippingAddressTo /// /// The Home Depot /// - [JsonPropertyName("company_name"), JsonPropertyOrder(11)] + [JsonPropertyName("company_name"), JsonPropertyOrder(9)] public string? CompanyName { get; set; } + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) + /// + /// CA + /// + [JsonPropertyName("country_code"), JsonPropertyOrder(10)] + public string? CountryCode { get; set; } + /// /// Email for the address owner. /// @@ -140,22 +130,32 @@ public partial class ShippingAddressTo /// /// example@example.com /// - [JsonPropertyName("email"), JsonPropertyOrder(12)] + [JsonPropertyName("email"), JsonPropertyOrder(11)] public string? Email { get; set; } /// /// Gets or Sets Geolocation /// - [JsonPropertyName("geolocation"), JsonPropertyOrder(13)] + [JsonPropertyName("geolocation"), JsonPropertyOrder(12)] public List? Geolocation { get; set; } /// /// Additional text about how to handle the shipment at this address. /// /// Additional text about how to handle the shipment at this address. - [JsonPropertyName("instructions"), JsonPropertyOrder(14)] + [JsonPropertyName("instructions"), JsonPropertyOrder(13)] public string? Instructions { get; set; } + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// The phone number of a contact person at this address. The format of this phone number varies depending on the country. + /// + /// +1 204-253-9411 ext. 123 + /// + [JsonPropertyName("phone"), JsonPropertyOrder(14)] + public string? Phone { get; set; } + /// /// Returns the string presentation of the object @@ -167,19 +167,19 @@ public override string ToString() sb.Append("class ShippingAddressTo {\n"); #pragma warning disable CS0612 // Type or member is obsolete sb.Append(" AddressLine1: ").Append(AddressLine1).Append("\n"); - sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); sb.Append(" CityLocality: ").Append(CityLocality).Append("\n"); - sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Phone: ").Append(Phone).Append("\n"); sb.Append(" PostalCode: ").Append(PostalCode).Append("\n"); sb.Append(" StateProvince: ").Append(StateProvince).Append("\n"); sb.Append(" AddressLine2: ").Append(AddressLine2).Append("\n"); sb.Append(" AddressLine3: ").Append(AddressLine3).Append("\n"); + sb.Append(" AddressResidentialIndicator: ").Append(AddressResidentialIndicator).Append("\n"); sb.Append(" CompanyName: ").Append(CompanyName).Append("\n"); + sb.Append(" CountryCode: ").Append(CountryCode).Append("\n"); sb.Append(" Email: ").Append(Email).Append("\n"); sb.Append(" Geolocation: ").Append(Geolocation).Append("\n"); sb.Append(" Instructions: ").Append(Instructions).Append("\n"); + sb.Append(" Phone: ").Append(Phone).Append("\n"); #pragma warning restore CS0612 // Type or member is obsolete sb.Append("}\n"); return sb.ToString(); diff --git a/generation/swagger.json b/generation/swagger.json index 76983ee1..c2e6e9a6 100644 --- a/generation/swagger.json +++ b/generation/swagger.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "ShipEngine API", - "version": "1.1.202410081510", + "version": "1.1.202410092210", "termsOfService": "https://www.shipengine.com/terms-of-service/", "x-logo": { "url": "https://shipengine.github.io/img/shipengine-logo-square.png", @@ -6435,13 +6435,10 @@ "description": "Any residential or business mailing address, anywhere in the world.\n\n> **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant.\n", "required": [ "name", - "phone", "address_line1", "city_locality", "state_province", - "postal_code", - "country_code", - "address_residential_indicator" + "postal_code" ], "additionalProperties": false, "allOf": [ @@ -10247,7 +10244,7 @@ "additionalProperties": false, "allOf": [ { - "$ref": "#/components/schemas/label" + "$ref": "#/components/schemas/label_request" } ], "properties": { @@ -10265,111 +10262,20 @@ } } }, - "label": { - "title": "label", + "label_request": { + "title": "label_request", "type": "object", "description": "A label represents the physical sticker that you affix to a package to ship it. ShipEngine makes it easy for you to [create labels](https://www.shipengine.com/docs/labels/create-a-label/) and then download them in PDF, PNG, or ZPL format so you can print them.\n", "additionalProperties": false, "properties": { - "label_id": { - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/se_id" - } - ], - "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n" - }, - "status": { - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/label_status" - } - ] - }, - "shipment_id": { - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/se_id" - } - ], - "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n" - }, "shipment": { - "writeOnly": true, "allOf": [ { - "$ref": "#/components/schemas/shipment" + "$ref": "#/components/schemas/shipment_request" } ], "description": "The shipment information used to generate the label" }, - "ship_date": { - "allOf": [ - { - "$ref": "#/components/schemas/date" - } - ], - "readOnly": true, - "description": "The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\n" - }, - "created_at": { - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/date_time" - } - ], - "description": "The date and time that the label was created in ShipEngine." - }, - "shipment_cost": { - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/monetary_value" - } - ], - "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n" - }, - "insurance_cost": { - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/monetary_value" - } - ], - "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n" - }, - "requested_comparison_amount": { - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/monetary_value" - } - ], - "description": "The total shipping cost for the specified comparison_rate_type.\n" - }, - "rate_details": { - "readOnly": true, - "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", - "type": "array", - "items": { - "allOf": [ - { - "$ref": "#/components/schemas/rate_detail" - } - ] - } - }, - "tracking_number": { - "type": "string", - "minLength": 1, - "readOnly": true, - "example": "782758401696", - "description": "The tracking number for the package. Tracking number formats vary across carriers." - }, "is_return_label": { "type": "boolean", "description": "Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned.\n" @@ -10379,29 +10285,6 @@ "nullable": true, "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n" }, - "is_international": { - "type": "boolean", - "readOnly": true, - "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n" - }, - "batch_id": { - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/se_id" - } - ], - "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n" - }, - "carrier_id": { - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/se_id" - } - ], - "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n" - }, "charge_event": { "allOf": [ { @@ -10419,15 +10302,6 @@ "writeOnly": true, "description": "The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is\nrequired by some carriers.\n" }, - "service_code": { - "allOf": [ - { - "$ref": "#/components/schemas/service_code" - } - ], - "readOnly": true, - "description": "The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\n" - }, "test_label": { "writeOnly": true, "type": "boolean", @@ -10435,15 +10309,6 @@ "deprecated": true, "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account." }, - "package_code": { - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/package_code" - } - ], - "description": "The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type.\n" - }, "validate_address": { "writeOnly": true, "default": "validate_and_clean", @@ -10453,21 +10318,6 @@ } ] }, - "voided": { - "type": "boolean", - "readOnly": true, - "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n" - }, - "voided_at": { - "nullable": true, - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/date_time" - } - ], - "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n" - }, "label_download_type": { "writeOnly": true, "default": "url", @@ -10504,11 +10354,6 @@ ], "description": "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.\n" }, - "trackable": { - "type": "boolean", - "readOnly": true, - "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n" - }, "label_image_id": { "nullable": true, "allOf": [ @@ -10517,201 +10362,80 @@ } ], "description": "The label image resource that was used to create a custom label image." - }, - "carrier_code": { - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/carrier_code" - } - ], - "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n" - }, - "tracking_status": { - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/tracking_status" - } - ], - "description": "The current status of the package, such as `in_transit` or `delivered`" - }, - "label_download": { + } + } + }, + "shipment_request": { + "title": "shipment_request", + "type": "object", + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n\n> **Note:** Either `ship_from` or `warehouse_id` must be set.\n", + "required": [ + "carrier_id", + "service_code", + "ship_to", + "packages" + ], + "additionalProperties": false, + "properties": { + "carrier_id": { "allOf": [ { - "$ref": "#/components/schemas/label_download" + "$ref": "#/components/schemas/se_id" } ], - "readOnly": true + "description": "The carrier account that is billed for the shipping charges" }, - "form_download": { - "readOnly": true, - "nullable": true, + "service_code": { "allOf": [ { - "$ref": "#/components/schemas/link" + "$ref": "#/components/schemas/service_code" } ], - "description": "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.\n" + "description": "The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\n" }, - "paperless_download": { - "readOnly": true, - "nullable": true, + "shipping_rule_id": { "allOf": [ { - "$ref": "#/components/schemas/paperless_download" + "$ref": "#/components/schemas/se_id" } ], - "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n" + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" }, - "insurance_claim": { - "readOnly": true, + "external_order_id": { + "type": "string", "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/link" - } - ], - "description": "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.\n" + "description": "ID that the Order Source assigned" }, - "packages": { + "items": { "type": "array", - "readOnly": true, - "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "default": [], "items": { "allOf": [ { - "$ref": "#/components/schemas/label_package" - }, - { - "$ref": "#/components/schemas/alternative_identifiers" + "$ref": "#/components/schemas/shipment_item" } ] - } + }, + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n" }, - "alternative_identifiers": { + "tax_identifiers": { "type": "array", - "readOnly": true, "nullable": true, - "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", "items": { - "$ref": "#/components/schemas/alternative_identifier" + "allOf": [ + { + "$ref": "#/components/schemas/tax_identifier" + } + ] } }, - "tracking_url": { - "readOnly": true, + "external_shipment_id": { + "type": "string", + "maxLength": 50, "nullable": true, - "type": "string", - "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", - "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n" - } - } - }, - "shipment": { - "title": "shipment", - "type": "object", - "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n\n> **Note:** Either `ship_from` or `warehouse_id` must be set.\n", - "required": [ - "shipment_id", - "carrier_id", - "service_code", - "ship_date", - "created_at", - "modified_at", - "shipment_status", - "ship_to", - "ship_from", - "warehouse_id", - "return_to", - "confirmation", - "customs", - "advanced_options", - "insurance_provider", - "tags", - "packages", - "total_weight" - ], - "additionalProperties": false, - "allOf": [ - { - "$ref": "#/components/schemas/partial_shipment" - } - ] - }, - "partial_shipment": { - "title": "partial_shipment", - "type": "object", - "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", - "additionalProperties": false, - "properties": { - "shipment_id": { - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/se_id" - } - ], - "description": "A string that uniquely identifies the shipment" - }, - "carrier_id": { - "allOf": [ - { - "$ref": "#/components/schemas/se_id" - } - ], - "description": "The carrier account that is billed for the shipping charges" - }, - "service_code": { - "allOf": [ - { - "$ref": "#/components/schemas/service_code" - } - ], - "description": "The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\n" - }, - "shipping_rule_id": { - "allOf": [ - { - "$ref": "#/components/schemas/se_id" - } - ], - "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" - }, - "external_order_id": { - "type": "string", - "nullable": true, - "description": "ID that the Order Source assigned" - }, - "items": { - "type": "array", - "default": [], - "items": { - "allOf": [ - { - "$ref": "#/components/schemas/shipment_item" - } - ] - }, - "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n" - }, - "tax_identifiers": { - "type": "array", - "nullable": true, - "items": { - "allOf": [ - { - "$ref": "#/components/schemas/tax_identifier" - } - ] - } - }, - "external_shipment_id": { - "type": "string", - "maxLength": 50, - "nullable": true, - "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n\n> **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated.\n" - }, - "shipment_number": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n\n> **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated.\n" + }, + "shipment_number": { "type": "string", "maxLength": 50, "nullable": true, @@ -10725,34 +10449,6 @@ ], "description": "The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\n" }, - "created_at": { - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/date_time" - } - ], - "description": "The date and time that the shipment was created in ShipEngine." - }, - "modified_at": { - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/date_time" - } - ], - "description": "The date and time that the shipment was created or last modified." - }, - "shipment_status": { - "readOnly": true, - "default": "pending", - "allOf": [ - { - "$ref": "#/components/schemas/shipment_status" - } - ], - "description": "The current status of the shipment" - }, "ship_to": { "allOf": [ { @@ -10764,7 +10460,7 @@ "ship_from": { "allOf": [ { - "$ref": "#/components/schemas/shipping_address" + "$ref": "#/components/schemas/shipping_address_from" } ], "description": "The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time.\n" @@ -10829,20 +10525,6 @@ ], "description": "The insurance provider to use for any insured packages in the shipment.\n" }, - "tags": { - "type": "array", - "readOnly": true, - "default": [], - "minItems": 0, - "items": { - "allOf": [ - { - "$ref": "#/components/schemas/tag" - } - ] - }, - "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n" - }, "order_source_code": { "allOf": [ { @@ -10862,15 +10544,6 @@ }, "description": "The packages in the shipment.\n\n> **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.\n" }, - "total_weight": { - "readOnly": true, - "allOf": [ - { - "$ref": "#/components/schemas/weight" - } - ], - "description": "The combined weight of all packages in the shipment" - }, "comparison_rate_type": { "nullable": true, "type": "string", @@ -11039,17 +10712,6 @@ "example": "2018-09-23T00:00:00.000Z", "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine.\n" }, - "shipment_status": { - "title": "shipment_status", - "type": "string", - "enum": [ - "pending", - "processing", - "label_purchased", - "cancelled" - ], - "description": "The possible shipment status values" - }, "shipping_address_to": { "title": "shipping_address_to", "type": "object", @@ -11098,10 +10760,14 @@ } } }, - "shipping_address": { - "title": "shipping_address", + "shipping_address_from": { + "title": "shipping_address_from", "type": "object", "additionalProperties": false, + "required": [ + "phone", + "country_code" + ], "allOf": [ { "$ref": "#/components/schemas/address" @@ -11125,6 +10791,19 @@ } } }, + "shipping_address": { + "title": "shipping_address", + "type": "object", + "additionalProperties": false, + "allOf": [ + { + "$ref": "#/components/schemas/address" + }, + { + "$ref": "#/components/schemas/partial_shipping_address" + } + ] + }, "delivery_confirmation": { "title": "delivery_confirmation", "type": "string", @@ -11506,7 +11185,7 @@ "title": "advanced_shipment_options", "type": "object", "description": "Advanced shipment options", - "additionalProperties": false, + "additionalProperties": true, "properties": { "bill_to_account": { "type": "string", @@ -11784,23 +11463,6 @@ ], "description": "The possible insurance provider values" }, - "tag": { - "title": "tag", - "type": "object", - "description": "Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.\n", - "required": [ - "name" - ], - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "minLength": 1, - "example": "Fragile", - "description": "The tag name." - } - } - }, "package": { "title": "package", "type": "object", @@ -12098,121 +11760,835 @@ "packaging_instruction": { "type": "string", "nullable": true, - "default": null, - "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container." + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container." + }, + "packaging_instruction_section": { + "$ref": "#/components/schemas/packaging_instruction_section" + }, + "packaging_type": { + "type": "string", + "nullable": true, + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good." + }, + "transport_mean": { + "$ref": "#/components/schemas/transport_mean" + }, + "transport_category": { + "type": "string", + "nullable": true, + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose." + }, + "regulation_authority": { + "type": "string", + "nullable": true, + "default": null, + "description": "Name of the regulatory authority." + }, + "regulation_level": { + "$ref": "#/components/schemas/regulation_level" + }, + "radioactive": { + "type": "boolean", + "nullable": true, + "example": false, + "description": "Indication if the substance is radioactive." + }, + "reportable_quantity": { + "type": "boolean", + "nullable": true, + "example": false, + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity." + }, + "tunnel_code": { + "type": "string", + "nullable": true, + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through" + }, + "additional_description": { + "type": "string", + "nullable": true, + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier" + } + } + }, + "packaging_group": { + "title": "packaging_group", + "type": "string", + "enum": [ + "i", + "ii", + "iii" + ] + }, + "dangerous_amount": { + "title": "dangerous_amount", + "type": "object", + "description": "This model represents the amount of the dangerous goods..", + "additionalProperties": false, + "properties": { + "amount": { + "type": "number", + "minimum": 0, + "default": 0, + "description": "The amount of dangerous goods." + }, + "unit": { + "type": "string", + "nullable": true, + "default": null, + "description": "The unit of dangerous goods." + } + } + }, + "packaging_instruction_section": { + "title": "packaging_instruction_section", + "type": "string", + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ] + }, + "transport_mean": { + "title": "transport_mean", + "type": "string", + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ] + }, + "regulation_level": { + "title": "regulation_level", + "type": "string", + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ] + }, + "label_charge_event": { + "title": "label_charge_event", + "type": "string", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "description": "Determines when the user's account will be charged for the label." + }, + "validate_address": { + "title": "validate_address", + "type": "string", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "description": "The possible validate address values" + }, + "label_download_type": { + "title": "label_download_type", + "type": "string", + "enum": [ + "url", + "inline" + ], + "description": "There are two different ways to [download a label](https://www.shipengine.com/docs/labels/downloading/):\n\n|Label Download Type | Description\n|--------------------|------------------------------\n|`url` |You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days.

This is the default if `label_download_type` is unspecified.\n|`inline` |You will receive the Base64-encoded label as part of the response. No need for a second request to download the label.\n" + }, + "create_label_response_body": { + "title": "create_label_response_body", + "type": "object", + "description": "A create label response body", + "additionalProperties": false, + "required": [ + "label_id", + "status", + "shipment_id", + "ship_date", + "created_at", + "shipment_cost", + "insurance_cost", + "tracking_number", + "is_international", + "batch_id", + "carrier_id", + "service_code", + "voided", + "voided_at", + "label_image_id", + "label_format", + "label_layout", + "trackable", + "carrier_code", + "tracking_status", + "label_download", + "form_download", + "paperless_download", + "insurance_claim", + "packages", + "is_return_label", + "rma_number", + "charge_event", + "package_code", + "display_scheme" + ], + "allOf": [ + { + "$ref": "#/components/schemas/label" + } + ] + }, + "label": { + "title": "label", + "type": "object", + "description": "A label represents the physical sticker that you affix to a package to ship it. ShipEngine makes it easy for you to [create labels](https://www.shipengine.com/docs/labels/create-a-label/) and then download them in PDF, PNG, or ZPL format so you can print them.\n", + "additionalProperties": false, + "properties": { + "label_id": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/se_id" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n" + }, + "status": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/label_status" + } + ] + }, + "shipment_id": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/se_id" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n" + }, + "shipment": { + "writeOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/shipment" + } + ], + "description": "The shipment information used to generate the label" + }, + "ship_date": { + "allOf": [ + { + "$ref": "#/components/schemas/date" + } + ], + "readOnly": true, + "description": "The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\n" + }, + "created_at": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/date_time" + } + ], + "description": "The date and time that the label was created in ShipEngine." + }, + "shipment_cost": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/monetary_value" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n" + }, + "insurance_cost": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/monetary_value" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n" + }, + "requested_comparison_amount": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/monetary_value" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n" + }, + "rate_details": { + "readOnly": true, + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/rate_detail" + } + ] + } + }, + "tracking_number": { + "type": "string", + "minLength": 1, + "readOnly": true, + "example": "782758401696", + "description": "The tracking number for the package. Tracking number formats vary across carriers." + }, + "is_return_label": { + "type": "boolean", + "description": "Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned.\n" + }, + "rma_number": { + "type": "string", + "nullable": true, + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n" + }, + "is_international": { + "type": "boolean", + "readOnly": true, + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n" + }, + "batch_id": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/se_id" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n" + }, + "carrier_id": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/se_id" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n" + }, + "charge_event": { + "allOf": [ + { + "$ref": "#/components/schemas/label_charge_event" + } + ], + "description": "The label charge event.\n" + }, + "outbound_label_id": { + "allOf": [ + { + "$ref": "#/components/schemas/se_id" + } + ], + "writeOnly": true, + "description": "The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is\nrequired by some carriers.\n" + }, + "service_code": { + "allOf": [ + { + "$ref": "#/components/schemas/service_code" + } + ], + "readOnly": true, + "description": "The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\n" + }, + "test_label": { + "writeOnly": true, + "type": "boolean", + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account." + }, + "package_code": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/package_code" + } + ], + "description": "The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type.\n" + }, + "validate_address": { + "writeOnly": true, + "default": "validate_and_clean", + "allOf": [ + { + "$ref": "#/components/schemas/validate_address" + } + ] + }, + "voided": { + "type": "boolean", + "readOnly": true, + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n" + }, + "voided_at": { + "nullable": true, + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/date_time" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n" + }, + "label_download_type": { + "writeOnly": true, + "default": "url", + "allOf": [ + { + "$ref": "#/components/schemas/label_download_type" + } + ] + }, + "label_format": { + "default": "pdf", + "allOf": [ + { + "$ref": "#/components/schemas/label_format" + } + ], + "description": "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.\n" + }, + "display_scheme": { + "default": "label", + "allOf": [ + { + "$ref": "#/components/schemas/display_scheme" + } + ], + "description": "The display format that the label should be shown in." + }, + "label_layout": { + "default": "4x6", + "allOf": [ + { + "$ref": "#/components/schemas/label_layout" + } + ], + "description": "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.\n" + }, + "trackable": { + "type": "boolean", + "readOnly": true, + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n" + }, + "label_image_id": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/image_id" + } + ], + "description": "The label image resource that was used to create a custom label image." + }, + "carrier_code": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/carrier_code" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n" + }, + "tracking_status": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/tracking_status" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`" + }, + "label_download": { + "allOf": [ + { + "$ref": "#/components/schemas/label_download" + } + ], + "readOnly": true + }, + "form_download": { + "readOnly": true, + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/link" + } + ], + "description": "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.\n" + }, + "paperless_download": { + "readOnly": true, + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/paperless_download" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n" + }, + "insurance_claim": { + "readOnly": true, + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/link" + } + ], + "description": "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.\n" + }, + "packages": { + "type": "array", + "readOnly": true, + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/label_package" + }, + { + "$ref": "#/components/schemas/alternative_identifiers" + } + ] + } + }, + "alternative_identifiers": { + "type": "array", + "readOnly": true, + "nullable": true, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "items": { + "$ref": "#/components/schemas/alternative_identifier" + } + }, + "tracking_url": { + "readOnly": true, + "nullable": true, + "type": "string", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n" + } + } + }, + "shipment": { + "title": "shipment", + "type": "object", + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n\n> **Note:** Either `ship_from` or `warehouse_id` must be set.\n", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "additionalProperties": false, + "allOf": [ + { + "$ref": "#/components/schemas/partial_shipment" + } + ] + }, + "partial_shipment": { + "title": "partial_shipment", + "type": "object", + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "additionalProperties": false, + "properties": { + "shipment_id": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/se_id" + } + ], + "description": "A string that uniquely identifies the shipment" + }, + "carrier_id": { + "allOf": [ + { + "$ref": "#/components/schemas/se_id" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "service_code": { + "allOf": [ + { + "$ref": "#/components/schemas/service_code" + } + ], + "description": "The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\n" + }, + "shipping_rule_id": { + "allOf": [ + { + "$ref": "#/components/schemas/se_id" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "external_order_id": { + "type": "string", + "nullable": true, + "description": "ID that the Order Source assigned" + }, + "items": { + "type": "array", + "default": [], + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/shipment_item" + } + ] + }, + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n" + }, + "tax_identifiers": { + "type": "array", + "nullable": true, + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/tax_identifier" + } + ] + } + }, + "external_shipment_id": { + "type": "string", + "maxLength": 50, + "nullable": true, + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n\n> **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated.\n" + }, + "shipment_number": { + "type": "string", + "maxLength": 50, + "nullable": true, + "description": "A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment.\n\n> **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated.\n" + }, + "ship_date": { + "allOf": [ + { + "$ref": "#/components/schemas/date" + } + ], + "description": "The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\n" + }, + "created_at": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/date_time" + } + ], + "description": "The date and time that the shipment was created in ShipEngine." + }, + "modified_at": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/date_time" + } + ], + "description": "The date and time that the shipment was created or last modified." + }, + "shipment_status": { + "readOnly": true, + "default": "pending", + "allOf": [ + { + "$ref": "#/components/schemas/shipment_status" + } + ], + "description": "The current status of the shipment" + }, + "ship_to": { + "allOf": [ + { + "$ref": "#/components/schemas/shipping_address_to" + } + ], + "description": "The recipient's mailing address" + }, + "ship_from": { + "allOf": [ + { + "$ref": "#/components/schemas/shipping_address" + } + ], + "description": "The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time.\n" + }, + "warehouse_id": { + "nullable": true, + "default": null, + "allOf": [ + { + "$ref": "#/components/schemas/se_id" + } + ], + "description": "The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified.\n" + }, + "return_to": { + "allOf": [ + { + "$ref": "#/components/schemas/shipping_address" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "is_return": { + "type": "boolean", + "nullable": true, + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n" }, - "packaging_instruction_section": { - "$ref": "#/components/schemas/packaging_instruction_section" + "confirmation": { + "default": "none", + "allOf": [ + { + "$ref": "#/components/schemas/delivery_confirmation" + } + ], + "description": "The type of delivery confirmation that is required for this shipment." }, - "packaging_type": { - "type": "string", + "customs": { "nullable": true, "default": null, - "description": "The type of exterior packaging used to contain the dangerous good." + "allOf": [ + { + "$ref": "#/components/schemas/international_shipment_options" + } + ], + "description": "Customs information. This is usually only needed for international shipments.\n" }, - "transport_mean": { - "$ref": "#/components/schemas/transport_mean" + "advanced_options": { + "allOf": [ + { + "$ref": "#/components/schemas/advanced_shipment_options" + } + ], + "description": "Advanced shipment options. These are entirely optional." }, - "transport_category": { - "type": "string", - "nullable": true, - "default": null, - "description": "Transport category assign to dangerous goods for the transport purpose." + "insurance_provider": { + "default": "none", + "allOf": [ + { + "$ref": "#/components/schemas/insurance_provider" + } + ], + "description": "The insurance provider to use for any insured packages in the shipment.\n" }, - "regulation_authority": { - "type": "string", - "nullable": true, - "default": null, - "description": "Name of the regulatory authority." + "tags": { + "type": "array", + "readOnly": true, + "default": [], + "minItems": 0, + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/tag" + } + ] + }, + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n" }, - "regulation_level": { - "$ref": "#/components/schemas/regulation_level" + "order_source_code": { + "allOf": [ + { + "$ref": "#/components/schemas/order_source_name" + } + ] }, - "radioactive": { - "type": "boolean", - "nullable": true, - "example": false, - "description": "Indication if the substance is radioactive." + "packages": { + "type": "array", + "minItems": 1, + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/package" + } + ] + }, + "description": "The packages in the shipment.\n\n> **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.\n" }, - "reportable_quantity": { - "type": "boolean", - "nullable": true, - "example": false, - "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity." + "total_weight": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/components/schemas/weight" + } + ], + "description": "The combined weight of all packages in the shipment" }, - "tunnel_code": { - "type": "string", + "comparison_rate_type": { "nullable": true, - "default": null, - "description": "Defines which types of tunnels the shipment is allowed to go through" - }, - "additional_description": { "type": "string", - "nullable": true, - "default": null, - "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier" + "description": "Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS.", + "example": "retail" } } }, - "packaging_group": { - "title": "packaging_group", + "shipment_status": { + "title": "shipment_status", "type": "string", "enum": [ - "i", - "ii", - "iii" - ] + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "description": "The possible shipment status values" }, - "dangerous_amount": { - "title": "dangerous_amount", + "tag": { + "title": "tag", "type": "object", - "description": "This model represents the amount of the dangerous goods..", + "description": "Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.\n", + "required": [ + "name" + ], "additionalProperties": false, "properties": { - "amount": { - "type": "number", - "minimum": 0, - "default": 0, - "description": "The amount of dangerous goods." - }, - "unit": { + "name": { "type": "string", - "nullable": true, - "default": null, - "description": "The unit of dangerous goods." + "minLength": 1, + "example": "Fragile", + "description": "The tag name." } } }, - "packaging_instruction_section": { - "title": "packaging_instruction_section", - "type": "string", - "enum": [ - "section_1", - "section_2", - "section_1a", - "section_1b" - ] - }, - "transport_mean": { - "title": "transport_mean", - "type": "string", - "enum": [ - "ground", - "water", - "cargo_aircraft_only", - "passenger_aircraft" - ] - }, - "regulation_level": { - "title": "regulation_level", - "type": "string", - "enum": [ - "lightly_regulated", - "fully_regulated", - "limited_quantities", - "excepted_quantity" - ] - }, "rate_detail": { "title": "rate_detail", "type": "object", @@ -12319,35 +12695,6 @@ ], "description": "Type of a tax added to shipping cost" }, - "label_charge_event": { - "title": "label_charge_event", - "type": "string", - "enum": [ - "carrier_default", - "on_creation", - "on_carrier_acceptance" - ], - "description": "Determines when the user's account will be charged for the label." - }, - "validate_address": { - "title": "validate_address", - "type": "string", - "enum": [ - "no_validation", - "validate_only", - "validate_and_clean" - ], - "description": "The possible validate address values" - }, - "label_download_type": { - "title": "label_download_type", - "type": "string", - "enum": [ - "url", - "inline" - ], - "description": "There are two different ways to [download a label](https://www.shipengine.com/docs/labels/downloading/):\n\n|Label Download Type | Description\n|--------------------|------------------------------\n|`url` |You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days.

This is the default if `label_download_type` is unspecified.\n|`inline` |You will receive the Base64-encoded label as part of the response. No need for a second request to download the label.\n" - }, "tracking_status": { "title": "tracking_status", "type": "string", @@ -12537,49 +12884,6 @@ } } }, - "create_label_response_body": { - "title": "create_label_response_body", - "type": "object", - "description": "A create label response body", - "additionalProperties": false, - "required": [ - "label_id", - "status", - "shipment_id", - "ship_date", - "created_at", - "shipment_cost", - "insurance_cost", - "tracking_number", - "is_international", - "batch_id", - "carrier_id", - "service_code", - "voided", - "voided_at", - "label_image_id", - "label_format", - "label_layout", - "trackable", - "carrier_code", - "tracking_status", - "label_download", - "form_download", - "paperless_download", - "insurance_claim", - "packages", - "is_return_label", - "rma_number", - "charge_event", - "package_code", - "display_scheme" - ], - "allOf": [ - { - "$ref": "#/components/schemas/label" - } - ] - }, "get_label_by_external_shipment_id_response_body": { "title": "get_label_by_external_shipment_id_response_body", "type": "object", @@ -14173,7 +14477,7 @@ "$ref": "#/components/schemas/shipment_id_request" }, { - "$ref": "#/components/schemas/shipment_request" + "$ref": "#/components/schemas/rate_shipment_request" } ], "allOf": [ @@ -14196,8 +14500,8 @@ } } }, - "shipment_request": { - "title": "shipment_request", + "rate_shipment_request": { + "title": "rate_shipment_request", "type": "object", "properties": { "shipment": { From 8bf353a96ac116d7b27afb34e22b70434b216c2d Mon Sep 17 00:00:00 2001 From: Joshua Flanagan Date: Wed, 9 Oct 2024 17:52:55 -0500 Subject: [PATCH 31/42] Update version --- CHANGELOG.md | 23 +++++++++++++++-------- ShipEngineSDK/ShipEngineSDK.csproj | 2 +- 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fb6244d4..076d741a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -181,19 +181,19 @@ Fixed handling of No Content responses ## 3.0.0-beta.1 -## Added +### Added - Created new SDK methods for the entire API that sit next to the pre-existing methods. The pre-existing methods will be deprecated eventually. ## 3.0.0-beta.2 -## Changed +### Changed - Add more explicit nullable reference types ## 3.0.0-beta.3 -## Changed +### Changed - Don't require any properties for deserialization so that small API changes don't completely break consumers - Don't try to serialize read-only properties @@ -201,19 +201,19 @@ Fixed handling of No Content responses ## 3.0.0-beta.4 -## Changed +### Changed - Make setters on readonly properties public ## 3.0.0-beta.10 -## Changed +### Changed - Allow requests to be modified before being sent ## 3.0.0-beta.11 -## Changed +### Changed - Added ability to scope request modifiers by using the `.WithRequestModifier()` method instead of the `.ModifyRequest` property. This will allow consumers to modify a single request without affecting any other consumers of the client. It also allows for @@ -222,13 +222,20 @@ Fixed handling of No Content responses ## 3.0.0-beta.12 -## Changed +### Changed - Updated to ShipEngine API 1.1.202409060709 ## 3.0.0-beta.14 -## Changed +### Changed - Updated to ShipEngine API 1.1.202410081510 - Add optional error properties, like field_name + +## 3.0.0-beta.14 + +### Changed + +- Updated to ShipEngine API 1.1.202410092210 +- AdvancedOptions now allow passing arbitrary key/values via AdditionalProperties diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index f5e06a20..99585d8c 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-beta.14 + 3.0.0-beta.15 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET From b76061a1f332ad8478ec13279200bde925c0150d Mon Sep 17 00:00:00 2001 From: Bibhusan-Shah Date: Wed, 16 Oct 2024 16:07:41 -0500 Subject: [PATCH 32/42] added A4 and A6 to label layout enum --- CHANGELOG.md | 25 ++++++++++--------- .../Model/AddressValidatingShipment.cs | 4 +-- .../Model/CalculateRatesResponseBody.cs | 4 +-- .../Model/CreateAndValidateShipment.cs | 4 +-- .../Model/CreateLabelFromRateResponseBody.cs | 4 +-- .../CreateLabelFromShipmentResponseBody.cs | 4 +-- .../Model/CreateLabelResponseBody.cs | 4 +-- .../Model/CreateReturnLabelResponseBody.cs | 4 +-- ...etLabelByExternalShipmentIdResponseBody.cs | 4 +-- .../Model/GetLabelByIdResponseBody.cs | 4 +-- .../GetShipmentByExternalIdResponseBody.cs | 4 +-- .../Model/GetShipmentByIdResponseBody.cs | 4 +-- ShipEngineSDK/Model/Label.cs | 4 +-- ShipEngineSDK/Model/LabelLayout.cs | 12 +++++++++ ShipEngineSDK/Model/ListLabelsResponseBody.cs | 4 +-- ShipEngineSDK/Model/PartialShipment.cs | 4 +-- ShipEngineSDK/Model/Shipment.cs | 4 +-- ShipEngineSDK/Model/ShipmentRequest.cs | 4 +-- .../Model/UpdateShipmentRequestBody.cs | 4 +-- .../Model/UpdateShipmentResponseBody.cs | 4 +-- ShipEngineSDK/ShipEngineSDK.csproj | 2 +- generation/swagger.json | 15 +++++------ 22 files changed, 70 insertions(+), 56 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 076d741a..4b2ba91a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,5 @@ # Changelog - ## 1.0.0 ### Features @@ -16,15 +15,13 @@ Implement the following SDK methods. - `CreateLabelFromRate` - `GetRatesWithShipmentDetails` - ## 1.0.7 ### Features Implement the following SDK methods. -- `CreateImplicitManifest` - +- `CreateImplicitManifest` ## 1.1.0 @@ -41,7 +38,6 @@ Rename LabelDownload method to the more generic Download Some documentation linking errors and minor typos - ## 1.1.1 ### Added @@ -52,7 +48,6 @@ Some documentation linking errors and minor typos The Customs Item Quantity type has been changed to integer type for CreateLabelFromShipmentDetails model. - ## 1.1.2 ### Fixed @@ -150,7 +145,7 @@ Updated nuget package dependencies ### Added -- Created new SDK methods for the entire API that sit next to the pre-existing methods. The pre-existing methods will be deprecated eventually. +- Created new SDK methods for the entire API that sit next to the pre-existing methods. The pre-existing methods will be deprecated eventually. ## 2.2.0 @@ -175,15 +170,14 @@ Fixed handling of No Content responses - Added ability to scope request modifiers by using the `.WithRequestModifier()` method instead of the `.ModifyRequest` property. This will allow consumers to modify a single request without affecting any other consumers of the client. It also allows for - multiple modifiers to be added. For example, a modifier could be added at the global level that applies to all requests and then + multiple modifiers to be added. For example, a modifier could be added at the global level that applies to all requests and then another modifier can be added for a single request. - ## 3.0.0-beta.1 ### Added -- Created new SDK methods for the entire API that sit next to the pre-existing methods. The pre-existing methods will be deprecated eventually. +- Created new SDK methods for the entire API that sit next to the pre-existing methods. The pre-existing methods will be deprecated eventually. ## 3.0.0-beta.2 @@ -217,7 +211,7 @@ Fixed handling of No Content responses - Added ability to scope request modifiers by using the `.WithRequestModifier()` method instead of the `.ModifyRequest` property. This will allow consumers to modify a single request without affecting any other consumers of the client. It also allows for - multiple modifiers to be added. For example, a modifier could be added at the global level that applies to all requests and then + multiple modifiers to be added. For example, a modifier could be added at the global level that applies to all requests and then another modifier can be added for a single request. ## 3.0.0-beta.12 @@ -233,9 +227,16 @@ Fixed handling of No Content responses - Updated to ShipEngine API 1.1.202410081510 - Add optional error properties, like field_name -## 3.0.0-beta.14 +## 3.0.0-beta.15 ### Changed - Updated to ShipEngine API 1.1.202410092210 - AdvancedOptions now allow passing arbitrary key/values via AdditionalProperties + +## 3.0.0-beta.16 + +### Added + +- Updated to ShipEngine API 1.1.202410161910 +- Added A4 and A6 as options for label layouts diff --git a/ShipEngineSDK/Model/AddressValidatingShipment.cs b/ShipEngineSDK/Model/AddressValidatingShipment.cs index 0c0b5fa3..40831882 100644 --- a/ShipEngineSDK/Model/AddressValidatingShipment.cs +++ b/ShipEngineSDK/Model/AddressValidatingShipment.cs @@ -186,9 +186,9 @@ public partial class AddressValidatingShipment public ShippingAddress? ReturnTo { get; set; } /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// 2018-09-23T00:00Z /// diff --git a/ShipEngineSDK/Model/CalculateRatesResponseBody.cs b/ShipEngineSDK/Model/CalculateRatesResponseBody.cs index 75ea1a4b..6f7e7ff5 100644 --- a/ShipEngineSDK/Model/CalculateRatesResponseBody.cs +++ b/ShipEngineSDK/Model/CalculateRatesResponseBody.cs @@ -95,9 +95,9 @@ public partial class CalculateRatesResponseBody public required ShippingAddress ReturnTo { get; set; } /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// 2018-09-23T00:00Z /// diff --git a/ShipEngineSDK/Model/CreateAndValidateShipment.cs b/ShipEngineSDK/Model/CreateAndValidateShipment.cs index c4809616..7b55c964 100644 --- a/ShipEngineSDK/Model/CreateAndValidateShipment.cs +++ b/ShipEngineSDK/Model/CreateAndValidateShipment.cs @@ -176,9 +176,9 @@ public partial class CreateAndValidateShipment public string? ServiceCode { get; set; } /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// 2018-09-23T00:00Z /// diff --git a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs index aa3bf100..2aacd939 100644 --- a/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromRateResponseBody.cs @@ -285,9 +285,9 @@ public partial class CreateLabelFromRateResponseBody public string? ServiceCode { get; set; } /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// This should not be used for input as it will be ignored on serialization. /// diff --git a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs index b43bf953..d4f799f8 100644 --- a/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromShipmentResponseBody.cs @@ -285,9 +285,9 @@ public partial class CreateLabelFromShipmentResponseBody public string? ServiceCode { get; set; } /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// This should not be used for input as it will be ignored on serialization. /// diff --git a/ShipEngineSDK/Model/CreateLabelResponseBody.cs b/ShipEngineSDK/Model/CreateLabelResponseBody.cs index 8d549c38..b55e0f65 100644 --- a/ShipEngineSDK/Model/CreateLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateLabelResponseBody.cs @@ -192,9 +192,9 @@ public partial class CreateLabelResponseBody public string? ServiceCode { get; set; } /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// This should not be used for input as it will be ignored on serialization. /// diff --git a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs index ed23526b..c9691217 100644 --- a/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs +++ b/ShipEngineSDK/Model/CreateReturnLabelResponseBody.cs @@ -285,9 +285,9 @@ public partial class CreateReturnLabelResponseBody public string? ServiceCode { get; set; } /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// This should not be used for input as it will be ignored on serialization. /// diff --git a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs index 2256b28a..452ec019 100644 --- a/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByExternalShipmentIdResponseBody.cs @@ -285,9 +285,9 @@ public partial class GetLabelByExternalShipmentIdResponseBody public string? ServiceCode { get; set; } /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// This should not be used for input as it will be ignored on serialization. /// diff --git a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs index e6669317..e5b14f32 100644 --- a/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetLabelByIdResponseBody.cs @@ -285,9 +285,9 @@ public partial class GetLabelByIdResponseBody public string? ServiceCode { get; set; } /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// This should not be used for input as it will be ignored on serialization. /// diff --git a/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs b/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs index 26713565..c7fc1c0e 100644 --- a/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetShipmentByExternalIdResponseBody.cs @@ -108,9 +108,9 @@ public partial class GetShipmentByExternalIdResponseBody public required string ServiceCode { get; set; } /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// 2018-09-23T00:00Z /// diff --git a/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs b/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs index c8f3d322..85cdc152 100644 --- a/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs +++ b/ShipEngineSDK/Model/GetShipmentByIdResponseBody.cs @@ -108,9 +108,9 @@ public partial class GetShipmentByIdResponseBody public required string ServiceCode { get; set; } /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// 2018-09-23T00:00Z /// diff --git a/ShipEngineSDK/Model/Label.cs b/ShipEngineSDK/Model/Label.cs index 6f613d5c..5e37ea93 100644 --- a/ShipEngineSDK/Model/Label.cs +++ b/ShipEngineSDK/Model/Label.cs @@ -285,9 +285,9 @@ public partial class Label public string? ServiceCode { get; set; } /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// This should not be used for input as it will be ignored on serialization. /// diff --git a/ShipEngineSDK/Model/LabelLayout.cs b/ShipEngineSDK/Model/LabelLayout.cs index 5ccc0de3..88d00229 100644 --- a/ShipEngineSDK/Model/LabelLayout.cs +++ b/ShipEngineSDK/Model/LabelLayout.cs @@ -62,6 +62,18 @@ public LabelLayout(string value) public static LabelLayout Letter { get; } = new("letter"); + /// + /// Enum A4 for value: A4 + /// + public static LabelLayout A4 { get; } = new("A4"); + + + /// + /// Enum A6 for value: A6 + /// + public static LabelLayout A6 { get; } = new("A6"); + + /// /// Get a string representation of the current value /// diff --git a/ShipEngineSDK/Model/ListLabelsResponseBody.cs b/ShipEngineSDK/Model/ListLabelsResponseBody.cs index d19a275c..b9c28854 100644 --- a/ShipEngineSDK/Model/ListLabelsResponseBody.cs +++ b/ShipEngineSDK/Model/ListLabelsResponseBody.cs @@ -65,9 +65,9 @@ public class ListLabelsResponseBodyItem public Shipment? Shipment { get; set; } /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// 2018-09-23T00:00Z /// diff --git a/ShipEngineSDK/Model/PartialShipment.cs b/ShipEngineSDK/Model/PartialShipment.cs index 2c9acbe5..94c00b57 100644 --- a/ShipEngineSDK/Model/PartialShipment.cs +++ b/ShipEngineSDK/Model/PartialShipment.cs @@ -159,9 +159,9 @@ public partial class PartialShipment public string? ServiceCode { get; set; } /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// 2018-09-23T00:00Z /// diff --git a/ShipEngineSDK/Model/Shipment.cs b/ShipEngineSDK/Model/Shipment.cs index 44c65996..1357c0f7 100644 --- a/ShipEngineSDK/Model/Shipment.cs +++ b/ShipEngineSDK/Model/Shipment.cs @@ -108,9 +108,9 @@ public partial class Shipment public required string ServiceCode { get; set; } /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// 2018-09-23T00:00Z /// diff --git a/ShipEngineSDK/Model/ShipmentRequest.cs b/ShipEngineSDK/Model/ShipmentRequest.cs index bb387a51..8edca8d5 100644 --- a/ShipEngineSDK/Model/ShipmentRequest.cs +++ b/ShipEngineSDK/Model/ShipmentRequest.cs @@ -140,9 +140,9 @@ public partial class ShipmentRequest public ShippingAddress? ReturnTo { get; set; } /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// 2018-09-23T00:00Z /// diff --git a/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs b/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs index c34eff15..e1800690 100644 --- a/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentRequestBody.cs @@ -173,9 +173,9 @@ public partial class UpdateShipmentRequestBody public string? ServiceCode { get; set; } /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// 2018-09-23T00:00Z /// diff --git a/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs b/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs index c34e9c50..c531141f 100644 --- a/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs +++ b/ShipEngineSDK/Model/UpdateShipmentResponseBody.cs @@ -112,9 +112,9 @@ public partial class UpdateShipmentResponseBody public required string ServiceCode { get; set; } /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// - /// The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. + /// The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. /// /// 2018-09-23T00:00Z /// diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index 99585d8c..d09cd622 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-beta.15 + 3.0.0-beta.16 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET diff --git a/generation/swagger.json b/generation/swagger.json index c2e6e9a6..8594fda2 100644 --- a/generation/swagger.json +++ b/generation/swagger.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "ShipEngine API", - "version": "1.1.202410092210", + "version": "1.1.202410161910", "termsOfService": "https://www.shipengine.com/terms-of-service/", "x-logo": { "url": "https://shipengine.github.io/img/shipengine-logo-square.png", @@ -6899,7 +6899,9 @@ "type": "string", "enum": [ "4x6", - "letter" + "letter", + "A4", + "A6" ], "description": "The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format.\n" }, @@ -9932,7 +9934,7 @@ } ], "readOnly": true, - "description": "The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\n" + "description": "The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\n" }, "created_at": { "readOnly": true, @@ -10447,7 +10449,7 @@ "$ref": "#/components/schemas/date" } ], - "description": "The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\n" + "description": "The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\n" }, "ship_to": { "allOf": [ @@ -11923,7 +11925,6 @@ "carrier_id", "service_code", "voided", - "voided_at", "label_image_id", "label_format", "label_layout", @@ -11995,7 +11996,7 @@ } ], "readOnly": true, - "description": "The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\n" + "description": "The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\n" }, "created_at": { "readOnly": true, @@ -12405,7 +12406,7 @@ "$ref": "#/components/schemas/date" } ], - "description": "The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\n" + "description": "The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\n" }, "created_at": { "readOnly": true, From 91f98fe56db8a5fc7e2fcf31211aa6069dda36b5 Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Wed, 5 Feb 2025 09:00:13 -0600 Subject: [PATCH 33/42] Mark v2 methods as obsolete --- ShipEngineSDK/ShipEngine.cs | 54 ++++++++++++++++++++---------- ShipEngineSDK/ShipEngineSDK.csproj | 2 +- 2 files changed, 37 insertions(+), 19 deletions(-) diff --git a/ShipEngineSDK/ShipEngine.cs b/ShipEngineSDK/ShipEngine.cs index 68953577..281ebd1a 100644 --- a/ShipEngineSDK/ShipEngine.cs +++ b/ShipEngineSDK/ShipEngine.cs @@ -23,6 +23,7 @@ public partial interface IShipEngine /// /// The address to validate. This can even be an incomplete or improperly formatted address /// An address validation result object + [Obsolete("This method is deprecated. Please use ValidateAddress(List addressToValidate) instead", false)] Task> ValidateAddresses(List
addresses); /// @@ -31,12 +32,14 @@ public partial interface IShipEngine /// The address to validate. This can even be an incomplete or improperly formatted address /// Configuration object that overrides the global config for this method call /// An address validation result object + [Obsolete("This method is deprecated. Please use ValidateAddress(HttpClient methodClient, List addressToValidate) instead", false)] Task> ValidateAddresses(List
addresses, Config methodConfig); /// /// Retrieve a list of all carriers that have been added to this account /// /// A list of carriers + [Obsolete("This method is deprecated. Please use ListCarriers(CancellationToken cancellationToken) instead", false)] Task ListCarriers(); /// @@ -44,6 +47,7 @@ public partial interface IShipEngine /// /// Configuration object that overrides the global config for this method call. /// A list of carriers + [Obsolete("This method is deprecated. Please use ListCarriers(HttpClient methodClient, CancellationToken cancellationToken) instead", false)] Task ListCarriers(Config methodConfig); /// @@ -51,6 +55,7 @@ public partial interface IShipEngine /// /// The details of the manifest you want to create. /// + [Obsolete("This method is deprecated. Please use CreateManifest(CreateManifestRequestBody createManifestRequestBody instead", false)] Task CreateManifest(Manifests.Params manifestParams); /// @@ -59,6 +64,7 @@ public partial interface IShipEngine /// Configuration object that overrides the global config for this method call. /// The details of the manifest you want to create. /// + [Obsolete("This method is deprecated. Please use CreateManifest(HttpClient methodClient, CreateManifestRequestBody createManifestRequestBody) instead", false)] Task CreateManifest(Config methodConfig, Manifests.Params manifestParams); /// @@ -66,6 +72,7 @@ public partial interface IShipEngine /// /// The id of the label to void /// Result object indicating the success of the void label attempt + [Obsolete("This method is deprecated. Please use VoidLabel(string labelId) instead", false)] Task VoidLabelWithLabelId(string labelId); /// @@ -74,6 +81,7 @@ public partial interface IShipEngine /// The id of the label to void /// Configuration object that overrides the global config for this method call /// Result object indicating the success of the void label attempt + [Obsolete("This method is deprecated. Please use VoidLabel(HttpClient methodClient, string labelId) instead", false)] Task VoidLabelWithLabelId(string labelId, Config methodConfig); /// @@ -81,6 +89,7 @@ public partial interface IShipEngine /// /// The label id associated with the shipment /// An object that contains the label id tracking information + [Obsolete("This method is deprecated. Please use GetTrackingLogFromLabel(string labelId) instead", false)] Task TrackUsingLabelId(string labelId); /// @@ -89,6 +98,7 @@ public partial interface IShipEngine /// The label id associated with the shipment /// Configuration object that overrides the global config for this method call /// An object that contains the label id tracking information + [Obsolete("This method is deprecated. Please use GetTrackingLogFromLabel(HttpClient methodClient, string labelId) instead", false)] Task TrackUsingLabelId(string labelId, Config methodConfig); /// @@ -97,6 +107,7 @@ public partial interface IShipEngine /// The tracking number of the package you wish to track. /// The carrierCode for the trackingNumber you are using to track the package. /// + [Obsolete("This method is deprecated. Please use GetTrackingLog(string? carrierCode, string? trackingNumber) instead", false)] Task TrackUsingCarrierCodeAndTrackingNumber(string trackingNumber, string carrierCode); /// @@ -106,6 +117,7 @@ public partial interface IShipEngine /// The carrierCode for the trackingNumber you are using to track the package. /// Configuration object that overrides the global config for this method call /// + [Obsolete("This method is deprecated. Please use GetTrackingLog(HttpClient methodClient, string? carrierCode, string? trackingNumber) instead", false)] Task TrackUsingCarrierCodeAndTrackingNumber(string trackingNumber, string carrierCode, Config methodConfig); /// @@ -113,6 +125,7 @@ public partial interface IShipEngine /// /// Details of the label that you want to create /// Object containing the created label information + [Obsolete("This method is deprecated. Please use CreateLabel(CreateLabelRequestBody createLabelRequestBody) instead", false)] Task CreateLabelFromShipmentDetails(CreateLabelFromShipmentDetails.Params labelParams); /// @@ -121,6 +134,7 @@ public partial interface IShipEngine /// Details of the label that you want to create /// Configuration object that overrides the global config for this method call /// Object containing the created label information + [Obsolete("This method is deprecated. Please use CreateLabel(HttpClient methodClient, CreateLabelRequestBody createLabelRequestBody) instead", false)] Task CreateLabelFromShipmentDetails(CreateLabelFromShipmentDetails.Params labelParams, Config methodConfig); /// @@ -128,6 +142,7 @@ public partial interface IShipEngine /// /// The details of the rate that you want to use to purchase a label /// Object containing the created label information + [Obsolete("This method is deprecated. Please use CreateLabelFromRate(CreateLabelFromRateRequestBody createLabelFromRateRequestBody) instead", false)] Task CreateLabelFromRate(CreateLabelFromRate.Params createLabelFromRateParams); /// @@ -136,6 +151,7 @@ public partial interface IShipEngine /// The details of the rate that you want to use to purchase a label /// Configuration object that overrides the global config for this method call /// Object containing the created label information + [Obsolete("This method is deprecated. Please use CreateLabelFromRate(HttpClient methodClient, CreateLabelFromRateRequestBody createLabelFromRateRequestBody) instead", false)] Task CreateLabelFromRate(CreateLabelFromRate.Params createLabelFromRateParams, Config methodConfig); /// @@ -143,6 +159,7 @@ public partial interface IShipEngine /// /// /// The rates result + [Obsolete("This method is deprecated. Please use CalculateRates(CalculateRatesRequestBody calculateRatesRequestBody) instead", false)] Task GetRatesWithShipmentDetails(GetRatesWithShipmentDetails.Params rateParams); /// @@ -151,6 +168,7 @@ public partial interface IShipEngine /// /// Configuration object that overrides the global config for this method call /// The rates result + [Obsolete("This method is deprecated. Please use CalculateRates(HttpClient methodClient, CalculateRatesRequestBody calculateRatesRequestBody) instead", false)] Task GetRatesWithShipmentDetails(GetRatesWithShipmentDetails.Params rateParams, Config methodConfig); } @@ -276,7 +294,7 @@ public void Dispose() /// /// The address to validate. This can even be an incomplete or improperly formatted address /// An address validation result object - + [Obsolete("This method is deprecated. Please use ValidateAddress(List addressToValidate) instead", false)] public async Task> ValidateAddresses(List
addresses) { @@ -295,7 +313,7 @@ public void Dispose() /// The address to validate. This can even be an incomplete or improperly formatted address /// Configuration object that overrides the global config for this method call. /// An address validation result object - + [Obsolete("This method is deprecated. Please use ValidateAddress(HttpClient methodClient, List addressToValidate) instead", false)] public async Task> ValidateAddresses(List
addresses, Config methodConfig) { @@ -316,7 +334,7 @@ public void Dispose() /// Retrieve a list of all carriers that have been added to this account ///
/// A list of carriers - + [Obsolete("This method is deprecated. Please use ListCarriers(CancellationToken cancellationToken) instead", false)] public async Task ListCarriers() { var path = "v1/carriers"; @@ -331,7 +349,7 @@ public void Dispose() /// /// Configuration object that overrides the global config for this method call. /// A list of carriers - + [Obsolete("This method is deprecated. Please use ListCarriers(HttpClient methodClient) instead", false)] public async Task ListCarriers(Config methodConfig) { var client = ConfigureHttpClient(methodConfig, new HttpClient()); @@ -351,7 +369,7 @@ public void Dispose() /// /// The details of the manifest you want to create. /// - + [Obsolete("This method is deprecated. Please use CreateManifest(CreateManifestRequestBody createManifestRequestBody) instead", false)] public async Task CreateManifest(Manifests.Params manifestParams) { var path = "v1/manifests"; @@ -369,7 +387,7 @@ public void Dispose() /// Configuration object that overrides the global config for this method call. /// The details of the manifest you want to create. /// - + [Obsolete("This method is deprecated. Please use CreateManifest(HttpClient methodClient, CreateManifestRequestBody createManifestRequestBody) instead", false)] public async Task CreateManifest(Config methodConfig, Manifests.Params manifestParams) { var client = ConfigureHttpClient(methodConfig, new HttpClient()); @@ -388,7 +406,7 @@ public void Dispose() /// /// The id of the label to void /// Result object indicating the success of the void label attempt - + [Obsolete("This method is deprecated. Please use VoidLabel(string labelId) instead", false)] public async Task VoidLabelWithLabelId(string labelId) { var path = $"v1/labels/{labelId}/void"; @@ -404,7 +422,7 @@ public void Dispose() /// The id of the label to void /// Configuration object that overrides the global config for this method call /// Result object indicating the success of the void label attempt - + [Obsolete("This method is deprecated. Please use VoidLabel(string labelId) instead", false)] public async Task VoidLabelWithLabelId(string labelId, Config methodConfig) { var client = ConfigureHttpClient(methodConfig, new HttpClient()); @@ -423,7 +441,7 @@ public void Dispose() /// /// The label id associated with the shipment /// An object that contains the label id tracking information - + [Obsolete("This method is deprecated. Please use GetTrackingLogFromLabel(string labelId) instead", false)] public async Task TrackUsingLabelId(string labelId) { var path = $"/v1/labels/{labelId}/track"; @@ -439,7 +457,7 @@ public void Dispose() /// The label id associated with the shipment /// Configuration object that overrides the global config for this method call /// An object that contains the label id tracking information - + [Obsolete("This method is deprecated. Please use GetTrackingLogFromLabel(HttpClient methodClient, string labelId) instead", false)] public async Task TrackUsingLabelId(string labelId, Config methodConfig) { var client = ConfigureHttpClient(methodConfig, new HttpClient()); @@ -459,7 +477,7 @@ public void Dispose() /// The tracking number of the package you wish to track. /// The carrierCode for the trackingNumber you are using to track the package. /// - + [Obsolete("This method is deprecated. Please use GetTrackingLog(string? carrierCode, string? trackingNumber) instead", false)] public async Task TrackUsingCarrierCodeAndTrackingNumber(string trackingNumber, string carrierCode) { var path = $"/v1/tracking?tracking_number={trackingNumber}&carrier_code={carrierCode}"; @@ -476,7 +494,7 @@ public void Dispose() /// The carrierCode for the trackingNumber you are using to track the package. /// Configuration object that overrides the global config for this method call /// - + [Obsolete("This method is deprecated. Please use GetTrackingLog(HttpClient methodClient, string? carrierCode, string? trackingNumber) instead", false)] public async Task TrackUsingCarrierCodeAndTrackingNumber(string trackingNumber, string carrierCode, Config methodConfig) { var client = ConfigureHttpClient(methodConfig, new HttpClient()); @@ -495,7 +513,7 @@ public void Dispose() /// /// Details of the label that you want to create /// Object containing the created label information - + [Obsolete("This method is deprecated. Please use CreateLabel(CreateLabelRequestBody createLabelRequestBody) instead", false)] public async Task CreateLabelFromShipmentDetails(CreateLabelFromShipmentDetails.Params labelParams) { @@ -514,7 +532,7 @@ public void Dispose() /// Details of the label that you want to create /// Configuration object that overrides the global config for this method call /// Object containing the created label information - + [Obsolete("This method is deprecated. Please use CreateLabel(HttpClient methodClient, CreateLabelRequestBody createLabelRequestBody) instead", false)] public async Task CreateLabelFromShipmentDetails(CreateLabelFromShipmentDetails.Params labelParams, Config methodConfig) { @@ -536,7 +554,7 @@ public void Dispose() /// /// The details of the rate that you want to use to purchase a label /// Object containing the created label information - + [Obsolete("This method is deprecated. Please use CreateLabelFromRate(CreateLabelFromRateRequestBody createLabelFromRateRequestBody) instead", false)] public async Task CreateLabelFromRate(CreateLabelFromRate.Params createLabelFromRateParams) { var path = $"/v1/labels/rates/{createLabelFromRateParams.RateId}"; @@ -554,7 +572,7 @@ public void Dispose() /// The details of the rate that you want to use to purchase a label /// Configuration object that overrides the global config for this method call /// Object containing the created label information - + [Obsolete("This method is deprecated. Please use CreateLabelFromRate(HttpClient methodClient, CreateLabelFromRateRequestBody createLabelFromRateRequestBody) instead", false)] public async Task CreateLabelFromRate(CreateLabelFromRate.Params createLabelFromRateParams, Config methodConfig) { @@ -576,7 +594,7 @@ public void Dispose() ///
/// /// The rates result - + [Obsolete("This method is deprecated. Please use CalculateRates(CalculateRatesRequestBody calculateRatesRequestBody) instead", false)] public async Task GetRatesWithShipmentDetails(GetRatesWithShipmentDetails.Params rateParams) { var path = "/v1/rates"; @@ -594,7 +612,7 @@ public void Dispose() /// /// Configuration object that overrides the global config for this method call /// The rates result - + [Obsolete("This method is deprecated. Please use CalculateRates(HttpClient methodClient, CalculateRatesRequestBody calculateRatesRequestBody) instead", false)] public async Task GetRatesWithShipmentDetails(GetRatesWithShipmentDetails.Params rateParams, Config methodConfig) { var client = ConfigureHttpClient(methodConfig, new HttpClient()); diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index d09cd622..dddf9e18 100644 --- a/ShipEngineSDK/ShipEngineSDK.csproj +++ b/ShipEngineSDK/ShipEngineSDK.csproj @@ -32,7 +32,7 @@ - + From 62d52264b70f95a00bf39a87aacc7efb8bae810b Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Wed, 5 Feb 2025 09:05:34 -0600 Subject: [PATCH 34/42] Update to the latest version of the ShipEngine spec --- CHANGELOG.md | 10 + .../Model/CreateLabelFromRateRequestBody.cs | 34 ++- .../GetTrackingLogFromLabelResponseBody.cs | 2 +- .../Model/GetTrackingLogResponseBody.cs | 2 +- ShipEngineSDK/Model/Products.cs | 28 +- ShipEngineSDK/Model/SmartPostHub.cs | 12 + ShipEngineSDK/Model/StatusDetailCode.cs | 282 +++++++++--------- ShipEngineSDK/Model/TrackEvent.cs | 2 +- ShipEngineSDK/Model/TrackingInformation.cs | 2 +- ShipEngineSDK/ShipEngineSDK.csproj | 2 +- generation/swagger.json | 143 +++++---- package-lock.json | 4 +- 12 files changed, 297 insertions(+), 226 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4b2ba91a..37f31d35 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -240,3 +240,13 @@ Fixed handling of No Content responses - Updated to ShipEngine API 1.1.202410161910 - Added A4 and A6 as options for label layouts + +## 3.0.0-beta.17 + +### Added + +- Updated to ShipEngine API 1.1.202501091801 + +### Updated + +- Marked v2 methods as obsolete \ No newline at end of file diff --git a/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs b/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs index 60d5bc5d..c6bf92c4 100644 --- a/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs +++ b/ShipEngineSDK/Model/CreateLabelFromRateRequestBody.cs @@ -26,35 +26,56 @@ namespace ShipEngineSDK.Model; public partial class CreateLabelFromRateRequestBody { + /// + /// Optional - Value will be saved in the shipment's advanced_options > custom_field1 + /// + /// Optional - Value will be saved in the shipment's advanced_options > custom_field1 + [JsonPropertyName("custom_field1"), JsonPropertyOrder(1)] + public string? CustomField1 { get; set; } + + /// + /// Optional - Value will be saved in the shipment's advanced_options > custom_field2 + /// + /// Optional - Value will be saved in the shipment's advanced_options > custom_field2 + [JsonPropertyName("custom_field2"), JsonPropertyOrder(2)] + public string? CustomField2 { get; set; } + + /// + /// Optional - Value will be saved in the shipment's advanced_options > custom_field3 + /// + /// Optional - Value will be saved in the shipment's advanced_options > custom_field3 + [JsonPropertyName("custom_field3"), JsonPropertyOrder(3)] + public string? CustomField3 { get; set; } + /// /// The display format that the label should be shown in. /// /// The display format that the label should be shown in. - [JsonPropertyName("display_scheme"), JsonPropertyOrder(1)] + [JsonPropertyName("display_scheme"), JsonPropertyOrder(4)] public DisplayScheme? DisplayScheme { get; set; } /// /// Gets or Sets LabelDownloadType /// - [JsonPropertyName("label_download_type"), JsonPropertyOrder(2)] + [JsonPropertyName("label_download_type"), JsonPropertyOrder(5)] public LabelDownloadType? LabelDownloadType { get; set; } /// /// Gets or Sets LabelFormat /// - [JsonPropertyName("label_format"), JsonPropertyOrder(3)] + [JsonPropertyName("label_format"), JsonPropertyOrder(6)] public LabelFormat? LabelFormat { get; set; } /// /// Gets or Sets LabelLayout /// - [JsonPropertyName("label_layout"), JsonPropertyOrder(4)] + [JsonPropertyName("label_layout"), JsonPropertyOrder(7)] public LabelLayout? LabelLayout { get; set; } /// /// Gets or Sets ValidateAddress /// - [JsonPropertyName("validate_address"), JsonPropertyOrder(5)] + [JsonPropertyName("validate_address"), JsonPropertyOrder(8)] public ValidateAddress? ValidateAddress { get; set; } @@ -67,6 +88,9 @@ public override string ToString() var sb = new StringBuilder(); sb.Append("class CreateLabelFromRateRequestBody {\n"); #pragma warning disable CS0612 // Type or member is obsolete + sb.Append(" CustomField1: ").Append(CustomField1).Append("\n"); + sb.Append(" CustomField2: ").Append(CustomField2).Append("\n"); + sb.Append(" CustomField3: ").Append(CustomField3).Append("\n"); sb.Append(" DisplayScheme: ").Append(DisplayScheme).Append("\n"); sb.Append(" LabelDownloadType: ").Append(LabelDownloadType).Append("\n"); sb.Append(" LabelFormat: ").Append(LabelFormat).Append("\n"); diff --git a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs index 027d4294..9e40aff4 100644 --- a/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogFromLabelResponseBody.cs @@ -178,7 +178,7 @@ public partial class GetTrackingLogFromLabelResponseBody /// This should not be used for input as it will be ignored on serialization. /// /// - /// Your shipment has been delivered. + /// Your parcel has been successfully delivered. /// [JsonPropertyName("status_detail_description"), JsonInclude] public string? StatusDetailDescription { get; set; } diff --git a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs index 23832b0c..e9889d05 100644 --- a/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs +++ b/ShipEngineSDK/Model/GetTrackingLogResponseBody.cs @@ -191,7 +191,7 @@ public partial class GetTrackingLogResponseBody /// This should not be used for input as it will be ignored on serialization. /// /// - /// Your shipment has been delivered. + /// Your parcel has been successfully delivered. /// [JsonPropertyName("status_detail_description"), JsonInclude] public string? StatusDetailDescription { get; set; } diff --git a/ShipEngineSDK/Model/Products.cs b/ShipEngineSDK/Model/Products.cs index aa1a44d3..ea2780a6 100644 --- a/ShipEngineSDK/Model/Products.cs +++ b/ShipEngineSDK/Model/Products.cs @@ -50,6 +50,13 @@ public partial class Products [JsonPropertyName("description"), JsonPropertyOrder(3)] public string? Description { get; set; } + /// + /// Additional details about products + /// + /// Additional details about products + [JsonPropertyName("extended_details"), JsonPropertyOrder(4)] + public Dictionary? ExtendedDetails { get; set; } + /// /// The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item. /// @@ -57,55 +64,55 @@ public partial class Products /// /// 3926.1 /// - [JsonPropertyName("harmonized_tariff_code"), JsonPropertyOrder(4)] + [JsonPropertyName("harmonized_tariff_code"), JsonPropertyOrder(5)] public string? HarmonizedTariffCode { get; set; } /// /// Manufacturers Identification code /// /// Manufacturers Identification code - [JsonPropertyName("mid_code"), JsonPropertyOrder(5)] + [JsonPropertyName("mid_code"), JsonPropertyOrder(6)] public string? MidCode { get; set; } /// /// link to the item on the seller website /// /// link to the item on the seller website - [JsonPropertyName("product_url"), JsonPropertyOrder(6)] + [JsonPropertyName("product_url"), JsonPropertyOrder(7)] public string? ProductUrl { get; set; } /// /// The quantity of this item in the shipment. /// /// The quantity of this item in the shipment. - [JsonPropertyName("quantity"), JsonPropertyOrder(7)] + [JsonPropertyName("quantity"), JsonPropertyOrder(8)] public int? Quantity { get; set; } /// /// The SKU (Stock Keeping Unit) of the item /// /// The SKU (Stock Keeping Unit) of the item - [JsonPropertyName("sku"), JsonPropertyOrder(8)] + [JsonPropertyName("sku"), JsonPropertyOrder(9)] public string? Sku { get; set; } /// /// Description of the Custom Item's SKU /// /// Description of the Custom Item's SKU - [JsonPropertyName("sku_description"), JsonPropertyOrder(9)] + [JsonPropertyName("sku_description"), JsonPropertyOrder(10)] public string? SkuDescription { get; set; } /// /// Gets or Sets UnitOfMeasure /// - [JsonPropertyName("unit_of_measure"), JsonPropertyOrder(10)] + [JsonPropertyName("unit_of_measure"), JsonPropertyOrder(11)] public string? UnitOfMeasure { get; set; } /// /// The declared value of each item /// /// The declared value of each item - [JsonPropertyName("value"), JsonPropertyOrder(11)] + [JsonPropertyName("value"), JsonPropertyOrder(12)] public MonetaryValue? Value { get; set; } /// @@ -115,14 +122,14 @@ public partial class Products /// /// 0.2 /// - [JsonPropertyName("vat_rate"), JsonPropertyOrder(12)] + [JsonPropertyName("vat_rate"), JsonPropertyOrder(13)] public decimal? VatRate { get; set; } /// /// The item weight /// /// The item weight - [JsonPropertyName("weight"), JsonPropertyOrder(13)] + [JsonPropertyName("weight"), JsonPropertyOrder(14)] public Weight? Weight { get; set; } @@ -138,6 +145,7 @@ public override string ToString() sb.Append(" CountryOfOrigin: ").Append(CountryOfOrigin).Append("\n"); sb.Append(" DangerousGoods: ").Append(DangerousGoods).Append("\n"); sb.Append(" Description: ").Append(Description).Append("\n"); + sb.Append(" ExtendedDetails: ").Append(ExtendedDetails).Append("\n"); sb.Append(" HarmonizedTariffCode: ").Append(HarmonizedTariffCode).Append("\n"); sb.Append(" MidCode: ").Append(MidCode).Append("\n"); sb.Append(" ProductUrl: ").Append(ProductUrl).Append("\n"); diff --git a/ShipEngineSDK/Model/SmartPostHub.cs b/ShipEngineSDK/Model/SmartPostHub.cs index 3e64f76d..83f886a0 100644 --- a/ShipEngineSDK/Model/SmartPostHub.cs +++ b/ShipEngineSDK/Model/SmartPostHub.cs @@ -254,6 +254,18 @@ public SmartPostHub(string value) public static SmartPostHub WheelingIl { get; } = new("wheeling_il"); + /// + /// Enum MiddletownCt for value: middletown_ct + /// + public static SmartPostHub MiddletownCt { get; } = new("middletown_ct"); + + + /// + /// Enum PortlandOr for value: portland_or + /// + public static SmartPostHub PortlandOr { get; } = new("portland_or"); + + /// /// Get a string representation of the current value /// diff --git a/ShipEngineSDK/Model/StatusDetailCode.cs b/ShipEngineSDK/Model/StatusDetailCode.cs index 18d21b81..145820e4 100644 --- a/ShipEngineSDK/Model/StatusDetailCode.cs +++ b/ShipEngineSDK/Model/StatusDetailCode.cs @@ -21,9 +21,9 @@ namespace ShipEngineSDK.Model; /// -/// The tracking status detail codes |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- | `COLLECTION_FAILED` | Shipment pickup failed. The delivery company will try again soon. | `AWAITING_DESPATCH` | Your shipment is ready to go and is waiting for pickup. | `COLLECTION_REQUESTED` | Your shipment pickup has been scheduled. | `DESPATCHED` | Your shipment has been handed over to the carrier or dropped off at collection point. It will soon start its journey. | `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system. | `NOT_YET_RECEIVED_BY_CARRIER` | The sender couldn't hand over your shipment. The delivery company will try to collect it again. | `COLLECTION_MADE` | Your shipment has been picked up by the carrier. | `ATTEMPTED_DELIVERY` | Delivery attempt failed. Please check the carrier's instructions for next steps. | `ATTEMPTED_DELIVERY_2ND` | Second delivery attempt failed. Please check the carrier's instructions for next steps. | `ATTEMPTED_DELIVERY_3RD` | Third delivery attempt failed. Please check the carrier's instructions for next steps. | `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please check carrier instructions. | `COD_AMOUNT_PAID` | Cash on delivery payment received. | `CUSTOMER_CARDED` | Delivery attempt failed. Please check for delivery instructions left by the carrier. | `CUSTOMER_IDENTIFICATION_FAILED` | There was a recipient identification issue. Please check carrier instructions. | `INVALID_METHOD_OF_PAYMENT` | Delivery failed due to incorrect payment. Please check carrier instructions. | `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | Delivery couldn't be completed due to issues with accessing address. Please follow carrier instructions. | `OUT_FOR_DELIVERY` | Your shipment is out for delivery. | `DELIVERED` | Your shipment has been delivered. | `DELIVERED_DAMAGED` | Your shipment was delivered but arrived damaged. | `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest. | `DELIVERED_SPECIFIED_SAFE_PLACE` | Your shipment has been left in your designated safe place. | `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your shipment was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details. | `DELIVERED_TO_NEIGHBOUR` | Your shipment was delivered to your neighbor. | `DELIVERED_TO_PO_BOX` | Your shipment was delivered to your PO Box. | `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the collection point. | `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery. | `PROOF_OF_DELIVERY` | Delivery confirmed. | `CANCELLED` | Your shipment has been cancelled. | `CANCELLED_BEFORE_DESPATCH` | Your shipment was cancelled before pickup. Contact the sender if unexpected. | `CUSTOMER_MOVED` | Recipient not at address. Your shipment is being returned. | `HAZARDOUS_PROHIBITED` | Your parcel contained a prohibited item and is being returned. Contact the sender. | `NOT_COLLECTED_FROM_PICKUP_POINT` | Shipment not collected from the pickup point. Your parcel is being returned to the sender. | `NOT_DELIVERED` | Delivery attempts failed. Your parcel is being returned to the sender. | `NOT_DELIVERED_ADDRESSEE_DECEASED` | Delivery not possible due to recipient's passing. | `PARCEL_DAMAGED` | Your parcel was damaged and can't be delivered. It's being returned. Contact the sender. | `PARCEL_DISPOSED` | Shipment was disposed of. Contact the sender for details. | `PARCEL_LOST` | Your parcel is lost. Contact the sender for next steps. | `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | Shipment is too large/heavy for delivery. Being returned. Contact sender. | `REFUSED_BY_CUSTOMER` | Delivery refused. Shipment being returned. Contact the sender. | `RETURN_TO_SENDER` | Your shipment is being returned to the sender. Contact them for details. | `ADDRESS_QUERY` | There's an issue with your delivery address. This may cause a delay or return. Contact sender or carrier. | `CARRIER_DELAYS` | There's a delivery delay. We'll update you when there's more info. | `CUSTOMS_CLEARED` | Your shipment has passed customs clearance. | `CUSTOMS_PROCESSING` | Your shipment is going through customs. | `DELAYED_NOT_CARRIER` | Unexpected delivery delay. We'll update you soon. | `DELIVERY_ARRANGED_WITH_RECIPIENT` | Delivery arranged by recipient. | `HELD_BY_CARRIER` | Your shipment is on hold due to a carrier issue. We'll update you soon. | `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your shipment is held by carrier due to customs issues. We'll update you. | `HELD_BY_CUSTOMS` | Your shipment is held in customs. We'll update you. | `HELD_BY_EXPORT_CUSTOMS` | Your shipment is held in export customs. We'll update you. | `HELD_BY_IMPORT_CUSTOMS` | Your shipment is held in import customs. We'll update you. | `HUB_SCAN_OUT` | Your shipment is at the main delivery depot. | `IN_TRANSIT` | Your shipment is on its way between depots. | `INCORRECT_DECLARATION` | Incorrect shipment dimensions. Delivery may be delayed or returned. We'll update you. | `INFORMATION` | The carrier has shared additional shipment information. | `MISSORTED` | Your shipment was missorted. There might be a delivery delay. We'll update you. | `PARCEL_OVER_LABELLED` | Your shipment was over labelled by the delivery company to improve processing. | `PARCEL_REPACKED` | Your shipment packaging was damaged. It's being repacked. This might delay delivery. | `PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL` | You've received an email with a shipment update. | `PARCEL_UPDATE_NOTIFICATION_VIA_SMS` | You've received a text message with a shipment update. | `RECEIVED_BY_CARRIER` | Your shipment has been received by the carrier. | `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your shipment is at the local delivery depot, ready for delivery. | `ROUTING_ERROR` | Your shipment was sent to the wrong place. There might be a delay. | `SUB_CONTRACTOR_EVENT` | Your shipment is with the local delivery partner. | `SUB_CONTRACTOR_RECEIVED` | Your shipment has been received by the local delivery partner. | `RECD_BY_CARRIER_NO_ELEC_ADVICE` | There's a system issue with your shipment. Tracking updates might be delayed. | `AWAITING_ELECTRONIC_ADVICE` | Your tracking number is ready. Your shipment is waiting to be registered in the carrier system and scheduled for pickup. | `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your shipment is ready for pickup at the specified location. | `COLLECT_AT_LOCAL_PO` | Your shipment has been redirected to the local post office for pickup. Check carrier instructions. | `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your shipment is being held for pickup. Check carrier instructions. | `DELIVERED_TO_LOCKER_COLLECTION_POINT` | Your shipment has been delivered to your locker. | `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates. +/// The tracking status detail codes |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- | `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates. | `SHIPMENT_CREATED` | Your tracking number is ready. Your parcel is waiting to be registered in the carrier system and scheduled for pickup. | `AWAITING_PICKUP_DROP_OFF` | Your parcel is waiting to be handed over to the carrier. | `DROPPED_OFF` | Your parcel has been dropped off and is ready for carrier processing. | `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system. | `PICKED_UP` | Your parcel has been picked up by the carrier. | `CUSTOMS_CLEARED` | Your parcel has cleared customs and is continuing its journey. | `CUSTOMS_PROCESSING` | Your parcel is currently being processed by customs. | `DELIVERY_ARRANGED_WITH_RECIPIENT` | Your parcel's delivery has been arranged with the carrier. | `HUB_SCAN_OUT` | Your parcel has left the carrier's hub. | `HUB_SCAN_IN` | Your parcel has arrived at the carrier's hub for processing. | `IN_TRANSIT` | Your shipment is on its way between the carrier hubs. | `INFORMATION` | The carrier has shared additional information about your parcel. | `PARCEL_OVER_LABELLED` | Your parcel's label has been updated by the carrier, which may affect tracking visibility. | `PARCEL_UPDATE_NOTIFICATION` | The carrier has sent you an update on your parcel status via SMS or email. | `RECEIVED_BY_CARRIER` | Your parcel has been received by the carrier and is beginning its journey. | `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your parcel has arrived at the local delivery depot and is almost ready for delivery. | `SUB_CONTRACTOR_EVENT` | The carrier has shared additional information about your parcel's handling by a delivery partner. | `SUB_CONTRACTOR_RECEIVED` | Your parcel has been received by the carrier's local delivery partner. | `PARCEL_REDIRECTED` | Your parcel has been redirected to a new delivery address per your request. | `DELIVERY_SCHEDULED` | Your parcel's delivery has been scheduled and will soon be out for delivery. | `HUB_PROCESSING` | Your parcel is being processed at a carrier hub. | `DELIVERY_RESCHEDULED` | Your parcel's delivery has been rescheduled due to operational issues. | `ATTEMPTED_DELIVERY` | The carrier attempted to deliver your parcel but was unable to complete delivery. | `ATTEMPTED_DELIVERY_FINAL` | The carrier made a final attempt to deliver your parcel but was unable to complete delivery. Please check the carrier's instructions for next steps. | `COD_AMOUNT_PAID` | Cash on delivery payment received. | `CUSTOMER_CARDED` | Delivery attempt failed. Please follow delivery instructions left by the carrier. | `OUT_FOR_DELIVERY` | Your parcel is on its way and will be delivered today. | `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your parcel is ready for collection at the selected pickup point. | `COLLECT_AT_LOCAL_PO` | Your parcel is ready for collection at your local post office. | `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your parcel is available for collection from the carrier's local delivery unit. | `DELIVERED_TO_RECEPTION` | Your parcel has been delivered to your building's reception or designated mail area. | `DELIVERED` | Your parcel has been successfully delivered. | `DELIVERED_DAMAGED` | Your parcel was delivered but arrived with visible damage. | `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest. | `DELIVERED_SPECIFIED_SAFE_PLACE` | Your parcel has been delivered to your specified safe place. | `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your parcel was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details. | `DELIVERED_TO_NEIGHBOUR` | Your parcel was delivered to your neighbor. | `DELIVERED_TO_PO_BOX` | Your parcel has been delivered to your specified PO Box. | `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the pick up point. | `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery. | `PROOF_OF_DELIVERY` | The carrier has confirmed delivery with proof, such as a signature or photo. | `PICKUP_FAILED` | Parcel pickup failed. The delivery company will try again soon. | `NOT_YET_RECEIVED_BY_CARRIER` | The carrier has not yet received your parcel, which may cause a delay. | `PARCEL_DAMAGED` | Your parcel was damaged in transit but will still be delivered. | `ADDRESS_QUERY` | There is an issue with the delivery address, which may delay your parcel. | `CARRIER_DELAYS` | Your parcel is delayed due to issues within the carrier network. | `DELAYED_NOT_CARRIER` | Your parcel is delayed due to circumstances beyond the carrier's control. | `HELD_BY_CARRIER` | Your parcel is being held due to an operational issue. Contact with the carrier for more information. | `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your parcel is being held by the carrier for customs documentation checks. This may occur when the carrier must confirm documentation before the parcel can continue its journey. | `HELD_BY_CUSTOMS` | Your parcel is being held at customs, which may delay delivery. | `HELD_BY_EXPORT_CUSTOMS` | Your parcel is held at export customs, which may delay delivery. | `HELD_BY_IMPORT_CUSTOMS` | Your parcel is held at import customs and may require action to proceed. | `INCORRECT_DECLARATION` | Your parcel has been incorrectly declared but is still moving forward for delivery. | `MISROUTED` | Your parcel was sent to the wrong place due to a routing error but is being redirected. | `PARCEL_REPACKED` | Your parcel was repackaged by the carrier due to damage and will still be delivered. | `RECD_BY_CARRIER_NO_ELEC_ADVICE` | Your parcel has been received by the carrier but may experience delays due to missing pre-advice. | `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please follow carrier instructions. | `CUSTOMER_IDENTIFICATION_FAILED` | Delivery couldn't be completed as identification requirements were not met. | `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | The carrier couldn't access the delivery location due to restricted entry. | `CANCELLED` | Your parcel has been cancelled. | `CUSTOMER_MOVED` | Delivery failed as the recipient is no longer at the specified address. Your parcel is being returned. | `HAZARDOUS_PROHIBITED` | Your parcel contains restricted items and will not be delivered. | `NOT_COLLECTED_FROM_PICKUP_POINT` | Your parcel was not collected from the pickup point within the designated time and will be returned. | `NOT_DELIVERED` | All delivery attempts failed. Your parcel is being returned to the sender. | `NOT_DELIVERED_ADDRESSEE_DECEASED` | The parcel could not be delivered as the addressee is reported deceased. | `PARCEL_DISPOSED` | Your parcel has been disposed of due to its contents or condition and will not be delivered. | `PARCEL_LOST` | The carrier has reported that your parcel is lost and will not be delivered. | `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | The parcel cannot be delivered as it exceeds the carrier's service limits. | `REFUSED_BY_CUSTOMER` | You have refused the parcel, and it will be returned to the sender. | `RETURN_TO_SENDER` | Your parcel is being returned to the sender due to delivery issues. | `UNSPECIFIED_EXCEPTION` | The carrier has reported an issue with your parcel, but details are unavailable. /// -/// The tracking status detail codes |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- | `COLLECTION_FAILED` | Shipment pickup failed. The delivery company will try again soon. | `AWAITING_DESPATCH` | Your shipment is ready to go and is waiting for pickup. | `COLLECTION_REQUESTED` | Your shipment pickup has been scheduled. | `DESPATCHED` | Your shipment has been handed over to the carrier or dropped off at collection point. It will soon start its journey. | `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system. | `NOT_YET_RECEIVED_BY_CARRIER` | The sender couldn't hand over your shipment. The delivery company will try to collect it again. | `COLLECTION_MADE` | Your shipment has been picked up by the carrier. | `ATTEMPTED_DELIVERY` | Delivery attempt failed. Please check the carrier's instructions for next steps. | `ATTEMPTED_DELIVERY_2ND` | Second delivery attempt failed. Please check the carrier's instructions for next steps. | `ATTEMPTED_DELIVERY_3RD` | Third delivery attempt failed. Please check the carrier's instructions for next steps. | `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please check carrier instructions. | `COD_AMOUNT_PAID` | Cash on delivery payment received. | `CUSTOMER_CARDED` | Delivery attempt failed. Please check for delivery instructions left by the carrier. | `CUSTOMER_IDENTIFICATION_FAILED` | There was a recipient identification issue. Please check carrier instructions. | `INVALID_METHOD_OF_PAYMENT` | Delivery failed due to incorrect payment. Please check carrier instructions. | `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | Delivery couldn't be completed due to issues with accessing address. Please follow carrier instructions. | `OUT_FOR_DELIVERY` | Your shipment is out for delivery. | `DELIVERED` | Your shipment has been delivered. | `DELIVERED_DAMAGED` | Your shipment was delivered but arrived damaged. | `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest. | `DELIVERED_SPECIFIED_SAFE_PLACE` | Your shipment has been left in your designated safe place. | `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your shipment was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details. | `DELIVERED_TO_NEIGHBOUR` | Your shipment was delivered to your neighbor. | `DELIVERED_TO_PO_BOX` | Your shipment was delivered to your PO Box. | `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the collection point. | `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery. | `PROOF_OF_DELIVERY` | Delivery confirmed. | `CANCELLED` | Your shipment has been cancelled. | `CANCELLED_BEFORE_DESPATCH` | Your shipment was cancelled before pickup. Contact the sender if unexpected. | `CUSTOMER_MOVED` | Recipient not at address. Your shipment is being returned. | `HAZARDOUS_PROHIBITED` | Your parcel contained a prohibited item and is being returned. Contact the sender. | `NOT_COLLECTED_FROM_PICKUP_POINT` | Shipment not collected from the pickup point. Your parcel is being returned to the sender. | `NOT_DELIVERED` | Delivery attempts failed. Your parcel is being returned to the sender. | `NOT_DELIVERED_ADDRESSEE_DECEASED` | Delivery not possible due to recipient's passing. | `PARCEL_DAMAGED` | Your parcel was damaged and can't be delivered. It's being returned. Contact the sender. | `PARCEL_DISPOSED` | Shipment was disposed of. Contact the sender for details. | `PARCEL_LOST` | Your parcel is lost. Contact the sender for next steps. | `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | Shipment is too large/heavy for delivery. Being returned. Contact sender. | `REFUSED_BY_CUSTOMER` | Delivery refused. Shipment being returned. Contact the sender. | `RETURN_TO_SENDER` | Your shipment is being returned to the sender. Contact them for details. | `ADDRESS_QUERY` | There's an issue with your delivery address. This may cause a delay or return. Contact sender or carrier. | `CARRIER_DELAYS` | There's a delivery delay. We'll update you when there's more info. | `CUSTOMS_CLEARED` | Your shipment has passed customs clearance. | `CUSTOMS_PROCESSING` | Your shipment is going through customs. | `DELAYED_NOT_CARRIER` | Unexpected delivery delay. We'll update you soon. | `DELIVERY_ARRANGED_WITH_RECIPIENT` | Delivery arranged by recipient. | `HELD_BY_CARRIER` | Your shipment is on hold due to a carrier issue. We'll update you soon. | `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your shipment is held by carrier due to customs issues. We'll update you. | `HELD_BY_CUSTOMS` | Your shipment is held in customs. We'll update you. | `HELD_BY_EXPORT_CUSTOMS` | Your shipment is held in export customs. We'll update you. | `HELD_BY_IMPORT_CUSTOMS` | Your shipment is held in import customs. We'll update you. | `HUB_SCAN_OUT` | Your shipment is at the main delivery depot. | `IN_TRANSIT` | Your shipment is on its way between depots. | `INCORRECT_DECLARATION` | Incorrect shipment dimensions. Delivery may be delayed or returned. We'll update you. | `INFORMATION` | The carrier has shared additional shipment information. | `MISSORTED` | Your shipment was missorted. There might be a delivery delay. We'll update you. | `PARCEL_OVER_LABELLED` | Your shipment was over labelled by the delivery company to improve processing. | `PARCEL_REPACKED` | Your shipment packaging was damaged. It's being repacked. This might delay delivery. | `PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL` | You've received an email with a shipment update. | `PARCEL_UPDATE_NOTIFICATION_VIA_SMS` | You've received a text message with a shipment update. | `RECEIVED_BY_CARRIER` | Your shipment has been received by the carrier. | `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your shipment is at the local delivery depot, ready for delivery. | `ROUTING_ERROR` | Your shipment was sent to the wrong place. There might be a delay. | `SUB_CONTRACTOR_EVENT` | Your shipment is with the local delivery partner. | `SUB_CONTRACTOR_RECEIVED` | Your shipment has been received by the local delivery partner. | `RECD_BY_CARRIER_NO_ELEC_ADVICE` | There's a system issue with your shipment. Tracking updates might be delayed. | `AWAITING_ELECTRONIC_ADVICE` | Your tracking number is ready. Your shipment is waiting to be registered in the carrier system and scheduled for pickup. | `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your shipment is ready for pickup at the specified location. | `COLLECT_AT_LOCAL_PO` | Your shipment has been redirected to the local post office for pickup. Check carrier instructions. | `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your shipment is being held for pickup. Check carrier instructions. | `DELIVERED_TO_LOCKER_COLLECTION_POINT` | Your shipment has been delivered to your locker. | `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates. +/// The tracking status detail codes |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- | `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates. | `SHIPMENT_CREATED` | Your tracking number is ready. Your parcel is waiting to be registered in the carrier system and scheduled for pickup. | `AWAITING_PICKUP_DROP_OFF` | Your parcel is waiting to be handed over to the carrier. | `DROPPED_OFF` | Your parcel has been dropped off and is ready for carrier processing. | `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system. | `PICKED_UP` | Your parcel has been picked up by the carrier. | `CUSTOMS_CLEARED` | Your parcel has cleared customs and is continuing its journey. | `CUSTOMS_PROCESSING` | Your parcel is currently being processed by customs. | `DELIVERY_ARRANGED_WITH_RECIPIENT` | Your parcel's delivery has been arranged with the carrier. | `HUB_SCAN_OUT` | Your parcel has left the carrier's hub. | `HUB_SCAN_IN` | Your parcel has arrived at the carrier's hub for processing. | `IN_TRANSIT` | Your shipment is on its way between the carrier hubs. | `INFORMATION` | The carrier has shared additional information about your parcel. | `PARCEL_OVER_LABELLED` | Your parcel's label has been updated by the carrier, which may affect tracking visibility. | `PARCEL_UPDATE_NOTIFICATION` | The carrier has sent you an update on your parcel status via SMS or email. | `RECEIVED_BY_CARRIER` | Your parcel has been received by the carrier and is beginning its journey. | `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your parcel has arrived at the local delivery depot and is almost ready for delivery. | `SUB_CONTRACTOR_EVENT` | The carrier has shared additional information about your parcel's handling by a delivery partner. | `SUB_CONTRACTOR_RECEIVED` | Your parcel has been received by the carrier's local delivery partner. | `PARCEL_REDIRECTED` | Your parcel has been redirected to a new delivery address per your request. | `DELIVERY_SCHEDULED` | Your parcel's delivery has been scheduled and will soon be out for delivery. | `HUB_PROCESSING` | Your parcel is being processed at a carrier hub. | `DELIVERY_RESCHEDULED` | Your parcel's delivery has been rescheduled due to operational issues. | `ATTEMPTED_DELIVERY` | The carrier attempted to deliver your parcel but was unable to complete delivery. | `ATTEMPTED_DELIVERY_FINAL` | The carrier made a final attempt to deliver your parcel but was unable to complete delivery. Please check the carrier's instructions for next steps. | `COD_AMOUNT_PAID` | Cash on delivery payment received. | `CUSTOMER_CARDED` | Delivery attempt failed. Please follow delivery instructions left by the carrier. | `OUT_FOR_DELIVERY` | Your parcel is on its way and will be delivered today. | `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your parcel is ready for collection at the selected pickup point. | `COLLECT_AT_LOCAL_PO` | Your parcel is ready for collection at your local post office. | `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your parcel is available for collection from the carrier's local delivery unit. | `DELIVERED_TO_RECEPTION` | Your parcel has been delivered to your building's reception or designated mail area. | `DELIVERED` | Your parcel has been successfully delivered. | `DELIVERED_DAMAGED` | Your parcel was delivered but arrived with visible damage. | `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest. | `DELIVERED_SPECIFIED_SAFE_PLACE` | Your parcel has been delivered to your specified safe place. | `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your parcel was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details. | `DELIVERED_TO_NEIGHBOUR` | Your parcel was delivered to your neighbor. | `DELIVERED_TO_PO_BOX` | Your parcel has been delivered to your specified PO Box. | `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the pick up point. | `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery. | `PROOF_OF_DELIVERY` | The carrier has confirmed delivery with proof, such as a signature or photo. | `PICKUP_FAILED` | Parcel pickup failed. The delivery company will try again soon. | `NOT_YET_RECEIVED_BY_CARRIER` | The carrier has not yet received your parcel, which may cause a delay. | `PARCEL_DAMAGED` | Your parcel was damaged in transit but will still be delivered. | `ADDRESS_QUERY` | There is an issue with the delivery address, which may delay your parcel. | `CARRIER_DELAYS` | Your parcel is delayed due to issues within the carrier network. | `DELAYED_NOT_CARRIER` | Your parcel is delayed due to circumstances beyond the carrier's control. | `HELD_BY_CARRIER` | Your parcel is being held due to an operational issue. Contact with the carrier for more information. | `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your parcel is being held by the carrier for customs documentation checks. This may occur when the carrier must confirm documentation before the parcel can continue its journey. | `HELD_BY_CUSTOMS` | Your parcel is being held at customs, which may delay delivery. | `HELD_BY_EXPORT_CUSTOMS` | Your parcel is held at export customs, which may delay delivery. | `HELD_BY_IMPORT_CUSTOMS` | Your parcel is held at import customs and may require action to proceed. | `INCORRECT_DECLARATION` | Your parcel has been incorrectly declared but is still moving forward for delivery. | `MISROUTED` | Your parcel was sent to the wrong place due to a routing error but is being redirected. | `PARCEL_REPACKED` | Your parcel was repackaged by the carrier due to damage and will still be delivered. | `RECD_BY_CARRIER_NO_ELEC_ADVICE` | Your parcel has been received by the carrier but may experience delays due to missing pre-advice. | `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please follow carrier instructions. | `CUSTOMER_IDENTIFICATION_FAILED` | Delivery couldn't be completed as identification requirements were not met. | `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | The carrier couldn't access the delivery location due to restricted entry. | `CANCELLED` | Your parcel has been cancelled. | `CUSTOMER_MOVED` | Delivery failed as the recipient is no longer at the specified address. Your parcel is being returned. | `HAZARDOUS_PROHIBITED` | Your parcel contains restricted items and will not be delivered. | `NOT_COLLECTED_FROM_PICKUP_POINT` | Your parcel was not collected from the pickup point within the designated time and will be returned. | `NOT_DELIVERED` | All delivery attempts failed. Your parcel is being returned to the sender. | `NOT_DELIVERED_ADDRESSEE_DECEASED` | The parcel could not be delivered as the addressee is reported deceased. | `PARCEL_DISPOSED` | Your parcel has been disposed of due to its contents or condition and will not be delivered. | `PARCEL_LOST` | The carrier has reported that your parcel is lost and will not be delivered. | `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | The parcel cannot be delivered as it exceeds the carrier's service limits. | `REFUSED_BY_CUSTOMER` | You have refused the parcel, and it will be returned to the sender. | `RETURN_TO_SENDER` | Your parcel is being returned to the sender due to delivery issues. | `UNSPECIFIED_EXCEPTION` | The carrier has reported an issue with your parcel, but details are unavailable. [JsonConverter(typeof(StatusDetailCodeJsonConverter))] public class StatusDetailCode { @@ -34,7 +34,7 @@ public class StatusDetailCode /// internal StatusDetailCode() { - _value = "COLLECTION_FAILED"; + _value = "CARRIER_STATUS_NOT_MAPPED"; } /// @@ -51,27 +51,27 @@ public StatusDetailCode(string value) } /// - /// Enum COLLECTIONFAILED for value: COLLECTION_FAILED + /// Enum CARRIERSTATUSNOTMAPPED for value: CARRIER_STATUS_NOT_MAPPED /// - public static StatusDetailCode COLLECTIONFAILED { get; } = new("COLLECTION_FAILED"); + public static StatusDetailCode CARRIERSTATUSNOTMAPPED { get; } = new("CARRIER_STATUS_NOT_MAPPED"); /// - /// Enum AWAITINGDESPATCH for value: AWAITING_DESPATCH + /// Enum SHIPMENTCREATED for value: SHIPMENT_CREATED /// - public static StatusDetailCode AWAITINGDESPATCH { get; } = new("AWAITING_DESPATCH"); + public static StatusDetailCode SHIPMENTCREATED { get; } = new("SHIPMENT_CREATED"); /// - /// Enum COLLECTIONREQUESTED for value: COLLECTION_REQUESTED + /// Enum AWAITINGPICKUPDROPOFF for value: AWAITING_PICKUP_DROP_OFF /// - public static StatusDetailCode COLLECTIONREQUESTED { get; } = new("COLLECTION_REQUESTED"); + public static StatusDetailCode AWAITINGPICKUPDROPOFF { get; } = new("AWAITING_PICKUP_DROP_OFF"); /// - /// Enum DESPATCHED for value: DESPATCHED + /// Enum DROPPEDOFF for value: DROPPED_OFF /// - public static StatusDetailCode DESPATCHED { get; } = new("DESPATCHED"); + public static StatusDetailCode DROPPEDOFF { get; } = new("DROPPED_OFF"); /// @@ -81,249 +81,261 @@ public StatusDetailCode(string value) /// - /// Enum NOTYETRECEIVEDBYCARRIER for value: NOT_YET_RECEIVED_BY_CARRIER + /// Enum PICKEDUP for value: PICKED_UP /// - public static StatusDetailCode NOTYETRECEIVEDBYCARRIER { get; } = new("NOT_YET_RECEIVED_BY_CARRIER"); + public static StatusDetailCode PICKEDUP { get; } = new("PICKED_UP"); /// - /// Enum COLLECTIONMADE for value: COLLECTION_MADE + /// Enum CUSTOMSCLEARED for value: CUSTOMS_CLEARED /// - public static StatusDetailCode COLLECTIONMADE { get; } = new("COLLECTION_MADE"); + public static StatusDetailCode CUSTOMSCLEARED { get; } = new("CUSTOMS_CLEARED"); /// - /// Enum ATTEMPTEDDELIVERY for value: ATTEMPTED_DELIVERY + /// Enum CUSTOMSPROCESSING for value: CUSTOMS_PROCESSING /// - public static StatusDetailCode ATTEMPTEDDELIVERY { get; } = new("ATTEMPTED_DELIVERY"); + public static StatusDetailCode CUSTOMSPROCESSING { get; } = new("CUSTOMS_PROCESSING"); /// - /// Enum ATTEMPTEDDELIVERY2ND for value: ATTEMPTED_DELIVERY_2ND + /// Enum DELIVERYARRANGEDWITHRECIPIENT for value: DELIVERY_ARRANGED_WITH_RECIPIENT /// - public static StatusDetailCode ATTEMPTEDDELIVERY2ND { get; } = new("ATTEMPTED_DELIVERY_2ND"); + public static StatusDetailCode DELIVERYARRANGEDWITHRECIPIENT { get; } = new("DELIVERY_ARRANGED_WITH_RECIPIENT"); /// - /// Enum ATTEMPTEDDELIVERY3RD for value: ATTEMPTED_DELIVERY_3RD + /// Enum HUBSCANOUT for value: HUB_SCAN_OUT /// - public static StatusDetailCode ATTEMPTEDDELIVERY3RD { get; } = new("ATTEMPTED_DELIVERY_3RD"); + public static StatusDetailCode HUBSCANOUT { get; } = new("HUB_SCAN_OUT"); /// - /// Enum CODAMOUNTNOTPAID for value: COD_AMOUNT_NOT_PAID + /// Enum HUBSCANIN for value: HUB_SCAN_IN /// - public static StatusDetailCode CODAMOUNTNOTPAID { get; } = new("COD_AMOUNT_NOT_PAID"); + public static StatusDetailCode HUBSCANIN { get; } = new("HUB_SCAN_IN"); /// - /// Enum CODAMOUNTPAID for value: COD_AMOUNT_PAID + /// Enum INTRANSIT for value: IN_TRANSIT /// - public static StatusDetailCode CODAMOUNTPAID { get; } = new("COD_AMOUNT_PAID"); + public static StatusDetailCode INTRANSIT { get; } = new("IN_TRANSIT"); /// - /// Enum CUSTOMERCARDED for value: CUSTOMER_CARDED + /// Enum INFORMATION for value: INFORMATION /// - public static StatusDetailCode CUSTOMERCARDED { get; } = new("CUSTOMER_CARDED"); + public static StatusDetailCode INFORMATION { get; } = new("INFORMATION"); /// - /// Enum CUSTOMERIDENTIFICATIONFAILED for value: CUSTOMER_IDENTIFICATION_FAILED + /// Enum PARCELOVERLABELLED for value: PARCEL_OVER_LABELLED /// - public static StatusDetailCode CUSTOMERIDENTIFICATIONFAILED { get; } = new("CUSTOMER_IDENTIFICATION_FAILED"); + public static StatusDetailCode PARCELOVERLABELLED { get; } = new("PARCEL_OVER_LABELLED"); /// - /// Enum INVALIDMETHODOFPAYMENT for value: INVALID_METHOD_OF_PAYMENT + /// Enum PARCELUPDATENOTIFICATION for value: PARCEL_UPDATE_NOTIFICATION /// - public static StatusDetailCode INVALIDMETHODOFPAYMENT { get; } = new("INVALID_METHOD_OF_PAYMENT"); + public static StatusDetailCode PARCELUPDATENOTIFICATION { get; } = new("PARCEL_UPDATE_NOTIFICATION"); /// - /// Enum NOACCESSTORECIPIENTSADDRESS for value: NO_ACCESS_TO_RECIPIENTS_ADDRESS + /// Enum RECEIVEDBYCARRIER for value: RECEIVED_BY_CARRIER /// - public static StatusDetailCode NOACCESSTORECIPIENTSADDRESS { get; } = new("NO_ACCESS_TO_RECIPIENTS_ADDRESS"); + public static StatusDetailCode RECEIVEDBYCARRIER { get; } = new("RECEIVED_BY_CARRIER"); /// - /// Enum OUTFORDELIVERY for value: OUT_FOR_DELIVERY + /// Enum RECEIVEDLOCALDELIVERYDEPOT for value: RECEIVED_LOCAL_DELIVERY_DEPOT /// - public static StatusDetailCode OUTFORDELIVERY { get; } = new("OUT_FOR_DELIVERY"); + public static StatusDetailCode RECEIVEDLOCALDELIVERYDEPOT { get; } = new("RECEIVED_LOCAL_DELIVERY_DEPOT"); /// - /// Enum DELIVERED for value: DELIVERED + /// Enum SUBCONTRACTOREVENT for value: SUB_CONTRACTOR_EVENT /// - public static StatusDetailCode DELIVERED { get; } = new("DELIVERED"); + public static StatusDetailCode SUBCONTRACTOREVENT { get; } = new("SUB_CONTRACTOR_EVENT"); /// - /// Enum DELIVEREDDAMAGED for value: DELIVERED_DAMAGED + /// Enum SUBCONTRACTORRECEIVED for value: SUB_CONTRACTOR_RECEIVED /// - public static StatusDetailCode DELIVEREDDAMAGED { get; } = new("DELIVERED_DAMAGED"); + public static StatusDetailCode SUBCONTRACTORRECEIVED { get; } = new("SUB_CONTRACTOR_RECEIVED"); /// - /// Enum DELIVEREDINPART for value: DELIVERED_IN_PART + /// Enum PARCELREDIRECTED for value: PARCEL_REDIRECTED /// - public static StatusDetailCode DELIVEREDINPART { get; } = new("DELIVERED_IN_PART"); + public static StatusDetailCode PARCELREDIRECTED { get; } = new("PARCEL_REDIRECTED"); /// - /// Enum DELIVEREDSPECIFIEDSAFEPLACE for value: DELIVERED_SPECIFIED_SAFE_PLACE + /// Enum DELIVERYSCHEDULED for value: DELIVERY_SCHEDULED /// - public static StatusDetailCode DELIVEREDSPECIFIEDSAFEPLACE { get; } = new("DELIVERED_SPECIFIED_SAFE_PLACE"); + public static StatusDetailCode DELIVERYSCHEDULED { get; } = new("DELIVERY_SCHEDULED"); /// - /// Enum DELIVEREDTOALTERNATIVEDELIVERYLOCATION for value: DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION + /// Enum HUBPROCESSING for value: HUB_PROCESSING /// - public static StatusDetailCode DELIVEREDTOALTERNATIVEDELIVERYLOCATION { get; } = new("DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION"); + public static StatusDetailCode HUBPROCESSING { get; } = new("HUB_PROCESSING"); /// - /// Enum DELIVEREDTONEIGHBOUR for value: DELIVERED_TO_NEIGHBOUR + /// Enum DELIVERYRESCHEDULED for value: DELIVERY_RESCHEDULED /// - public static StatusDetailCode DELIVEREDTONEIGHBOUR { get; } = new("DELIVERED_TO_NEIGHBOUR"); + public static StatusDetailCode DELIVERYRESCHEDULED { get; } = new("DELIVERY_RESCHEDULED"); /// - /// Enum DELIVEREDTOPOBOX for value: DELIVERED_TO_PO_BOX + /// Enum ATTEMPTEDDELIVERY for value: ATTEMPTED_DELIVERY /// - public static StatusDetailCode DELIVEREDTOPOBOX { get; } = new("DELIVERED_TO_PO_BOX"); + public static StatusDetailCode ATTEMPTEDDELIVERY { get; } = new("ATTEMPTED_DELIVERY"); /// - /// Enum PARCELCOLLECTEDFROMPICKUPPOINT for value: PARCEL_COLLECTED_FROM_PICKUP_POINT + /// Enum ATTEMPTEDDELIVERYFINAL for value: ATTEMPTED_DELIVERY_FINAL /// - public static StatusDetailCode PARCELCOLLECTEDFROMPICKUPPOINT { get; } = new("PARCEL_COLLECTED_FROM_PICKUP_POINT"); + public static StatusDetailCode ATTEMPTEDDELIVERYFINAL { get; } = new("ATTEMPTED_DELIVERY_FINAL"); /// - /// Enum POSTTRANSITSTATUS for value: POST_TRANSIT_STATUS + /// Enum CODAMOUNTPAID for value: COD_AMOUNT_PAID /// - public static StatusDetailCode POSTTRANSITSTATUS { get; } = new("POST_TRANSIT_STATUS"); + public static StatusDetailCode CODAMOUNTPAID { get; } = new("COD_AMOUNT_PAID"); /// - /// Enum PROOFOFDELIVERY for value: PROOF_OF_DELIVERY + /// Enum CUSTOMERCARDED for value: CUSTOMER_CARDED /// - public static StatusDetailCode PROOFOFDELIVERY { get; } = new("PROOF_OF_DELIVERY"); + public static StatusDetailCode CUSTOMERCARDED { get; } = new("CUSTOMER_CARDED"); /// - /// Enum CANCELLED for value: CANCELLED + /// Enum OUTFORDELIVERY for value: OUT_FOR_DELIVERY /// - public static StatusDetailCode CANCELLED { get; } = new("CANCELLED"); + public static StatusDetailCode OUTFORDELIVERY { get; } = new("OUT_FOR_DELIVERY"); /// - /// Enum CANCELLEDBEFOREDESPATCH for value: CANCELLED_BEFORE_DESPATCH + /// Enum AWAITINGCOLLECTIONFROMPICKUPPOINT for value: AWAITING_COLLECTION_FROM_PICKUP_POINT /// - public static StatusDetailCode CANCELLEDBEFOREDESPATCH { get; } = new("CANCELLED_BEFORE_DESPATCH"); + public static StatusDetailCode AWAITINGCOLLECTIONFROMPICKUPPOINT { get; } = new("AWAITING_COLLECTION_FROM_PICKUP_POINT"); /// - /// Enum CUSTOMERMOVED for value: CUSTOMER_MOVED + /// Enum COLLECTATLOCALPO for value: COLLECT_AT_LOCAL_PO /// - public static StatusDetailCode CUSTOMERMOVED { get; } = new("CUSTOMER_MOVED"); + public static StatusDetailCode COLLECTATLOCALPO { get; } = new("COLLECT_AT_LOCAL_PO"); /// - /// Enum HAZARDOUSPROHIBITED for value: HAZARDOUS_PROHIBITED + /// Enum CUSTOMERTOCOLLECTFROMCARRIER for value: CUSTOMER_TO_COLLECT_FROM_CARRIER /// - public static StatusDetailCode HAZARDOUSPROHIBITED { get; } = new("HAZARDOUS_PROHIBITED"); + public static StatusDetailCode CUSTOMERTOCOLLECTFROMCARRIER { get; } = new("CUSTOMER_TO_COLLECT_FROM_CARRIER"); /// - /// Enum NOTCOLLECTEDFROMPICKUPPOINT for value: NOT_COLLECTED_FROM_PICKUP_POINT + /// Enum DELIVEREDTORECEPTION for value: DELIVERED_TO_RECEPTION /// - public static StatusDetailCode NOTCOLLECTEDFROMPICKUPPOINT { get; } = new("NOT_COLLECTED_FROM_PICKUP_POINT"); + public static StatusDetailCode DELIVEREDTORECEPTION { get; } = new("DELIVERED_TO_RECEPTION"); /// - /// Enum NOTDELIVERED for value: NOT_DELIVERED + /// Enum DELIVERED for value: DELIVERED /// - public static StatusDetailCode NOTDELIVERED { get; } = new("NOT_DELIVERED"); + public static StatusDetailCode DELIVERED { get; } = new("DELIVERED"); /// - /// Enum NOTDELIVEREDADDRESSEEDECEASED for value: NOT_DELIVERED_ADDRESSEE_DECEASED + /// Enum DELIVEREDDAMAGED for value: DELIVERED_DAMAGED /// - public static StatusDetailCode NOTDELIVEREDADDRESSEEDECEASED { get; } = new("NOT_DELIVERED_ADDRESSEE_DECEASED"); + public static StatusDetailCode DELIVEREDDAMAGED { get; } = new("DELIVERED_DAMAGED"); /// - /// Enum PARCELDAMAGED for value: PARCEL_DAMAGED + /// Enum DELIVEREDINPART for value: DELIVERED_IN_PART /// - public static StatusDetailCode PARCELDAMAGED { get; } = new("PARCEL_DAMAGED"); + public static StatusDetailCode DELIVEREDINPART { get; } = new("DELIVERED_IN_PART"); /// - /// Enum PARCELDISPOSED for value: PARCEL_DISPOSED + /// Enum DELIVEREDSPECIFIEDSAFEPLACE for value: DELIVERED_SPECIFIED_SAFE_PLACE /// - public static StatusDetailCode PARCELDISPOSED { get; } = new("PARCEL_DISPOSED"); + public static StatusDetailCode DELIVEREDSPECIFIEDSAFEPLACE { get; } = new("DELIVERED_SPECIFIED_SAFE_PLACE"); /// - /// Enum PARCELLOST for value: PARCEL_LOST + /// Enum DELIVEREDTOALTERNATIVEDELIVERYLOCATION for value: DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION /// - public static StatusDetailCode PARCELLOST { get; } = new("PARCEL_LOST"); + public static StatusDetailCode DELIVEREDTOALTERNATIVEDELIVERYLOCATION { get; } = new("DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION"); /// - /// Enum PARCELOUTSIDEOFSERVICECAPABILITY for value: PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY + /// Enum DELIVEREDTONEIGHBOUR for value: DELIVERED_TO_NEIGHBOUR /// - public static StatusDetailCode PARCELOUTSIDEOFSERVICECAPABILITY { get; } = new("PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY"); + public static StatusDetailCode DELIVEREDTONEIGHBOUR { get; } = new("DELIVERED_TO_NEIGHBOUR"); /// - /// Enum REFUSEDBYCUSTOMER for value: REFUSED_BY_CUSTOMER + /// Enum DELIVEREDTOPOBOX for value: DELIVERED_TO_PO_BOX /// - public static StatusDetailCode REFUSEDBYCUSTOMER { get; } = new("REFUSED_BY_CUSTOMER"); + public static StatusDetailCode DELIVEREDTOPOBOX { get; } = new("DELIVERED_TO_PO_BOX"); /// - /// Enum RETURNTOSENDER for value: RETURN_TO_SENDER + /// Enum PARCELCOLLECTEDFROMPICKUPPOINT for value: PARCEL_COLLECTED_FROM_PICKUP_POINT /// - public static StatusDetailCode RETURNTOSENDER { get; } = new("RETURN_TO_SENDER"); + public static StatusDetailCode PARCELCOLLECTEDFROMPICKUPPOINT { get; } = new("PARCEL_COLLECTED_FROM_PICKUP_POINT"); /// - /// Enum ADDRESSQUERY for value: ADDRESS_QUERY + /// Enum POSTTRANSITSTATUS for value: POST_TRANSIT_STATUS /// - public static StatusDetailCode ADDRESSQUERY { get; } = new("ADDRESS_QUERY"); + public static StatusDetailCode POSTTRANSITSTATUS { get; } = new("POST_TRANSIT_STATUS"); /// - /// Enum CARRIERDELAYS for value: CARRIER_DELAYS + /// Enum PROOFOFDELIVERY for value: PROOF_OF_DELIVERY /// - public static StatusDetailCode CARRIERDELAYS { get; } = new("CARRIER_DELAYS"); + public static StatusDetailCode PROOFOFDELIVERY { get; } = new("PROOF_OF_DELIVERY"); /// - /// Enum CUSTOMSCLEARED for value: CUSTOMS_CLEARED + /// Enum PICKUPFAILED for value: PICKUP_FAILED /// - public static StatusDetailCode CUSTOMSCLEARED { get; } = new("CUSTOMS_CLEARED"); + public static StatusDetailCode PICKUPFAILED { get; } = new("PICKUP_FAILED"); /// - /// Enum CUSTOMSPROCESSING for value: CUSTOMS_PROCESSING + /// Enum NOTYETRECEIVEDBYCARRIER for value: NOT_YET_RECEIVED_BY_CARRIER /// - public static StatusDetailCode CUSTOMSPROCESSING { get; } = new("CUSTOMS_PROCESSING"); + public static StatusDetailCode NOTYETRECEIVEDBYCARRIER { get; } = new("NOT_YET_RECEIVED_BY_CARRIER"); /// - /// Enum DELAYEDNOTCARRIER for value: DELAYED_NOT_CARRIER + /// Enum PARCELDAMAGED for value: PARCEL_DAMAGED /// - public static StatusDetailCode DELAYEDNOTCARRIER { get; } = new("DELAYED_NOT_CARRIER"); + public static StatusDetailCode PARCELDAMAGED { get; } = new("PARCEL_DAMAGED"); /// - /// Enum DELIVERYARRANGEDWITHRECIPIENT for value: DELIVERY_ARRANGED_WITH_RECIPIENT + /// Enum ADDRESSQUERY for value: ADDRESS_QUERY /// - public static StatusDetailCode DELIVERYARRANGEDWITHRECIPIENT { get; } = new("DELIVERY_ARRANGED_WITH_RECIPIENT"); + public static StatusDetailCode ADDRESSQUERY { get; } = new("ADDRESS_QUERY"); + + + /// + /// Enum CARRIERDELAYS for value: CARRIER_DELAYS + /// + public static StatusDetailCode CARRIERDELAYS { get; } = new("CARRIER_DELAYS"); + + + /// + /// Enum DELAYEDNOTCARRIER for value: DELAYED_NOT_CARRIER + /// + public static StatusDetailCode DELAYEDNOTCARRIER { get; } = new("DELAYED_NOT_CARRIER"); /// @@ -356,18 +368,6 @@ public StatusDetailCode(string value) public static StatusDetailCode HELDBYIMPORTCUSTOMS { get; } = new("HELD_BY_IMPORT_CUSTOMS"); - /// - /// Enum HUBSCANOUT for value: HUB_SCAN_OUT - /// - public static StatusDetailCode HUBSCANOUT { get; } = new("HUB_SCAN_OUT"); - - - /// - /// Enum INTRANSIT for value: IN_TRANSIT - /// - public static StatusDetailCode INTRANSIT { get; } = new("IN_TRANSIT"); - - /// /// Enum INCORRECTDECLARATION for value: INCORRECT_DECLARATION /// @@ -375,111 +375,111 @@ public StatusDetailCode(string value) /// - /// Enum INFORMATION for value: INFORMATION + /// Enum MISROUTED for value: MISROUTED /// - public static StatusDetailCode INFORMATION { get; } = new("INFORMATION"); + public static StatusDetailCode MISROUTED { get; } = new("MISROUTED"); /// - /// Enum MISSORTED for value: MISSORTED + /// Enum PARCELREPACKED for value: PARCEL_REPACKED /// - public static StatusDetailCode MISSORTED { get; } = new("MISSORTED"); + public static StatusDetailCode PARCELREPACKED { get; } = new("PARCEL_REPACKED"); /// - /// Enum PARCELOVERLABELLED for value: PARCEL_OVER_LABELLED + /// Enum RECDBYCARRIERNOELECADVICE for value: RECD_BY_CARRIER_NO_ELEC_ADVICE /// - public static StatusDetailCode PARCELOVERLABELLED { get; } = new("PARCEL_OVER_LABELLED"); + public static StatusDetailCode RECDBYCARRIERNOELECADVICE { get; } = new("RECD_BY_CARRIER_NO_ELEC_ADVICE"); /// - /// Enum PARCELREPACKED for value: PARCEL_REPACKED + /// Enum CODAMOUNTNOTPAID for value: COD_AMOUNT_NOT_PAID /// - public static StatusDetailCode PARCELREPACKED { get; } = new("PARCEL_REPACKED"); + public static StatusDetailCode CODAMOUNTNOTPAID { get; } = new("COD_AMOUNT_NOT_PAID"); /// - /// Enum PARCELUPDATENOTIFICATIONVIAEMAIL for value: PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL + /// Enum CUSTOMERIDENTIFICATIONFAILED for value: CUSTOMER_IDENTIFICATION_FAILED /// - public static StatusDetailCode PARCELUPDATENOTIFICATIONVIAEMAIL { get; } = new("PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL"); + public static StatusDetailCode CUSTOMERIDENTIFICATIONFAILED { get; } = new("CUSTOMER_IDENTIFICATION_FAILED"); /// - /// Enum PARCELUPDATENOTIFICATIONVIASMS for value: PARCEL_UPDATE_NOTIFICATION_VIA_SMS + /// Enum NOACCESSTORECIPIENTSADDRESS for value: NO_ACCESS_TO_RECIPIENTS_ADDRESS /// - public static StatusDetailCode PARCELUPDATENOTIFICATIONVIASMS { get; } = new("PARCEL_UPDATE_NOTIFICATION_VIA_SMS"); + public static StatusDetailCode NOACCESSTORECIPIENTSADDRESS { get; } = new("NO_ACCESS_TO_RECIPIENTS_ADDRESS"); /// - /// Enum RECEIVEDBYCARRIER for value: RECEIVED_BY_CARRIER + /// Enum CANCELLED for value: CANCELLED /// - public static StatusDetailCode RECEIVEDBYCARRIER { get; } = new("RECEIVED_BY_CARRIER"); + public static StatusDetailCode CANCELLED { get; } = new("CANCELLED"); /// - /// Enum RECEIVEDLOCALDELIVERYDEPOT for value: RECEIVED_LOCAL_DELIVERY_DEPOT + /// Enum CUSTOMERMOVED for value: CUSTOMER_MOVED /// - public static StatusDetailCode RECEIVEDLOCALDELIVERYDEPOT { get; } = new("RECEIVED_LOCAL_DELIVERY_DEPOT"); + public static StatusDetailCode CUSTOMERMOVED { get; } = new("CUSTOMER_MOVED"); /// - /// Enum ROUTINGERROR for value: ROUTING_ERROR + /// Enum HAZARDOUSPROHIBITED for value: HAZARDOUS_PROHIBITED /// - public static StatusDetailCode ROUTINGERROR { get; } = new("ROUTING_ERROR"); + public static StatusDetailCode HAZARDOUSPROHIBITED { get; } = new("HAZARDOUS_PROHIBITED"); /// - /// Enum SUBCONTRACTOREVENT for value: SUB_CONTRACTOR_EVENT + /// Enum NOTCOLLECTEDFROMPICKUPPOINT for value: NOT_COLLECTED_FROM_PICKUP_POINT /// - public static StatusDetailCode SUBCONTRACTOREVENT { get; } = new("SUB_CONTRACTOR_EVENT"); + public static StatusDetailCode NOTCOLLECTEDFROMPICKUPPOINT { get; } = new("NOT_COLLECTED_FROM_PICKUP_POINT"); /// - /// Enum SUBCONTRACTORRECEIVED for value: SUB_CONTRACTOR_RECEIVED + /// Enum NOTDELIVERED for value: NOT_DELIVERED /// - public static StatusDetailCode SUBCONTRACTORRECEIVED { get; } = new("SUB_CONTRACTOR_RECEIVED"); + public static StatusDetailCode NOTDELIVERED { get; } = new("NOT_DELIVERED"); /// - /// Enum RECDBYCARRIERNOELECADVICE for value: RECD_BY_CARRIER_NO_ELEC_ADVICE + /// Enum NOTDELIVEREDADDRESSEEDECEASED for value: NOT_DELIVERED_ADDRESSEE_DECEASED /// - public static StatusDetailCode RECDBYCARRIERNOELECADVICE { get; } = new("RECD_BY_CARRIER_NO_ELEC_ADVICE"); + public static StatusDetailCode NOTDELIVEREDADDRESSEEDECEASED { get; } = new("NOT_DELIVERED_ADDRESSEE_DECEASED"); /// - /// Enum AWAITINGELECTRONICADVICE for value: AWAITING_ELECTRONIC_ADVICE + /// Enum PARCELDISPOSED for value: PARCEL_DISPOSED /// - public static StatusDetailCode AWAITINGELECTRONICADVICE { get; } = new("AWAITING_ELECTRONIC_ADVICE"); + public static StatusDetailCode PARCELDISPOSED { get; } = new("PARCEL_DISPOSED"); /// - /// Enum AWAITINGCOLLECTIONFROMPICKUPPOINT for value: AWAITING_COLLECTION_FROM_PICKUP_POINT + /// Enum PARCELLOST for value: PARCEL_LOST /// - public static StatusDetailCode AWAITINGCOLLECTIONFROMPICKUPPOINT { get; } = new("AWAITING_COLLECTION_FROM_PICKUP_POINT"); + public static StatusDetailCode PARCELLOST { get; } = new("PARCEL_LOST"); /// - /// Enum COLLECTATLOCALPO for value: COLLECT_AT_LOCAL_PO + /// Enum PARCELOUTSIDEOFSERVICECAPABILITY for value: PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY /// - public static StatusDetailCode COLLECTATLOCALPO { get; } = new("COLLECT_AT_LOCAL_PO"); + public static StatusDetailCode PARCELOUTSIDEOFSERVICECAPABILITY { get; } = new("PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY"); /// - /// Enum CUSTOMERTOCOLLECTFROMCARRIER for value: CUSTOMER_TO_COLLECT_FROM_CARRIER + /// Enum REFUSEDBYCUSTOMER for value: REFUSED_BY_CUSTOMER /// - public static StatusDetailCode CUSTOMERTOCOLLECTFROMCARRIER { get; } = new("CUSTOMER_TO_COLLECT_FROM_CARRIER"); + public static StatusDetailCode REFUSEDBYCUSTOMER { get; } = new("REFUSED_BY_CUSTOMER"); /// - /// Enum DELIVEREDTOLOCKERCOLLECTIONPOINT for value: DELIVERED_TO_LOCKER_COLLECTION_POINT + /// Enum RETURNTOSENDER for value: RETURN_TO_SENDER /// - public static StatusDetailCode DELIVEREDTOLOCKERCOLLECTIONPOINT { get; } = new("DELIVERED_TO_LOCKER_COLLECTION_POINT"); + public static StatusDetailCode RETURNTOSENDER { get; } = new("RETURN_TO_SENDER"); /// - /// Enum CARRIERSTATUSNOTMAPPED for value: CARRIER_STATUS_NOT_MAPPED + /// Enum UNSPECIFIEDEXCEPTION for value: UNSPECIFIED_EXCEPTION /// - public static StatusDetailCode CARRIERSTATUSNOTMAPPED { get; } = new("CARRIER_STATUS_NOT_MAPPED"); + public static StatusDetailCode UNSPECIFIEDEXCEPTION { get; } = new("UNSPECIFIED_EXCEPTION"); /// diff --git a/ShipEngineSDK/Model/TrackEvent.cs b/ShipEngineSDK/Model/TrackEvent.cs index 701ae614..8d6b32b4 100644 --- a/ShipEngineSDK/Model/TrackEvent.cs +++ b/ShipEngineSDK/Model/TrackEvent.cs @@ -224,7 +224,7 @@ public partial class TrackEvent /// This should not be used for input as it will be ignored on serialization. /// /// - /// Your shipment is on its way between depots. + /// Your shipment is on its way between the carrier hubs. /// [JsonPropertyName("status_detail_description"), JsonInclude] public string? StatusDetailDescription { get; set; } diff --git a/ShipEngineSDK/Model/TrackingInformation.cs b/ShipEngineSDK/Model/TrackingInformation.cs index 7280cbeb..900d00a1 100644 --- a/ShipEngineSDK/Model/TrackingInformation.cs +++ b/ShipEngineSDK/Model/TrackingInformation.cs @@ -168,7 +168,7 @@ public partial class TrackingInformation /// This should not be used for input as it will be ignored on serialization. /// /// - /// Your shipment has been delivered. + /// Your parcel has been successfully delivered. /// [JsonPropertyName("status_detail_description"), JsonInclude] public string? StatusDetailDescription { get; set; } diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index dddf9e18..5f5054b6 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-beta.16 + 3.0.0-beta.17 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET diff --git a/generation/swagger.json b/generation/swagger.json index 8594fda2..c8df5af5 100644 --- a/generation/swagger.json +++ b/generation/swagger.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "ShipEngine API", - "version": "1.1.202410161910", + "version": "1.1.202501091801", "termsOfService": "https://www.shipengine.com/terms-of-service/", "x-logo": { "url": "https://shipengine.github.io/img/shipengine-logo-square.png", @@ -9368,7 +9368,9 @@ "newark_ny", "south_brunswick_nj", "scranton_pa", - "wheeling_il" + "wheeling_il", + "middletown_ct", + "portland_or" ], "description": "The possible smart post hub values" }, @@ -11525,12 +11527,10 @@ "$ref": "#/components/schemas/monetary_value" } ], - "default": [ - { - "currency": "usd", - "amount": 0 - } - ], + "default": { + "currency": "USD", + "amount": 0 + }, "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" }, "label_messages": { @@ -11702,6 +11702,11 @@ "items": { "$ref": "#/components/schemas/dangerous_goods" } + }, + "extended_details": { + "type": "object", + "description": "Additional details about products", + "additionalProperties": true } } }, @@ -12752,12 +12757,10 @@ "$ref": "#/components/schemas/monetary_value" } ], - "default": [ - { - "currency": "usd", - "amount": 0 - } - ], + "default": { + "currency": "USD", + "amount": 0 + }, "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" }, "tracking_number": { @@ -12905,7 +12908,21 @@ { "$ref": "#/components/schemas/purchase_label_without_shipment" } - ] + ], + "properties": { + "custom_field1": { + "type": "string", + "description": "Optional - Value will be saved in the shipment's advanced_options > custom_field1" + }, + "custom_field2": { + "type": "string", + "description": "Optional - Value will be saved in the shipment's advanced_options > custom_field2" + }, + "custom_field3": { + "type": "string", + "description": "Optional - Value will be saved in the shipment's advanced_options > custom_field3" + } + } }, "purchase_label_without_shipment": { "title": "purchase_label_without_shipment", @@ -13181,7 +13198,7 @@ "status_detail_description": { "type": "string", "readOnly": true, - "example": "Your shipment has been delivered.", + "example": "Your parcel has been successfully delivered.", "minLength": 0, "description": "Status detail description" }, @@ -13263,23 +13280,38 @@ "readOnly": true, "title": "status_detail_code", "enum": [ - "COLLECTION_FAILED", - "AWAITING_DESPATCH", - "COLLECTION_REQUESTED", - "DESPATCHED", + "CARRIER_STATUS_NOT_MAPPED", + "SHIPMENT_CREATED", + "AWAITING_PICKUP_DROP_OFF", + "DROPPED_OFF", "ELEC_ADVICE_RECD_BY_CARRIER", - "NOT_YET_RECEIVED_BY_CARRIER", - "COLLECTION_MADE", + "PICKED_UP", + "CUSTOMS_CLEARED", + "CUSTOMS_PROCESSING", + "DELIVERY_ARRANGED_WITH_RECIPIENT", + "HUB_SCAN_OUT", + "HUB_SCAN_IN", + "IN_TRANSIT", + "INFORMATION", + "PARCEL_OVER_LABELLED", + "PARCEL_UPDATE_NOTIFICATION", + "RECEIVED_BY_CARRIER", + "RECEIVED_LOCAL_DELIVERY_DEPOT", + "SUB_CONTRACTOR_EVENT", + "SUB_CONTRACTOR_RECEIVED", + "PARCEL_REDIRECTED", + "DELIVERY_SCHEDULED", + "HUB_PROCESSING", + "DELIVERY_RESCHEDULED", "ATTEMPTED_DELIVERY", - "ATTEMPTED_DELIVERY_2ND", - "ATTEMPTED_DELIVERY_3RD", - "COD_AMOUNT_NOT_PAID", + "ATTEMPTED_DELIVERY_FINAL", "COD_AMOUNT_PAID", "CUSTOMER_CARDED", - "CUSTOMER_IDENTIFICATION_FAILED", - "INVALID_METHOD_OF_PAYMENT", - "NO_ACCESS_TO_RECIPIENTS_ADDRESS", "OUT_FOR_DELIVERY", + "AWAITING_COLLECTION_FROM_PICKUP_POINT", + "COLLECT_AT_LOCAL_PO", + "CUSTOMER_TO_COLLECT_FROM_CARRIER", + "DELIVERED_TO_RECEPTION", "DELIVERED", "DELIVERED_DAMAGED", "DELIVERED_IN_PART", @@ -13290,54 +13322,39 @@ "PARCEL_COLLECTED_FROM_PICKUP_POINT", "POST_TRANSIT_STATUS", "PROOF_OF_DELIVERY", - "CANCELLED", - "CANCELLED_BEFORE_DESPATCH", - "CUSTOMER_MOVED", - "HAZARDOUS_PROHIBITED", - "NOT_COLLECTED_FROM_PICKUP_POINT", - "NOT_DELIVERED", - "NOT_DELIVERED_ADDRESSEE_DECEASED", + "PICKUP_FAILED", + "NOT_YET_RECEIVED_BY_CARRIER", "PARCEL_DAMAGED", - "PARCEL_DISPOSED", - "PARCEL_LOST", - "PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY", - "REFUSED_BY_CUSTOMER", - "RETURN_TO_SENDER", "ADDRESS_QUERY", "CARRIER_DELAYS", - "CUSTOMS_CLEARED", - "CUSTOMS_PROCESSING", "DELAYED_NOT_CARRIER", - "DELIVERY_ARRANGED_WITH_RECIPIENT", "HELD_BY_CARRIER", "HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING", "HELD_BY_CUSTOMS", "HELD_BY_EXPORT_CUSTOMS", "HELD_BY_IMPORT_CUSTOMS", - "HUB_SCAN_OUT", - "IN_TRANSIT", "INCORRECT_DECLARATION", - "INFORMATION", - "MISSORTED", - "PARCEL_OVER_LABELLED", + "MISROUTED", "PARCEL_REPACKED", - "PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL", - "PARCEL_UPDATE_NOTIFICATION_VIA_SMS", - "RECEIVED_BY_CARRIER", - "RECEIVED_LOCAL_DELIVERY_DEPOT", - "ROUTING_ERROR", - "SUB_CONTRACTOR_EVENT", - "SUB_CONTRACTOR_RECEIVED", "RECD_BY_CARRIER_NO_ELEC_ADVICE", - "AWAITING_ELECTRONIC_ADVICE", - "AWAITING_COLLECTION_FROM_PICKUP_POINT", - "COLLECT_AT_LOCAL_PO", - "CUSTOMER_TO_COLLECT_FROM_CARRIER", - "DELIVERED_TO_LOCKER_COLLECTION_POINT", - "CARRIER_STATUS_NOT_MAPPED" + "COD_AMOUNT_NOT_PAID", + "CUSTOMER_IDENTIFICATION_FAILED", + "NO_ACCESS_TO_RECIPIENTS_ADDRESS", + "CANCELLED", + "CUSTOMER_MOVED", + "HAZARDOUS_PROHIBITED", + "NOT_COLLECTED_FROM_PICKUP_POINT", + "NOT_DELIVERED", + "NOT_DELIVERED_ADDRESSEE_DECEASED", + "PARCEL_DISPOSED", + "PARCEL_LOST", + "PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY", + "REFUSED_BY_CUSTOMER", + "RETURN_TO_SENDER", + "UNSPECIFIED_EXCEPTION" ], "type": "string", - "description": "The tracking status detail codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n| `COLLECTION_FAILED` | Shipment pickup failed. The delivery company will try again soon.\n| `AWAITING_DESPATCH` | Your shipment is ready to go and is waiting for pickup.\n| `COLLECTION_REQUESTED` | Your shipment pickup has been scheduled.\n| `DESPATCHED` | Your shipment has been handed over to the carrier or dropped off at collection point. It will soon start its journey.\n| `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system.\n| `NOT_YET_RECEIVED_BY_CARRIER` | The sender couldn't hand over your shipment. The delivery company will try to collect it again.\n| `COLLECTION_MADE` | Your shipment has been picked up by the carrier.\n| `ATTEMPTED_DELIVERY` | Delivery attempt failed. Please check the carrier's instructions for next steps.\n| `ATTEMPTED_DELIVERY_2ND` | Second delivery attempt failed. Please check the carrier's instructions for next steps.\n| `ATTEMPTED_DELIVERY_3RD` | Third delivery attempt failed. Please check the carrier's instructions for next steps.\n| `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please check carrier instructions.\n| `COD_AMOUNT_PAID` | Cash on delivery payment received.\n| `CUSTOMER_CARDED` | Delivery attempt failed. Please check for delivery instructions left by the carrier.\n| `CUSTOMER_IDENTIFICATION_FAILED` | There was a recipient identification issue. Please check carrier instructions.\n| `INVALID_METHOD_OF_PAYMENT` | Delivery failed due to incorrect payment. Please check carrier instructions.\n| `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | Delivery couldn't be completed due to issues with accessing address. Please follow carrier instructions.\n| `OUT_FOR_DELIVERY` | Your shipment is out for delivery.\n| `DELIVERED` | Your shipment has been delivered.\n| `DELIVERED_DAMAGED` | Your shipment was delivered but arrived damaged.\n| `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest.\n| `DELIVERED_SPECIFIED_SAFE_PLACE` | Your shipment has been left in your designated safe place.\n| `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your shipment was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details.\n| `DELIVERED_TO_NEIGHBOUR` | Your shipment was delivered to your neighbor.\n| `DELIVERED_TO_PO_BOX` | Your shipment was delivered to your PO Box.\n| `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the collection point.\n| `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery.\n| `PROOF_OF_DELIVERY` | Delivery confirmed.\n| `CANCELLED` | Your shipment has been cancelled.\n| `CANCELLED_BEFORE_DESPATCH` | Your shipment was cancelled before pickup. Contact the sender if unexpected.\n| `CUSTOMER_MOVED` | Recipient not at address. Your shipment is being returned.\n| `HAZARDOUS_PROHIBITED` | Your parcel contained a prohibited item and is being returned. Contact the sender.\n| `NOT_COLLECTED_FROM_PICKUP_POINT` | Shipment not collected from the pickup point. Your parcel is being returned to the sender.\n| `NOT_DELIVERED` | Delivery attempts failed. Your parcel is being returned to the sender.\n| `NOT_DELIVERED_ADDRESSEE_DECEASED` | Delivery not possible due to recipient's passing.\n| `PARCEL_DAMAGED` | Your parcel was damaged and can't be delivered. It's being returned. Contact the sender.\n| `PARCEL_DISPOSED` | Shipment was disposed of. Contact the sender for details.\n| `PARCEL_LOST` | Your parcel is lost. Contact the sender for next steps.\n| `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | Shipment is too large/heavy for delivery. Being returned. Contact sender.\n| `REFUSED_BY_CUSTOMER` | Delivery refused. Shipment being returned. Contact the sender.\n| `RETURN_TO_SENDER` | Your shipment is being returned to the sender. Contact them for details.\n| `ADDRESS_QUERY` | There's an issue with your delivery address. This may cause a delay or return. Contact sender or carrier.\n| `CARRIER_DELAYS` | There's a delivery delay. We'll update you when there's more info.\n| `CUSTOMS_CLEARED` | Your shipment has passed customs clearance.\n| `CUSTOMS_PROCESSING` | Your shipment is going through customs.\n| `DELAYED_NOT_CARRIER` | Unexpected delivery delay. We'll update you soon.\n| `DELIVERY_ARRANGED_WITH_RECIPIENT` | Delivery arranged by recipient.\n| `HELD_BY_CARRIER` | Your shipment is on hold due to a carrier issue. We'll update you soon.\n| `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your shipment is held by carrier due to customs issues. We'll update you.\n| `HELD_BY_CUSTOMS` | Your shipment is held in customs. We'll update you.\n| `HELD_BY_EXPORT_CUSTOMS` | Your shipment is held in export customs. We'll update you.\n| `HELD_BY_IMPORT_CUSTOMS` | Your shipment is held in import customs. We'll update you.\n| `HUB_SCAN_OUT` | Your shipment is at the main delivery depot.\n| `IN_TRANSIT` | Your shipment is on its way between depots.\n| `INCORRECT_DECLARATION` | Incorrect shipment dimensions. Delivery may be delayed or returned. We'll update you.\n| `INFORMATION` | The carrier has shared additional shipment information.\n| `MISSORTED` | Your shipment was missorted. There might be a delivery delay. We'll update you.\n| `PARCEL_OVER_LABELLED` | Your shipment was over labelled by the delivery company to improve processing.\n| `PARCEL_REPACKED` | Your shipment packaging was damaged. It's being repacked. This might delay delivery.\n| `PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL` | You've received an email with a shipment update.\n| `PARCEL_UPDATE_NOTIFICATION_VIA_SMS` | You've received a text message with a shipment update.\n| `RECEIVED_BY_CARRIER` | Your shipment has been received by the carrier.\n| `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your shipment is at the local delivery depot, ready for delivery.\n| `ROUTING_ERROR` | Your shipment was sent to the wrong place. There might be a delay.\n| `SUB_CONTRACTOR_EVENT` | Your shipment is with the local delivery partner.\n| `SUB_CONTRACTOR_RECEIVED` | Your shipment has been received by the local delivery partner.\n| `RECD_BY_CARRIER_NO_ELEC_ADVICE` | There's a system issue with your shipment. Tracking updates might be delayed.\n| `AWAITING_ELECTRONIC_ADVICE` | Your tracking number is ready. Your shipment is waiting to be registered in the carrier system and scheduled for pickup.\n| `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your shipment is ready for pickup at the specified location.\n| `COLLECT_AT_LOCAL_PO` | Your shipment has been redirected to the local post office for pickup. Check carrier instructions.\n| `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your shipment is being held for pickup. Check carrier instructions.\n| `DELIVERED_TO_LOCKER_COLLECTION_POINT` | Your shipment has been delivered to your locker.\n| `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates.\n" + "description": "The tracking status detail codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n| `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates.\n| `SHIPMENT_CREATED` | Your tracking number is ready. Your parcel is waiting to be registered in the carrier system and scheduled for pickup.\n| `AWAITING_PICKUP_DROP_OFF` | Your parcel is waiting to be handed over to the carrier.\n| `DROPPED_OFF` | Your parcel has been dropped off and is ready for carrier processing.\n| `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system.\n| `PICKED_UP` | Your parcel has been picked up by the carrier.\n| `CUSTOMS_CLEARED` | Your parcel has cleared customs and is continuing its journey.\n| `CUSTOMS_PROCESSING` | Your parcel is currently being processed by customs.\n| `DELIVERY_ARRANGED_WITH_RECIPIENT` | Your parcel's delivery has been arranged with the carrier.\n| `HUB_SCAN_OUT` | Your parcel has left the carrier's hub.\n| `HUB_SCAN_IN` | Your parcel has arrived at the carrier's hub for processing.\n| `IN_TRANSIT` | Your shipment is on its way between the carrier hubs.\n| `INFORMATION` | The carrier has shared additional information about your parcel.\n| `PARCEL_OVER_LABELLED` | Your parcel's label has been updated by the carrier, which may affect tracking visibility.\n| `PARCEL_UPDATE_NOTIFICATION` | The carrier has sent you an update on your parcel status via SMS or email.\n| `RECEIVED_BY_CARRIER` | Your parcel has been received by the carrier and is beginning its journey.\n| `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your parcel has arrived at the local delivery depot and is almost ready for delivery.\n| `SUB_CONTRACTOR_EVENT` | The carrier has shared additional information about your parcel's handling by a delivery partner.\n| `SUB_CONTRACTOR_RECEIVED` | Your parcel has been received by the carrier's local delivery partner.\n| `PARCEL_REDIRECTED` | Your parcel has been redirected to a new delivery address per your request.\n| `DELIVERY_SCHEDULED` | Your parcel's delivery has been scheduled and will soon be out for delivery.\n| `HUB_PROCESSING` | Your parcel is being processed at a carrier hub.\n| `DELIVERY_RESCHEDULED` | Your parcel's delivery has been rescheduled due to operational issues.\n| `ATTEMPTED_DELIVERY` | The carrier attempted to deliver your parcel but was unable to complete delivery.\n| `ATTEMPTED_DELIVERY_FINAL` | The carrier made a final attempt to deliver your parcel but was unable to complete delivery. Please check the carrier's instructions for next steps.\n| `COD_AMOUNT_PAID` | Cash on delivery payment received.\n| `CUSTOMER_CARDED` | Delivery attempt failed. Please follow delivery instructions left by the carrier.\n| `OUT_FOR_DELIVERY` | Your parcel is on its way and will be delivered today.\n| `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your parcel is ready for collection at the selected pickup point.\n| `COLLECT_AT_LOCAL_PO` | Your parcel is ready for collection at your local post office.\n| `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your parcel is available for collection from the carrier's local delivery unit.\n| `DELIVERED_TO_RECEPTION` | Your parcel has been delivered to your building's reception or designated mail area.\n| `DELIVERED` | Your parcel has been successfully delivered.\n| `DELIVERED_DAMAGED` | Your parcel was delivered but arrived with visible damage.\n| `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest.\n| `DELIVERED_SPECIFIED_SAFE_PLACE` | Your parcel has been delivered to your specified safe place.\n| `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your parcel was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details.\n| `DELIVERED_TO_NEIGHBOUR` | Your parcel was delivered to your neighbor.\n| `DELIVERED_TO_PO_BOX` | Your parcel has been delivered to your specified PO Box.\n| `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the pick up point.\n| `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery.\n| `PROOF_OF_DELIVERY` | The carrier has confirmed delivery with proof, such as a signature or photo.\n| `PICKUP_FAILED` | Parcel pickup failed. The delivery company will try again soon.\n| `NOT_YET_RECEIVED_BY_CARRIER` | The carrier has not yet received your parcel, which may cause a delay.\n| `PARCEL_DAMAGED` | Your parcel was damaged in transit but will still be delivered.\n| `ADDRESS_QUERY` | There is an issue with the delivery address, which may delay your parcel.\n| `CARRIER_DELAYS` | Your parcel is delayed due to issues within the carrier network.\n| `DELAYED_NOT_CARRIER` | Your parcel is delayed due to circumstances beyond the carrier's control.\n| `HELD_BY_CARRIER` | Your parcel is being held due to an operational issue. Contact with the carrier for more information.\n| `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your parcel is being held by the carrier for customs documentation checks. This may occur when the carrier must confirm documentation before the parcel can continue its journey.\n| `HELD_BY_CUSTOMS` | Your parcel is being held at customs, which may delay delivery.\n| `HELD_BY_EXPORT_CUSTOMS` | Your parcel is held at export customs, which may delay delivery.\n| `HELD_BY_IMPORT_CUSTOMS` | Your parcel is held at import customs and may require action to proceed.\n| `INCORRECT_DECLARATION` | Your parcel has been incorrectly declared but is still moving forward for delivery.\n| `MISROUTED` | Your parcel was sent to the wrong place due to a routing error but is being redirected.\n| `PARCEL_REPACKED` | Your parcel was repackaged by the carrier due to damage and will still be delivered.\n| `RECD_BY_CARRIER_NO_ELEC_ADVICE` | Your parcel has been received by the carrier but may experience delays due to missing pre-advice.\n| `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please follow carrier instructions.\n| `CUSTOMER_IDENTIFICATION_FAILED` | Delivery couldn't be completed as identification requirements were not met.\n| `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | The carrier couldn't access the delivery location due to restricted entry.\n| `CANCELLED` | Your parcel has been cancelled.\n| `CUSTOMER_MOVED` | Delivery failed as the recipient is no longer at the specified address. Your parcel is being returned.\n| `HAZARDOUS_PROHIBITED` | Your parcel contains restricted items and will not be delivered.\n| `NOT_COLLECTED_FROM_PICKUP_POINT` | Your parcel was not collected from the pickup point within the designated time and will be returned.\n| `NOT_DELIVERED` | All delivery attempts failed. Your parcel is being returned to the sender.\n| `NOT_DELIVERED_ADDRESSEE_DECEASED` | The parcel could not be delivered as the addressee is reported deceased.\n| `PARCEL_DISPOSED` | Your parcel has been disposed of due to its contents or condition and will not be delivered.\n| `PARCEL_LOST` | The carrier has reported that your parcel is lost and will not be delivered.\n| `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | The parcel cannot be delivered as it exceeds the carrier's service limits.\n| `REFUSED_BY_CUSTOMER` | You have refused the parcel, and it will be returned to the sender.\n| `RETURN_TO_SENDER` | Your parcel is being returned to the sender due to delivery issues.\n| `UNSPECIFIED_EXCEPTION` | The carrier has reported an issue with your parcel, but details are unavailable.\n" }, "track_event": { "title": "track_event", @@ -13459,7 +13476,7 @@ "type": "string", "readOnly": true, "minLength": 0, - "example": "Your shipment is on its way between depots.", + "example": "Your shipment is on its way between the carrier hubs.", "description": "Event Status Detail Description" }, "carrier_status_code": { diff --git a/package-lock.json b/package-lock.json index 9303a6bc..7ace65f7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "shipengine-dotnet", - "version": "1.0.0", + "version": "3.0.0-beta.14", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "shipengine-dotnet", - "version": "1.0.0", + "version": "3.0.0-beta.14", "license": "Apache-2.0", "devDependencies": { "@openapitools/openapi-generator-cli": "^2.13.4" From 4e4603c027aaa438e6a0265754f1940f25203e03 Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Wed, 5 Feb 2025 09:14:14 -0600 Subject: [PATCH 35/42] Update versions for v3 release --- CHANGELOG.md | 68 +----------------------------- ShipEngineSDK/ShipEngineSDK.csproj | 2 +- package-lock.json | 4 +- package.json | 2 +- 4 files changed, 6 insertions(+), 70 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 97d4f0e3..4a5f2499 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -210,80 +210,16 @@ Fixed handling of No Content responses - Added SP code TrackingStatusCode -## 3.0.0-beta.1 +## 3.0.0 ### Added -- Created new SDK methods for the entire API that sit next to the pre-existing methods. The pre-existing methods will be deprecated eventually. - -## 3.0.0-beta.2 - -### Changed - -- Add more explicit nullable reference types - -## 3.0.0-beta.3 - -### Changed - -- Don't require any properties for deserialization so that small API changes don't completely break consumers -- Don't try to serialize read-only properties -- Don't try to deserialize write-only properties - -## 3.0.0-beta.4 - -### Changed - -- Make setters on readonly properties public - -## 3.0.0-beta.10 - -### Changed - -- Allow requests to be modified before being sent - -## 3.0.0-beta.11 - -### Changed - +- Created new SDK methods for the entire ShipEngine API - Added ability to scope request modifiers by using the `.WithRequestModifier()` method instead of the `.ModifyRequest` property. This will allow consumers to modify a single request without affecting any other consumers of the client. It also allows for multiple modifiers to be added. For example, a modifier could be added at the global level that applies to all requests and then another modifier can be added for a single request. -## 3.0.0-beta.12 - -### Changed - -- Updated to ShipEngine API 1.1.202409060709 - -## 3.0.0-beta.14 - -### Changed - -- Updated to ShipEngine API 1.1.202410081510 -- Add optional error properties, like field_name - -## 3.0.0-beta.15 - ### Changed -- Updated to ShipEngine API 1.1.202410092210 -- AdvancedOptions now allow passing arbitrary key/values via AdditionalProperties - -## 3.0.0-beta.16 - -### Added - -- Updated to ShipEngine API 1.1.202410161910 -- Added A4 and A6 as options for label layouts - -## 3.0.0-beta.17 - -### Added - -- Updated to ShipEngine API 1.1.202501091801 - -### Updated - - Marked v2 methods as obsolete diff --git a/ShipEngineSDK/ShipEngineSDK.csproj b/ShipEngineSDK/ShipEngineSDK.csproj index 5f5054b6..bd9a837b 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-beta.17 + 3.0.0 ShipEngine ShipEngine The official ShipEngine C# SDK for .NET diff --git a/package-lock.json b/package-lock.json index 6ebdf0b4..3e46ab52 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "shipengine-dotnet", - "version": "3.0.0-beta.17", + "version": "3.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "shipengine-dotnet", - "version": "3.0.0-beta.17", + "version": "3.0.0", "license": "Apache-2.0", "dependencies": { "shipengine-dotnet": "file:" diff --git a/package.json b/package.json index 4ead8184..ca227541 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "shipengine-dotnet", - "version": "3.0.0-beta.17", + "version": "3.0.0", "description": "Package primarily used to generate the API and models from OpenApi spec\"", "main": "index.js", "directories": { From d9aa7e097c72faab18a0498d420a75b8eb42630d Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Wed, 5 Feb 2025 10:38:35 -0600 Subject: [PATCH 36/42] Add generated documentation --- .openapi-generator-ignore | 5 +- .openapi-generator/FILES | 329 ++++++++ README.md | 455 ++++++++++- ShipEngineSDK/Model/ErrorType.cs | 12 + docs/apis/AccountApi.md | 359 +++++++++ docs/apis/AddressesApi.md | 125 +++ docs/apis/BatchesApi.md | 617 +++++++++++++++ docs/apis/CarrierAccountsApi.md | 253 ++++++ docs/apis/CarriersApi.md | 420 ++++++++++ docs/apis/DownloadsApi.md | 74 ++ docs/apis/InsuranceApi.md | 239 ++++++ docs/apis/LabelsApi.md | 574 ++++++++++++++ docs/apis/ManifestsApi.md | 259 ++++++ docs/apis/PackagePickupsApi.md | 253 ++++++ docs/apis/PackageTypesApi.md | 302 +++++++ docs/apis/RatesApi.md | 243 ++++++ docs/apis/ServicePointsApi.md | 129 +++ docs/apis/ShipmentsApi.md | 744 ++++++++++++++++++ docs/apis/TagsApi.md | 243 ++++++ docs/apis/TokensApi.md | 66 ++ docs/apis/TrackingApi.md | 190 +++++ docs/apis/WarehousesApi.md | 363 +++++++++ docs/apis/WebhooksApi.md | 302 +++++++ docs/{ => legacy}/CreateLabelFromRate.md | 0 .../CreateLabelFromShipmentDetails.md | 0 docs/{ => legacy}/CreateManifest.md | 0 .../GetRatesWithShipmentDetails.md | 0 docs/{ => legacy}/ListCarriers.md | 0 .../TrackUsingCarrierCodeAndTrackingNumber.md | 0 docs/{ => legacy}/TrackUsingLabelID.md | 0 docs/{ => legacy}/ValidateAddresses.md | 0 docs/{ => legacy}/VoidLabelWithLabelId.md | 0 docs/models/AccountSettings.md | 11 + docs/models/AccountSettingsImages.md | 17 + docs/models/AddFundsToCarrierRequestBody.md | 12 + docs/models/AddFundsToCarrierResponseBody.md | 11 + docs/models/AddFundsToInsuranceRequestBody.md | 12 + .../models/AddFundsToInsuranceResponseBody.md | 12 + docs/models/AddToBatchRequestBody.md | 12 + docs/models/Address.md | 22 + docs/models/AddressResidentialIndicator.md | 10 + docs/models/AddressToValidate.md | 22 + docs/models/AddressValidatingShipment.md | 38 + docs/models/AddressValidationCode.md | 10 + docs/models/AddressValidationDetailCode.md | 10 + docs/models/AddressValidationMessageType.md | 10 + docs/models/AddressValidationResult.md | 14 + docs/models/AddressValidationStatus.md | 10 + docs/models/AdvancedShipmentOptions.md | 37 + ...cedShipmentOptionsDangerousGoodsContact.md | 12 + .../AdvancedShipmentOptionsFedexFreight.md | 12 + ...dShipmentOptionsWindsorFrameworkDetails.md | 12 + docs/models/AllowedIncoterms.md | 9 + docs/models/AlternativeIdentifier.md | 12 + docs/models/AlternativeIdentifiers.md | 10 + docs/models/AncillaryServiceEndorsement.md | 10 + docs/models/Batch.md | 31 + docs/models/BatchResponseError.md | 13 + docs/models/BatchStatus.md | 10 + docs/models/BatchesSortBy.md | 10 + docs/models/BillToParty.md | 10 + docs/models/BulkRate.md | 15 + docs/models/CalculateRatesRequestBody.md | 11 + docs/models/CalculateRatesResponseBody.md | 38 + docs/models/Carrier.md | 25 + docs/models/CarrierAdvancedOption.md | 13 + docs/models/CarrierName.md | 10 + docs/models/CarrierNameWithSettings.md | 10 + docs/models/CollectOnDelivery.md | 12 + docs/models/CollectOnDeliveryPaymentType.md | 10 + docs/models/CompareBulkRatesRequestBody.md | 11 + .../ConnectAccessWorldwideRequestBody.md | 13 + .../ConnectAmazonBuyShippingRequestBody.md | 14 + docs/models/ConnectAmazonShippingUk.md | 12 + docs/models/ConnectApcRequestBody.md | 13 + docs/models/ConnectAsendiaRequestBody.md | 17 + .../models/ConnectAustraliaPostRequestBody.md | 14 + docs/models/ConnectCanadaPostRequestBody.md | 15 + docs/models/ConnectCarrierRequestBody.md | 9 + docs/models/ConnectCarrierResponseBody.md | 11 + docs/models/ConnectDhlEcommerceRequestBody.md | 25 + docs/models/ConnectDhlExpressAuRequestBody.md | 12 + docs/models/ConnectDhlExpressCaRequestBody.md | 12 + docs/models/ConnectDhlExpressRequestBody.md | 15 + docs/models/ConnectDhlExpressUkRequestBody.md | 14 + docs/models/ConnectDpdRequestBody.md | 13 + docs/models/ConnectEndiciaRequestBody.md | 13 + docs/models/ConnectFedexRequestBody.md | 25 + docs/models/ConnectFedexUkRequestBody.md | 25 + docs/models/ConnectFirstmileRequestBody.md | 14 + docs/models/ConnectImexRequestBody.md | 13 + docs/models/ConnectInsurerRequestBody.md | 12 + docs/models/ConnectLasershipRequestBody.md | 36 + docs/models/ConnectNewgisticsRequestBody.md | 14 + docs/models/ConnectOntracRequestBody.md | 13 + docs/models/ConnectPurolatorRequestBody.md | 13 + docs/models/ConnectRoyalMailRequestBody.md | 22 + docs/models/ConnectRrDonnelleyRequestBody.md | 13 + docs/models/ConnectSekoRequestBody.md | 12 + docs/models/ConnectSendleRequestBody.md | 13 + docs/models/ConnectStampsRequestBody.md | 13 + docs/models/ConnectUpsRequestBody.md | 14 + docs/models/ContactDetails.md | 12 + .../CreateAccountSettingsImageRequestBody.md | 17 + .../CreateAndProcessBatchRequestBody.md | 15 + ...AndProcessBatchRequestBodyProcessLabels.md | 15 + docs/models/CreateAndValidateShipment.md | 39 + docs/models/CreateBatchRequest.md | 9 + docs/models/CreateBatchRequestBody.md | 14 + docs/models/CreateBatchResponseBody.md | 31 + docs/models/CreateLabelFromRateRequestBody.md | 18 + .../models/CreateLabelFromRateResponseBody.md | 49 ++ .../CreateLabelFromShipmentRequestBody.md | 15 + .../CreateLabelFromShipmentResponseBody.md | 49 ++ docs/models/CreateLabelRequestBody.md | 24 + docs/models/CreateLabelResponseBody.md | 49 ++ .../CreateManifestByObjectRequestBody.md | 15 + .../CreateManifestLabelIdsRequestBody.md | 11 + docs/models/CreateManifestRequestBody.md | 9 + docs/models/CreateManifestResponseBody.md | 24 + docs/models/CreatePackageTypeRequestBody.md | 15 + docs/models/CreatePackageTypeResponseBody.md | 15 + docs/models/CreateReturnLabelRequestBody.md | 16 + docs/models/CreateReturnLabelResponseBody.md | 49 ++ .../CreateShipmentResponseBodyFields.md | 11 + docs/models/CreateShipmentsRequestBody.md | 11 + docs/models/CreateShipmentsResponseBody.md | 12 + docs/models/CreateTagResponseBody.md | 11 + docs/models/CreateWarehouseRequestBody.md | 16 + docs/models/CreateWarehouseResponseBody.md | 16 + docs/models/CreateWebhookRequestBody.md | 13 + docs/models/CreateWebhookResponseBody.md | 14 + docs/models/CustomsItem.md | 21 + docs/models/DangerousAmount.md | 12 + docs/models/DangerousGoods.md | 29 + docs/models/DefaultLabelLayout.md | 10 + docs/models/DeletePickupByIdResponseBody.md | 12 + .../DeleteScheduledPickupResponseBody.md | 11 + docs/models/DeliveryConfirmation.md | 10 + docs/models/DeprecatedManifest.md | 20 + docs/models/DhlExpressAccountSettings.md | 13 + docs/models/DhlExpressSettingsResponseBody.md | 13 + docs/models/DimensionUnit.md | 10 + docs/models/Dimensions.md | 14 + docs/models/DisplayScheme.md | 10 + docs/models/Error.md | 17 + docs/models/ErrorCode.md | 10 + docs/models/ErrorResponseBody.md | 12 + docs/models/ErrorSource.md | 10 + docs/models/ErrorType.md | 10 + docs/models/ErrorWithLabelIdResponseBody.md | 12 + docs/models/EstimateRatesRequestBody.md | 23 + docs/models/FedexAccountSettings.md | 17 + .../models/FedexAccountSettingsRequestBody.md | 17 + docs/models/FedexPickupType.md | 10 + docs/models/FedexSettingsResponseBody.md | 17 + .../GetAccountSettingsImagesResponseBody.md | 17 + docs/models/GetAccountSettingsResponseBody.md | 10 + .../GetBatchByExternalIdResponseBody.md | 31 + docs/models/GetBatchByIdResponseBody.md | 31 + docs/models/GetCarrierByIdResponseBody.md | 25 + docs/models/GetCarrierOptionsResponseBody.md | 11 + docs/models/GetCarrierSettingsResponseBody.md | 9 + docs/models/GetCarriersResponseBody.md | 12 + .../models/GetInsuranceBalanceResponseBody.md | 12 + ...etLabelByExternalShipmentIdResponseBody.md | 49 ++ docs/models/GetLabelByIdResponseBody.md | 49 ++ docs/models/GetManifestByIdResponseBody.md | 20 + docs/models/GetPackageTypeByIdResponseBody.md | 15 + docs/models/GetPickupByIdResponseBody.md | 23 + docs/models/GetPickupsResponseBody.md | 16 + docs/models/GetRateByIdResponseBody.md | 37 + .../models/GetServicePointByIdResponseBody.md | 11 + ...ervicePointByIdResponseBodyServicePoint.md | 24 + docs/models/GetServicePointsRequest.md | 9 + docs/models/GetServicePointsRequestBody.md | 18 + .../GetServicePointsRequestBodyAddress.md | 17 + ...tServicePointsRequestBodyProvidersInner.md | 11 + .../GetServicePointsRequestBodyShipment.md | 12 + ...ePointsRequestBodyShipmentPackagesInner.md | 10 + .../GetShipmentByExternalIdResponseBody.md | 37 + docs/models/GetShipmentByIdResponseBody.md | 37 + .../GetTrackingLogFromLabelResponseBody.md | 26 + docs/models/GetTrackingLogResponseBody.md | 26 + docs/models/GetWarehouseByIdResponseBody.md | 16 + docs/models/GetWebhookByIdResponseBody.md | 14 + docs/models/IdentifierType.md | 10 + docs/models/ImporterOfRecords.md | 21 + docs/models/InsuranceProvider.md | 10 + docs/models/InternationalShipmentOptions.md | 18 + docs/models/InvoiceAdditionalDetails.md | 15 + docs/models/Label.md | 49 ++ docs/models/LabelChargeEvent.md | 10 + docs/models/LabelDownload.md | 14 + docs/models/LabelDownloadType.md | 10 + docs/models/LabelFormat.md | 10 + docs/models/LabelLayout.md | 10 + docs/models/LabelMessages.md | 13 + docs/models/LabelPackage.md | 28 + docs/models/LabelPackagesInner.md | 28 + docs/models/LabelRequest.md | 22 + docs/models/LabelStatus.md | 10 + docs/models/Link.md | 12 + docs/models/ListAccountImagesResponseBody.md | 15 + docs/models/ListAccountSettingsBody.md | 11 + .../ListAccountSettingsImagesResponseBody.md | 14 + docs/models/ListBatchErrorsResponseBody.md | 12 + docs/models/ListBatchesResponseBody.md | 15 + .../ListCarrierPackageTypesResponseBody.md | 11 + .../models/ListCarrierServicesResponseBody.md | 11 + docs/models/ListCarriersResponseBody.md | 11 + docs/models/ListLabelsResponseBody.md | 15 + docs/models/ListManifestsResponseBody.md | 15 + docs/models/ListPackageTypesResponseBody.md | 11 + docs/models/ListPickupResponseBody.md | 15 + docs/models/ListServicePointsResponseBody.md | 14 + ...icePointsResponseBodyServicePointsInner.md | 25 + ...eBodyServicePointsInnerHoursOfOperation.md | 17 + ...ePointsInnerHoursOfOperationMondayInner.md | 11 + docs/models/ListShipmentRatesResponseBody.md | 17 + docs/models/ListShipmentsResponseBody.md | 15 + docs/models/ListTagsResponseBody.md | 11 + docs/models/ListWarehousesResponseBody.md | 11 + docs/models/Manifest.md | 20 + docs/models/ManifestDownload.md | 11 + docs/models/ManifestRequest.md | 12 + docs/models/ManifestRequestStatus.md | 10 + docs/models/Manifests.md | 11 + docs/models/ManifestsRequests.md | 11 + docs/models/ModifyBatch.md | 12 + docs/models/MonetaryValue.md | 12 + docs/models/NonDelivery.md | 10 + docs/models/OptionalLink.md | 12 + docs/models/OrderSourceName.md | 10 + docs/models/OriginType.md | 10 + docs/models/Package.md | 22 + docs/models/PackageContents.md | 10 + docs/models/PackageType.md | 15 + docs/models/PackagingGroup.md | 9 + docs/models/PackagingInstructionSection.md | 9 + docs/models/PagedListResponseBody.md | 14 + docs/models/PaginationLink.md | 14 + docs/models/PaperlessDownload.md | 13 + docs/models/ParseAddressRequestBody.md | 12 + docs/models/ParseAddressResponseBody.md | 13 + docs/models/ParseShipmentRequestBody.md | 12 + docs/models/ParseShipmentResponseBody.md | 13 + docs/models/PartialAddress.md | 22 + docs/models/PartialShipment.md | 37 + docs/models/PartialShippingAddress.md | 11 + docs/models/PartialShippingAddressTo.md | 12 + ...artialShippingAddressToGeolocationInner.md | 11 + docs/models/PaymentAmount.md | 11 + docs/models/Pickup.md | 22 + docs/models/PickupResponseBody.md | 22 + docs/models/PickupWindow.md | 12 + docs/models/PickupWindows.md | 11 + docs/models/ProcessBatchRequestBody.md | 14 + docs/models/Products.md | 24 + docs/models/PurchaseLabelWithoutShipment.md | 15 + docs/models/Rate.md | 37 + docs/models/RateDetail.md | 17 + docs/models/RateDetailAttributes.md | 13 + docs/models/RateDetailType.md | 10 + docs/models/RateEstimate.md | 34 + docs/models/RateEstimateByCarrierId.md | 10 + docs/models/RateEstimateByCarrierIds.md | 10 + docs/models/RateEstimateOptions.md | 22 + docs/models/RateRequestBody.md | 16 + docs/models/RateRequestByShipmentIds.md | 10 + docs/models/RateRequestByShipments.md | 10 + docs/models/RateRequestOptions.md | 10 + docs/models/RateRequestRateOptions.md | 10 + docs/models/RateResponse.md | 10 + docs/models/RateResponseStatus.md | 10 + docs/models/RateShipmentRequest.md | 10 + docs/models/RateType.md | 10 + docs/models/RatesInformation.md | 17 + docs/models/ReasonCode.md | 10 + docs/models/RecognizedEntity.md | 16 + docs/models/Redirect.md | 10 + docs/models/RegulationLevel.md | 9 + docs/models/RemoveFromBatchRequestBody.md | 12 + docs/models/ResponseMessage.md | 14 + docs/models/SchedulePickupRequestBody.md | 22 + docs/models/SchedulePickupResponseBody.md | 23 + docs/models/Service.md | 17 + docs/models/Shipment.md | 37 + docs/models/ShipmentIdRequest.md | 10 + docs/models/ShipmentItem.md | 19 + docs/models/ShipmentRequest.md | 31 + docs/models/ShipmentStatus.md | 10 + docs/models/ShipmentsSortBy.md | 10 + docs/models/ShippingAddress.md | 22 + docs/models/ShippingAddressFrom.md | 22 + docs/models/ShippingAddressTo.md | 23 + docs/models/SmartPostHub.md | 10 + docs/models/SortDir.md | 10 + docs/models/StatusCode.md | 10 + docs/models/StatusDetailCode.md | 10 + docs/models/Tag.md | 11 + docs/models/TagShipmentResponseBody.md | 11 + docs/models/TaxIdentifier.md | 14 + docs/models/TaxType.md | 10 + docs/models/TaxableEntityType.md | 10 + ...TokensGetEphemeralTokenResponseBodyYaml.md | 11 + docs/models/TrackEvent.md | 29 + docs/models/TrackingInformation.md | 26 + docs/models/TrackingStatus.md | 10 + docs/models/TransportMean.md | 9 + .../UpdateAccountSettingsImageRequestBody.md | 17 + .../UpdateAmazonBuyShippingRequestBody.md | 11 + .../UpdateCarrierSettingsRequestBody.md | 9 + .../UpdateDhlExpressSettingsRequestBody.md | 13 + docs/models/UpdateFedexSettingsRequestBody.md | 17 + .../UpdateNewgisticsSettingsRequestBody.md | 12 + docs/models/UpdatePackageTypeRequestBody.md | 15 + docs/models/UpdateShipmentFields.md | 10 + docs/models/UpdateShipmentRequestBody.md | 38 + docs/models/UpdateShipmentResponseBody.md | 39 + docs/models/UpdateShipmentsTags.md | 10 + docs/models/UpdateShipmentsTagsRequestBody.md | 11 + .../UpdateShipmentsTagsShipmentsTagsInner.md | 11 + docs/models/UpdateUpsSettingsRequestBody.md | 22 + docs/models/UpdateWarehouseRequestBody.md | 16 + .../UpdateWarehouseSettingsRequestBody.md | 11 + docs/models/UpdateWebhookRequestBody.md | 12 + docs/models/UpsAccountSettings.md | 22 + docs/models/UpsInvoice.md | 15 + docs/models/UpsPickupType.md | 10 + docs/models/UpsSettingsResponseBody.md | 22 + docs/models/ValidateAddress.md | 10 + docs/models/ValidateShipmentFields.md | 10 + docs/models/ValidationStatus.md | 10 + docs/models/VoidLabelResponseBody.md | 13 + docs/models/Warehouse.md | 16 + docs/models/Webhook.md | 14 + docs/models/WebhookEvent.md | 10 + docs/models/WebhookHeader.md | 12 + docs/models/Weight.md | 12 + docs/models/WeightUnit.md | 10 + ...ADME.mustache => README.solution.mustache} | 25 +- generation/templates/api_doc.mustache | 42 +- openapitools.json | 6 +- 344 files changed, 11520 insertions(+), 60 deletions(-) create mode 100644 docs/apis/AccountApi.md create mode 100644 docs/apis/AddressesApi.md create mode 100644 docs/apis/BatchesApi.md create mode 100644 docs/apis/CarrierAccountsApi.md create mode 100644 docs/apis/CarriersApi.md create mode 100644 docs/apis/DownloadsApi.md create mode 100644 docs/apis/InsuranceApi.md create mode 100644 docs/apis/LabelsApi.md create mode 100644 docs/apis/ManifestsApi.md create mode 100644 docs/apis/PackagePickupsApi.md create mode 100644 docs/apis/PackageTypesApi.md create mode 100644 docs/apis/RatesApi.md create mode 100644 docs/apis/ServicePointsApi.md create mode 100644 docs/apis/ShipmentsApi.md create mode 100644 docs/apis/TagsApi.md create mode 100644 docs/apis/TokensApi.md create mode 100644 docs/apis/TrackingApi.md create mode 100644 docs/apis/WarehousesApi.md create mode 100644 docs/apis/WebhooksApi.md rename docs/{ => legacy}/CreateLabelFromRate.md (100%) rename docs/{ => legacy}/CreateLabelFromShipmentDetails.md (100%) rename docs/{ => legacy}/CreateManifest.md (100%) rename docs/{ => legacy}/GetRatesWithShipmentDetails.md (100%) rename docs/{ => legacy}/ListCarriers.md (100%) rename docs/{ => legacy}/TrackUsingCarrierCodeAndTrackingNumber.md (100%) rename docs/{ => legacy}/TrackUsingLabelID.md (100%) rename docs/{ => legacy}/ValidateAddresses.md (100%) rename docs/{ => legacy}/VoidLabelWithLabelId.md (100%) create mode 100644 docs/models/AccountSettings.md create mode 100644 docs/models/AccountSettingsImages.md create mode 100644 docs/models/AddFundsToCarrierRequestBody.md create mode 100644 docs/models/AddFundsToCarrierResponseBody.md create mode 100644 docs/models/AddFundsToInsuranceRequestBody.md create mode 100644 docs/models/AddFundsToInsuranceResponseBody.md create mode 100644 docs/models/AddToBatchRequestBody.md create mode 100644 docs/models/Address.md create mode 100644 docs/models/AddressResidentialIndicator.md create mode 100644 docs/models/AddressToValidate.md create mode 100644 docs/models/AddressValidatingShipment.md create mode 100644 docs/models/AddressValidationCode.md create mode 100644 docs/models/AddressValidationDetailCode.md create mode 100644 docs/models/AddressValidationMessageType.md create mode 100644 docs/models/AddressValidationResult.md create mode 100644 docs/models/AddressValidationStatus.md create mode 100644 docs/models/AdvancedShipmentOptions.md create mode 100644 docs/models/AdvancedShipmentOptionsDangerousGoodsContact.md create mode 100644 docs/models/AdvancedShipmentOptionsFedexFreight.md create mode 100644 docs/models/AdvancedShipmentOptionsWindsorFrameworkDetails.md create mode 100644 docs/models/AllowedIncoterms.md create mode 100644 docs/models/AlternativeIdentifier.md create mode 100644 docs/models/AlternativeIdentifiers.md create mode 100644 docs/models/AncillaryServiceEndorsement.md create mode 100644 docs/models/Batch.md create mode 100644 docs/models/BatchResponseError.md create mode 100644 docs/models/BatchStatus.md create mode 100644 docs/models/BatchesSortBy.md create mode 100644 docs/models/BillToParty.md create mode 100644 docs/models/BulkRate.md create mode 100644 docs/models/CalculateRatesRequestBody.md create mode 100644 docs/models/CalculateRatesResponseBody.md create mode 100644 docs/models/Carrier.md create mode 100644 docs/models/CarrierAdvancedOption.md create mode 100644 docs/models/CarrierName.md create mode 100644 docs/models/CarrierNameWithSettings.md create mode 100644 docs/models/CollectOnDelivery.md create mode 100644 docs/models/CollectOnDeliveryPaymentType.md create mode 100644 docs/models/CompareBulkRatesRequestBody.md create mode 100644 docs/models/ConnectAccessWorldwideRequestBody.md create mode 100644 docs/models/ConnectAmazonBuyShippingRequestBody.md create mode 100644 docs/models/ConnectAmazonShippingUk.md create mode 100644 docs/models/ConnectApcRequestBody.md create mode 100644 docs/models/ConnectAsendiaRequestBody.md create mode 100644 docs/models/ConnectAustraliaPostRequestBody.md create mode 100644 docs/models/ConnectCanadaPostRequestBody.md create mode 100644 docs/models/ConnectCarrierRequestBody.md create mode 100644 docs/models/ConnectCarrierResponseBody.md create mode 100644 docs/models/ConnectDhlEcommerceRequestBody.md create mode 100644 docs/models/ConnectDhlExpressAuRequestBody.md create mode 100644 docs/models/ConnectDhlExpressCaRequestBody.md create mode 100644 docs/models/ConnectDhlExpressRequestBody.md create mode 100644 docs/models/ConnectDhlExpressUkRequestBody.md create mode 100644 docs/models/ConnectDpdRequestBody.md create mode 100644 docs/models/ConnectEndiciaRequestBody.md create mode 100644 docs/models/ConnectFedexRequestBody.md create mode 100644 docs/models/ConnectFedexUkRequestBody.md create mode 100644 docs/models/ConnectFirstmileRequestBody.md create mode 100644 docs/models/ConnectImexRequestBody.md create mode 100644 docs/models/ConnectInsurerRequestBody.md create mode 100644 docs/models/ConnectLasershipRequestBody.md create mode 100644 docs/models/ConnectNewgisticsRequestBody.md create mode 100644 docs/models/ConnectOntracRequestBody.md create mode 100644 docs/models/ConnectPurolatorRequestBody.md create mode 100644 docs/models/ConnectRoyalMailRequestBody.md create mode 100644 docs/models/ConnectRrDonnelleyRequestBody.md create mode 100644 docs/models/ConnectSekoRequestBody.md create mode 100644 docs/models/ConnectSendleRequestBody.md create mode 100644 docs/models/ConnectStampsRequestBody.md create mode 100644 docs/models/ConnectUpsRequestBody.md create mode 100644 docs/models/ContactDetails.md create mode 100644 docs/models/CreateAccountSettingsImageRequestBody.md create mode 100644 docs/models/CreateAndProcessBatchRequestBody.md create mode 100644 docs/models/CreateAndProcessBatchRequestBodyProcessLabels.md create mode 100644 docs/models/CreateAndValidateShipment.md create mode 100644 docs/models/CreateBatchRequest.md create mode 100644 docs/models/CreateBatchRequestBody.md create mode 100644 docs/models/CreateBatchResponseBody.md create mode 100644 docs/models/CreateLabelFromRateRequestBody.md create mode 100644 docs/models/CreateLabelFromRateResponseBody.md create mode 100644 docs/models/CreateLabelFromShipmentRequestBody.md create mode 100644 docs/models/CreateLabelFromShipmentResponseBody.md create mode 100644 docs/models/CreateLabelRequestBody.md create mode 100644 docs/models/CreateLabelResponseBody.md create mode 100644 docs/models/CreateManifestByObjectRequestBody.md create mode 100644 docs/models/CreateManifestLabelIdsRequestBody.md create mode 100644 docs/models/CreateManifestRequestBody.md create mode 100644 docs/models/CreateManifestResponseBody.md create mode 100644 docs/models/CreatePackageTypeRequestBody.md create mode 100644 docs/models/CreatePackageTypeResponseBody.md create mode 100644 docs/models/CreateReturnLabelRequestBody.md create mode 100644 docs/models/CreateReturnLabelResponseBody.md create mode 100644 docs/models/CreateShipmentResponseBodyFields.md create mode 100644 docs/models/CreateShipmentsRequestBody.md create mode 100644 docs/models/CreateShipmentsResponseBody.md create mode 100644 docs/models/CreateTagResponseBody.md create mode 100644 docs/models/CreateWarehouseRequestBody.md create mode 100644 docs/models/CreateWarehouseResponseBody.md create mode 100644 docs/models/CreateWebhookRequestBody.md create mode 100644 docs/models/CreateWebhookResponseBody.md create mode 100644 docs/models/CustomsItem.md create mode 100644 docs/models/DangerousAmount.md create mode 100644 docs/models/DangerousGoods.md create mode 100644 docs/models/DefaultLabelLayout.md create mode 100644 docs/models/DeletePickupByIdResponseBody.md create mode 100644 docs/models/DeleteScheduledPickupResponseBody.md create mode 100644 docs/models/DeliveryConfirmation.md create mode 100644 docs/models/DeprecatedManifest.md create mode 100644 docs/models/DhlExpressAccountSettings.md create mode 100644 docs/models/DhlExpressSettingsResponseBody.md create mode 100644 docs/models/DimensionUnit.md create mode 100644 docs/models/Dimensions.md create mode 100644 docs/models/DisplayScheme.md create mode 100644 docs/models/Error.md create mode 100644 docs/models/ErrorCode.md create mode 100644 docs/models/ErrorResponseBody.md create mode 100644 docs/models/ErrorSource.md create mode 100644 docs/models/ErrorType.md create mode 100644 docs/models/ErrorWithLabelIdResponseBody.md create mode 100644 docs/models/EstimateRatesRequestBody.md create mode 100644 docs/models/FedexAccountSettings.md create mode 100644 docs/models/FedexAccountSettingsRequestBody.md create mode 100644 docs/models/FedexPickupType.md create mode 100644 docs/models/FedexSettingsResponseBody.md create mode 100644 docs/models/GetAccountSettingsImagesResponseBody.md create mode 100644 docs/models/GetAccountSettingsResponseBody.md create mode 100644 docs/models/GetBatchByExternalIdResponseBody.md create mode 100644 docs/models/GetBatchByIdResponseBody.md create mode 100644 docs/models/GetCarrierByIdResponseBody.md create mode 100644 docs/models/GetCarrierOptionsResponseBody.md create mode 100644 docs/models/GetCarrierSettingsResponseBody.md create mode 100644 docs/models/GetCarriersResponseBody.md create mode 100644 docs/models/GetInsuranceBalanceResponseBody.md create mode 100644 docs/models/GetLabelByExternalShipmentIdResponseBody.md create mode 100644 docs/models/GetLabelByIdResponseBody.md create mode 100644 docs/models/GetManifestByIdResponseBody.md create mode 100644 docs/models/GetPackageTypeByIdResponseBody.md create mode 100644 docs/models/GetPickupByIdResponseBody.md create mode 100644 docs/models/GetPickupsResponseBody.md create mode 100644 docs/models/GetRateByIdResponseBody.md create mode 100644 docs/models/GetServicePointByIdResponseBody.md create mode 100644 docs/models/GetServicePointByIdResponseBodyServicePoint.md create mode 100644 docs/models/GetServicePointsRequest.md create mode 100644 docs/models/GetServicePointsRequestBody.md create mode 100644 docs/models/GetServicePointsRequestBodyAddress.md create mode 100644 docs/models/GetServicePointsRequestBodyProvidersInner.md create mode 100644 docs/models/GetServicePointsRequestBodyShipment.md create mode 100644 docs/models/GetServicePointsRequestBodyShipmentPackagesInner.md create mode 100644 docs/models/GetShipmentByExternalIdResponseBody.md create mode 100644 docs/models/GetShipmentByIdResponseBody.md create mode 100644 docs/models/GetTrackingLogFromLabelResponseBody.md create mode 100644 docs/models/GetTrackingLogResponseBody.md create mode 100644 docs/models/GetWarehouseByIdResponseBody.md create mode 100644 docs/models/GetWebhookByIdResponseBody.md create mode 100644 docs/models/IdentifierType.md create mode 100644 docs/models/ImporterOfRecords.md create mode 100644 docs/models/InsuranceProvider.md create mode 100644 docs/models/InternationalShipmentOptions.md create mode 100644 docs/models/InvoiceAdditionalDetails.md create mode 100644 docs/models/Label.md create mode 100644 docs/models/LabelChargeEvent.md create mode 100644 docs/models/LabelDownload.md create mode 100644 docs/models/LabelDownloadType.md create mode 100644 docs/models/LabelFormat.md create mode 100644 docs/models/LabelLayout.md create mode 100644 docs/models/LabelMessages.md create mode 100644 docs/models/LabelPackage.md create mode 100644 docs/models/LabelPackagesInner.md create mode 100644 docs/models/LabelRequest.md create mode 100644 docs/models/LabelStatus.md create mode 100644 docs/models/Link.md create mode 100644 docs/models/ListAccountImagesResponseBody.md create mode 100644 docs/models/ListAccountSettingsBody.md create mode 100644 docs/models/ListAccountSettingsImagesResponseBody.md create mode 100644 docs/models/ListBatchErrorsResponseBody.md create mode 100644 docs/models/ListBatchesResponseBody.md create mode 100644 docs/models/ListCarrierPackageTypesResponseBody.md create mode 100644 docs/models/ListCarrierServicesResponseBody.md create mode 100644 docs/models/ListCarriersResponseBody.md create mode 100644 docs/models/ListLabelsResponseBody.md create mode 100644 docs/models/ListManifestsResponseBody.md create mode 100644 docs/models/ListPackageTypesResponseBody.md create mode 100644 docs/models/ListPickupResponseBody.md create mode 100644 docs/models/ListServicePointsResponseBody.md create mode 100644 docs/models/ListServicePointsResponseBodyServicePointsInner.md create mode 100644 docs/models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.md create mode 100644 docs/models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md create mode 100644 docs/models/ListShipmentRatesResponseBody.md create mode 100644 docs/models/ListShipmentsResponseBody.md create mode 100644 docs/models/ListTagsResponseBody.md create mode 100644 docs/models/ListWarehousesResponseBody.md create mode 100644 docs/models/Manifest.md create mode 100644 docs/models/ManifestDownload.md create mode 100644 docs/models/ManifestRequest.md create mode 100644 docs/models/ManifestRequestStatus.md create mode 100644 docs/models/Manifests.md create mode 100644 docs/models/ManifestsRequests.md create mode 100644 docs/models/ModifyBatch.md create mode 100644 docs/models/MonetaryValue.md create mode 100644 docs/models/NonDelivery.md create mode 100644 docs/models/OptionalLink.md create mode 100644 docs/models/OrderSourceName.md create mode 100644 docs/models/OriginType.md create mode 100644 docs/models/Package.md create mode 100644 docs/models/PackageContents.md create mode 100644 docs/models/PackageType.md create mode 100644 docs/models/PackagingGroup.md create mode 100644 docs/models/PackagingInstructionSection.md create mode 100644 docs/models/PagedListResponseBody.md create mode 100644 docs/models/PaginationLink.md create mode 100644 docs/models/PaperlessDownload.md create mode 100644 docs/models/ParseAddressRequestBody.md create mode 100644 docs/models/ParseAddressResponseBody.md create mode 100644 docs/models/ParseShipmentRequestBody.md create mode 100644 docs/models/ParseShipmentResponseBody.md create mode 100644 docs/models/PartialAddress.md create mode 100644 docs/models/PartialShipment.md create mode 100644 docs/models/PartialShippingAddress.md create mode 100644 docs/models/PartialShippingAddressTo.md create mode 100644 docs/models/PartialShippingAddressToGeolocationInner.md create mode 100644 docs/models/PaymentAmount.md create mode 100644 docs/models/Pickup.md create mode 100644 docs/models/PickupResponseBody.md create mode 100644 docs/models/PickupWindow.md create mode 100644 docs/models/PickupWindows.md create mode 100644 docs/models/ProcessBatchRequestBody.md create mode 100644 docs/models/Products.md create mode 100644 docs/models/PurchaseLabelWithoutShipment.md create mode 100644 docs/models/Rate.md create mode 100644 docs/models/RateDetail.md create mode 100644 docs/models/RateDetailAttributes.md create mode 100644 docs/models/RateDetailType.md create mode 100644 docs/models/RateEstimate.md create mode 100644 docs/models/RateEstimateByCarrierId.md create mode 100644 docs/models/RateEstimateByCarrierIds.md create mode 100644 docs/models/RateEstimateOptions.md create mode 100644 docs/models/RateRequestBody.md create mode 100644 docs/models/RateRequestByShipmentIds.md create mode 100644 docs/models/RateRequestByShipments.md create mode 100644 docs/models/RateRequestOptions.md create mode 100644 docs/models/RateRequestRateOptions.md create mode 100644 docs/models/RateResponse.md create mode 100644 docs/models/RateResponseStatus.md create mode 100644 docs/models/RateShipmentRequest.md create mode 100644 docs/models/RateType.md create mode 100644 docs/models/RatesInformation.md create mode 100644 docs/models/ReasonCode.md create mode 100644 docs/models/RecognizedEntity.md create mode 100644 docs/models/Redirect.md create mode 100644 docs/models/RegulationLevel.md create mode 100644 docs/models/RemoveFromBatchRequestBody.md create mode 100644 docs/models/ResponseMessage.md create mode 100644 docs/models/SchedulePickupRequestBody.md create mode 100644 docs/models/SchedulePickupResponseBody.md create mode 100644 docs/models/Service.md create mode 100644 docs/models/Shipment.md create mode 100644 docs/models/ShipmentIdRequest.md create mode 100644 docs/models/ShipmentItem.md create mode 100644 docs/models/ShipmentRequest.md create mode 100644 docs/models/ShipmentStatus.md create mode 100644 docs/models/ShipmentsSortBy.md create mode 100644 docs/models/ShippingAddress.md create mode 100644 docs/models/ShippingAddressFrom.md create mode 100644 docs/models/ShippingAddressTo.md create mode 100644 docs/models/SmartPostHub.md create mode 100644 docs/models/SortDir.md create mode 100644 docs/models/StatusCode.md create mode 100644 docs/models/StatusDetailCode.md create mode 100644 docs/models/Tag.md create mode 100644 docs/models/TagShipmentResponseBody.md create mode 100644 docs/models/TaxIdentifier.md create mode 100644 docs/models/TaxType.md create mode 100644 docs/models/TaxableEntityType.md create mode 100644 docs/models/TokensGetEphemeralTokenResponseBodyYaml.md create mode 100644 docs/models/TrackEvent.md create mode 100644 docs/models/TrackingInformation.md create mode 100644 docs/models/TrackingStatus.md create mode 100644 docs/models/TransportMean.md create mode 100644 docs/models/UpdateAccountSettingsImageRequestBody.md create mode 100644 docs/models/UpdateAmazonBuyShippingRequestBody.md create mode 100644 docs/models/UpdateCarrierSettingsRequestBody.md create mode 100644 docs/models/UpdateDhlExpressSettingsRequestBody.md create mode 100644 docs/models/UpdateFedexSettingsRequestBody.md create mode 100644 docs/models/UpdateNewgisticsSettingsRequestBody.md create mode 100644 docs/models/UpdatePackageTypeRequestBody.md create mode 100644 docs/models/UpdateShipmentFields.md create mode 100644 docs/models/UpdateShipmentRequestBody.md create mode 100644 docs/models/UpdateShipmentResponseBody.md create mode 100644 docs/models/UpdateShipmentsTags.md create mode 100644 docs/models/UpdateShipmentsTagsRequestBody.md create mode 100644 docs/models/UpdateShipmentsTagsShipmentsTagsInner.md create mode 100644 docs/models/UpdateUpsSettingsRequestBody.md create mode 100644 docs/models/UpdateWarehouseRequestBody.md create mode 100644 docs/models/UpdateWarehouseSettingsRequestBody.md create mode 100644 docs/models/UpdateWebhookRequestBody.md create mode 100644 docs/models/UpsAccountSettings.md create mode 100644 docs/models/UpsInvoice.md create mode 100644 docs/models/UpsPickupType.md create mode 100644 docs/models/UpsSettingsResponseBody.md create mode 100644 docs/models/ValidateAddress.md create mode 100644 docs/models/ValidateShipmentFields.md create mode 100644 docs/models/ValidationStatus.md create mode 100644 docs/models/VoidLabelResponseBody.md create mode 100644 docs/models/Warehouse.md create mode 100644 docs/models/Webhook.md create mode 100644 docs/models/WebhookEvent.md create mode 100644 docs/models/WebhookHeader.md create mode 100644 docs/models/Weight.md create mode 100644 docs/models/WeightUnit.md rename generation/templates/{README.mustache => README.solution.mustache} (86%) diff --git a/.openapi-generator-ignore b/.openapi-generator-ignore index 36141c71..648ec835 100644 --- a/.openapi-generator-ignore +++ b/.openapi-generator-ignore @@ -31,9 +31,10 @@ ShipEngineSDK/Client/*.cs ShipEngineSDK/Extensions/*.cs # We should re-enable these eventually -README.md +#README.md */README.md -docs/**/* +#docs/**/* +docs/scripts/* ShipEngineSDK.Test/*/*.cs api/** .gitignore diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index baf157d5..f571e18d 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -1,3 +1,4 @@ +README.md ShipEngineSDK/Api/AccountApi.cs ShipEngineSDK/Api/AddressesApi.cs ShipEngineSDK/Api/BatchesApi.cs @@ -326,3 +327,331 @@ ShipEngineSDK/Model/WebhookEvent.cs ShipEngineSDK/Model/WebhookHeader.cs ShipEngineSDK/Model/Weight.cs ShipEngineSDK/Model/WeightUnit.cs +docs/apis/AccountApi.md +docs/apis/AddressesApi.md +docs/apis/BatchesApi.md +docs/apis/CarrierAccountsApi.md +docs/apis/CarriersApi.md +docs/apis/DownloadsApi.md +docs/apis/InsuranceApi.md +docs/apis/LabelsApi.md +docs/apis/ManifestsApi.md +docs/apis/PackagePickupsApi.md +docs/apis/PackageTypesApi.md +docs/apis/RatesApi.md +docs/apis/ServicePointsApi.md +docs/apis/ShipmentsApi.md +docs/apis/TagsApi.md +docs/apis/TokensApi.md +docs/apis/TrackingApi.md +docs/apis/WarehousesApi.md +docs/apis/WebhooksApi.md +docs/models/AccountSettings.md +docs/models/AccountSettingsImages.md +docs/models/AddFundsToCarrierRequestBody.md +docs/models/AddFundsToCarrierResponseBody.md +docs/models/AddFundsToInsuranceRequestBody.md +docs/models/AddFundsToInsuranceResponseBody.md +docs/models/AddToBatchRequestBody.md +docs/models/Address.md +docs/models/AddressResidentialIndicator.md +docs/models/AddressToValidate.md +docs/models/AddressValidatingShipment.md +docs/models/AddressValidationCode.md +docs/models/AddressValidationDetailCode.md +docs/models/AddressValidationMessageType.md +docs/models/AddressValidationResult.md +docs/models/AddressValidationStatus.md +docs/models/AdvancedShipmentOptions.md +docs/models/AdvancedShipmentOptionsDangerousGoodsContact.md +docs/models/AdvancedShipmentOptionsFedexFreight.md +docs/models/AdvancedShipmentOptionsWindsorFrameworkDetails.md +docs/models/AllowedIncoterms.md +docs/models/AlternativeIdentifier.md +docs/models/AlternativeIdentifiers.md +docs/models/AncillaryServiceEndorsement.md +docs/models/Batch.md +docs/models/BatchResponseError.md +docs/models/BatchStatus.md +docs/models/BatchesSortBy.md +docs/models/BillToParty.md +docs/models/BulkRate.md +docs/models/CalculateRatesRequestBody.md +docs/models/CalculateRatesResponseBody.md +docs/models/Carrier.md +docs/models/CarrierAdvancedOption.md +docs/models/CarrierName.md +docs/models/CarrierNameWithSettings.md +docs/models/CollectOnDelivery.md +docs/models/CollectOnDeliveryPaymentType.md +docs/models/CompareBulkRatesRequestBody.md +docs/models/ConnectAccessWorldwideRequestBody.md +docs/models/ConnectAmazonBuyShippingRequestBody.md +docs/models/ConnectAmazonShippingUk.md +docs/models/ConnectApcRequestBody.md +docs/models/ConnectAsendiaRequestBody.md +docs/models/ConnectAustraliaPostRequestBody.md +docs/models/ConnectCanadaPostRequestBody.md +docs/models/ConnectCarrierRequestBody.md +docs/models/ConnectCarrierResponseBody.md +docs/models/ConnectDhlEcommerceRequestBody.md +docs/models/ConnectDhlExpressAuRequestBody.md +docs/models/ConnectDhlExpressCaRequestBody.md +docs/models/ConnectDhlExpressRequestBody.md +docs/models/ConnectDhlExpressUkRequestBody.md +docs/models/ConnectDpdRequestBody.md +docs/models/ConnectEndiciaRequestBody.md +docs/models/ConnectFedexRequestBody.md +docs/models/ConnectFedexUkRequestBody.md +docs/models/ConnectFirstmileRequestBody.md +docs/models/ConnectImexRequestBody.md +docs/models/ConnectInsurerRequestBody.md +docs/models/ConnectLasershipRequestBody.md +docs/models/ConnectNewgisticsRequestBody.md +docs/models/ConnectOntracRequestBody.md +docs/models/ConnectPurolatorRequestBody.md +docs/models/ConnectRoyalMailRequestBody.md +docs/models/ConnectRrDonnelleyRequestBody.md +docs/models/ConnectSekoRequestBody.md +docs/models/ConnectSendleRequestBody.md +docs/models/ConnectStampsRequestBody.md +docs/models/ConnectUpsRequestBody.md +docs/models/ContactDetails.md +docs/models/CreateAccountSettingsImageRequestBody.md +docs/models/CreateAndProcessBatchRequestBody.md +docs/models/CreateAndProcessBatchRequestBodyProcessLabels.md +docs/models/CreateAndValidateShipment.md +docs/models/CreateBatchRequest.md +docs/models/CreateBatchRequestBody.md +docs/models/CreateBatchResponseBody.md +docs/models/CreateLabelFromRateRequestBody.md +docs/models/CreateLabelFromRateResponseBody.md +docs/models/CreateLabelFromShipmentRequestBody.md +docs/models/CreateLabelFromShipmentResponseBody.md +docs/models/CreateLabelRequestBody.md +docs/models/CreateLabelResponseBody.md +docs/models/CreateManifestByObjectRequestBody.md +docs/models/CreateManifestLabelIdsRequestBody.md +docs/models/CreateManifestRequestBody.md +docs/models/CreateManifestResponseBody.md +docs/models/CreatePackageTypeRequestBody.md +docs/models/CreatePackageTypeResponseBody.md +docs/models/CreateReturnLabelRequestBody.md +docs/models/CreateReturnLabelResponseBody.md +docs/models/CreateShipmentResponseBodyFields.md +docs/models/CreateShipmentsRequestBody.md +docs/models/CreateShipmentsResponseBody.md +docs/models/CreateTagResponseBody.md +docs/models/CreateWarehouseRequestBody.md +docs/models/CreateWarehouseResponseBody.md +docs/models/CreateWebhookRequestBody.md +docs/models/CreateWebhookResponseBody.md +docs/models/CustomsItem.md +docs/models/DangerousAmount.md +docs/models/DangerousGoods.md +docs/models/DefaultLabelLayout.md +docs/models/DeletePickupByIdResponseBody.md +docs/models/DeleteScheduledPickupResponseBody.md +docs/models/DeliveryConfirmation.md +docs/models/DeprecatedManifest.md +docs/models/DhlExpressAccountSettings.md +docs/models/DhlExpressSettingsResponseBody.md +docs/models/DimensionUnit.md +docs/models/Dimensions.md +docs/models/DisplayScheme.md +docs/models/Error.md +docs/models/ErrorCode.md +docs/models/ErrorResponseBody.md +docs/models/ErrorSource.md +docs/models/ErrorType.md +docs/models/ErrorWithLabelIdResponseBody.md +docs/models/EstimateRatesRequestBody.md +docs/models/FedexAccountSettings.md +docs/models/FedexAccountSettingsRequestBody.md +docs/models/FedexPickupType.md +docs/models/FedexSettingsResponseBody.md +docs/models/GetAccountSettingsImagesResponseBody.md +docs/models/GetAccountSettingsResponseBody.md +docs/models/GetBatchByExternalIdResponseBody.md +docs/models/GetBatchByIdResponseBody.md +docs/models/GetCarrierByIdResponseBody.md +docs/models/GetCarrierOptionsResponseBody.md +docs/models/GetCarrierSettingsResponseBody.md +docs/models/GetCarriersResponseBody.md +docs/models/GetInsuranceBalanceResponseBody.md +docs/models/GetLabelByExternalShipmentIdResponseBody.md +docs/models/GetLabelByIdResponseBody.md +docs/models/GetManifestByIdResponseBody.md +docs/models/GetPackageTypeByIdResponseBody.md +docs/models/GetPickupByIdResponseBody.md +docs/models/GetPickupsResponseBody.md +docs/models/GetRateByIdResponseBody.md +docs/models/GetServicePointByIdResponseBody.md +docs/models/GetServicePointByIdResponseBodyServicePoint.md +docs/models/GetServicePointsRequest.md +docs/models/GetServicePointsRequestBody.md +docs/models/GetServicePointsRequestBodyAddress.md +docs/models/GetServicePointsRequestBodyProvidersInner.md +docs/models/GetServicePointsRequestBodyShipment.md +docs/models/GetServicePointsRequestBodyShipmentPackagesInner.md +docs/models/GetShipmentByExternalIdResponseBody.md +docs/models/GetShipmentByIdResponseBody.md +docs/models/GetTrackingLogFromLabelResponseBody.md +docs/models/GetTrackingLogResponseBody.md +docs/models/GetWarehouseByIdResponseBody.md +docs/models/GetWebhookByIdResponseBody.md +docs/models/IdentifierType.md +docs/models/ImporterOfRecords.md +docs/models/InsuranceProvider.md +docs/models/InternationalShipmentOptions.md +docs/models/InvoiceAdditionalDetails.md +docs/models/Label.md +docs/models/LabelChargeEvent.md +docs/models/LabelDownload.md +docs/models/LabelDownloadType.md +docs/models/LabelFormat.md +docs/models/LabelLayout.md +docs/models/LabelMessages.md +docs/models/LabelPackage.md +docs/models/LabelPackagesInner.md +docs/models/LabelRequest.md +docs/models/LabelStatus.md +docs/models/Link.md +docs/models/ListAccountImagesResponseBody.md +docs/models/ListAccountSettingsBody.md +docs/models/ListAccountSettingsImagesResponseBody.md +docs/models/ListBatchErrorsResponseBody.md +docs/models/ListBatchesResponseBody.md +docs/models/ListCarrierPackageTypesResponseBody.md +docs/models/ListCarrierServicesResponseBody.md +docs/models/ListCarriersResponseBody.md +docs/models/ListLabelsResponseBody.md +docs/models/ListManifestsResponseBody.md +docs/models/ListPackageTypesResponseBody.md +docs/models/ListPickupResponseBody.md +docs/models/ListServicePointsResponseBody.md +docs/models/ListServicePointsResponseBodyServicePointsInner.md +docs/models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.md +docs/models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md +docs/models/ListShipmentRatesResponseBody.md +docs/models/ListShipmentsResponseBody.md +docs/models/ListTagsResponseBody.md +docs/models/ListWarehousesResponseBody.md +docs/models/Manifest.md +docs/models/ManifestDownload.md +docs/models/ManifestRequest.md +docs/models/ManifestRequestStatus.md +docs/models/Manifests.md +docs/models/ManifestsRequests.md +docs/models/ModifyBatch.md +docs/models/MonetaryValue.md +docs/models/NonDelivery.md +docs/models/OptionalLink.md +docs/models/OrderSourceName.md +docs/models/OriginType.md +docs/models/Package.md +docs/models/PackageContents.md +docs/models/PackageType.md +docs/models/PackagingGroup.md +docs/models/PackagingInstructionSection.md +docs/models/PagedListResponseBody.md +docs/models/PaginationLink.md +docs/models/PaperlessDownload.md +docs/models/ParseAddressRequestBody.md +docs/models/ParseAddressResponseBody.md +docs/models/ParseShipmentRequestBody.md +docs/models/ParseShipmentResponseBody.md +docs/models/PartialAddress.md +docs/models/PartialShipment.md +docs/models/PartialShippingAddress.md +docs/models/PartialShippingAddressTo.md +docs/models/PartialShippingAddressToGeolocationInner.md +docs/models/PaymentAmount.md +docs/models/Pickup.md +docs/models/PickupResponseBody.md +docs/models/PickupWindow.md +docs/models/PickupWindows.md +docs/models/ProcessBatchRequestBody.md +docs/models/Products.md +docs/models/PurchaseLabelWithoutShipment.md +docs/models/Rate.md +docs/models/RateDetail.md +docs/models/RateDetailAttributes.md +docs/models/RateDetailType.md +docs/models/RateEstimate.md +docs/models/RateEstimateByCarrierId.md +docs/models/RateEstimateByCarrierIds.md +docs/models/RateEstimateOptions.md +docs/models/RateRequestBody.md +docs/models/RateRequestByShipmentIds.md +docs/models/RateRequestByShipments.md +docs/models/RateRequestOptions.md +docs/models/RateRequestRateOptions.md +docs/models/RateResponse.md +docs/models/RateResponseStatus.md +docs/models/RateShipmentRequest.md +docs/models/RateType.md +docs/models/RatesInformation.md +docs/models/ReasonCode.md +docs/models/RecognizedEntity.md +docs/models/Redirect.md +docs/models/RegulationLevel.md +docs/models/RemoveFromBatchRequestBody.md +docs/models/ResponseMessage.md +docs/models/SchedulePickupRequestBody.md +docs/models/SchedulePickupResponseBody.md +docs/models/Service.md +docs/models/Shipment.md +docs/models/ShipmentIdRequest.md +docs/models/ShipmentItem.md +docs/models/ShipmentRequest.md +docs/models/ShipmentStatus.md +docs/models/ShipmentsSortBy.md +docs/models/ShippingAddress.md +docs/models/ShippingAddressFrom.md +docs/models/ShippingAddressTo.md +docs/models/SmartPostHub.md +docs/models/SortDir.md +docs/models/StatusCode.md +docs/models/StatusDetailCode.md +docs/models/Tag.md +docs/models/TagShipmentResponseBody.md +docs/models/TaxIdentifier.md +docs/models/TaxType.md +docs/models/TaxableEntityType.md +docs/models/TokensGetEphemeralTokenResponseBodyYaml.md +docs/models/TrackEvent.md +docs/models/TrackingInformation.md +docs/models/TrackingStatus.md +docs/models/TransportMean.md +docs/models/UpdateAccountSettingsImageRequestBody.md +docs/models/UpdateAmazonBuyShippingRequestBody.md +docs/models/UpdateCarrierSettingsRequestBody.md +docs/models/UpdateDhlExpressSettingsRequestBody.md +docs/models/UpdateFedexSettingsRequestBody.md +docs/models/UpdateNewgisticsSettingsRequestBody.md +docs/models/UpdatePackageTypeRequestBody.md +docs/models/UpdateShipmentFields.md +docs/models/UpdateShipmentRequestBody.md +docs/models/UpdateShipmentResponseBody.md +docs/models/UpdateShipmentsTags.md +docs/models/UpdateShipmentsTagsRequestBody.md +docs/models/UpdateShipmentsTagsShipmentsTagsInner.md +docs/models/UpdateUpsSettingsRequestBody.md +docs/models/UpdateWarehouseRequestBody.md +docs/models/UpdateWarehouseSettingsRequestBody.md +docs/models/UpdateWebhookRequestBody.md +docs/models/UpsAccountSettings.md +docs/models/UpsInvoice.md +docs/models/UpsPickupType.md +docs/models/UpsSettingsResponseBody.md +docs/models/ValidateAddress.md +docs/models/ValidateShipmentFields.md +docs/models/ValidationStatus.md +docs/models/VoidLabelResponseBody.md +docs/models/Warehouse.md +docs/models/Webhook.md +docs/models/WebhookEvent.md +docs/models/WebhookHeader.md +docs/models/Weight.md +docs/models/WeightUnit.md diff --git a/README.md b/README.md index b018e03e..789c1371 100644 --- a/README.md +++ b/README.md @@ -28,20 +28,455 @@ The only configuration requirement is an [API key](https://www.shipengine.com/do using ShipEngineSDK; var shipengine = new ShipEngine("___YOUR_API_KEY_HERE__"); + +var carriers = await shipengine.ListCarriers(CancellationToken.Default); ``` + +## Overview + +This C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: + +- API version: 1.1.202501091801 +- SDK version: 3.0.0 +- Generator version: 7.7.0 +- Build package: org.openapitools.codegen.languages.CSharpClientCodegen + For more information, please visit [https://www.shipengine.com/contact/](https://www.shipengine.com/contact/) + + +## Frameworks supported +- .NET Core >=1.0 +- .NET Framework >=4.6 + + ## Methods -- [`CreateLabelFromRate`](./docs/CreateLabelFromRate.md) - When retrieving rates for shipments using the `GetRatesWithShipmentDetails` method, the returned information contains a `RateId` property that can be used to purchase a label without having to refill in the shipment information repeatedly. -- [`CreateLabelFromShipmentDetails`](./docs/CreateLabelFromShipmentDetails.md) - Purchase and print a label for shipment. -- [`GetRatesWithShipmentDetails`](./docs/GetRatesWithShipmentDetails.md) - Given some shipment details and rate options, this method returns a list of rate quotes. -- [`ListCarriers`](./docs/ListCarriers.md) - Returns a list of carrier accounts that have been connected through +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 + + + +## Models + + - [AccountSettings](docs//models/AccountSettings.md) + - [AccountSettingsImages](docs//models/AccountSettingsImages.md) + - [AddFundsToCarrierRequestBody](docs//models/AddFundsToCarrierRequestBody.md) + - [AddFundsToCarrierResponseBody](docs//models/AddFundsToCarrierResponseBody.md) + - [AddFundsToInsuranceRequestBody](docs//models/AddFundsToInsuranceRequestBody.md) + - [AddFundsToInsuranceResponseBody](docs//models/AddFundsToInsuranceResponseBody.md) + - [AddToBatchRequestBody](docs//models/AddToBatchRequestBody.md) + - [Address](docs//models/Address.md) + - [AddressResidentialIndicator](docs//models/AddressResidentialIndicator.md) + - [AddressToValidate](docs//models/AddressToValidate.md) + - [AddressValidatingShipment](docs//models/AddressValidatingShipment.md) + - [AddressValidationCode](docs//models/AddressValidationCode.md) + - [AddressValidationDetailCode](docs//models/AddressValidationDetailCode.md) + - [AddressValidationMessageType](docs//models/AddressValidationMessageType.md) + - [AddressValidationResult](docs//models/AddressValidationResult.md) + - [AddressValidationStatus](docs//models/AddressValidationStatus.md) + - [AdvancedShipmentOptions](docs//models/AdvancedShipmentOptions.md) + - [AdvancedShipmentOptionsDangerousGoodsContact](docs//models/AdvancedShipmentOptionsDangerousGoodsContact.md) + - [AdvancedShipmentOptionsFedexFreight](docs//models/AdvancedShipmentOptionsFedexFreight.md) + - [AdvancedShipmentOptionsWindsorFrameworkDetails](docs//models/AdvancedShipmentOptionsWindsorFrameworkDetails.md) + - [AllowedIncoterms](docs//models/AllowedIncoterms.md) + - [AlternativeIdentifier](docs//models/AlternativeIdentifier.md) + - [AlternativeIdentifiers](docs//models/AlternativeIdentifiers.md) + - [AncillaryServiceEndorsement](docs//models/AncillaryServiceEndorsement.md) + - [Batch](docs//models/Batch.md) + - [BatchResponseError](docs//models/BatchResponseError.md) + - [BatchStatus](docs//models/BatchStatus.md) + - [BatchesSortBy](docs//models/BatchesSortBy.md) + - [BillToParty](docs//models/BillToParty.md) + - [BulkRate](docs//models/BulkRate.md) + - [CalculateRatesRequestBody](docs//models/CalculateRatesRequestBody.md) + - [CalculateRatesResponseBody](docs//models/CalculateRatesResponseBody.md) + - [Carrier](docs//models/Carrier.md) + - [CarrierAdvancedOption](docs//models/CarrierAdvancedOption.md) + - [CarrierName](docs//models/CarrierName.md) + - [CarrierNameWithSettings](docs//models/CarrierNameWithSettings.md) + - [CollectOnDelivery](docs//models/CollectOnDelivery.md) + - [CollectOnDeliveryPaymentType](docs//models/CollectOnDeliveryPaymentType.md) + - [CompareBulkRatesRequestBody](docs//models/CompareBulkRatesRequestBody.md) + - [ConnectAccessWorldwideRequestBody](docs//models/ConnectAccessWorldwideRequestBody.md) + - [ConnectAmazonBuyShippingRequestBody](docs//models/ConnectAmazonBuyShippingRequestBody.md) + - [ConnectAmazonShippingUk](docs//models/ConnectAmazonShippingUk.md) + - [ConnectApcRequestBody](docs//models/ConnectApcRequestBody.md) + - [ConnectAsendiaRequestBody](docs//models/ConnectAsendiaRequestBody.md) + - [ConnectAustraliaPostRequestBody](docs//models/ConnectAustraliaPostRequestBody.md) + - [ConnectCanadaPostRequestBody](docs//models/ConnectCanadaPostRequestBody.md) + - [ConnectCarrierRequestBody](docs//models/ConnectCarrierRequestBody.md) + - [ConnectCarrierResponseBody](docs//models/ConnectCarrierResponseBody.md) + - [ConnectDhlEcommerceRequestBody](docs//models/ConnectDhlEcommerceRequestBody.md) + - [ConnectDhlExpressAuRequestBody](docs//models/ConnectDhlExpressAuRequestBody.md) + - [ConnectDhlExpressCaRequestBody](docs//models/ConnectDhlExpressCaRequestBody.md) + - [ConnectDhlExpressRequestBody](docs//models/ConnectDhlExpressRequestBody.md) + - [ConnectDhlExpressUkRequestBody](docs//models/ConnectDhlExpressUkRequestBody.md) + - [ConnectDpdRequestBody](docs//models/ConnectDpdRequestBody.md) + - [ConnectEndiciaRequestBody](docs//models/ConnectEndiciaRequestBody.md) + - [ConnectFedexRequestBody](docs//models/ConnectFedexRequestBody.md) + - [ConnectFedexUkRequestBody](docs//models/ConnectFedexUkRequestBody.md) + - [ConnectFirstmileRequestBody](docs//models/ConnectFirstmileRequestBody.md) + - [ConnectImexRequestBody](docs//models/ConnectImexRequestBody.md) + - [ConnectInsurerRequestBody](docs//models/ConnectInsurerRequestBody.md) + - [ConnectLasershipRequestBody](docs//models/ConnectLasershipRequestBody.md) + - [ConnectNewgisticsRequestBody](docs//models/ConnectNewgisticsRequestBody.md) + - [ConnectOntracRequestBody](docs//models/ConnectOntracRequestBody.md) + - [ConnectPurolatorRequestBody](docs//models/ConnectPurolatorRequestBody.md) + - [ConnectRoyalMailRequestBody](docs//models/ConnectRoyalMailRequestBody.md) + - [ConnectRrDonnelleyRequestBody](docs//models/ConnectRrDonnelleyRequestBody.md) + - [ConnectSekoRequestBody](docs//models/ConnectSekoRequestBody.md) + - [ConnectSendleRequestBody](docs//models/ConnectSendleRequestBody.md) + - [ConnectStampsRequestBody](docs//models/ConnectStampsRequestBody.md) + - [ConnectUpsRequestBody](docs//models/ConnectUpsRequestBody.md) + - [ContactDetails](docs//models/ContactDetails.md) + - [CreateAccountSettingsImageRequestBody](docs//models/CreateAccountSettingsImageRequestBody.md) + - [CreateAndProcessBatchRequestBody](docs//models/CreateAndProcessBatchRequestBody.md) + - [CreateAndProcessBatchRequestBodyProcessLabels](docs//models/CreateAndProcessBatchRequestBodyProcessLabels.md) + - [CreateAndValidateShipment](docs//models/CreateAndValidateShipment.md) + - [CreateBatchRequest](docs//models/CreateBatchRequest.md) + - [CreateBatchRequestBody](docs//models/CreateBatchRequestBody.md) + - [CreateBatchResponseBody](docs//models/CreateBatchResponseBody.md) + - [CreateLabelFromRateRequestBody](docs//models/CreateLabelFromRateRequestBody.md) + - [CreateLabelFromRateResponseBody](docs//models/CreateLabelFromRateResponseBody.md) + - [CreateLabelFromShipmentRequestBody](docs//models/CreateLabelFromShipmentRequestBody.md) + - [CreateLabelFromShipmentResponseBody](docs//models/CreateLabelFromShipmentResponseBody.md) + - [CreateLabelRequestBody](docs//models/CreateLabelRequestBody.md) + - [CreateLabelResponseBody](docs//models/CreateLabelResponseBody.md) + - [CreateManifestByObjectRequestBody](docs//models/CreateManifestByObjectRequestBody.md) + - [CreateManifestLabelIdsRequestBody](docs//models/CreateManifestLabelIdsRequestBody.md) + - [CreateManifestRequestBody](docs//models/CreateManifestRequestBody.md) + - [CreateManifestResponseBody](docs//models/CreateManifestResponseBody.md) + - [CreatePackageTypeRequestBody](docs//models/CreatePackageTypeRequestBody.md) + - [CreatePackageTypeResponseBody](docs//models/CreatePackageTypeResponseBody.md) + - [CreateReturnLabelRequestBody](docs//models/CreateReturnLabelRequestBody.md) + - [CreateReturnLabelResponseBody](docs//models/CreateReturnLabelResponseBody.md) + - [CreateShipmentResponseBodyFields](docs//models/CreateShipmentResponseBodyFields.md) + - [CreateShipmentsRequestBody](docs//models/CreateShipmentsRequestBody.md) + - [CreateShipmentsResponseBody](docs//models/CreateShipmentsResponseBody.md) + - [CreateTagResponseBody](docs//models/CreateTagResponseBody.md) + - [CreateWarehouseRequestBody](docs//models/CreateWarehouseRequestBody.md) + - [CreateWarehouseResponseBody](docs//models/CreateWarehouseResponseBody.md) + - [CreateWebhookRequestBody](docs//models/CreateWebhookRequestBody.md) + - [CreateWebhookResponseBody](docs//models/CreateWebhookResponseBody.md) + - [CustomsItem](docs//models/CustomsItem.md) + - [DangerousAmount](docs//models/DangerousAmount.md) + - [DangerousGoods](docs//models/DangerousGoods.md) + - [DefaultLabelLayout](docs//models/DefaultLabelLayout.md) + - [DeletePickupByIdResponseBody](docs//models/DeletePickupByIdResponseBody.md) + - [DeleteScheduledPickupResponseBody](docs//models/DeleteScheduledPickupResponseBody.md) + - [DeliveryConfirmation](docs//models/DeliveryConfirmation.md) + - [DeprecatedManifest](docs//models/DeprecatedManifest.md) + - [DhlExpressAccountSettings](docs//models/DhlExpressAccountSettings.md) + - [DhlExpressSettingsResponseBody](docs//models/DhlExpressSettingsResponseBody.md) + - [DimensionUnit](docs//models/DimensionUnit.md) + - [Dimensions](docs//models/Dimensions.md) + - [DisplayScheme](docs//models/DisplayScheme.md) + - [Error](docs//models/Error.md) + - [ErrorCode](docs//models/ErrorCode.md) + - [ErrorResponseBody](docs//models/ErrorResponseBody.md) + - [ErrorSource](docs//models/ErrorSource.md) + - [ErrorType](docs//models/ErrorType.md) + - [ErrorWithLabelIdResponseBody](docs//models/ErrorWithLabelIdResponseBody.md) + - [EstimateRatesRequestBody](docs//models/EstimateRatesRequestBody.md) + - [FedexAccountSettings](docs//models/FedexAccountSettings.md) + - [FedexAccountSettingsRequestBody](docs//models/FedexAccountSettingsRequestBody.md) + - [FedexPickupType](docs//models/FedexPickupType.md) + - [FedexSettingsResponseBody](docs//models/FedexSettingsResponseBody.md) + - [GetAccountSettingsImagesResponseBody](docs//models/GetAccountSettingsImagesResponseBody.md) + - [GetAccountSettingsResponseBody](docs//models/GetAccountSettingsResponseBody.md) + - [GetBatchByExternalIdResponseBody](docs//models/GetBatchByExternalIdResponseBody.md) + - [GetBatchByIdResponseBody](docs//models/GetBatchByIdResponseBody.md) + - [GetCarrierByIdResponseBody](docs//models/GetCarrierByIdResponseBody.md) + - [GetCarrierOptionsResponseBody](docs//models/GetCarrierOptionsResponseBody.md) + - [GetCarrierSettingsResponseBody](docs//models/GetCarrierSettingsResponseBody.md) + - [GetCarriersResponseBody](docs//models/GetCarriersResponseBody.md) + - [GetInsuranceBalanceResponseBody](docs//models/GetInsuranceBalanceResponseBody.md) + - [GetLabelByExternalShipmentIdResponseBody](docs//models/GetLabelByExternalShipmentIdResponseBody.md) + - [GetLabelByIdResponseBody](docs//models/GetLabelByIdResponseBody.md) + - [GetManifestByIdResponseBody](docs//models/GetManifestByIdResponseBody.md) + - [GetPackageTypeByIdResponseBody](docs//models/GetPackageTypeByIdResponseBody.md) + - [GetPickupByIdResponseBody](docs//models/GetPickupByIdResponseBody.md) + - [GetPickupsResponseBody](docs//models/GetPickupsResponseBody.md) + - [GetRateByIdResponseBody](docs//models/GetRateByIdResponseBody.md) + - [GetServicePointByIdResponseBody](docs//models/GetServicePointByIdResponseBody.md) + - [GetServicePointByIdResponseBodyServicePoint](docs//models/GetServicePointByIdResponseBodyServicePoint.md) + - [GetServicePointsRequest](docs//models/GetServicePointsRequest.md) + - [GetServicePointsRequestBody](docs//models/GetServicePointsRequestBody.md) + - [GetServicePointsRequestBodyAddress](docs//models/GetServicePointsRequestBodyAddress.md) + - [GetServicePointsRequestBodyProvidersInner](docs//models/GetServicePointsRequestBodyProvidersInner.md) + - [GetServicePointsRequestBodyShipment](docs//models/GetServicePointsRequestBodyShipment.md) + - [GetServicePointsRequestBodyShipmentPackagesInner](docs//models/GetServicePointsRequestBodyShipmentPackagesInner.md) + - [GetShipmentByExternalIdResponseBody](docs//models/GetShipmentByExternalIdResponseBody.md) + - [GetShipmentByIdResponseBody](docs//models/GetShipmentByIdResponseBody.md) + - [GetTrackingLogFromLabelResponseBody](docs//models/GetTrackingLogFromLabelResponseBody.md) + - [GetTrackingLogResponseBody](docs//models/GetTrackingLogResponseBody.md) + - [GetWarehouseByIdResponseBody](docs//models/GetWarehouseByIdResponseBody.md) + - [GetWebhookByIdResponseBody](docs//models/GetWebhookByIdResponseBody.md) + - [IdentifierType](docs//models/IdentifierType.md) + - [ImporterOfRecords](docs//models/ImporterOfRecords.md) + - [InsuranceProvider](docs//models/InsuranceProvider.md) + - [InternationalShipmentOptions](docs//models/InternationalShipmentOptions.md) + - [InvoiceAdditionalDetails](docs//models/InvoiceAdditionalDetails.md) + - [Label](docs//models/Label.md) + - [LabelChargeEvent](docs//models/LabelChargeEvent.md) + - [LabelDownload](docs//models/LabelDownload.md) + - [LabelDownloadType](docs//models/LabelDownloadType.md) + - [LabelFormat](docs//models/LabelFormat.md) + - [LabelLayout](docs//models/LabelLayout.md) + - [LabelMessages](docs//models/LabelMessages.md) + - [LabelPackage](docs//models/LabelPackage.md) + - [LabelPackagesInner](docs//models/LabelPackagesInner.md) + - [LabelRequest](docs//models/LabelRequest.md) + - [LabelStatus](docs//models/LabelStatus.md) + - [Link](docs//models/Link.md) + - [ListAccountImagesResponseBody](docs//models/ListAccountImagesResponseBody.md) + - [ListAccountSettingsBody](docs//models/ListAccountSettingsBody.md) + - [ListAccountSettingsImagesResponseBody](docs//models/ListAccountSettingsImagesResponseBody.md) + - [ListBatchErrorsResponseBody](docs//models/ListBatchErrorsResponseBody.md) + - [ListBatchesResponseBody](docs//models/ListBatchesResponseBody.md) + - [ListCarrierPackageTypesResponseBody](docs//models/ListCarrierPackageTypesResponseBody.md) + - [ListCarrierServicesResponseBody](docs//models/ListCarrierServicesResponseBody.md) + - [ListCarriersResponseBody](docs//models/ListCarriersResponseBody.md) + - [ListLabelsResponseBody](docs//models/ListLabelsResponseBody.md) + - [ListManifestsResponseBody](docs//models/ListManifestsResponseBody.md) + - [ListPackageTypesResponseBody](docs//models/ListPackageTypesResponseBody.md) + - [ListPickupResponseBody](docs//models/ListPickupResponseBody.md) + - [ListServicePointsResponseBody](docs//models/ListServicePointsResponseBody.md) + - [ListServicePointsResponseBodyServicePointsInner](docs//models/ListServicePointsResponseBodyServicePointsInner.md) + - [ListServicePointsResponseBodyServicePointsInnerHoursOfOperation](docs//models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.md) + - [ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner](docs//models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md) + - [ListShipmentRatesResponseBody](docs//models/ListShipmentRatesResponseBody.md) + - [ListShipmentsResponseBody](docs//models/ListShipmentsResponseBody.md) + - [ListTagsResponseBody](docs//models/ListTagsResponseBody.md) + - [ListWarehousesResponseBody](docs//models/ListWarehousesResponseBody.md) + - [Manifest](docs//models/Manifest.md) + - [ManifestDownload](docs//models/ManifestDownload.md) + - [ManifestRequest](docs//models/ManifestRequest.md) + - [ManifestRequestStatus](docs//models/ManifestRequestStatus.md) + - [Manifests](docs//models/Manifests.md) + - [ManifestsRequests](docs//models/ManifestsRequests.md) + - [ModifyBatch](docs//models/ModifyBatch.md) + - [MonetaryValue](docs//models/MonetaryValue.md) + - [NonDelivery](docs//models/NonDelivery.md) + - [OptionalLink](docs//models/OptionalLink.md) + - [OrderSourceName](docs//models/OrderSourceName.md) + - [OriginType](docs//models/OriginType.md) + - [Package](docs//models/Package.md) + - [PackageContents](docs//models/PackageContents.md) + - [PackageType](docs//models/PackageType.md) + - [PackagingGroup](docs//models/PackagingGroup.md) + - [PackagingInstructionSection](docs//models/PackagingInstructionSection.md) + - [PagedListResponseBody](docs//models/PagedListResponseBody.md) + - [PaginationLink](docs//models/PaginationLink.md) + - [PaperlessDownload](docs//models/PaperlessDownload.md) + - [ParseAddressRequestBody](docs//models/ParseAddressRequestBody.md) + - [ParseAddressResponseBody](docs//models/ParseAddressResponseBody.md) + - [ParseShipmentRequestBody](docs//models/ParseShipmentRequestBody.md) + - [ParseShipmentResponseBody](docs//models/ParseShipmentResponseBody.md) + - [PartialAddress](docs//models/PartialAddress.md) + - [PartialShipment](docs//models/PartialShipment.md) + - [PartialShippingAddress](docs//models/PartialShippingAddress.md) + - [PartialShippingAddressTo](docs//models/PartialShippingAddressTo.md) + - [PartialShippingAddressToGeolocationInner](docs//models/PartialShippingAddressToGeolocationInner.md) + - [PaymentAmount](docs//models/PaymentAmount.md) + - [Pickup](docs//models/Pickup.md) + - [PickupResponseBody](docs//models/PickupResponseBody.md) + - [PickupWindow](docs//models/PickupWindow.md) + - [PickupWindows](docs//models/PickupWindows.md) + - [ProcessBatchRequestBody](docs//models/ProcessBatchRequestBody.md) + - [Products](docs//models/Products.md) + - [PurchaseLabelWithoutShipment](docs//models/PurchaseLabelWithoutShipment.md) + - [Rate](docs//models/Rate.md) + - [RateDetail](docs//models/RateDetail.md) + - [RateDetailAttributes](docs//models/RateDetailAttributes.md) + - [RateDetailType](docs//models/RateDetailType.md) + - [RateEstimate](docs//models/RateEstimate.md) + - [RateEstimateByCarrierId](docs//models/RateEstimateByCarrierId.md) + - [RateEstimateByCarrierIds](docs//models/RateEstimateByCarrierIds.md) + - [RateEstimateOptions](docs//models/RateEstimateOptions.md) + - [RateRequestBody](docs//models/RateRequestBody.md) + - [RateRequestByShipmentIds](docs//models/RateRequestByShipmentIds.md) + - [RateRequestByShipments](docs//models/RateRequestByShipments.md) + - [RateRequestOptions](docs//models/RateRequestOptions.md) + - [RateRequestRateOptions](docs//models/RateRequestRateOptions.md) + - [RateResponse](docs//models/RateResponse.md) + - [RateResponseStatus](docs//models/RateResponseStatus.md) + - [RateShipmentRequest](docs//models/RateShipmentRequest.md) + - [RateType](docs//models/RateType.md) + - [RatesInformation](docs//models/RatesInformation.md) + - [ReasonCode](docs//models/ReasonCode.md) + - [RecognizedEntity](docs//models/RecognizedEntity.md) + - [Redirect](docs//models/Redirect.md) + - [RegulationLevel](docs//models/RegulationLevel.md) + - [RemoveFromBatchRequestBody](docs//models/RemoveFromBatchRequestBody.md) + - [ResponseMessage](docs//models/ResponseMessage.md) + - [SchedulePickupRequestBody](docs//models/SchedulePickupRequestBody.md) + - [SchedulePickupResponseBody](docs//models/SchedulePickupResponseBody.md) + - [Service](docs//models/Service.md) + - [Shipment](docs//models/Shipment.md) + - [ShipmentIdRequest](docs//models/ShipmentIdRequest.md) + - [ShipmentItem](docs//models/ShipmentItem.md) + - [ShipmentRequest](docs//models/ShipmentRequest.md) + - [ShipmentStatus](docs//models/ShipmentStatus.md) + - [ShipmentsSortBy](docs//models/ShipmentsSortBy.md) + - [ShippingAddress](docs//models/ShippingAddress.md) + - [ShippingAddressFrom](docs//models/ShippingAddressFrom.md) + - [ShippingAddressTo](docs//models/ShippingAddressTo.md) + - [SmartPostHub](docs//models/SmartPostHub.md) + - [SortDir](docs//models/SortDir.md) + - [StatusCode](docs//models/StatusCode.md) + - [StatusDetailCode](docs//models/StatusDetailCode.md) + - [Tag](docs//models/Tag.md) + - [TagShipmentResponseBody](docs//models/TagShipmentResponseBody.md) + - [TaxIdentifier](docs//models/TaxIdentifier.md) + - [TaxType](docs//models/TaxType.md) + - [TaxableEntityType](docs//models/TaxableEntityType.md) + - [TokensGetEphemeralTokenResponseBodyYaml](docs//models/TokensGetEphemeralTokenResponseBodyYaml.md) + - [TrackEvent](docs//models/TrackEvent.md) + - [TrackingInformation](docs//models/TrackingInformation.md) + - [TrackingStatus](docs//models/TrackingStatus.md) + - [TransportMean](docs//models/TransportMean.md) + - [UpdateAccountSettingsImageRequestBody](docs//models/UpdateAccountSettingsImageRequestBody.md) + - [UpdateAmazonBuyShippingRequestBody](docs//models/UpdateAmazonBuyShippingRequestBody.md) + - [UpdateCarrierSettingsRequestBody](docs//models/UpdateCarrierSettingsRequestBody.md) + - [UpdateDhlExpressSettingsRequestBody](docs//models/UpdateDhlExpressSettingsRequestBody.md) + - [UpdateFedexSettingsRequestBody](docs//models/UpdateFedexSettingsRequestBody.md) + - [UpdateNewgisticsSettingsRequestBody](docs//models/UpdateNewgisticsSettingsRequestBody.md) + - [UpdatePackageTypeRequestBody](docs//models/UpdatePackageTypeRequestBody.md) + - [UpdateShipmentFields](docs//models/UpdateShipmentFields.md) + - [UpdateShipmentRequestBody](docs//models/UpdateShipmentRequestBody.md) + - [UpdateShipmentResponseBody](docs//models/UpdateShipmentResponseBody.md) + - [UpdateShipmentsTags](docs//models/UpdateShipmentsTags.md) + - [UpdateShipmentsTagsRequestBody](docs//models/UpdateShipmentsTagsRequestBody.md) + - [UpdateShipmentsTagsShipmentsTagsInner](docs//models/UpdateShipmentsTagsShipmentsTagsInner.md) + - [UpdateUpsSettingsRequestBody](docs//models/UpdateUpsSettingsRequestBody.md) + - [UpdateWarehouseRequestBody](docs//models/UpdateWarehouseRequestBody.md) + - [UpdateWarehouseSettingsRequestBody](docs//models/UpdateWarehouseSettingsRequestBody.md) + - [UpdateWebhookRequestBody](docs//models/UpdateWebhookRequestBody.md) + - [UpsAccountSettings](docs//models/UpsAccountSettings.md) + - [UpsInvoice](docs//models/UpsInvoice.md) + - [UpsPickupType](docs//models/UpsPickupType.md) + - [UpsSettingsResponseBody](docs//models/UpsSettingsResponseBody.md) + - [ValidateAddress](docs//models/ValidateAddress.md) + - [ValidateShipmentFields](docs//models/ValidateShipmentFields.md) + - [ValidationStatus](docs//models/ValidationStatus.md) + - [VoidLabelResponseBody](docs//models/VoidLabelResponseBody.md) + - [Warehouse](docs//models/Warehouse.md) + - [Webhook](docs//models/Webhook.md) + - [WebhookEvent](docs//models/WebhookEvent.md) + - [WebhookHeader](docs//models/WebhookHeader.md) + - [Weight](docs//models/Weight.md) + - [WeightUnit](docs//models/WeightUnit.md) + + + +## Legacy Methods + +These methods have been deprecated in favor of the methods listed above, but are still in the SDK. + +- [`CreateLabelFromRate`](./docs/legacy/CreateLabelFromRate.md) - When retrieving rates for shipments using the `GetRatesWithShipmentDetails` method, the returned information contains a `RateId` property that can be used to purchase a label without having to refill in the shipment information repeatedly. +- [`CreateLabelFromShipmentDetails`](./docs/legacy/CreateLabelFromShipmentDetails.md) - Purchase and print a label for shipment. +- [`GetRatesWithShipmentDetails`](./docs/legacy/GetRatesWithShipmentDetails.md) - Given some shipment details and rate options, this method returns a list of rate quotes. +- [`ListCarriers`](./docs/legacy/ListCarriers.md) - Returns a list of carrier accounts that have been connected through the [ShipEngine dashboard](https://www.shipengine.com/docs/carriers/setup/). -- [`TrackUsingLabelId`](./docs/TrackUsingLabelId.md) - Track a package by its associated label ID. -- [`TrackUsingCarrierCodeAndTrackingNumber`](./docs/TrackUsingCarrierCodeAndTrackingNumber.md) - Track a package for a given carrier and tracking number. -- [`ValidateAddresses`](./docs/ValidateAddresses.md) - Indicates whether the provided addresses are valid. If the addresses are valid, the method returns a normalized version based on the standards of the country in which the address resides. If an address cannot be normalized, an error is returned. -- [`VoidLabelWithLabelId`](./docs/VoidLabelWithLabelId.md) - Void a label with its Label ID. -- [`CreateManifests`](./docs/CreateManifest.md) - Create a shipment manifest. +- [`TrackUsingLabelId`](./docs/legacy/TrackUsingLabelId.md) - Track a package by its associated label ID. +- [`TrackUsingCarrierCodeAndTrackingNumber`](./docs/legacy/TrackUsingCarrierCodeAndTrackingNumber.md) - Track a package for a given carrier and tracking number. +- [`ValidateAddresses`](./docs/legacy/ValidateAddresses.md) - Indicates whether the provided addresses are valid. If the addresses are valid, the method returns a normalized version based on the standards of the country in which the address resides. If an address cannot be normalized, an error is returned. +- [`VoidLabelWithLabelId`](./docs/legacy/VoidLabelWithLabelId.md) - Void a label with its Label ID. +- [`CreateManifests`](./docs/legacy/CreateManifest.md) - Create a shipment manifest. ## Contributing @@ -54,7 +489,7 @@ To build the project locally on your computer: 1. **Clone this repo**
`git clone https://github.com/ShipEngine/shipengine-dotnet.git` -2. **Install [.NET 5.x](https://dotnet.microsoft.com/download)** +2. **Install [.NET 8.x](https://dotnet.microsoft.com/download)** 3. **Install dependencies**
`dotnet restore` diff --git a/ShipEngineSDK/Model/ErrorType.cs b/ShipEngineSDK/Model/ErrorType.cs index 2c2b630d..07ea4e80 100644 --- a/ShipEngineSDK/Model/ErrorType.cs +++ b/ShipEngineSDK/Model/ErrorType.cs @@ -86,6 +86,18 @@ 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/docs/apis/AccountApi.md b/docs/apis/AccountApi.md new file mode 100644 index 00000000..6c6b8dfe --- /dev/null +++ b/docs/apis/AccountApi.md @@ -0,0 +1,359 @@ + + +# Account Methods + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**CreateAccountImage**](AccountApi.md#createaccountimage) | **POST** /v1/account/settings/images | Create an Account Image | +| [**DeleteAccountImageById**](AccountApi.md#deleteaccountimagebyid) | **DELETE** /v1/account/settings/images/{label_image_id} | Delete Account Image By Id | +| [**GetAccountSettingsImagesById**](AccountApi.md#getaccountsettingsimagesbyid) | **GET** /v1/account/settings/images/{label_image_id} | Get Account Image By ID | +| [**ListAccountImages**](AccountApi.md#listaccountimages) | **GET** /v1/account/settings/images | List Account Images | +| [**ListAccountSettings**](AccountApi.md#listaccountsettings) | **GET** /v1/account/settings | List Account Settings | +| [**UpdateAccountSettingsImagesById**](AccountApi.md#updateaccountsettingsimagesbyid) | **PUT** /v1/account/settings/images/{label_image_id} | Update Account Image By ID | + + +# **CreateAccountImage** +```csharp +GetAccountSettingsImagesResponseBody CreateAccountImage (CreateAccountSettingsImageRequestBody createAccountSettingsImageRequestBody, CancellationToken cancellationToken = default) + +GetAccountSettingsImagesResponseBody CreateAccountImage (HttpClient methodClient, CreateAccountSettingsImageRequestBody createAccountSettingsImageRequestBody, CancellationToken cancellationToken = default) +``` + +Create an Account Image + +Create an Account Image + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class CreateAccountImageExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var createAccountSettingsImageRequestBody = new CreateAccountSettingsImageRequestBody(); + + try + { + // Create an Account Image + GetAccountSettingsImagesResponseBody result = await shipEngine.CreateAccountImage(createAccountSettingsImageRequestBody); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling AccountApi.CreateAccountImage: " + 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. | | +| **createAccountSettingsImageRequestBody** | [**CreateAccountSettingsImageRequestBody**](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 + +[**GetAccountSettingsImagesResponseBody**](../models/GetAccountSettingsImagesResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **DeleteAccountImageById** +```csharp +string DeleteAccountImageById (string labelImageId, CancellationToken cancellationToken = default) + +string DeleteAccountImageById (HttpClient methodClient, string labelImageId, CancellationToken cancellationToken = default) +``` + +Delete Account Image By Id + +Delete Account Image By Id + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class DeleteAccountImageByIdExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var labelImageId = "labelImageId_example"; + + try + { + // Delete Account Image By Id + string result = await shipEngine.DeleteAccountImageById(labelImageId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling AccountApi.DeleteAccountImageById: " + 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. | | +| **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. | | + +### Return type + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **GetAccountSettingsImagesById** +```csharp +GetAccountSettingsImagesResponseBody GetAccountSettingsImagesById (string labelImageId, CancellationToken cancellationToken = default) + +GetAccountSettingsImagesResponseBody GetAccountSettingsImagesById (HttpClient methodClient, string labelImageId, CancellationToken cancellationToken = default) +``` + +Get Account Image By ID + +Retrieve information for an account image. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetAccountSettingsImagesByIdExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var labelImageId = "labelImageId_example"; + + try + { + // Get Account Image By ID + GetAccountSettingsImagesResponseBody result = await shipEngine.GetAccountSettingsImagesById(labelImageId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling AccountApi.GetAccountSettingsImagesById: " + 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. | | +| **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. | | + +### Return type + +[**GetAccountSettingsImagesResponseBody**](../models/GetAccountSettingsImagesResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ListAccountImages** +```csharp +ListAccountSettingsImagesResponseBody ListAccountImages (, CancellationToken cancellationToken = default) + +ListAccountSettingsImagesResponseBody ListAccountImages (HttpClient methodClient, , CancellationToken cancellationToken = default) +``` + +List Account Images + +List all account images for the ShipEngine account + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ListAccountImagesExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + + try + { + // List Account Images + ListAccountSettingsImagesResponseBody result = await shipEngine.ListAccountImages(); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling AccountApi.ListAccountImages: " + 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. | | +| **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 + +[**ListAccountSettingsImagesResponseBody**](../models/ListAccountSettingsImagesResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ListAccountSettings** +```csharp +GetAccountSettingsResponseBody ListAccountSettings (, CancellationToken cancellationToken = default) + +GetAccountSettingsResponseBody ListAccountSettings (HttpClient methodClient, , CancellationToken cancellationToken = default) +``` + +List Account Settings + +List all account settings for the ShipEngine account + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ListAccountSettingsExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + + try + { + // List Account Settings + GetAccountSettingsResponseBody result = await shipEngine.ListAccountSettings(); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling AccountApi.ListAccountSettings: " + 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. | | +| **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 + +[**GetAccountSettingsResponseBody**](../models/GetAccountSettingsResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **UpdateAccountSettingsImagesById** +```csharp +string UpdateAccountSettingsImagesById (UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBodystring labelImageId, CancellationToken cancellationToken = default) + +string UpdateAccountSettingsImagesById (HttpClient methodClient, UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBodystring labelImageId, CancellationToken cancellationToken = default) +``` + +Update Account Image By ID + +Update information for an account image. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class UpdateAccountSettingsImagesByIdExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var updateAccountSettingsImageRequestBody = new UpdateAccountSettingsImageRequestBody(); + var labelImageId = "labelImageId_example"; + + try + { + // Update Account Image By ID + string result = await shipEngine.UpdateAccountSettingsImagesById(updateAccountSettingsImageRequestBody, labelImageId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling AccountApi.UpdateAccountSettingsImagesById: " + 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. | | +| **updateAccountSettingsImageRequestBody** | [**UpdateAccountSettingsImageRequestBody**](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. | | + +### Return type + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/AddressesApi.md b/docs/apis/AddressesApi.md new file mode 100644 index 00000000..19ab4757 --- /dev/null +++ b/docs/apis/AddressesApi.md @@ -0,0 +1,125 @@ + + +# Addresses Methods + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**ParseAddress**](AddressesApi.md#parseaddress) | **PUT** /v1/addresses/recognize | Parse an address | +| [**ValidateAddress**](AddressesApi.md#validateaddress) | **POST** /v1/addresses/validate | Validate An Address | + + +# **ParseAddress** +```csharp +ParseAddressResponseBody ParseAddress (ParseAddressRequestBody parseAddressRequestBody, CancellationToken cancellationToken = default) + +ParseAddressResponseBody ParseAddress (HttpClient methodClient, ParseAddressRequestBody parseAddressRequestBody, CancellationToken cancellationToken = default) +``` + +Parse an address + +The address-recognition API makes it easy for you to extract address data from unstructured text, including the recipient name, line 1, line 2, city, postal code, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's address-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed address data is returned in the same structure that's used for other ShipEngine APIs, such as address validation, rate quotes, and shipping labels. > **Note:** Address recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ParseAddressExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var parseAddressRequestBody = new ParseAddressRequestBody(); + + try + { + // Parse an address + ParseAddressResponseBody result = await shipEngine.ParseAddress(parseAddressRequestBody); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling AddressesApi.ParseAddress: " + 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. | | +| **parseAddressRequestBody** | [**ParseAddressRequestBody**](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 + +[**ParseAddressResponseBody**](../models/ParseAddressResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ValidateAddress** +```csharp +List<AddressValidationResult> ValidateAddress (List addressToValidate, CancellationToken cancellationToken = default) + +List<AddressValidationResult> ValidateAddress (HttpClient methodClient, List addressToValidate, CancellationToken cancellationToken = default) +``` + +Validate An Address + +Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. ShipEngine cross references multiple databases to validate addresses and identify potential deliverability issues. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ValidateAddressExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var addressToValidate = new List(); + + try + { + // Validate An Address + List result = await shipEngine.ValidateAddress(addressToValidate); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling AddressesApi.ValidateAddress: " + 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. | | +| **addressToValidate** | [**List<AddressToValidate>**](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 + +[**List<AddressValidationResult>**](../models/AddressValidationResult.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/BatchesApi.md b/docs/apis/BatchesApi.md new file mode 100644 index 00000000..d824347b --- /dev/null +++ b/docs/apis/BatchesApi.md @@ -0,0 +1,617 @@ + + +# Batches Methods + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**AddToBatch**](BatchesApi.md#addtobatch) | **POST** /v1/batches/{batch_id}/add | Add to a Batch | +| [**CreateBatch**](BatchesApi.md#createbatch) | **POST** /v1/batches | Create A Batch | +| [**DeleteBatch**](BatchesApi.md#deletebatch) | **DELETE** /v1/batches/{batch_id} | Delete Batch By Id | +| [**GetBatchByExternalId**](BatchesApi.md#getbatchbyexternalid) | **GET** /v1/batches/external_batch_id/{external_batch_id} | Get Batch By External ID | +| [**GetBatchById**](BatchesApi.md#getbatchbyid) | **GET** /v1/batches/{batch_id} | Get Batch By ID | +| [**ListBatchErrors**](BatchesApi.md#listbatcherrors) | **GET** /v1/batches/{batch_id}/errors | Get Batch Errors | +| [**ListBatches**](BatchesApi.md#listbatches) | **GET** /v1/batches | List Batches | +| [**ProcessBatch**](BatchesApi.md#processbatch) | **POST** /v1/batches/{batch_id}/process/labels | Process Batch ID Labels | +| [**RemoveFromBatch**](BatchesApi.md#removefrombatch) | **POST** /v1/batches/{batch_id}/remove | Remove From Batch | +| [**UpdateBatch**](BatchesApi.md#updatebatch) | **PUT** /v1/batches/{batch_id} | Update Batch By Id | + + +# **AddToBatch** +```csharp +string AddToBatch (AddToBatchRequestBody addToBatchRequestBodystring batchId, CancellationToken cancellationToken = default) + +string AddToBatch (HttpClient methodClient, AddToBatchRequestBody addToBatchRequestBodystring batchId, CancellationToken cancellationToken = default) +``` + +Add to a Batch + +Add a Shipment or Rate to a Batch + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class AddToBatchExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var addToBatchRequestBody = new AddToBatchRequestBody(); + var batchId = "batchId_example"; + + try + { + // Add to a Batch + string result = await shipEngine.AddToBatch(addToBatchRequestBody, batchId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling BatchesApi.AddToBatch: " + 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. | | +| **addToBatchRequestBody** | [**AddToBatchRequestBody**](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. | | + +### Return type + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **CreateBatch** +```csharp +CreateBatchResponseBody CreateBatch (CreateBatchRequest createBatchRequest, CancellationToken cancellationToken = default) + +CreateBatchResponseBody CreateBatch (HttpClient methodClient, CreateBatchRequest createBatchRequest, CancellationToken cancellationToken = default) +``` + +Create A Batch + +Create a Batch + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class CreateBatchExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var createBatchRequest = new CreateBatchRequest(); + + try + { + // Create A Batch + CreateBatchResponseBody result = await shipEngine.CreateBatch(createBatchRequest); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling BatchesApi.CreateBatch: " + 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. | | +| **createBatchRequest** | [**CreateBatchRequest**](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 + +[**CreateBatchResponseBody**](../models/CreateBatchResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **DeleteBatch** +```csharp +string DeleteBatch (string batchId, CancellationToken cancellationToken = default) + +string DeleteBatch (HttpClient methodClient, string batchId, CancellationToken cancellationToken = default) +``` + +Delete Batch By Id + +Delete Batch By Id + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class DeleteBatchExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var batchId = "batchId_example"; + + try + { + // Delete Batch By Id + string result = await shipEngine.DeleteBatch(batchId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling BatchesApi.DeleteBatch: " + 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. | | +| **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. | | + +### Return type + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **GetBatchByExternalId** +```csharp +GetBatchByExternalIdResponseBody GetBatchByExternalId (string externalBatchId, CancellationToken cancellationToken = default) + +GetBatchByExternalIdResponseBody GetBatchByExternalId (HttpClient methodClient, string externalBatchId, CancellationToken cancellationToken = default) +``` + +Get Batch By External ID + +Get Batch By External ID + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetBatchByExternalIdExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var externalBatchId = 13553d7f-3c87-4771-bae1-c49bacef11cb; + + try + { + // Get Batch By External ID + GetBatchByExternalIdResponseBody result = await shipEngine.GetBatchByExternalId(externalBatchId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling BatchesApi.GetBatchByExternalId: " + 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. | | +| **externalBatchId** | **string** | | | +| **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 + +[**GetBatchByExternalIdResponseBody**](../models/GetBatchByExternalIdResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **GetBatchById** +```csharp +GetBatchByIdResponseBody GetBatchById (string batchId, CancellationToken cancellationToken = default) + +GetBatchByIdResponseBody GetBatchById (HttpClient methodClient, string batchId, CancellationToken cancellationToken = default) +``` + +Get Batch By ID + +Get Batch By ID + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetBatchByIdExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var batchId = "batchId_example"; + + try + { + // Get Batch By ID + GetBatchByIdResponseBody result = await shipEngine.GetBatchById(batchId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling BatchesApi.GetBatchById: " + 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. | | +| **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. | | + +### Return type + +[**GetBatchByIdResponseBody**](../models/GetBatchByIdResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ListBatchErrors** +```csharp +ListBatchErrorsResponseBody ListBatchErrors (string batchIdint pagesize = nullint page = null, CancellationToken cancellationToken = default) + +ListBatchErrorsResponseBody ListBatchErrors (HttpClient methodClient, string batchIdint pagesize = nullint page = null, CancellationToken cancellationToken = default) +``` + +Get Batch Errors + +Error handling in batches are handled differently than in a single synchronous request. You must retrieve the status of your batch by [getting a batch](https://www.shipengine.com/docs/reference/get-batch-by-id/) and getting an overview of the statuses or you can list errors directly here below to get detailed information about the errors. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ListBatchErrorsExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var batchId = "batchId_example"; + var pagesize = 56; + var page = 2; + + try + { + // Get Batch Errors + ListBatchErrorsResponseBody result = await shipEngine.ListBatchErrors(batchId, pagesize, page); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling BatchesApi.ListBatchErrors: " + 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. | | +| **batchId** | **string** | Batch ID | | +| **pagesize** | **int** | | [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] | +| **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 + +[**ListBatchErrorsResponseBody**](../models/ListBatchErrorsResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ListBatches** +```csharp +ListBatchesResponseBody ListBatches (BatchStatus status = nullBatchesSortBy sortBy = nullSortDir sortDir = nullstring batchNumber = nullint page = nullint pageSize = null, CancellationToken cancellationToken = default) + +ListBatchesResponseBody ListBatches (HttpClient methodClient, BatchStatus status = nullBatchesSortBy sortBy = nullSortDir sortDir = nullstring batchNumber = nullint page = nullint pageSize = null, CancellationToken cancellationToken = default) +``` + +List Batches + +List Batches associated with your Shipengine account + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ListBatchesExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var status = (BatchStatus) "open"; + var sortBy = (BatchesSortBy) "ship_date"; + var sortDir = (SortDir) "asc"; + var batchNumber = "batchNumber_example"; + var page = 2; + var pageSize = 50; + + try + { + // List Batches + ListBatchesResponseBody result = await shipEngine.ListBatches(status, sortBy, sortDir, batchNumber, page, pageSize); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling BatchesApi.ListBatches: " + 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. | | +| **status** | **BatchStatus** | | [optional] | +| **sortBy** | **BatchesSortBy** | | [optional] | +| **sortDir** | **SortDir** | Controls the sort order of the query. | [optional] | +| **batchNumber** | **string** | Batch Number | [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] | +| **pageSize** | **int** | The number of results to return per response. | [optional] [default to 25] | +| **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 + +[**ListBatchesResponseBody**](../models/ListBatchesResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ProcessBatch** +```csharp +string ProcessBatch (ProcessBatchRequestBody processBatchRequestBodystring batchId, CancellationToken cancellationToken = default) + +string ProcessBatch (HttpClient methodClient, ProcessBatchRequestBody processBatchRequestBodystring batchId, CancellationToken cancellationToken = default) +``` + +Process Batch ID Labels + +Process Batch ID Labels + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ProcessBatchExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var processBatchRequestBody = new ProcessBatchRequestBody(); + var batchId = "batchId_example"; + + try + { + // Process Batch ID Labels + string result = await shipEngine.ProcessBatch(processBatchRequestBody, batchId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling BatchesApi.ProcessBatch: " + 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. | | +| **processBatchRequestBody** | [**ProcessBatchRequestBody**](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. | | + +### Return type + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **RemoveFromBatch** +```csharp +string RemoveFromBatch (RemoveFromBatchRequestBody removeFromBatchRequestBodystring batchId, CancellationToken cancellationToken = default) + +string RemoveFromBatch (HttpClient methodClient, RemoveFromBatchRequestBody removeFromBatchRequestBodystring batchId, CancellationToken cancellationToken = default) +``` + +Remove From Batch + +Remove a shipment or rate from a batch + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class RemoveFromBatchExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var removeFromBatchRequestBody = new RemoveFromBatchRequestBody(); + var batchId = "batchId_example"; + + try + { + // Remove From Batch + string result = await shipEngine.RemoveFromBatch(removeFromBatchRequestBody, batchId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling BatchesApi.RemoveFromBatch: " + 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. | | +| **removeFromBatchRequestBody** | [**RemoveFromBatchRequestBody**](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. | | + +### Return type + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **UpdateBatch** +```csharp +string UpdateBatch (string batchId, CancellationToken cancellationToken = default) + +string UpdateBatch (HttpClient methodClient, string batchId, CancellationToken cancellationToken = default) +``` + +Update Batch By Id + +Update Batch By Id + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class UpdateBatchExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var batchId = "batchId_example"; + + try + { + // Update Batch By Id + string result = await shipEngine.UpdateBatch(batchId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling BatchesApi.UpdateBatch: " + 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. | | +| **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. | | + +### Return type + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/CarrierAccountsApi.md b/docs/apis/CarrierAccountsApi.md new file mode 100644 index 00000000..f8c43e2e --- /dev/null +++ b/docs/apis/CarrierAccountsApi.md @@ -0,0 +1,253 @@ + + +# CarrierAccounts Methods + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**ConnectCarrier**](CarrierAccountsApi.md#connectcarrier) | **POST** /v1/connections/carriers/{carrier_name} | Connect a carrier account | +| [**DisconnectCarrier**](CarrierAccountsApi.md#disconnectcarrier) | **DELETE** /v1/connections/carriers/{carrier_name}/{carrier_id} | Disconnect a carrier | +| [**GetCarrierSettings**](CarrierAccountsApi.md#getcarriersettings) | **GET** /v1/connections/carriers/{carrier_name}/{carrier_id}/settings | Get carrier settings | +| [**UpdateCarrierSettings**](CarrierAccountsApi.md#updatecarriersettings) | **PUT** /v1/connections/carriers/{carrier_name}/{carrier_id}/settings | Update carrier settings | + + +# **ConnectCarrier** +```csharp +ConnectCarrierResponseBody ConnectCarrier (CarrierName carrierNameConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default) + +ConnectCarrierResponseBody ConnectCarrier (HttpClient methodClient, CarrierName carrierNameConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default) +``` + +Connect a carrier account + +Connect a carrier account + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ConnectCarrierExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var carrierName = dhl_express; + var connectCarrierRequestBody = new ConnectCarrierRequestBody(); + + try + { + // Connect a carrier account + ConnectCarrierResponseBody result = await shipEngine.ConnectCarrier(carrierName, connectCarrierRequestBody); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling CarrierAccountsApi.ConnectCarrier: " + 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. | | +| **carrierName** | **CarrierName** | The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. | | +| **connectCarrierRequestBody** | [**ConnectCarrierRequestBody**](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 + +[**ConnectCarrierResponseBody**](../models/ConnectCarrierResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **DisconnectCarrier** +```csharp +string DisconnectCarrier (CarrierName carrierNamestring carrierId, CancellationToken cancellationToken = default) + +string DisconnectCarrier (HttpClient methodClient, CarrierName carrierNamestring carrierId, CancellationToken cancellationToken = default) +``` + +Disconnect a carrier + +Disconnect a carrier + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class DisconnectCarrierExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var carrierName = dhl_express; + var carrierId = se-28529731; + + try + { + // Disconnect a carrier + string result = await shipEngine.DisconnectCarrier(carrierName, carrierId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling CarrierAccountsApi.DisconnectCarrier: " + 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. | | +| **carrierName** | **CarrierName** | The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. | | +| **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. | | + +### Return type + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **GetCarrierSettings** +```csharp +GetCarrierSettingsResponseBody GetCarrierSettings (CarrierNameWithSettings carrierNamestring carrierId, CancellationToken cancellationToken = default) + +GetCarrierSettingsResponseBody GetCarrierSettings (HttpClient methodClient, CarrierNameWithSettings carrierNamestring carrierId, CancellationToken cancellationToken = default) +``` + +Get carrier settings + +Get carrier settings + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetCarrierSettingsExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var carrierName = dhl_express; + var carrierId = se-28529731; + + try + { + // Get carrier settings + GetCarrierSettingsResponseBody result = await shipEngine.GetCarrierSettings(carrierName, carrierId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling CarrierAccountsApi.GetCarrierSettings: " + 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. | | +| **carrierName** | **CarrierNameWithSettings** | The carrier name, such as `ups`, `fedex`, or `dhl_express`. | | +| **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. | | + +### Return type + +[**GetCarrierSettingsResponseBody**](../models/GetCarrierSettingsResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **UpdateCarrierSettings** +```csharp +string UpdateCarrierSettings (CarrierNameWithSettings carrierNameUpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBodystring carrierId, CancellationToken cancellationToken = default) + +string UpdateCarrierSettings (HttpClient methodClient, CarrierNameWithSettings carrierNameUpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBodystring carrierId, CancellationToken cancellationToken = default) +``` + +Update carrier settings + +Update carrier settings + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class UpdateCarrierSettingsExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var carrierName = dhl_express; + var updateCarrierSettingsRequestBody = new UpdateCarrierSettingsRequestBody(); + var carrierId = se-28529731; + + try + { + // Update carrier settings + string result = await shipEngine.UpdateCarrierSettings(carrierName, updateCarrierSettingsRequestBody, carrierId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling CarrierAccountsApi.UpdateCarrierSettings: " + 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. | | +| **carrierName** | **CarrierNameWithSettings** | The carrier name, such as `ups`, `fedex`, or `dhl_express`. | | +| **updateCarrierSettingsRequestBody** | [**UpdateCarrierSettingsRequestBody**](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. | | + +### Return type + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/CarriersApi.md b/docs/apis/CarriersApi.md new file mode 100644 index 00000000..15b49f1c --- /dev/null +++ b/docs/apis/CarriersApi.md @@ -0,0 +1,420 @@ + + +# Carriers Methods + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**AddFundsToCarrier**](CarriersApi.md#addfundstocarrier) | **PUT** /v1/carriers/{carrier_id}/add_funds | Add Funds To Carrier | +| [**DisconnectCarrierById**](CarriersApi.md#disconnectcarrierbyid) | **DELETE** /v1/carriers/{carrier_id} | Disconnect Carrier by ID | +| [**GetCarrierById**](CarriersApi.md#getcarrierbyid) | **GET** /v1/carriers/{carrier_id} | Get Carrier By ID | +| [**GetCarrierOptions**](CarriersApi.md#getcarrieroptions) | **GET** /v1/carriers/{carrier_id}/options | Get Carrier Options | +| [**ListCarrierPackageTypes**](CarriersApi.md#listcarrierpackagetypes) | **GET** /v1/carriers/{carrier_id}/packages | List Carrier Package Types | +| [**ListCarrierServices**](CarriersApi.md#listcarrierservices) | **GET** /v1/carriers/{carrier_id}/services | List Carrier Services | +| [**ListCarriers**](CarriersApi.md#listcarriers) | **GET** /v1/carriers | List Carriers | + + +# **AddFundsToCarrier** +```csharp +AddFundsToCarrierResponseBody AddFundsToCarrier (AddFundsToCarrierRequestBody addFundsToCarrierRequestBodystring carrierId, CancellationToken cancellationToken = default) + +AddFundsToCarrierResponseBody AddFundsToCarrier (HttpClient methodClient, AddFundsToCarrierRequestBody addFundsToCarrierRequestBodystring carrierId, CancellationToken cancellationToken = default) +``` + +Add Funds To Carrier + +Add Funds To A Carrier + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class AddFundsToCarrierExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var addFundsToCarrierRequestBody = new AddFundsToCarrierRequestBody(); + var carrierId = se-28529731; + + try + { + // Add Funds To Carrier + AddFundsToCarrierResponseBody result = await shipEngine.AddFundsToCarrier(addFundsToCarrierRequestBody, carrierId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling CarriersApi.AddFundsToCarrier: " + 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. | | +| **addFundsToCarrierRequestBody** | [**AddFundsToCarrierRequestBody**](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. | | + +### Return type + +[**AddFundsToCarrierResponseBody**](../models/AddFundsToCarrierResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **DisconnectCarrierById** +```csharp +string DisconnectCarrierById (string carrierId, CancellationToken cancellationToken = default) + +string DisconnectCarrierById (HttpClient methodClient, string carrierId, CancellationToken cancellationToken = default) +``` + +Disconnect Carrier by ID + +Disconnect a Carrier of the given ID from the account + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class DisconnectCarrierByIdExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var carrierId = se-28529731; + + try + { + // Disconnect Carrier by ID + string result = await shipEngine.DisconnectCarrierById(carrierId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling CarriersApi.DisconnectCarrierById: " + 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. | | +| **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. | | + +### Return type + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **GetCarrierById** +```csharp +GetCarrierByIdResponseBody GetCarrierById (string carrierId, CancellationToken cancellationToken = default) + +GetCarrierByIdResponseBody GetCarrierById (HttpClient methodClient, string carrierId, CancellationToken cancellationToken = default) +``` + +Get Carrier By ID + +Retrive carrier info by ID + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetCarrierByIdExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var carrierId = se-28529731; + + try + { + // Get Carrier By ID + GetCarrierByIdResponseBody result = await shipEngine.GetCarrierById(carrierId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling CarriersApi.GetCarrierById: " + 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. | | +| **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. | | + +### Return type + +[**GetCarrierByIdResponseBody**](../models/GetCarrierByIdResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **GetCarrierOptions** +```csharp +GetCarrierOptionsResponseBody GetCarrierOptions (string carrierId, CancellationToken cancellationToken = default) + +GetCarrierOptionsResponseBody GetCarrierOptions (HttpClient methodClient, string carrierId, CancellationToken cancellationToken = default) +``` + +Get Carrier Options + +Get a list of the options available for the carrier + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetCarrierOptionsExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var carrierId = se-28529731; + + try + { + // Get Carrier Options + GetCarrierOptionsResponseBody result = await shipEngine.GetCarrierOptions(carrierId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling CarriersApi.GetCarrierOptions: " + 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. | | +| **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. | | + +### Return type + +[**GetCarrierOptionsResponseBody**](../models/GetCarrierOptionsResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ListCarrierPackageTypes** +```csharp +ListCarrierPackageTypesResponseBody ListCarrierPackageTypes (string carrierId, CancellationToken cancellationToken = default) + +ListCarrierPackageTypesResponseBody ListCarrierPackageTypes (HttpClient methodClient, string carrierId, CancellationToken cancellationToken = default) +``` + +List Carrier Package Types + +List the package types associated with the carrier + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ListCarrierPackageTypesExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var carrierId = se-28529731; + + try + { + // List Carrier Package Types + ListCarrierPackageTypesResponseBody result = await shipEngine.ListCarrierPackageTypes(carrierId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling CarriersApi.ListCarrierPackageTypes: " + 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. | | +| **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. | | + +### Return type + +[**ListCarrierPackageTypesResponseBody**](../models/ListCarrierPackageTypesResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ListCarrierServices** +```csharp +ListCarrierServicesResponseBody ListCarrierServices (string carrierId, CancellationToken cancellationToken = default) + +ListCarrierServicesResponseBody ListCarrierServices (HttpClient methodClient, string carrierId, CancellationToken cancellationToken = default) +``` + +List Carrier Services + +List the services associated with the carrier ID + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ListCarrierServicesExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var carrierId = se-28529731; + + try + { + // List Carrier Services + ListCarrierServicesResponseBody result = await shipEngine.ListCarrierServices(carrierId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling CarriersApi.ListCarrierServices: " + 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. | | +| **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. | | + +### Return type + +[**ListCarrierServicesResponseBody**](../models/ListCarrierServicesResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ListCarriers** +```csharp +GetCarriersResponseBody ListCarriers (, CancellationToken cancellationToken = default) + +GetCarriersResponseBody ListCarriers (HttpClient methodClient, , CancellationToken cancellationToken = default) +``` + +List Carriers + +List all carriers that have been added to this account + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ListCarriersExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + + try + { + // List Carriers + GetCarriersResponseBody result = await shipEngine.ListCarriers(); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling CarriersApi.ListCarriers: " + 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. | | +| **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 + +[**GetCarriersResponseBody**](../models/GetCarriersResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/DownloadsApi.md b/docs/apis/DownloadsApi.md new file mode 100644 index 00000000..92fae193 --- /dev/null +++ b/docs/apis/DownloadsApi.md @@ -0,0 +1,74 @@ + + +# Downloads Methods + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**DownloadFile**](DownloadsApi.md#downloadfile) | **GET** /v1/downloads/{dir}/{subdir}/{filename} | Download File | + + +# **DownloadFile** +```csharp +System.IO.Stream DownloadFile (string subdirstring filenamestring dirint rotation = nullstring download = null, CancellationToken cancellationToken = default) + +System.IO.Stream DownloadFile (HttpClient methodClient, string subdirstring filenamestring dirint rotation = nullstring download = null, CancellationToken cancellationToken = default) +``` + +Download File + +Get File + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class DownloadFileExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var subdir = "subdir_example"; + var filename = "filename_example"; + var dir = "dir_example"; + var rotation = 56; + var download = "download_example"; + + try + { + // Download File + System.IO.Stream result = await shipEngine.DownloadFile(subdir, filename, dir, rotation, download); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling DownloadsApi.DownloadFile: " + 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. | | +| **subdir** | **string** | | | +| **filename** | **string** | | | +| **dir** | **string** | | | +| **rotation** | **int** | | [optional] | +| **download** | **string** | | [optional] | +| **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 + +**System.IO.Stream** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/InsuranceApi.md b/docs/apis/InsuranceApi.md new file mode 100644 index 00000000..40363665 --- /dev/null +++ b/docs/apis/InsuranceApi.md @@ -0,0 +1,239 @@ + + +# Insurance Methods + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**AddFundsToInsurance**](InsuranceApi.md#addfundstoinsurance) | **PATCH** /v1/insurance/shipsurance/add_funds | Add Funds To Insurance | +| [**ConnectInsurer**](InsuranceApi.md#connectinsurer) | **POST** /v1/connections/insurance/shipsurance | Connect a Shipsurance Account | +| [**DisconnectInsurer**](InsuranceApi.md#disconnectinsurer) | **DELETE** /v1/connections/insurance/shipsurance | Disconnect a Shipsurance Account | +| [**GetInsuranceBalance**](InsuranceApi.md#getinsurancebalance) | **GET** /v1/insurance/shipsurance/balance | Get Insurance Funds Balance | + + +# **AddFundsToInsurance** +```csharp +AddFundsToInsuranceResponseBody AddFundsToInsurance (AddFundsToInsuranceRequestBody addFundsToInsuranceRequestBody, CancellationToken cancellationToken = default) + +AddFundsToInsuranceResponseBody AddFundsToInsurance (HttpClient methodClient, AddFundsToInsuranceRequestBody addFundsToInsuranceRequestBody, CancellationToken cancellationToken = default) +``` + +Add Funds To Insurance + +You may need to auto fund your account from time to time. For example, if you don't normally ship items over $100, and may want to add funds to insurance rather than keeping the account funded. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class AddFundsToInsuranceExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var addFundsToInsuranceRequestBody = new AddFundsToInsuranceRequestBody(); + + try + { + // Add Funds To Insurance + AddFundsToInsuranceResponseBody result = await shipEngine.AddFundsToInsurance(addFundsToInsuranceRequestBody); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling InsuranceApi.AddFundsToInsurance: " + 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. | | +| **addFundsToInsuranceRequestBody** | [**AddFundsToInsuranceRequestBody**](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 + +[**AddFundsToInsuranceResponseBody**](../models/AddFundsToInsuranceResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ConnectInsurer** +```csharp +Object ConnectInsurer (ConnectInsurerRequestBody connectInsurerRequestBody, CancellationToken cancellationToken = default) + +Object ConnectInsurer (HttpClient methodClient, ConnectInsurerRequestBody connectInsurerRequestBody, CancellationToken cancellationToken = default) +``` + +Connect a Shipsurance Account + +Connect a Shipsurance Account + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ConnectInsurerExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var connectInsurerRequestBody = new ConnectInsurerRequestBody(); + + try + { + // Connect a Shipsurance Account + Object result = await shipEngine.ConnectInsurer(connectInsurerRequestBody); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling InsuranceApi.ConnectInsurer: " + 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. | | +| **connectInsurerRequestBody** | [**ConnectInsurerRequestBody**](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 + +**Object** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **DisconnectInsurer** +```csharp +Object DisconnectInsurer (, CancellationToken cancellationToken = default) + +Object DisconnectInsurer (HttpClient methodClient, , CancellationToken cancellationToken = default) +``` + +Disconnect a Shipsurance Account + +Disconnect a Shipsurance Account + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class DisconnectInsurerExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + + try + { + // Disconnect a Shipsurance Account + Object result = await shipEngine.DisconnectInsurer(); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling InsuranceApi.DisconnectInsurer: " + 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. | | +| **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 + +**Object** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **GetInsuranceBalance** +```csharp +GetInsuranceBalanceResponseBody GetInsuranceBalance (, CancellationToken cancellationToken = default) + +GetInsuranceBalanceResponseBody GetInsuranceBalance (HttpClient methodClient, , CancellationToken cancellationToken = default) +``` + +Get Insurance Funds Balance + +Retrieve the balance of your Shipsurance account. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetInsuranceBalanceExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + + try + { + // Get Insurance Funds Balance + GetInsuranceBalanceResponseBody result = await shipEngine.GetInsuranceBalance(); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling InsuranceApi.GetInsuranceBalance: " + 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. | | +| **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 + +[**GetInsuranceBalanceResponseBody**](../models/GetInsuranceBalanceResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/LabelsApi.md b/docs/apis/LabelsApi.md new file mode 100644 index 00000000..b3e36504 --- /dev/null +++ b/docs/apis/LabelsApi.md @@ -0,0 +1,574 @@ + + +# Labels Methods + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**CreateLabel**](LabelsApi.md#createlabel) | **POST** /v1/labels | Purchase Label | +| [**CreateLabelFromRate**](LabelsApi.md#createlabelfromrate) | **POST** /v1/labels/rates/{rate_id} | Purchase Label with Rate ID | +| [**CreateLabelFromShipment**](LabelsApi.md#createlabelfromshipment) | **POST** /v1/labels/shipment/{shipment_id} | Purchase Label with Shipment ID | +| [**CreateReturnLabel**](LabelsApi.md#createreturnlabel) | **POST** /v1/labels/{label_id}/return | Create a return label | +| [**GetLabelByExternalShipmentId**](LabelsApi.md#getlabelbyexternalshipmentid) | **GET** /v1/labels/external_shipment_id/{external_shipment_id} | Get Label By External Shipment ID | +| [**GetLabelById**](LabelsApi.md#getlabelbyid) | **GET** /v1/labels/{label_id} | Get Label By ID | +| [**GetTrackingLogFromLabel**](LabelsApi.md#gettrackinglogfromlabel) | **GET** /v1/labels/{label_id}/track | Get Label Tracking Information | +| [**ListLabels**](LabelsApi.md#listlabels) | **GET** /v1/labels | List labels | +| [**VoidLabel**](LabelsApi.md#voidlabel) | **PUT** /v1/labels/{label_id}/void | Void a Label By ID | + + +# **CreateLabel** +```csharp +CreateLabelResponseBody CreateLabel (CreateLabelRequestBody createLabelRequestBody, CancellationToken cancellationToken = default) + +CreateLabelResponseBody CreateLabel (HttpClient methodClient, CreateLabelRequestBody createLabelRequestBody, CancellationToken cancellationToken = default) +``` + +Purchase Label + +Purchase and print a label for shipment + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class CreateLabelExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var createLabelRequestBody = new CreateLabelRequestBody(); + + try + { + // Purchase Label + CreateLabelResponseBody result = await shipEngine.CreateLabel(createLabelRequestBody); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling LabelsApi.CreateLabel: " + 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. | | +| **createLabelRequestBody** | [**CreateLabelRequestBody**](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 + +[**CreateLabelResponseBody**](../models/CreateLabelResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **CreateLabelFromRate** +```csharp +CreateLabelFromRateResponseBody CreateLabelFromRate (CreateLabelFromRateRequestBody createLabelFromRateRequestBodystring rateId, CancellationToken cancellationToken = default) + +CreateLabelFromRateResponseBody CreateLabelFromRate (HttpClient methodClient, CreateLabelFromRateRequestBody createLabelFromRateRequestBodystring rateId, CancellationToken cancellationToken = default) +``` + +Purchase Label with Rate ID + +When retrieving rates for shipments using the `/rates` endpoint, the returned information contains a `rate_id` property that can be used to generate a label without having to refill in the shipment information repeatedly. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class CreateLabelFromRateExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var createLabelFromRateRequestBody = new CreateLabelFromRateRequestBody(); + var rateId = "rateId_example"; + + try + { + // Purchase Label with Rate ID + CreateLabelFromRateResponseBody result = await shipEngine.CreateLabelFromRate(createLabelFromRateRequestBody, rateId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling LabelsApi.CreateLabelFromRate: " + 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. | | +| **createLabelFromRateRequestBody** | [**CreateLabelFromRateRequestBody**](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. | | + +### Return type + +[**CreateLabelFromRateResponseBody**](../models/CreateLabelFromRateResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **CreateLabelFromShipment** +```csharp +CreateLabelFromShipmentResponseBody CreateLabelFromShipment (CreateLabelFromShipmentRequestBody createLabelFromShipmentRequestBodystring shipmentId, CancellationToken cancellationToken = default) + +CreateLabelFromShipmentResponseBody CreateLabelFromShipment (HttpClient methodClient, CreateLabelFromShipmentRequestBody createLabelFromShipmentRequestBodystring shipmentId, CancellationToken cancellationToken = default) +``` + +Purchase Label with Shipment ID + +Purchase a label using a shipment ID that has already been created with the desired address and package info. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class CreateLabelFromShipmentExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var createLabelFromShipmentRequestBody = new CreateLabelFromShipmentRequestBody(); + var shipmentId = "shipmentId_example"; + + try + { + // Purchase Label with Shipment ID + CreateLabelFromShipmentResponseBody result = await shipEngine.CreateLabelFromShipment(createLabelFromShipmentRequestBody, shipmentId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling LabelsApi.CreateLabelFromShipment: " + 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. | | +| **createLabelFromShipmentRequestBody** | [**CreateLabelFromShipmentRequestBody**](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. | | + +### Return type + +[**CreateLabelFromShipmentResponseBody**](../models/CreateLabelFromShipmentResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **CreateReturnLabel** +```csharp +CreateReturnLabelResponseBody CreateReturnLabel (CreateReturnLabelRequestBody createReturnLabelRequestBodystring labelId, CancellationToken cancellationToken = default) + +CreateReturnLabelResponseBody CreateReturnLabel (HttpClient methodClient, CreateReturnLabelRequestBody createReturnLabelRequestBodystring labelId, CancellationToken cancellationToken = default) +``` + +Create a return label + +Create a return label + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class CreateReturnLabelExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var createReturnLabelRequestBody = new CreateReturnLabelRequestBody(); + var labelId = "labelId_example"; + + try + { + // Create a return label + CreateReturnLabelResponseBody result = await shipEngine.CreateReturnLabel(createReturnLabelRequestBody, labelId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling LabelsApi.CreateReturnLabel: " + 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. | | +| **createReturnLabelRequestBody** | [**CreateReturnLabelRequestBody**](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. | | + +### Return type + +[**CreateReturnLabelResponseBody**](../models/CreateReturnLabelResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **GetLabelByExternalShipmentId** +```csharp +GetLabelByExternalShipmentIdResponseBody GetLabelByExternalShipmentId (string externalShipmentIdLabelDownloadType labelDownloadType = null, CancellationToken cancellationToken = default) + +GetLabelByExternalShipmentIdResponseBody GetLabelByExternalShipmentId (HttpClient methodClient, string externalShipmentIdLabelDownloadType labelDownloadType = null, CancellationToken cancellationToken = default) +``` + +Get Label By External Shipment ID + +Find a label by using the external shipment id that was used during label creation + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetLabelByExternalShipmentIdExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var externalShipmentId = 0bcb569d-1727-4ff9-ab49-b2fec0cee5ae; + var labelDownloadType = url; + + try + { + // Get Label By External Shipment ID + GetLabelByExternalShipmentIdResponseBody result = await shipEngine.GetLabelByExternalShipmentId(externalShipmentId, labelDownloadType); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling LabelsApi.GetLabelByExternalShipmentId: " + 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. | | +| **externalShipmentId** | **string** | | | +| **labelDownloadType** | **LabelDownloadType** | | [optional] | +| **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 + +[**GetLabelByExternalShipmentIdResponseBody**](../models/GetLabelByExternalShipmentIdResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **GetLabelById** +```csharp +GetLabelByIdResponseBody GetLabelById (string labelIdLabelDownloadType labelDownloadType = null, CancellationToken cancellationToken = default) + +GetLabelByIdResponseBody GetLabelById (HttpClient methodClient, string labelIdLabelDownloadType labelDownloadType = null, CancellationToken cancellationToken = default) +``` + +Get Label By ID + +Retrieve information for individual labels. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetLabelByIdExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var labelId = "labelId_example"; + var labelDownloadType = url; + + try + { + // Get Label By ID + GetLabelByIdResponseBody result = await shipEngine.GetLabelById(labelId, labelDownloadType); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling LabelsApi.GetLabelById: " + 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. | | +| **labelId** | **string** | Label ID | | +| **labelDownloadType** | **LabelDownloadType** | | [optional] | +| **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 + +[**GetLabelByIdResponseBody**](../models/GetLabelByIdResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **GetTrackingLogFromLabel** +```csharp +GetTrackingLogFromLabelResponseBody GetTrackingLogFromLabel (string labelId, CancellationToken cancellationToken = default) + +GetTrackingLogFromLabelResponseBody GetTrackingLogFromLabel (HttpClient methodClient, string labelId, CancellationToken cancellationToken = default) +``` + +Get Label Tracking Information + +Retrieve the label's tracking information + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetTrackingLogFromLabelExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var labelId = "labelId_example"; + + try + { + // Get Label Tracking Information + GetTrackingLogFromLabelResponseBody result = await shipEngine.GetTrackingLogFromLabel(labelId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling LabelsApi.GetTrackingLogFromLabel: " + 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. | | +| **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. | | + +### Return type + +[**GetTrackingLogFromLabelResponseBody**](../models/GetTrackingLogFromLabelResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ListLabels** +```csharp +ListLabelsResponseBody ListLabels (DateTimeOffset createdAtStart = nullDateTimeOffset createdAtEnd = nullLabelStatus labelStatus = nullSortDir sortDir = nullstring serviceCode = nullstring carrierId = nullstring trackingNumber = nullstring batchId = nullstring rateId = nullstring shipmentId = nullstring warehouseId = nullint page = nullint pageSize = nullstring sortBy = null, CancellationToken cancellationToken = default) + +ListLabelsResponseBody ListLabels (HttpClient methodClient, DateTimeOffset createdAtStart = nullDateTimeOffset createdAtEnd = nullLabelStatus labelStatus = nullSortDir sortDir = nullstring serviceCode = nullstring carrierId = nullstring trackingNumber = nullstring batchId = nullstring rateId = nullstring shipmentId = nullstring warehouseId = nullint page = nullint pageSize = nullstring sortBy = null, CancellationToken cancellationToken = default) +``` + +List labels + +This endpoint returns a list of labels that you've [created](https://www.shipengine.com/docs/labels/create-a-label/). You can optionally filter the results as well as control their sort order and the number of results returned at a time. By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want to get your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id` + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ListLabelsExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var createdAtStart = 2019-03-12T19:24:13.657Z; + var createdAtEnd = 2019-03-12T19:24:13.657Z; + var labelStatus = (LabelStatus) "processing"; + var sortDir = (SortDir) "asc"; + var serviceCode = usps_first_class_mail; + var carrierId = "carrierId_example"; + var trackingNumber = 9405511899223197428490; + var batchId = "batchId_example"; + var rateId = "rateId_example"; + var shipmentId = "shipmentId_example"; + var warehouseId = "warehouseId_example"; + var page = 2; + var pageSize = 50; + var sortBy = "modified_at"; + + try + { + // List labels + ListLabelsResponseBody result = await shipEngine.ListLabels(createdAtStart, createdAtEnd, labelStatus, sortDir, serviceCode, carrierId, trackingNumber, batchId, rateId, shipmentId, warehouseId, page, pageSize, sortBy); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling LabelsApi.ListLabels: " + 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. | | +| **createdAtStart** | **DateTimeOffset** | Only return labels that were created on or after a specific date/time | [optional] | +| **createdAtEnd** | **DateTimeOffset** | Only return labels that were created on or before a specific date/time | [optional] | +| **labelStatus** | **LabelStatus** | Only return labels that are currently in the specified status | [optional] | +| **sortDir** | **SortDir** | Controls the sort order of the query. | [optional] | +| **serviceCode** | **string** | Only return labels for a specific [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) | [optional] | +| **carrierId** | **string** | Only return labels for a specific [carrier account](https://www.shipengine.com/docs/carriers/setup/) | [optional] | +| **trackingNumber** | **string** | Only return labels with a specific tracking number | [optional] | +| **batchId** | **string** | Only return labels that were created in a specific [batch](https://www.shipengine.com/docs/labels/bulk/) | [optional] | +| **rateId** | **string** | Rate ID | [optional] | +| **shipmentId** | **string** | Shipment ID | [optional] | +| **warehouseId** | **string** | Only return labels that originate from a specific [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) | [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] | +| **pageSize** | **int** | The number of results to return per response. | [optional] [default to 25] | +| **sortBy** | **string** | Controls which field the query is sorted by. | [optional] [default to created_at] | +| **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 + +[**ListLabelsResponseBody**](../models/ListLabelsResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **VoidLabel** +```csharp +VoidLabelResponseBody VoidLabel (string labelId, CancellationToken cancellationToken = default) + +VoidLabelResponseBody VoidLabel (HttpClient methodClient, string labelId, CancellationToken cancellationToken = default) +``` + +Void a Label By ID + +Void a label by ID to get a refund. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class VoidLabelExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var labelId = "labelId_example"; + + try + { + // Void a Label By ID + VoidLabelResponseBody result = await shipEngine.VoidLabel(labelId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling LabelsApi.VoidLabel: " + 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. | | +| **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. | | + +### Return type + +[**VoidLabelResponseBody**](../models/VoidLabelResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/ManifestsApi.md b/docs/apis/ManifestsApi.md new file mode 100644 index 00000000..68d0a1cf --- /dev/null +++ b/docs/apis/ManifestsApi.md @@ -0,0 +1,259 @@ + + +# Manifests Methods + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**CreateManifest**](ManifestsApi.md#createmanifest) | **POST** /v1/manifests | Create Manifest | +| [**GetManifestById**](ManifestsApi.md#getmanifestbyid) | **GET** /v1/manifests/{manifest_id} | Get Manifest By Id | +| [**GetManifestRequestById**](ManifestsApi.md#getmanifestrequestbyid) | **GET** /v1/manifests/requests/{manifest_request_id} | Get Manifest Request By Id | +| [**ListManifests**](ManifestsApi.md#listmanifests) | **GET** /v1/manifests | List Manifests | + + +# **CreateManifest** +```csharp +CreateManifestResponseBody CreateManifest (CreateManifestRequestBody createManifestRequestBody, CancellationToken cancellationToken = default) + +CreateManifestResponseBody CreateManifest (HttpClient methodClient, CreateManifestRequestBody createManifestRequestBody, CancellationToken cancellationToken = default) +``` + +Create Manifest + +Each ShipEngine manifest is created for a specific warehouse, so you'll need to provide the warehouse_id rather than the ship_from address. You can create a warehouse for each location that you want to create manifests for. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class CreateManifestExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var createManifestRequestBody = new CreateManifestRequestBody(); + + try + { + // Create Manifest + CreateManifestResponseBody result = await shipEngine.CreateManifest(createManifestRequestBody); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling ManifestsApi.CreateManifest: " + 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. | | +| **createManifestRequestBody** | [**CreateManifestRequestBody**](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 + +[**CreateManifestResponseBody**](../models/CreateManifestResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **GetManifestById** +```csharp +GetManifestByIdResponseBody GetManifestById (string manifestId, CancellationToken cancellationToken = default) + +GetManifestByIdResponseBody GetManifestById (HttpClient methodClient, string manifestId, CancellationToken cancellationToken = default) +``` + +Get Manifest By Id + +Get Manifest By Id + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetManifestByIdExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var manifestId = "manifestId_example"; + + try + { + // Get Manifest By Id + GetManifestByIdResponseBody result = await shipEngine.GetManifestById(manifestId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling ManifestsApi.GetManifestById: " + 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. | | +| **manifestId** | **string** | The Manifest 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. | | + +### Return type + +[**GetManifestByIdResponseBody**](../models/GetManifestByIdResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **GetManifestRequestById** +```csharp +CreateManifestResponseBody GetManifestRequestById (string manifestRequestId, CancellationToken cancellationToken = default) + +CreateManifestResponseBody GetManifestRequestById (HttpClient methodClient, string manifestRequestId, CancellationToken cancellationToken = default) +``` + +Get Manifest Request By Id + +Get Manifest Request By Id + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetManifestRequestByIdExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var manifestRequestId = "manifestRequestId_example"; + + try + { + // Get Manifest Request By Id + CreateManifestResponseBody result = await shipEngine.GetManifestRequestById(manifestRequestId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling ManifestsApi.GetManifestRequestById: " + 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. | | +| **manifestRequestId** | **string** | The Manifest Request 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. | | + +### Return type + +[**CreateManifestResponseBody**](../models/CreateManifestResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ListManifests** +```csharp +ListManifestsResponseBody ListManifests (DateTimeOffset shipDateStart = nullDateTimeOffset shipDateEnd = nullDateTimeOffset createdAtStart = nullDateTimeOffset createdAtEnd = nullList labelIds = nullstring warehouseId = nullstring carrierId = nullint page = nullint pageSize = null, CancellationToken cancellationToken = default) + +ListManifestsResponseBody ListManifests (HttpClient methodClient, DateTimeOffset shipDateStart = nullDateTimeOffset shipDateEnd = nullDateTimeOffset createdAtStart = nullDateTimeOffset createdAtEnd = nullList labelIds = nullstring warehouseId = nullstring carrierId = nullint page = nullint pageSize = null, CancellationToken cancellationToken = default) +``` + +List Manifests + +Similar to querying shipments, we allow you to query manifests since there will likely be a large number over a long period of time. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ListManifestsExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var shipDateStart = 2018-09-23T15:00:00.000Z; + var shipDateEnd = 2018-09-23T15:00:00.000Z; + var createdAtStart = 2019-03-12T19:24:13.657Z; + var createdAtEnd = 2019-03-12T19:24:13.657Z; + var labelIds = new List(); + var warehouseId = "warehouseId_example"; + var carrierId = "carrierId_example"; + var page = 2; + var pageSize = 50; + + try + { + // List Manifests + ListManifestsResponseBody result = await shipEngine.ListManifests(shipDateStart, shipDateEnd, createdAtStart, createdAtEnd, labelIds, warehouseId, carrierId, page, pageSize); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling ManifestsApi.ListManifests: " + 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. | | +| **shipDateStart** | **DateTimeOffset** | ship date start range | [optional] | +| **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>**](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] | +| **pageSize** | **int** | The number of results to return per response. | [optional] [default to 25] | +| **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 + +[**ListManifestsResponseBody**](../models/ListManifestsResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/PackagePickupsApi.md b/docs/apis/PackagePickupsApi.md new file mode 100644 index 00000000..97e7553c --- /dev/null +++ b/docs/apis/PackagePickupsApi.md @@ -0,0 +1,253 @@ + + +# PackagePickups Methods + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**DeleteScheduledPickup**](PackagePickupsApi.md#deletescheduledpickup) | **DELETE** /v1/pickups/{pickup_id} | Delete a Scheduled Pickup | +| [**GetPickupById**](PackagePickupsApi.md#getpickupbyid) | **GET** /v1/pickups/{pickup_id} | Get Pickup By ID | +| [**ListScheduledPickups**](PackagePickupsApi.md#listscheduledpickups) | **GET** /v1/pickups | List Scheduled Pickups | +| [**SchedulePickup**](PackagePickupsApi.md#schedulepickup) | **POST** /v1/pickups | Schedule a Pickup | + + +# **DeleteScheduledPickup** +```csharp +DeletePickupByIdResponseBody DeleteScheduledPickup (string pickupId, CancellationToken cancellationToken = default) + +DeletePickupByIdResponseBody DeleteScheduledPickup (HttpClient methodClient, string pickupId, CancellationToken cancellationToken = default) +``` + +Delete a Scheduled Pickup + +Delete a previously-scheduled pickup by ID + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class DeleteScheduledPickupExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var pickupId = "pickupId_example"; + + try + { + // Delete a Scheduled Pickup + DeletePickupByIdResponseBody result = await shipEngine.DeleteScheduledPickup(pickupId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling PackagePickupsApi.DeleteScheduledPickup: " + 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. | | +| **pickupId** | **string** | | | +| **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 + +[**DeletePickupByIdResponseBody**](../models/DeletePickupByIdResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **GetPickupById** +```csharp +GetPickupByIdResponseBody GetPickupById (string pickupId, CancellationToken cancellationToken = default) + +GetPickupByIdResponseBody GetPickupById (HttpClient methodClient, string pickupId, CancellationToken cancellationToken = default) +``` + +Get Pickup By ID + +Get Pickup By ID + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetPickupByIdExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var pickupId = "pickupId_example"; + + try + { + // Get Pickup By ID + GetPickupByIdResponseBody result = await shipEngine.GetPickupById(pickupId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling PackagePickupsApi.GetPickupById: " + 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. | | +| **pickupId** | **string** | | | +| **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 + +[**GetPickupByIdResponseBody**](../models/GetPickupByIdResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ListScheduledPickups** +```csharp +GetPickupsResponseBody ListScheduledPickups (DateTimeOffset createdAtStart = nullDateTimeOffset createdAtEnd = nullstring carrierId = nullstring warehouseId = nullint page = nullint pageSize = null, CancellationToken cancellationToken = default) + +GetPickupsResponseBody ListScheduledPickups (HttpClient methodClient, DateTimeOffset createdAtStart = nullDateTimeOffset createdAtEnd = nullstring carrierId = nullstring warehouseId = nullint page = nullint pageSize = null, CancellationToken cancellationToken = default) +``` + +List Scheduled Pickups + +List all pickups that have been scheduled for this carrier + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ListScheduledPickupsExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var createdAtStart = 2019-03-12T19:24:13.657Z; + var createdAtEnd = 2019-03-12T19:24:13.657Z; + var carrierId = "carrierId_example"; + var warehouseId = "warehouseId_example"; + var page = 2; + var pageSize = 50; + + try + { + // List Scheduled Pickups + GetPickupsResponseBody result = await shipEngine.ListScheduledPickups(createdAtStart, createdAtEnd, carrierId, warehouseId, page, pageSize); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling PackagePickupsApi.ListScheduledPickups: " + 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. | | +| **createdAtStart** | **DateTimeOffset** | Only return scheduled pickups that were created on or after a specific date/time | [optional] | +| **createdAtEnd** | **DateTimeOffset** | Only return scheduled pickups that were created on or before a specific date/time | [optional] | +| **carrierId** | **string** | Carrier ID | [optional] | +| **warehouseId** | **string** | Warehouse 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] | +| **pageSize** | **int** | The number of results to return per response. | [optional] [default to 25] | +| **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 + +[**GetPickupsResponseBody**](../models/GetPickupsResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **SchedulePickup** +```csharp +SchedulePickupResponseBody SchedulePickup (SchedulePickupRequestBody schedulePickupRequestBody, CancellationToken cancellationToken = default) + +SchedulePickupResponseBody SchedulePickup (HttpClient methodClient, SchedulePickupRequestBody schedulePickupRequestBody, CancellationToken cancellationToken = default) +``` + +Schedule a Pickup + +Schedule a package pickup with a carrier + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class SchedulePickupExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var schedulePickupRequestBody = new SchedulePickupRequestBody(); + + try + { + // Schedule a Pickup + SchedulePickupResponseBody result = await shipEngine.SchedulePickup(schedulePickupRequestBody); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling PackagePickupsApi.SchedulePickup: " + 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. | | +| **schedulePickupRequestBody** | [**SchedulePickupRequestBody**](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 + +[**SchedulePickupResponseBody**](../models/SchedulePickupResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/PackageTypesApi.md b/docs/apis/PackageTypesApi.md new file mode 100644 index 00000000..1bced23a --- /dev/null +++ b/docs/apis/PackageTypesApi.md @@ -0,0 +1,302 @@ + + +# PackageTypes Methods + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**CreatePackageType**](PackageTypesApi.md#createpackagetype) | **POST** /v1/packages | Create Custom Package Type | +| [**DeletePackageType**](PackageTypesApi.md#deletepackagetype) | **DELETE** /v1/packages/{package_id} | Delete A Custom Package By ID | +| [**GetPackageTypeById**](PackageTypesApi.md#getpackagetypebyid) | **GET** /v1/packages/{package_id} | Get Custom Package Type By ID | +| [**ListPackageTypes**](PackageTypesApi.md#listpackagetypes) | **GET** /v1/packages | List Custom Package Types | +| [**UpdatePackageType**](PackageTypesApi.md#updatepackagetype) | **PUT** /v1/packages/{package_id} | Update Custom Package Type By ID | + + +# **CreatePackageType** +```csharp +CreatePackageTypeResponseBody CreatePackageType (CreatePackageTypeRequestBody createPackageTypeRequestBody, CancellationToken cancellationToken = default) + +CreatePackageTypeResponseBody CreatePackageType (HttpClient methodClient, CreatePackageTypeRequestBody createPackageTypeRequestBody, CancellationToken cancellationToken = default) +``` + +Create Custom Package Type + +Create a custom package type to better assist in getting accurate rate estimates + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class CreatePackageTypeExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var createPackageTypeRequestBody = new CreatePackageTypeRequestBody(); + + try + { + // Create Custom Package Type + CreatePackageTypeResponseBody result = await shipEngine.CreatePackageType(createPackageTypeRequestBody); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling PackageTypesApi.CreatePackageType: " + 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. | | +| **createPackageTypeRequestBody** | [**CreatePackageTypeRequestBody**](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 + +[**CreatePackageTypeResponseBody**](../models/CreatePackageTypeResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **DeletePackageType** +```csharp +string DeletePackageType (string packageId, CancellationToken cancellationToken = default) + +string DeletePackageType (HttpClient methodClient, string packageId, CancellationToken cancellationToken = default) +``` + +Delete A Custom Package By ID + +Delete a custom package using the ID + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class DeletePackageTypeExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var packageId = "packageId_example"; + + try + { + // Delete A Custom Package By ID + string result = await shipEngine.DeletePackageType(packageId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling PackageTypesApi.DeletePackageType: " + 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. | | +| **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. | | + +### Return type + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **GetPackageTypeById** +```csharp +GetPackageTypeByIdResponseBody GetPackageTypeById (string packageId, CancellationToken cancellationToken = default) + +GetPackageTypeByIdResponseBody GetPackageTypeById (HttpClient methodClient, string packageId, CancellationToken cancellationToken = default) +``` + +Get Custom Package Type By ID + +Get Custom Package Type by ID + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetPackageTypeByIdExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var packageId = "packageId_example"; + + try + { + // Get Custom Package Type By ID + GetPackageTypeByIdResponseBody result = await shipEngine.GetPackageTypeById(packageId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling PackageTypesApi.GetPackageTypeById: " + 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. | | +| **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. | | + +### Return type + +[**GetPackageTypeByIdResponseBody**](../models/GetPackageTypeByIdResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ListPackageTypes** +```csharp +ListPackageTypesResponseBody ListPackageTypes (, CancellationToken cancellationToken = default) + +ListPackageTypesResponseBody ListPackageTypes (HttpClient methodClient, , CancellationToken cancellationToken = default) +``` + +List Custom Package Types + +List the custom package types associated with the account + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ListPackageTypesExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + + try + { + // List Custom Package Types + ListPackageTypesResponseBody result = await shipEngine.ListPackageTypes(); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling PackageTypesApi.ListPackageTypes: " + 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. | | +| **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 + +[**ListPackageTypesResponseBody**](../models/ListPackageTypesResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **UpdatePackageType** +```csharp +string UpdatePackageType (UpdatePackageTypeRequestBody updatePackageTypeRequestBodystring packageId, CancellationToken cancellationToken = default) + +string UpdatePackageType (HttpClient methodClient, UpdatePackageTypeRequestBody updatePackageTypeRequestBodystring packageId, CancellationToken cancellationToken = default) +``` + +Update Custom Package Type By ID + +Update the custom package type object by ID + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class UpdatePackageTypeExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var updatePackageTypeRequestBody = new UpdatePackageTypeRequestBody(); + var packageId = "packageId_example"; + + try + { + // Update Custom Package Type By ID + string result = await shipEngine.UpdatePackageType(updatePackageTypeRequestBody, packageId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling PackageTypesApi.UpdatePackageType: " + 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. | | +| **updatePackageTypeRequestBody** | [**UpdatePackageTypeRequestBody**](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. | | + +### Return type + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/RatesApi.md b/docs/apis/RatesApi.md new file mode 100644 index 00000000..502ad6eb --- /dev/null +++ b/docs/apis/RatesApi.md @@ -0,0 +1,243 @@ + + +# Rates Methods + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**CalculateRates**](RatesApi.md#calculaterates) | **POST** /v1/rates | Get Shipping Rates | +| [**CompareBulkRates**](RatesApi.md#comparebulkrates) | **POST** /v1/rates/bulk | Get Bulk Rates | +| [**EstimateRates**](RatesApi.md#estimaterates) | **POST** /v1/rates/estimate | Estimate Rates | +| [**GetRateById**](RatesApi.md#getratebyid) | **GET** /v1/rates/{rate_id} | Get Rate By ID | + + +# **CalculateRates** +```csharp +CalculateRatesResponseBody CalculateRates (CalculateRatesRequestBody calculateRatesRequestBody, CancellationToken cancellationToken = default) + +CalculateRatesResponseBody CalculateRates (HttpClient methodClient, CalculateRatesRequestBody calculateRatesRequestBody, CancellationToken cancellationToken = default) +``` + +Get Shipping Rates + +It's not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don't solely ship things using a single shipping option; so we provide functionality to show you all your options! + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class CalculateRatesExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var calculateRatesRequestBody = new CalculateRatesRequestBody(); + + try + { + // Get Shipping Rates + CalculateRatesResponseBody result = await shipEngine.CalculateRates(calculateRatesRequestBody); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling RatesApi.CalculateRates: " + 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. | | +| **calculateRatesRequestBody** | [**CalculateRatesRequestBody**](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 + +[**CalculateRatesResponseBody**](../models/CalculateRatesResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **CompareBulkRates** +```csharp +List<BulkRate> CompareBulkRates (CompareBulkRatesRequestBody compareBulkRatesRequestBody, CancellationToken cancellationToken = default) + +List<BulkRate> CompareBulkRates (HttpClient methodClient, CompareBulkRatesRequestBody compareBulkRatesRequestBody, CancellationToken cancellationToken = default) +``` + +Get Bulk Rates + +Get Bulk Shipment Rates + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class CompareBulkRatesExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var compareBulkRatesRequestBody = new CompareBulkRatesRequestBody(); + + try + { + // Get Bulk Rates + List result = await shipEngine.CompareBulkRates(compareBulkRatesRequestBody); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling RatesApi.CompareBulkRates: " + 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. | | +| **compareBulkRatesRequestBody** | [**CompareBulkRatesRequestBody**](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 + +[**List<BulkRate>**](../models/BulkRate.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **EstimateRates** +```csharp +List<RateEstimate> EstimateRates (EstimateRatesRequestBody estimateRatesRequestBody, CancellationToken cancellationToken = default) + +List<RateEstimate> EstimateRates (HttpClient methodClient, EstimateRatesRequestBody estimateRatesRequestBody, CancellationToken cancellationToken = default) +``` + +Estimate Rates + +Get Rate Estimates + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class EstimateRatesExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var estimateRatesRequestBody = new EstimateRatesRequestBody(); + + try + { + // Estimate Rates + List result = await shipEngine.EstimateRates(estimateRatesRequestBody); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling RatesApi.EstimateRates: " + 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. | | +| **estimateRatesRequestBody** | [**EstimateRatesRequestBody**](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 + +[**List<RateEstimate>**](../models/RateEstimate.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **GetRateById** +```csharp +GetRateByIdResponseBody GetRateById (string rateId, CancellationToken cancellationToken = default) + +GetRateByIdResponseBody GetRateById (HttpClient methodClient, string rateId, CancellationToken cancellationToken = default) +``` + +Get Rate By ID + +Retrieve a previously queried rate by its ID + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetRateByIdExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var rateId = "rateId_example"; + + try + { + // Get Rate By ID + GetRateByIdResponseBody result = await shipEngine.GetRateById(rateId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling RatesApi.GetRateById: " + 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. | | +| **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. | | + +### Return type + +[**GetRateByIdResponseBody**](../models/GetRateByIdResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/ServicePointsApi.md b/docs/apis/ServicePointsApi.md new file mode 100644 index 00000000..1d459dc8 --- /dev/null +++ b/docs/apis/ServicePointsApi.md @@ -0,0 +1,129 @@ + + +# ServicePoints Methods + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**ServicePointsGetById**](ServicePointsApi.md#servicepointsgetbyid) | **GET** /v1/service_points/{carrier_code}/{country_code}/{service_point_id} | Get Service Point By ID | +| [**ServicePointsList**](ServicePointsApi.md#servicepointslist) | **POST** /v1/service_points/list | List Service Points | + + +# **ServicePointsGetById** +```csharp +GetServicePointByIdResponseBody ServicePointsGetById (string carrierCodestring countryCodestring servicePointId, CancellationToken cancellationToken = default) + +GetServicePointByIdResponseBody ServicePointsGetById (HttpClient methodClient, string carrierCodestring countryCodestring servicePointId, CancellationToken cancellationToken = default) +``` + +Get Service Point By ID + +Returns a carrier service point by using the service_point_id + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ServicePointsGetByIdExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var carrierCode = stamps_com; + var countryCode = CA; + var servicePointId = 614940; + + try + { + // Get Service Point By ID + GetServicePointByIdResponseBody result = await shipEngine.ServicePointsGetById(carrierCode, countryCode, servicePointId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling ServicePointsApi.ServicePointsGetById: " + 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. | | +| **carrierCode** | **string** | Carrier code | | +| **countryCode** | **string** | A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) | | +| **servicePointId** | **string** | | | +| **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 + +[**GetServicePointByIdResponseBody**](../models/GetServicePointByIdResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ServicePointsList** +```csharp +ListServicePointsResponseBody ServicePointsList (GetServicePointsRequest getServicePointsRequest, CancellationToken cancellationToken = default) + +ListServicePointsResponseBody ServicePointsList (HttpClient methodClient, GetServicePointsRequest getServicePointsRequest, CancellationToken cancellationToken = default) +``` + +List Service Points + +List carrier service points by location + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ServicePointsListExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var getServicePointsRequest = new GetServicePointsRequest(); + + try + { + // List Service Points + ListServicePointsResponseBody result = await shipEngine.ServicePointsList(getServicePointsRequest); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling ServicePointsApi.ServicePointsList: " + 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. | | +| **getServicePointsRequest** | [**GetServicePointsRequest**](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 + +[**ListServicePointsResponseBody**](../models/ListServicePointsResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/ShipmentsApi.md b/docs/apis/ShipmentsApi.md new file mode 100644 index 00000000..b3ae8362 --- /dev/null +++ b/docs/apis/ShipmentsApi.md @@ -0,0 +1,744 @@ + + +# Shipments Methods + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**CancelShipments**](ShipmentsApi.md#cancelshipments) | **PUT** /v1/shipments/{shipment_id}/cancel | Cancel a Shipment | +| [**CreateShipments**](ShipmentsApi.md#createshipments) | **POST** /v1/shipments | Create Shipments | +| [**GetShipmentByExternalId**](ShipmentsApi.md#getshipmentbyexternalid) | **GET** /v1/shipments/external_shipment_id/{external_shipment_id} | Get Shipment By External ID | +| [**GetShipmentById**](ShipmentsApi.md#getshipmentbyid) | **GET** /v1/shipments/{shipment_id} | Get Shipment By ID | +| [**ListShipmentRates**](ShipmentsApi.md#listshipmentrates) | **GET** /v1/shipments/{shipment_id}/rates | Get Shipment Rates | +| [**ListShipments**](ShipmentsApi.md#listshipments) | **GET** /v1/shipments | List Shipments | +| [**ParseShipment**](ShipmentsApi.md#parseshipment) | **PUT** /v1/shipments/recognize | Parse shipping info | +| [**ShipmentsListTags**](ShipmentsApi.md#shipmentslisttags) | **GET** /v1/shipments/{shipment_id}/tags | Get Shipment Tags | +| [**ShipmentsUpdateTags**](ShipmentsApi.md#shipmentsupdatetags) | **PUT** /v1/shipments/tags | Update Shipments Tags | +| [**TagShipment**](ShipmentsApi.md#tagshipment) | **POST** /v1/shipments/{shipment_id}/tags/{tag_name} | Add Tag to Shipment | +| [**UntagShipment**](ShipmentsApi.md#untagshipment) | **DELETE** /v1/shipments/{shipment_id}/tags/{tag_name} | Remove Tag from Shipment | +| [**UpdateShipment**](ShipmentsApi.md#updateshipment) | **PUT** /v1/shipments/{shipment_id} | Update Shipment By ID | + + +# **CancelShipments** +```csharp +string CancelShipments (string shipmentId, CancellationToken cancellationToken = default) + +string CancelShipments (HttpClient methodClient, string shipmentId, CancellationToken cancellationToken = default) +``` + +Cancel a Shipment + +Mark a shipment cancelled, if it is no longer needed or being used by your organized. Any label associated with the shipment needs to be voided first An example use case would be if a batch label creation job is going to run at a set time and only queries `pending` shipments. Marking a shipment as cancelled would remove it from this process + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class CancelShipmentsExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var shipmentId = "shipmentId_example"; + + try + { + // Cancel a Shipment + string result = await shipEngine.CancelShipments(shipmentId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling ShipmentsApi.CancelShipments: " + 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. | | +| **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. | | + +### Return type + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **CreateShipments** +```csharp +CreateShipmentsResponseBody CreateShipments (CreateShipmentsRequestBody createShipmentsRequestBody, CancellationToken cancellationToken = default) + +CreateShipmentsResponseBody CreateShipments (HttpClient methodClient, CreateShipmentsRequestBody createShipmentsRequestBody, CancellationToken cancellationToken = default) +``` + +Create Shipments + +Create one or multiple shipments. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class CreateShipmentsExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var createShipmentsRequestBody = new CreateShipmentsRequestBody(); + + try + { + // Create Shipments + CreateShipmentsResponseBody result = await shipEngine.CreateShipments(createShipmentsRequestBody); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling ShipmentsApi.CreateShipments: " + 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. | | +| **createShipmentsRequestBody** | [**CreateShipmentsRequestBody**](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 + +[**CreateShipmentsResponseBody**](../models/CreateShipmentsResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **GetShipmentByExternalId** +```csharp +GetShipmentByExternalIdResponseBody GetShipmentByExternalId (string externalShipmentId, CancellationToken cancellationToken = default) + +GetShipmentByExternalIdResponseBody GetShipmentByExternalId (HttpClient methodClient, string externalShipmentId, CancellationToken cancellationToken = default) +``` + +Get Shipment By External ID + +Query Shipments created using your own custom ID convention using this endpint + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetShipmentByExternalIdExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var externalShipmentId = 0bcb569d-1727-4ff9-ab49-b2fec0cee5ae; + + try + { + // Get Shipment By External ID + GetShipmentByExternalIdResponseBody result = await shipEngine.GetShipmentByExternalId(externalShipmentId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling ShipmentsApi.GetShipmentByExternalId: " + 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. | | +| **externalShipmentId** | **string** | | | +| **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 + +[**GetShipmentByExternalIdResponseBody**](../models/GetShipmentByExternalIdResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **GetShipmentById** +```csharp +GetShipmentByIdResponseBody GetShipmentById (string shipmentId, CancellationToken cancellationToken = default) + +GetShipmentByIdResponseBody GetShipmentById (HttpClient methodClient, string shipmentId, CancellationToken cancellationToken = default) +``` + +Get Shipment By ID + +Get an individual shipment based on its ID + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetShipmentByIdExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var shipmentId = "shipmentId_example"; + + try + { + // Get Shipment By ID + GetShipmentByIdResponseBody result = await shipEngine.GetShipmentById(shipmentId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling ShipmentsApi.GetShipmentById: " + 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. | | +| **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. | | + +### Return type + +[**GetShipmentByIdResponseBody**](../models/GetShipmentByIdResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ListShipmentRates** +```csharp +ListShipmentRatesResponseBody ListShipmentRates (string shipmentIdDateTimeOffset createdAtStart = null, CancellationToken cancellationToken = default) + +ListShipmentRatesResponseBody ListShipmentRates (HttpClient methodClient, string shipmentIdDateTimeOffset createdAtStart = null, CancellationToken cancellationToken = default) +``` + +Get Shipment Rates + +Get Rates for the shipment information associated with the shipment ID + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ListShipmentRatesExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var shipmentId = "shipmentId_example"; + var createdAtStart = 2019-03-12T19:24:13.657Z; + + try + { + // Get Shipment Rates + ListShipmentRatesResponseBody result = await shipEngine.ListShipmentRates(shipmentId, createdAtStart); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling ShipmentsApi.ListShipmentRates: " + 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. | | +| **shipmentId** | **string** | Shipment ID | | +| **createdAtStart** | **DateTimeOffset** | Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) | [optional] | +| **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 + +[**ListShipmentRatesResponseBody**](../models/ListShipmentRatesResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ListShipments** +```csharp +ListShipmentsResponseBody ListShipments (DateTimeOffset createdAtStart = nullDateTimeOffset createdAtEnd = nullDateTimeOffset modifiedAtStart = nullDateTimeOffset modifiedAtEnd = nullShipmentStatus shipmentStatus = nullShipmentsSortBy sortBy = nullSortDir sortDir = nullstring batchId = nullstring tag = nullstring salesOrderId = nullint page = nullint pageSize = null, CancellationToken cancellationToken = default) + +ListShipmentsResponseBody ListShipments (HttpClient methodClient, DateTimeOffset createdAtStart = nullDateTimeOffset createdAtEnd = nullDateTimeOffset modifiedAtStart = nullDateTimeOffset modifiedAtEnd = nullShipmentStatus shipmentStatus = nullShipmentsSortBy sortBy = nullSortDir sortDir = nullstring batchId = nullstring tag = nullstring salesOrderId = nullint page = nullint pageSize = null, CancellationToken cancellationToken = default) +``` + +List Shipments + +Get list of Shipments + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ListShipmentsExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var createdAtStart = 2019-03-12T19:24:13.657Z; + var createdAtEnd = 2019-03-12T19:24:13.657Z; + var modifiedAtStart = 2019-03-12T19:24:13.657Z; + var modifiedAtEnd = 2019-03-12T19:24:13.657Z; + var shipmentStatus = (ShipmentStatus) "pending"; + var sortBy = modified_at; + var sortDir = (SortDir) "asc"; + var batchId = "batchId_example"; + var tag = Letters_to_santa; + var salesOrderId = "salesOrderId_example"; + var page = 2; + var pageSize = 50; + + try + { + // List Shipments + ListShipmentsResponseBody result = await shipEngine.ListShipments(createdAtStart, createdAtEnd, modifiedAtStart, modifiedAtEnd, shipmentStatus, sortBy, sortDir, batchId, tag, salesOrderId, page, pageSize); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling ShipmentsApi.ListShipments: " + 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. | | +| **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] | +| **modifiedAtStart** | **DateTimeOffset** | Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time) | [optional] | +| **modifiedAtEnd** | **DateTimeOffset** | Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time) | [optional] | +| **shipmentStatus** | **ShipmentStatus** | | [optional] | +| **sortBy** | **ShipmentsSortBy** | | [optional] | +| **sortDir** | **SortDir** | Controls the sort order of the query. | [optional] | +| **batchId** | **string** | Batch ID | [optional] | +| **tag** | **string** | Search for shipments based on the custom tag added to the shipment object | [optional] | +| **salesOrderId** | **string** | Sales Order 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] | +| **pageSize** | **int** | The number of results to return per response. | [optional] [default to 25] | +| **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 + +[**ListShipmentsResponseBody**](../models/ListShipmentsResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ParseShipment** +```csharp +ParseShipmentResponseBody ParseShipment (ParseShipmentRequestBody parseShipmentRequestBody, CancellationToken cancellationToken = default) + +ParseShipmentResponseBody ParseShipment (HttpClient methodClient, ParseShipmentRequestBody parseShipmentRequestBody, CancellationToken cancellationToken = default) +``` + +Parse shipping info + +The shipment-recognition API makes it easy for you to extract shipping data from unstructured text, including people's names, addresses, package weights and dimensions, insurance and delivery requirements, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's shipment-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed shipment data is returned in the same structure that's used for other ShipEngine APIs, so you can easily use the parsed data to create a shipping label. > **Note:** Shipment recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ParseShipmentExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var parseShipmentRequestBody = new ParseShipmentRequestBody(); + + try + { + // Parse shipping info + ParseShipmentResponseBody result = await shipEngine.ParseShipment(parseShipmentRequestBody); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling ShipmentsApi.ParseShipment: " + 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. | | +| **parseShipmentRequestBody** | [**ParseShipmentRequestBody**](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 + +[**ParseShipmentResponseBody**](../models/ParseShipmentResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ShipmentsListTags** +```csharp +TagShipmentResponseBody ShipmentsListTags (string shipmentId, CancellationToken cancellationToken = default) + +TagShipmentResponseBody ShipmentsListTags (HttpClient methodClient, string shipmentId, CancellationToken cancellationToken = default) +``` + +Get Shipment Tags + +Get Shipment tags based on its ID + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ShipmentsListTagsExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var shipmentId = "shipmentId_example"; + + try + { + // Get Shipment Tags + TagShipmentResponseBody result = await shipEngine.ShipmentsListTags(shipmentId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling ShipmentsApi.ShipmentsListTags: " + 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. | | +| **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. | | + +### Return type + +[**TagShipmentResponseBody**](../models/TagShipmentResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ShipmentsUpdateTags** +```csharp +void ShipmentsUpdateTags (UpdateShipmentsTagsRequestBody updateShipmentsTagsRequestBody, CancellationToken cancellationToken = default) + +void ShipmentsUpdateTags (HttpClient methodClient, UpdateShipmentsTagsRequestBody updateShipmentsTagsRequestBody, CancellationToken cancellationToken = default) +``` + +Update Shipments Tags + +Update Shipments Tags + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ShipmentsUpdateTagsExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var updateShipmentsTagsRequestBody = new UpdateShipmentsTagsRequestBody(); + + try + { + // Update Shipments Tags + shipEngine.ShipmentsUpdateTags(updateShipmentsTagsRequestBody); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling ShipmentsApi.ShipmentsUpdateTags: " + 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. | | +| **updateShipmentsTagsRequestBody** | [**UpdateShipmentsTagsRequestBody**](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 + +void (empty response body) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **TagShipment** +```csharp +TagShipmentResponseBody TagShipment (string shipmentIdstring tagName, CancellationToken cancellationToken = default) + +TagShipmentResponseBody TagShipment (HttpClient methodClient, string shipmentIdstring tagName, CancellationToken cancellationToken = default) +``` + +Add Tag to Shipment + +Add a tag to the shipment object + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class TagShipmentExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var shipmentId = "shipmentId_example"; + var tagName = "tagName_example"; + + try + { + // Add Tag to Shipment + TagShipmentResponseBody result = await shipEngine.TagShipment(shipmentId, tagName); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling ShipmentsApi.TagShipment: " + 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. | | +| **shipmentId** | **string** | Shipment ID | | +| **tagName** | **string** | | | +| **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 + +[**TagShipmentResponseBody**](../models/TagShipmentResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **UntagShipment** +```csharp +string UntagShipment (string shipmentIdstring tagName, CancellationToken cancellationToken = default) + +string UntagShipment (HttpClient methodClient, string shipmentIdstring tagName, CancellationToken cancellationToken = default) +``` + +Remove Tag from Shipment + +Remove an existing tag from the Shipment object + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class UntagShipmentExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var shipmentId = "shipmentId_example"; + var tagName = "tagName_example"; + + try + { + // Remove Tag from Shipment + string result = await shipEngine.UntagShipment(shipmentId, tagName); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling ShipmentsApi.UntagShipment: " + 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. | | +| **shipmentId** | **string** | Shipment ID | | +| **tagName** | **string** | | | +| **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 + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **UpdateShipment** +```csharp +UpdateShipmentResponseBody UpdateShipment (UpdateShipmentRequestBody updateShipmentRequestBodystring shipmentId, CancellationToken cancellationToken = default) + +UpdateShipmentResponseBody UpdateShipment (HttpClient methodClient, UpdateShipmentRequestBody updateShipmentRequestBodystring shipmentId, CancellationToken cancellationToken = default) +``` + +Update Shipment By ID + +Update a shipment object based on its ID + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class UpdateShipmentExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var updateShipmentRequestBody = new UpdateShipmentRequestBody(); + var shipmentId = "shipmentId_example"; + + try + { + // Update Shipment By ID + UpdateShipmentResponseBody result = await shipEngine.UpdateShipment(updateShipmentRequestBody, shipmentId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling ShipmentsApi.UpdateShipment: " + 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. | | +| **updateShipmentRequestBody** | [**UpdateShipmentRequestBody**](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. | | + +### Return type + +[**UpdateShipmentResponseBody**](../models/UpdateShipmentResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/TagsApi.md b/docs/apis/TagsApi.md new file mode 100644 index 00000000..c1538616 --- /dev/null +++ b/docs/apis/TagsApi.md @@ -0,0 +1,243 @@ + + +# Tags Methods + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**CreateTag**](TagsApi.md#createtag) | **POST** /v1/tags/{tag_name} | Create a New Tag | +| [**DeleteTag**](TagsApi.md#deletetag) | **DELETE** /v1/tags/{tag_name} | Delete Tag | +| [**ListTags**](TagsApi.md#listtags) | **GET** /v1/tags | Get Tags | +| [**RenameTag**](TagsApi.md#renametag) | **PUT** /v1/tags/{tag_name}/{new_tag_name} | Update Tag Name | + + +# **CreateTag** +```csharp +CreateTagResponseBody CreateTag (string tagName, CancellationToken cancellationToken = default) + +CreateTagResponseBody CreateTag (HttpClient methodClient, string tagName, CancellationToken cancellationToken = default) +``` + +Create a New Tag + +Create a new Tag for customizing how you track your shipments + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class CreateTagExample + { + 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(tagName); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling TagsApi.CreateTag: " + 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. | | +| **tagName** | **string** | | | +| **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) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **DeleteTag** +```csharp +string DeleteTag (string tagName, CancellationToken cancellationToken = default) + +string DeleteTag (HttpClient methodClient, string tagName, CancellationToken cancellationToken = default) +``` + +Delete Tag + +Delete a tag that is no longer needed + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class DeleteTagExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var tagName = "tagName_example"; + + try + { + // Delete Tag + string result = await shipEngine.DeleteTag(tagName); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling TagsApi.DeleteTag: " + 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. | | +| **tagName** | **string** | | | +| **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 + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ListTags** +```csharp +ListTagsResponseBody ListTags (, CancellationToken cancellationToken = default) + +ListTagsResponseBody ListTags (HttpClient methodClient, , CancellationToken cancellationToken = default) +``` + +Get Tags + +Get a list of all tags associated with an account. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ListTagsExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + + try + { + // Get Tags + ListTagsResponseBody result = await shipEngine.ListTags(); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling TagsApi.ListTags: " + 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. | | +| **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 + +[**ListTagsResponseBody**](../models/ListTagsResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **RenameTag** +```csharp +string RenameTag (string tagNamestring newTagName, CancellationToken cancellationToken = default) + +string RenameTag (HttpClient methodClient, string tagNamestring newTagName, CancellationToken cancellationToken = default) +``` + +Update Tag Name + +Change a tag name while still keeping the relevant shipments attached to it + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class RenameTagExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var tagName = "tagName_example"; + var newTagName = "newTagName_example"; + + try + { + // Update Tag Name + string result = await shipEngine.RenameTag(tagName, newTagName); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling TagsApi.RenameTag: " + 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. | | +| **tagName** | **string** | | | +| **newTagName** | **string** | | | +| **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 + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/TokensApi.md b/docs/apis/TokensApi.md new file mode 100644 index 00000000..1c8d5c48 --- /dev/null +++ b/docs/apis/TokensApi.md @@ -0,0 +1,66 @@ + + +# Tokens Methods + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**TokensGetEphemeralToken**](TokensApi.md#tokensgetephemeraltoken) | **POST** /v1/tokens/ephemeral | Get Ephemeral Token | + + +# **TokensGetEphemeralToken** +```csharp +TokensGetEphemeralTokenResponseBodyYaml TokensGetEphemeralToken (Redirect redirect = null, CancellationToken cancellationToken = default) + +TokensGetEphemeralTokenResponseBodyYaml TokensGetEphemeralToken (HttpClient methodClient, Redirect redirect = null, CancellationToken cancellationToken = default) +``` + +Get Ephemeral Token + +This endpoint returns a token that can be passed to an application for authorized access. The lifetime of this token is 10 seconds. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class TokensGetEphemeralTokenExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var redirect = (Redirect) "shipengine-dashboard"; + + try + { + // Get Ephemeral Token + TokensGetEphemeralTokenResponseBodyYaml result = await shipEngine.TokensGetEphemeralToken(redirect); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling TokensApi.TokensGetEphemeralToken: " + 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. | | +| **redirect** | **Redirect** | Include a redirect url to the application formatted with the ephemeral token. | [optional] | +| **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 + +[**TokensGetEphemeralTokenResponseBodyYaml**](../models/TokensGetEphemeralTokenResponseBodyYaml.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/TrackingApi.md b/docs/apis/TrackingApi.md new file mode 100644 index 00000000..b47a4a8f --- /dev/null +++ b/docs/apis/TrackingApi.md @@ -0,0 +1,190 @@ + + +# Tracking Methods + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**GetTrackingLog**](TrackingApi.md#gettrackinglog) | **GET** /v1/tracking | Get Tracking Information | +| [**StartTracking**](TrackingApi.md#starttracking) | **POST** /v1/tracking/start | Start Tracking a Package | +| [**StopTracking**](TrackingApi.md#stoptracking) | **POST** /v1/tracking/stop | Stop Tracking a Package | + + +# **GetTrackingLog** +```csharp +GetTrackingLogResponseBody GetTrackingLog (string carrierCode = nullstring trackingNumber = null, CancellationToken cancellationToken = default) + +GetTrackingLogResponseBody GetTrackingLog (HttpClient methodClient, string carrierCode = nullstring trackingNumber = null, CancellationToken cancellationToken = default) +``` + +Get Tracking Information + +Retrieve package tracking information + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetTrackingLogExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var carrierCode = stamps_com; + var trackingNumber = 9405511899223197428490; + + try + { + // Get Tracking Information + GetTrackingLogResponseBody result = await shipEngine.GetTrackingLog(carrierCode, trackingNumber); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling TrackingApi.GetTrackingLog: " + 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. | | +| **carrierCode** | **string** | A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. | [optional] | +| **trackingNumber** | **string** | The tracking number associated with a shipment | [optional] | +| **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 + +[**GetTrackingLogResponseBody**](../models/GetTrackingLogResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **StartTracking** +```csharp +string StartTracking (string carrierCode = nullstring trackingNumber = null, CancellationToken cancellationToken = default) + +string StartTracking (HttpClient methodClient, string carrierCode = nullstring trackingNumber = null, CancellationToken cancellationToken = default) +``` + +Start Tracking a Package + +Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package, and receive notifications via webhooks whenever the shipping status changes. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class StartTrackingExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var carrierCode = stamps_com; + var trackingNumber = 9405511899223197428490; + + try + { + // Start Tracking a Package + string result = await shipEngine.StartTracking(carrierCode, trackingNumber); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling TrackingApi.StartTracking: " + 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. | | +| **carrierCode** | **string** | A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. | [optional] | +| **trackingNumber** | **string** | The tracking number associated with a shipment | [optional] | +| **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 + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **StopTracking** +```csharp +string StopTracking (string carrierCode = nullstring trackingNumber = null, CancellationToken cancellationToken = default) + +string StopTracking (HttpClient methodClient, string carrierCode = nullstring trackingNumber = null, CancellationToken cancellationToken = default) +``` + +Stop Tracking a Package + +Unsubscribe from tracking updates for a package. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class StopTrackingExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var carrierCode = stamps_com; + var trackingNumber = 9405511899223197428490; + + try + { + // Stop Tracking a Package + string result = await shipEngine.StopTracking(carrierCode, trackingNumber); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling TrackingApi.StopTracking: " + 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. | | +| **carrierCode** | **string** | A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. | [optional] | +| **trackingNumber** | **string** | The tracking number associated with a shipment | [optional] | +| **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 + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/WarehousesApi.md b/docs/apis/WarehousesApi.md new file mode 100644 index 00000000..ae32fc95 --- /dev/null +++ b/docs/apis/WarehousesApi.md @@ -0,0 +1,363 @@ + + +# Warehouses Methods + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**CreateWarehouse**](WarehousesApi.md#createwarehouse) | **POST** /v1/warehouses | Create Warehouse | +| [**DeleteWarehouse**](WarehousesApi.md#deletewarehouse) | **DELETE** /v1/warehouses/{warehouse_id} | Delete Warehouse By ID | +| [**GetWarehouseById**](WarehousesApi.md#getwarehousebyid) | **GET** /v1/warehouses/{warehouse_id} | Get Warehouse By Id | +| [**ListWarehouses**](WarehousesApi.md#listwarehouses) | **GET** /v1/warehouses | List Warehouses | +| [**UpdateWarehouse**](WarehousesApi.md#updatewarehouse) | **PUT** /v1/warehouses/{warehouse_id} | Update Warehouse By Id | +| [**UpdateWarehouseSettings**](WarehousesApi.md#updatewarehousesettings) | **PUT** /v1/warehouses/{warehouse_id}/settings | Update Warehouse Settings | + + +# **CreateWarehouse** +```csharp +CreateWarehouseResponseBody CreateWarehouse (CreateWarehouseRequestBody createWarehouseRequestBody, CancellationToken cancellationToken = default) + +CreateWarehouseResponseBody CreateWarehouse (HttpClient methodClient, CreateWarehouseRequestBody createWarehouseRequestBody, CancellationToken cancellationToken = default) +``` + +Create Warehouse + +Create a warehouse location that you can use to create shipping items by simply passing in the generated warehouse id. If the return address is not supplied in the request body then it is assumed that the origin address is the return address as well + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class CreateWarehouseExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var createWarehouseRequestBody = new CreateWarehouseRequestBody(); + + try + { + // Create Warehouse + CreateWarehouseResponseBody result = await shipEngine.CreateWarehouse(createWarehouseRequestBody); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling WarehousesApi.CreateWarehouse: " + 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. | | +| **createWarehouseRequestBody** | [**CreateWarehouseRequestBody**](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 + +[**CreateWarehouseResponseBody**](../models/CreateWarehouseResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **DeleteWarehouse** +```csharp +string DeleteWarehouse (string warehouseId, CancellationToken cancellationToken = default) + +string DeleteWarehouse (HttpClient methodClient, string warehouseId, CancellationToken cancellationToken = default) +``` + +Delete Warehouse By ID + +Delete a warehouse by ID + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class DeleteWarehouseExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var warehouseId = "warehouseId_example"; + + try + { + // Delete Warehouse By ID + string result = await shipEngine.DeleteWarehouse(warehouseId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling WarehousesApi.DeleteWarehouse: " + 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. | | +| **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. | | + +### Return type + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **GetWarehouseById** +```csharp +GetWarehouseByIdResponseBody GetWarehouseById (string warehouseId, CancellationToken cancellationToken = default) + +GetWarehouseByIdResponseBody GetWarehouseById (HttpClient methodClient, string warehouseId, CancellationToken cancellationToken = default) +``` + +Get Warehouse By Id + +Retrieve warehouse data based on the warehouse ID + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetWarehouseByIdExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var warehouseId = "warehouseId_example"; + + try + { + // Get Warehouse By Id + GetWarehouseByIdResponseBody result = await shipEngine.GetWarehouseById(warehouseId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling WarehousesApi.GetWarehouseById: " + 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. | | +| **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. | | + +### Return type + +[**GetWarehouseByIdResponseBody**](../models/GetWarehouseByIdResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ListWarehouses** +```csharp +ListWarehousesResponseBody ListWarehouses (, CancellationToken cancellationToken = default) + +ListWarehousesResponseBody ListWarehouses (HttpClient methodClient, , CancellationToken cancellationToken = default) +``` + +List Warehouses + +Retrieve a list of warehouses associated with this account. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ListWarehousesExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + + try + { + // List Warehouses + ListWarehousesResponseBody result = await shipEngine.ListWarehouses(); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling WarehousesApi.ListWarehouses: " + 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. | | +| **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 + +[**ListWarehousesResponseBody**](../models/ListWarehousesResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **UpdateWarehouse** +```csharp +string UpdateWarehouse (UpdateWarehouseRequestBody updateWarehouseRequestBodystring warehouseId, CancellationToken cancellationToken = default) + +string UpdateWarehouse (HttpClient methodClient, UpdateWarehouseRequestBody updateWarehouseRequestBodystring warehouseId, CancellationToken cancellationToken = default) +``` + +Update Warehouse By Id + +Update Warehouse object information + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class UpdateWarehouseExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var updateWarehouseRequestBody = new UpdateWarehouseRequestBody(); + var warehouseId = "warehouseId_example"; + + try + { + // Update Warehouse By Id + string result = await shipEngine.UpdateWarehouse(updateWarehouseRequestBody, warehouseId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling WarehousesApi.UpdateWarehouse: " + 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. | | +| **updateWarehouseRequestBody** | [**UpdateWarehouseRequestBody**](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. | | + +### Return type + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **UpdateWarehouseSettings** +```csharp +string UpdateWarehouseSettings (UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBodystring warehouseId, CancellationToken cancellationToken = default) + +string UpdateWarehouseSettings (HttpClient methodClient, UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBodystring warehouseId, CancellationToken cancellationToken = default) +``` + +Update Warehouse Settings + +Update Warehouse settings object information + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class UpdateWarehouseSettingsExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var updateWarehouseSettingsRequestBody = new UpdateWarehouseSettingsRequestBody(); + var warehouseId = "warehouseId_example"; + + try + { + // Update Warehouse Settings + string result = await shipEngine.UpdateWarehouseSettings(updateWarehouseSettingsRequestBody, warehouseId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling WarehousesApi.UpdateWarehouseSettings: " + 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. | | +| **updateWarehouseSettingsRequestBody** | [**UpdateWarehouseSettingsRequestBody**](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. | | + +### Return type + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/WebhooksApi.md b/docs/apis/WebhooksApi.md new file mode 100644 index 00000000..55e539fc --- /dev/null +++ b/docs/apis/WebhooksApi.md @@ -0,0 +1,302 @@ + + +# Webhooks Methods + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**CreateWebhook**](WebhooksApi.md#createwebhook) | **POST** /v1/environment/webhooks | Create a Webhook | +| [**DeleteWebhook**](WebhooksApi.md#deletewebhook) | **DELETE** /v1/environment/webhooks/{webhook_id} | Delete Webhook By ID | +| [**GetWebhookById**](WebhooksApi.md#getwebhookbyid) | **GET** /v1/environment/webhooks/{webhook_id} | Get Webhook By ID | +| [**ListWebhooks**](WebhooksApi.md#listwebhooks) | **GET** /v1/environment/webhooks | List Webhooks | +| [**UpdateWebhook**](WebhooksApi.md#updatewebhook) | **PUT** /v1/environment/webhooks/{webhook_id} | Update a Webhook | + + +# **CreateWebhook** +```csharp +CreateWebhookResponseBody CreateWebhook (CreateWebhookRequestBody createWebhookRequestBody, CancellationToken cancellationToken = default) + +CreateWebhookResponseBody CreateWebhook (HttpClient methodClient, CreateWebhookRequestBody createWebhookRequestBody, CancellationToken cancellationToken = default) +``` + +Create a Webhook + +Create a webook for specific events in the environment. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class CreateWebhookExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var createWebhookRequestBody = new CreateWebhookRequestBody(); + + try + { + // Create a Webhook + CreateWebhookResponseBody result = await shipEngine.CreateWebhook(createWebhookRequestBody); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling WebhooksApi.CreateWebhook: " + 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. | | +| **createWebhookRequestBody** | [**CreateWebhookRequestBody**](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 + +[**CreateWebhookResponseBody**](../models/CreateWebhookResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **DeleteWebhook** +```csharp +string DeleteWebhook (string webhookId, CancellationToken cancellationToken = default) + +string DeleteWebhook (HttpClient methodClient, string webhookId, CancellationToken cancellationToken = default) +``` + +Delete Webhook By ID + +Delete a webhook + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class DeleteWebhookExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var webhookId = "webhookId_example"; + + try + { + // Delete Webhook By ID + string result = await shipEngine.DeleteWebhook(webhookId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling WebhooksApi.DeleteWebhook: " + 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. | | +| **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. | | + +### Return type + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **GetWebhookById** +```csharp +GetWebhookByIdResponseBody GetWebhookById (string webhookId, CancellationToken cancellationToken = default) + +GetWebhookByIdResponseBody GetWebhookById (HttpClient methodClient, string webhookId, CancellationToken cancellationToken = default) +``` + +Get Webhook By ID + +Retrieve individual webhook by an ID + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class GetWebhookByIdExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var webhookId = "webhookId_example"; + + try + { + // Get Webhook By ID + GetWebhookByIdResponseBody result = await shipEngine.GetWebhookById(webhookId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling WebhooksApi.GetWebhookById: " + 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. | | +| **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. | | + +### Return type + +[**GetWebhookByIdResponseBody**](../models/GetWebhookByIdResponseBody.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **ListWebhooks** +```csharp +List<Webhook> ListWebhooks (, CancellationToken cancellationToken = default) + +List<Webhook> ListWebhooks (HttpClient methodClient, , CancellationToken cancellationToken = default) +``` + +List Webhooks + +List all webhooks currently enabled for the account. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class ListWebhooksExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + + try + { + // List Webhooks + List result = await shipEngine.ListWebhooks(); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling WebhooksApi.ListWebhooks: " + 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. | | +| **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 + +[**List<Webhook>**](../models/Webhook.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + + +# **UpdateWebhook** +```csharp +string UpdateWebhook (UpdateWebhookRequestBody updateWebhookRequestBodystring webhookId, CancellationToken cancellationToken = default) + +string UpdateWebhook (HttpClient methodClient, UpdateWebhookRequestBody updateWebhookRequestBodystring webhookId, CancellationToken cancellationToken = default) +``` + +Update a Webhook + +Update the webhook url property + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using ShipEngineSDK; +using ShipEngineSDK.Model; + +namespace Example +{ + public class UpdateWebhookExample + { + public static async Task Main() + { + var shipEngine = new ShipEngine("api_key"); + var updateWebhookRequestBody = new UpdateWebhookRequestBody(); + var webhookId = "webhookId_example"; + + try + { + // Update a Webhook + string result = await shipEngine.UpdateWebhook(updateWebhookRequestBody, webhookId); + Debug.WriteLine(result); + } + catch (ShipEngineException e) + { + Debug.Print("Exception when calling WebhooksApi.UpdateWebhook: " + 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. | | +| **updateWebhookRequestBody** | [**UpdateWebhookRequestBody**](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. | | + +### Return type + +**string** + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/CreateLabelFromRate.md b/docs/legacy/CreateLabelFromRate.md similarity index 100% rename from docs/CreateLabelFromRate.md rename to docs/legacy/CreateLabelFromRate.md diff --git a/docs/CreateLabelFromShipmentDetails.md b/docs/legacy/CreateLabelFromShipmentDetails.md similarity index 100% rename from docs/CreateLabelFromShipmentDetails.md rename to docs/legacy/CreateLabelFromShipmentDetails.md diff --git a/docs/CreateManifest.md b/docs/legacy/CreateManifest.md similarity index 100% rename from docs/CreateManifest.md rename to docs/legacy/CreateManifest.md diff --git a/docs/GetRatesWithShipmentDetails.md b/docs/legacy/GetRatesWithShipmentDetails.md similarity index 100% rename from docs/GetRatesWithShipmentDetails.md rename to docs/legacy/GetRatesWithShipmentDetails.md diff --git a/docs/ListCarriers.md b/docs/legacy/ListCarriers.md similarity index 100% rename from docs/ListCarriers.md rename to docs/legacy/ListCarriers.md diff --git a/docs/TrackUsingCarrierCodeAndTrackingNumber.md b/docs/legacy/TrackUsingCarrierCodeAndTrackingNumber.md similarity index 100% rename from docs/TrackUsingCarrierCodeAndTrackingNumber.md rename to docs/legacy/TrackUsingCarrierCodeAndTrackingNumber.md diff --git a/docs/TrackUsingLabelID.md b/docs/legacy/TrackUsingLabelID.md similarity index 100% rename from docs/TrackUsingLabelID.md rename to docs/legacy/TrackUsingLabelID.md diff --git a/docs/ValidateAddresses.md b/docs/legacy/ValidateAddresses.md similarity index 100% rename from docs/ValidateAddresses.md rename to docs/legacy/ValidateAddresses.md diff --git a/docs/VoidLabelWithLabelId.md b/docs/legacy/VoidLabelWithLabelId.md similarity index 100% rename from docs/VoidLabelWithLabelId.md rename to docs/legacy/VoidLabelWithLabelId.md diff --git a/docs/models/AccountSettings.md b/docs/models/AccountSettings.md new file mode 100644 index 00000000..382b8eca --- /dev/null +++ b/docs/models/AccountSettings.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.AccountSettings +A ShipEngine account settings response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DefaultLabelLayout** | **DefaultLabelLayout** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AccountSettingsImages.md b/docs/models/AccountSettingsImages.md new file mode 100644 index 00000000..6e82ddc6 --- /dev/null +++ b/docs/models/AccountSettingsImages.md @@ -0,0 +1,17 @@ +# ShipEngineSDK.Model.AccountSettingsImages +A ShipEngine account images body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedAt** | **DateTimeOffset** | The date and time that the image was created in ShipEngine. | [optional] [readonly] +**ImageContentType** | **string** | The image type | [optional] +**ImageData** | **string** | A base64 encoded string representation of the image. | [optional] +**IsDefault** | **bool** | Indicates whether this image is set as default. | [optional] +**LabelImageId** | **string** | A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. | [optional] [readonly] +**ModifiedAt** | **DateTimeOffset** | The date and time that the image was modified in ShipEngine. | [optional] [readonly] +**Name** | **string** | A human readable name for the image. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AddFundsToCarrierRequestBody.md b/docs/models/AddFundsToCarrierRequestBody.md new file mode 100644 index 00000000..a315e996 --- /dev/null +++ b/docs/models/AddFundsToCarrierRequestBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.AddFundsToCarrierRequestBody +An add funds to carrier request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Amount** | **decimal** | The monetary amount, in the specified currency. | +**Currency** | **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 | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AddFundsToCarrierResponseBody.md b/docs/models/AddFundsToCarrierResponseBody.md new file mode 100644 index 00000000..9704966c --- /dev/null +++ b/docs/models/AddFundsToCarrierResponseBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.AddFundsToCarrierResponseBody +The current balance of the requested carrier account + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Balance** | [**MonetaryValue**](MonetaryValue.md) | The current balance of the account | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AddFundsToInsuranceRequestBody.md b/docs/models/AddFundsToInsuranceRequestBody.md new file mode 100644 index 00000000..6b36aa87 --- /dev/null +++ b/docs/models/AddFundsToInsuranceRequestBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.AddFundsToInsuranceRequestBody +An add funds to insurance request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Amount** | **decimal** | The monetary amount, in the specified currency. | +**Currency** | **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 | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AddFundsToInsuranceResponseBody.md b/docs/models/AddFundsToInsuranceResponseBody.md new file mode 100644 index 00000000..9f25a289 --- /dev/null +++ b/docs/models/AddFundsToInsuranceResponseBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.AddFundsToInsuranceResponseBody +Add funds to insurance response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Amount** | **decimal** | The monetary amount, in the specified currency. | +**Currency** | **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 | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AddToBatchRequestBody.md b/docs/models/AddToBatchRequestBody.md new file mode 100644 index 00000000..5403429e --- /dev/null +++ b/docs/models/AddToBatchRequestBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.AddToBatchRequestBody +An add to batch request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RateIds** | **List<string>** | Array of Rate IDs to be modifed on the batch | [optional] +**ShipmentIds** | **List<string>** | The Shipment Ids to be modified on the batch | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Address.md b/docs/models/Address.md new file mode 100644 index 00000000..9c7149ee --- /dev/null +++ b/docs/models/Address.md @@ -0,0 +1,22 @@ +# ShipEngineSDK.Model.Address +Any residential or business mailing address, anywhere in the world. > **Note:** Either `name` or `company_name` must be set. Both may be specified, if relevant. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddressLine1** | **string** | The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. | +**CityLocality** | **string** | The name of the city or locality | +**Name** | **string** | The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. | +**PostalCode** | **string** | postal code | +**StateProvince** | **string** | The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. | +**AddressLine2** | **string** | The second line of the street address. For some addresses, this line may not be needed. | [optional] +**AddressLine3** | **string** | The third line of the street address. For some addresses, this line may not be needed. | [optional] +**AddressResidentialIndicator** | **AddressResidentialIndicator** | Indicates whether this is a residential address. | [optional] +**CompanyName** | **string** | If this is a business address, then the company name should be specified here. | [optional] +**CountryCode** | **string** | The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) | [optional] +**Email** | **string** | Email for the address owner. | [optional] +**Phone** | **string** | The phone number of a contact person at this address. The format of this phone number varies depending on the country. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AddressResidentialIndicator.md b/docs/models/AddressResidentialIndicator.md new file mode 100644 index 00000000..b2ca5c5f --- /dev/null +++ b/docs/models/AddressResidentialIndicator.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.AddressResidentialIndicator +Indicates whether an address is residential. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AddressToValidate.md b/docs/models/AddressToValidate.md new file mode 100644 index 00000000..14045b22 --- /dev/null +++ b/docs/models/AddressToValidate.md @@ -0,0 +1,22 @@ +# ShipEngineSDK.Model.AddressToValidate +Any residential or business mailing address, anywhere in the world. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddressLine1** | **string** | The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. | +**CityLocality** | **string** | The name of the city or locality | +**CountryCode** | **string** | The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) | +**StateProvince** | **string** | The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. | +**AddressLine2** | **string** | The second line of the street address. For some addresses, this line may not be needed. | [optional] +**AddressLine3** | **string** | The third line of the street address. For some addresses, this line may not be needed. | [optional] +**AddressResidentialIndicator** | **AddressResidentialIndicator** | Indicates whether this is a residential address. | [optional] +**CompanyName** | **string** | If this is a business address, then the company name should be specified here. | [optional] +**Email** | **string** | Email for the address owner. | [optional] +**Name** | **string** | The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. | [optional] +**Phone** | **string** | The phone number of a contact person at this address. The format of this phone number varies depending on the country. | [optional] +**PostalCode** | **string** | postal code | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AddressValidatingShipment.md b/docs/models/AddressValidatingShipment.md new file mode 100644 index 00000000..44f8efbc --- /dev/null +++ b/docs/models/AddressValidatingShipment.md @@ -0,0 +1,38 @@ +# ShipEngineSDK.Model.AddressValidatingShipment +An address validating shipment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierId** | **string** | The carrier account that is billed for the shipping charges | +**ServiceCode** | **string** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | +**ShipFrom** | [**ShippingAddress**](ShippingAddress.md) | The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. | +**ShipTo** | [**ShippingAddressTo**](ShippingAddressTo.md) | The recipient's mailing address | +**ShipmentId** | **string** | A string that uniquely identifies the shipment | [readonly] +**AdvancedOptions** | [**AdvancedShipmentOptions**](AdvancedShipmentOptions.md) | Advanced shipment options. These are entirely optional. | [optional] +**ComparisonRateType** | **string** | Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. | [optional] +**Confirmation** | **DeliveryConfirmation** | The type of delivery confirmation that is required for this shipment. | [optional] +**CreatedAt** | **DateTimeOffset** | The date and time that the shipment was created in ShipEngine. | [optional] [readonly] +**Customs** | [**InternationalShipmentOptions**](InternationalShipmentOptions.md) | Customs information. This is usually only needed for international shipments. | [optional] +**ExternalOrderId** | **string** | ID that the Order Source assigned | [optional] +**ExternalShipmentId** | **string** | A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**InsuranceProvider** | **InsuranceProvider** | The insurance provider to use for any insured packages in the shipment. | [optional] +**IsReturn** | **bool** | An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. | [optional] [default to false] +**Items** | [**List<ShipmentItem>**](ShipmentItem.md) | Describe the packages included in this shipment as related to potential metadata that was imported from external order sources | [optional] +**ModifiedAt** | **DateTimeOffset** | The date and time that the shipment was created or last modified. | [optional] [readonly] +**OrderSourceCode** | **OrderSourceName** | | [optional] +**Packages** | [**List<Package>**](Package.md) | The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. | [optional] +**ReturnTo** | [**ShippingAddress**](ShippingAddress.md) | The return address for this shipment. Defaults to the `ship_from` address. | [optional] +**ShipDate** | **DateTimeOffset** | The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | [optional] +**ShipmentNumber** | **string** | A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**ShipmentStatus** | **ShipmentStatus** | The current status of the shipment | [optional] [readonly] +**ShippingRuleId** | **string** | ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment | [optional] +**Tags** | [**List<Tag>**](Tag.md) | Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. | [optional] [readonly] +**TaxIdentifiers** | [**List<TaxIdentifier>**](TaxIdentifier.md) | | [optional] +**TotalWeight** | [**Weight**](Weight.md) | The combined weight of all packages in the shipment | [optional] [readonly] +**ValidateAddress** | **ValidateAddress** | | [optional] +**WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AddressValidationCode.md b/docs/models/AddressValidationCode.md new file mode 100644 index 00000000..683a4b36 --- /dev/null +++ b/docs/models/AddressValidationCode.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.AddressValidationCode +The error codes that can be returned by the address validation API + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AddressValidationDetailCode.md b/docs/models/AddressValidationDetailCode.md new file mode 100644 index 00000000..cb3378c7 --- /dev/null +++ b/docs/models/AddressValidationDetailCode.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.AddressValidationDetailCode +The detailed error codes that can be returned by the address validation API + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AddressValidationMessageType.md b/docs/models/AddressValidationMessageType.md new file mode 100644 index 00000000..dd346af5 --- /dev/null +++ b/docs/models/AddressValidationMessageType.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.AddressValidationMessageType +The different types of messages that can be returned by the address validation API + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AddressValidationResult.md b/docs/models/AddressValidationResult.md new file mode 100644 index 00000000..cefd7627 --- /dev/null +++ b/docs/models/AddressValidationResult.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.AddressValidationResult +An address validation result + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Messages** | [**List<ResponseMessage>**](ResponseMessage.md) | The list of messages that were generated during the address validation request. | [readonly] +**OriginalAddress** | [**Address**](Address.md) | The original address that was sent for validation | +**Status** | **AddressValidationStatus** | | +**MatchedAddress** | [**Address**](Address.md) | The matched address found by the Shipengine API | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AddressValidationStatus.md b/docs/models/AddressValidationStatus.md new file mode 100644 index 00000000..c5902a7e --- /dev/null +++ b/docs/models/AddressValidationStatus.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.AddressValidationStatus +The possible address validation status values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AdvancedShipmentOptions.md b/docs/models/AdvancedShipmentOptions.md new file mode 100644 index 00000000..ca55a8bc --- /dev/null +++ b/docs/models/AdvancedShipmentOptions.md @@ -0,0 +1,37 @@ +# ShipEngineSDK.Model.AdvancedShipmentOptions +Advanced shipment options + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AdditionalHandling** | **bool** | Indicate to the carrier that this shipment requires additional handling. | [optional] +**BillToAccount** | **string** | This field is used to [bill shipping costs to a third party](https://www.shipengine.com/docs/shipping/bill-to-third-party/). This field must be used in conjunction with the `bill_to_country_code`, `bill_to_party`, and `bill_to_postal_code` fields. | [optional] +**BillToCountryCode** | **string** | The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the third-party that is responsible for shipping costs. | [optional] +**BillToParty** | **BillToParty** | Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set. | [optional] +**BillToPostalCode** | **string** | The postal code of the third-party that is responsible for shipping costs. | [optional] +**CertificateNumber** | **string** | certificate number. | [optional] +**CollectOnDelivery** | [**CollectOnDelivery**](CollectOnDelivery.md) | | [optional] +**ContainsAlcohol** | **bool** | Indicates that the shipment contains alcohol. | [optional] [default to false] +**CustomField1** | **string** | An arbitrary field that can be used to store information about the shipment. | [optional] +**CustomField2** | **string** | An arbitrary field that can be used to store information about the shipment. | [optional] +**CustomField3** | **string** | An arbitrary field that can be used to store information about the shipment. | [optional] +**DangerousGoods** | **bool** | Indicates if the Dangerous goods are present in the shipment | [optional] [default to false] +**DangerousGoodsContact** | [**AdvancedShipmentOptionsDangerousGoodsContact**](AdvancedShipmentOptionsDangerousGoodsContact.md) | | [optional] +**DeliveredDutyPaid** | **bool** | Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express. | [optional] [default to false] +**DryIce** | **bool** | Indicates if the shipment contain dry ice | [optional] [default to false] +**DryIceWeight** | [**Weight**](Weight.md) | The weight of the dry ice in the shipment | [optional] +**FedexFreight** | [**AdvancedShipmentOptionsFedexFreight**](AdvancedShipmentOptionsFedexFreight.md) | | [optional] +**FreightClass** | **string** | The National Motor Freight Traffic Association [freight class](http://www.nmfta.org/pages/nmfc?AspxAutoDetectCookieSupport=1), such as \"77.5\", \"110\", or \"250\". | [optional] +**InvoiceNumber** | **string** | invoice number. | [optional] +**LicenseNumber** | **string** | license number. | [optional] +**NonMachinable** | **bool** | Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details. | [optional] [default to false] +**OriginType** | **OriginType** | | [optional] +**SaturdayDelivery** | **bool** | Enables Saturday delivery, if supported by the carrier. | [optional] [default to false] +**ShipperRelease** | **bool** | | [optional] +**ThirdPartyConsignee** | **bool** | Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached | [optional] [default to false] +**UseUpsGroundFreightPricing** | **bool** | Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified. | [optional] +**WindsorFrameworkDetails** | [**AdvancedShipmentOptionsWindsorFrameworkDetails**](AdvancedShipmentOptionsWindsorFrameworkDetails.md) | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AdvancedShipmentOptionsDangerousGoodsContact.md b/docs/models/AdvancedShipmentOptionsDangerousGoodsContact.md new file mode 100644 index 00000000..04739f87 --- /dev/null +++ b/docs/models/AdvancedShipmentOptionsDangerousGoodsContact.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.AdvancedShipmentOptionsDangerousGoodsContact +Contact information for Dangerous goods + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Name of the contact | [optional] +**Phone** | **string** | Phone number of the contact | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AdvancedShipmentOptionsFedexFreight.md b/docs/models/AdvancedShipmentOptionsFedexFreight.md new file mode 100644 index 00000000..0af9c3e2 --- /dev/null +++ b/docs/models/AdvancedShipmentOptionsFedexFreight.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.AdvancedShipmentOptionsFedexFreight +Provide details for the Fedex freight service + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BookingConfirmation** | **string** | | [optional] +**ShipperLoadAndCount** | **string** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AdvancedShipmentOptionsWindsorFrameworkDetails.md b/docs/models/AdvancedShipmentOptionsWindsorFrameworkDetails.md new file mode 100644 index 00000000..fa237cfd --- /dev/null +++ b/docs/models/AdvancedShipmentOptionsWindsorFrameworkDetails.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.AdvancedShipmentOptionsWindsorFrameworkDetails +The Windsor framework is a new regulation in the UK that simplifies customs procedures for goods moved from the UK mainland to Northern Ireland. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MovementIndicator** | **string** | An indicator that will tell the carrier and HMRC the type of movement for the shipment. | [optional] +**NotAtRisk** | **bool** | An indicator that allows a shipper to declare the shipment as not-at-risk. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AllowedIncoterms.md b/docs/models/AllowedIncoterms.md new file mode 100644 index 00000000..711314d4 --- /dev/null +++ b/docs/models/AllowedIncoterms.md @@ -0,0 +1,9 @@ +# ShipEngineSDK.Model.AllowedIncoterms + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AlternativeIdentifier.md b/docs/models/AlternativeIdentifier.md new file mode 100644 index 00000000..5e30ee8a --- /dev/null +++ b/docs/models/AlternativeIdentifier.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.AlternativeIdentifier +Additional information some carriers may provide by which to identify a given label in their system. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of alternative_identifier that corresponds to the value. | [optional] +**Value** | **string** | The value of the alternative_identifier. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AlternativeIdentifiers.md b/docs/models/AlternativeIdentifiers.md new file mode 100644 index 00000000..b8f9eabc --- /dev/null +++ b/docs/models/AlternativeIdentifiers.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.AlternativeIdentifiers + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarAlternativeIdentifiers** | [**List<AlternativeIdentifier>**](AlternativeIdentifier.md) | Alternative identifiers associated with this package. | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/AncillaryServiceEndorsement.md b/docs/models/AncillaryServiceEndorsement.md new file mode 100644 index 00000000..6b07f67b --- /dev/null +++ b/docs/models/AncillaryServiceEndorsement.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.AncillaryServiceEndorsement +[Ancillary service endorsements](https://pe.usps.com/text/qsg300/Q507.htm) are used by mailers to request an addressee's new address and to provide the carrier with instructions on how to handle packages that are undeliverable as addressed. | Ancillary Service Endorsement | Description |- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- | `none` | No ancillary service is requested. Depending on the carrier servive, the package may be forwarded, returned, or discarded. | `return_service_requested` | The package is returned to the sender. If possible, notification of the new address is is included with the returned package. | `forwarding_service_requested` | Forward the package to the new address, if possible; otherwise, return it to the sender. | `address_service_requested` | Forward the package to the new address, if possible; otherwise, return it to the sender. This is similar to `forwarding_service_requested`, but different restrictions and charges may apply. | `change_service_requested` | The package is discarded. If possible, notification of the new address is sent to the sender. | `leave_if_no_response` | + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Batch.md b/docs/models/Batch.md new file mode 100644 index 00000000..4c2147ea --- /dev/null +++ b/docs/models/Batch.md @@ -0,0 +1,31 @@ +# ShipEngineSDK.Model.Batch +Batches are an advanced feature of ShipEngine designed for users who need to generate hundreds or thousands of labels at a time. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchErrorsUrl** | [**OptionalLink**](OptionalLink.md) | Link to batch errors endpoint | [readonly] +**BatchId** | **string** | A string that uniquely identifies the batch | [readonly] +**BatchLabelsUrl** | [**OptionalLink**](OptionalLink.md) | Link to batch labels query | +**BatchNumber** | **string** | The batch number. | [readonly] +**BatchShipmentsUrl** | [**OptionalLink**](OptionalLink.md) | The batch shipments endpoint | +**Completed** | **int** | The number of labels generated in the batch | [readonly] +**Count** | **int** | The total of errors, warnings, and completed properties | [readonly] +**CreatedAt** | **DateTimeOffset** | The date and time the batch was created in ShipEngine | [readonly] +**Errors** | **int** | The number of errors that occurred while generating the batch | [readonly] +**FormDownload** | [**OptionalLink**](OptionalLink.md) | The form download for any customs that are needed | [readonly] +**Forms** | **int** | The number of forms for customs that are available for download | [readonly] +**LabelDownload** | [**LabelDownload**](LabelDownload.md) | The label download for the batch | [readonly] +**LabelFormat** | **LabelFormat** | | [readonly] +**LabelLayout** | **LabelLayout** | label layout | [readonly] +**PaperlessDownload** | [**PaperlessDownload**](PaperlessDownload.md) | The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. | [readonly] +**ProcessErrors** | [**List<Error>**](Error.md) | The errors associated with the failed API call | [readonly] +**Status** | **BatchStatus** | | [readonly] +**Warnings** | **int** | The number of warnings that occurred while generating the batch | [readonly] +**BatchNotes** | **string** | Custom notes you can add for each created batch | [readonly] [default to ""] +**ExternalBatchId** | **string** | A string that uniquely identifies the external batch | [readonly] +**ProcessedAt** | **DateTimeOffset** | The date and time the batch was processed in ShipEngine | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/BatchResponseError.md b/docs/models/BatchResponseError.md new file mode 100644 index 00000000..7021c465 --- /dev/null +++ b/docs/models/BatchResponseError.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.BatchResponseError +A batch response error + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Error** | **string** | Error message associated with the shipment. | [optional] [readonly] +**ExternalShipmentId** | **string** | An external shipment id associated with the shipment | [optional] [readonly] +**ShipmentId** | **string** | A string that uniquely identifies the shipment | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/BatchStatus.md b/docs/models/BatchStatus.md new file mode 100644 index 00000000..ef74cfb0 --- /dev/null +++ b/docs/models/BatchStatus.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.BatchStatus +The possible batch status values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/BatchesSortBy.md b/docs/models/BatchesSortBy.md new file mode 100644 index 00000000..22830c55 --- /dev/null +++ b/docs/models/BatchesSortBy.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.BatchesSortBy +The possible batches sort by values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/BillToParty.md b/docs/models/BillToParty.md new file mode 100644 index 00000000..2f9c9f4f --- /dev/null +++ b/docs/models/BillToParty.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.BillToParty +The possible bill to party values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/BulkRate.md b/docs/models/BulkRate.md new file mode 100644 index 00000000..a52d0451 --- /dev/null +++ b/docs/models/BulkRate.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.BulkRate +A bulk rate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedAt** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. | [readonly] +**Errors** | [**List<Error>**](Error.md) | An array of errors that were returned while retrieving the bulk rate | [readonly] +**RateRequestId** | **string** | A string that uniquely identifies the rate request | [readonly] +**ShipmentId** | **string** | A string that uniquely identifies the shipment | [readonly] +**Status** | **RateResponseStatus** | | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CalculateRatesRequestBody.md b/docs/models/CalculateRatesRequestBody.md new file mode 100644 index 00000000..855eec69 --- /dev/null +++ b/docs/models/CalculateRatesRequestBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.CalculateRatesRequestBody +A rate shipment request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RateOptions** | [**RateRequestBody**](RateRequestBody.md) | The rate options | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CalculateRatesResponseBody.md b/docs/models/CalculateRatesResponseBody.md new file mode 100644 index 00000000..6f16a087 --- /dev/null +++ b/docs/models/CalculateRatesResponseBody.md @@ -0,0 +1,38 @@ +# ShipEngineSDK.Model.CalculateRatesResponseBody +A rate shipment response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AdvancedOptions** | [**AdvancedShipmentOptions**](AdvancedShipmentOptions.md) | Advanced shipment options. These are entirely optional. | +**Confirmation** | **DeliveryConfirmation** | The type of delivery confirmation that is required for this shipment. | +**CreatedAt** | **DateTimeOffset** | The date and time that the shipment was created in ShipEngine. | [readonly] +**InsuranceProvider** | **InsuranceProvider** | The insurance provider to use for any insured packages in the shipment. | +**ModifiedAt** | **DateTimeOffset** | The date and time that the shipment was created or last modified. | [readonly] +**Packages** | [**List<Package>**](Package.md) | The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. | +**RateResponse** | [**RatesInformation**](RatesInformation.md) | The rates response | +**ReturnTo** | [**ShippingAddress**](ShippingAddress.md) | The return address for this shipment. Defaults to the `ship_from` address. | +**ShipDate** | **DateTimeOffset** | The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | +**ShipmentId** | **string** | A string that uniquely identifies the shipment | [readonly] +**ShipmentStatus** | **ShipmentStatus** | The current status of the shipment | [readonly] +**Tags** | [**List<Tag>**](Tag.md) | Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. | [readonly] +**TotalWeight** | [**Weight**](Weight.md) | The combined weight of all packages in the shipment | [readonly] +**CarrierId** | **string** | The carrier account that is billed for the shipping charges | [optional] +**ComparisonRateType** | **string** | Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. | [optional] +**Customs** | [**InternationalShipmentOptions**](InternationalShipmentOptions.md) | Customs information. This is usually only needed for international shipments. | +**ExternalOrderId** | **string** | ID that the Order Source assigned | [optional] +**ExternalShipmentId** | **string** | A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**IsReturn** | **bool** | An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. | [optional] [default to false] +**Items** | [**List<ShipmentItem>**](ShipmentItem.md) | Describe the packages included in this shipment as related to potential metadata that was imported from external order sources | [optional] +**OrderSourceCode** | **OrderSourceName** | | [optional] +**ServiceCode** | **string** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | [optional] +**ShipFrom** | [**ShippingAddress**](ShippingAddress.md) | The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. | [optional] +**ShipTo** | [**ShippingAddressTo**](ShippingAddressTo.md) | The recipient's mailing address | [optional] +**ShipmentNumber** | **string** | A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**ShippingRuleId** | **string** | ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment | [optional] +**TaxIdentifiers** | [**List<TaxIdentifier>**](TaxIdentifier.md) | | [optional] +**WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Carrier.md b/docs/models/Carrier.md new file mode 100644 index 00000000..8cb315c7 --- /dev/null +++ b/docs/models/Carrier.md @@ -0,0 +1,25 @@ +# ShipEngineSDK.Model.Carrier +A carrier object that represents a provider such as UPS, USPS, DHL, etc that has been tied to the current account. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountNumber** | **string** | The account number that the carrier is connected to. | [optional] [readonly] +**Balance** | **decimal** | Current available balance | [optional] [readonly] +**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** | A string that uniquely identifies the carrier. | [optional] [readonly] +**DisabledByBillingPlan** | **bool** | The carrier is disabled by the current ShipEngine account's billing plan. | [optional] [readonly] +**FriendlyName** | **string** | Screen readable name | [optional] [readonly] +**FundingSourceId** | **string** | Funding source ID for the carrier | [optional] [readonly] +**HasMultiPackageSupportingServices** | **bool** | Carrier supports multiple packages per shipment | [optional] [readonly] +**Nickname** | **string** | Nickname given to the account when initially setting up the carrier. | [optional] [readonly] +**Options** | [**List<CarrierAdvancedOption>**](CarrierAdvancedOption.md) | A list of options that are available to that carrier | [optional] [readonly] +**Packages** | [**List<PackageType>**](PackageType.md) | A list of package types that are supported by the carrier | [optional] [readonly] +**Primary** | **bool** | Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation | [optional] [readonly] +**RequiresFundedAmount** | **bool** | Indicates whether the carrier requires funding to use its services | [optional] [readonly] +**Services** | [**List<Service>**](Service.md) | A list of services that are offered by the carrier | [optional] [readonly] +**SupportsLabelMessages** | **bool** | The carrier supports adding custom label messages to an order. | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CarrierAdvancedOption.md b/docs/models/CarrierAdvancedOption.md new file mode 100644 index 00000000..52de6d7d --- /dev/null +++ b/docs/models/CarrierAdvancedOption.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.CarrierAdvancedOption +Advanced options that are specific to the carrier + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DefaultValue** | **string** | Default value of option | [optional] [readonly] +**Description** | **string** | Description of option | [optional] [readonly] +**Name** | **string** | Name of advanced option | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CarrierName.md b/docs/models/CarrierName.md new file mode 100644 index 00000000..b7b23d5a --- /dev/null +++ b/docs/models/CarrierName.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.CarrierName +The shipping carriers that are supported by ShipEngine + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CarrierNameWithSettings.md b/docs/models/CarrierNameWithSettings.md new file mode 100644 index 00000000..d256f185 --- /dev/null +++ b/docs/models/CarrierNameWithSettings.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.CarrierNameWithSettings +The shipping carriers for which ShipEngine supports carrier settings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CollectOnDelivery.md b/docs/models/CollectOnDelivery.md new file mode 100644 index 00000000..59e1df1d --- /dev/null +++ b/docs/models/CollectOnDelivery.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.CollectOnDelivery +Defer payment until package is delivered, instead of when it is ordered. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PaymentAmount** | [**PaymentAmount**](PaymentAmount.md) | | [optional] +**PaymentType** | **CollectOnDeliveryPaymentType** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CollectOnDeliveryPaymentType.md b/docs/models/CollectOnDeliveryPaymentType.md new file mode 100644 index 00000000..567540e1 --- /dev/null +++ b/docs/models/CollectOnDeliveryPaymentType.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.CollectOnDeliveryPaymentType +Types of payment that are supported + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CompareBulkRatesRequestBody.md b/docs/models/CompareBulkRatesRequestBody.md new file mode 100644 index 00000000..f9332855 --- /dev/null +++ b/docs/models/CompareBulkRatesRequestBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.CompareBulkRatesRequestBody +A rate shipments request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RateOptions** | [**RateRequestBody**](RateRequestBody.md) | The rate options | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectAccessWorldwideRequestBody.md b/docs/models/ConnectAccessWorldwideRequestBody.md new file mode 100644 index 00000000..9eac6f00 --- /dev/null +++ b/docs/models/ConnectAccessWorldwideRequestBody.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.ConnectAccessWorldwideRequestBody +An Access Worldwide account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nickname** | **string** | The nickname associated with the carrier connection | +**Password** | **string** | Access Worldwide Password | +**Username** | **string** | Access Worldwide Username | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectAmazonBuyShippingRequestBody.md b/docs/models/ConnectAmazonBuyShippingRequestBody.md new file mode 100644 index 00000000..f0065ce6 --- /dev/null +++ b/docs/models/ConnectAmazonBuyShippingRequestBody.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.ConnectAmazonBuyShippingRequestBody +An Amazon account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Email** | **string** | An email address. | +**MerchantSellerId** | **string** | | +**MwsAuthToken** | **string** | | +**Nickname** | **string** | Nickname to be associated with the account connection | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectAmazonShippingUk.md b/docs/models/ConnectAmazonShippingUk.md new file mode 100644 index 00000000..d9ef2978 --- /dev/null +++ b/docs/models/ConnectAmazonShippingUk.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.ConnectAmazonShippingUk +An Amazon Shipping UK account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AuthCode** | **string** | Amazon UK Shipping auth code. | +**Nickname** | **string** | The nickname associated with the carrier connection | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectApcRequestBody.md b/docs/models/ConnectApcRequestBody.md new file mode 100644 index 00000000..3db54da2 --- /dev/null +++ b/docs/models/ConnectApcRequestBody.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.ConnectApcRequestBody +An APC account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nickname** | **string** | The nickname for the APC account | +**Password** | **string** | The password for the APC account | +**Username** | **string** | The username for the APC account | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectAsendiaRequestBody.md b/docs/models/ConnectAsendiaRequestBody.md new file mode 100644 index 00000000..6beffe38 --- /dev/null +++ b/docs/models/ConnectAsendiaRequestBody.md @@ -0,0 +1,17 @@ +# ShipEngineSDK.Model.ConnectAsendiaRequestBody +An Asendia account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountNumber** | **string** | Asendia account number | +**ApiKey** | **string** | Asendia api_key | +**Nickname** | **string** | The nickname of the Asendia account | +**Password** | **string** | Asendia password | +**ProcessingLocation** | **string** | Asendia processing location, one of: 'MIA', 'JFK', 'ORD', 'PHL', 'SFO', 'LAX', 'SLC', 'TOR', 'BUF', 'CAL' | +**Username** | **string** | Asendia username | +**SubAccountNumber** | **string** | Asendia sub account number | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectAustraliaPostRequestBody.md b/docs/models/ConnectAustraliaPostRequestBody.md new file mode 100644 index 00000000..45436f0d --- /dev/null +++ b/docs/models/ConnectAustraliaPostRequestBody.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.ConnectAustraliaPostRequestBody +An Australia Post account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountNumber** | **string** | Account number | +**ApiKey** | **string** | API key | +**ApiSecret** | **string** | API secret | +**Nickname** | **string** | Nickname | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectCanadaPostRequestBody.md b/docs/models/ConnectCanadaPostRequestBody.md new file mode 100644 index 00000000..9f24ac2b --- /dev/null +++ b/docs/models/ConnectCanadaPostRequestBody.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.ConnectCanadaPostRequestBody +A Canada Post account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountNumber** | **string** | Canada Post Account Number | +**ApiKey** | **string** | Canada Post Account API Key | +**ApiSecret** | **string** | Canada Post Account API Secret | +**ContractId** | **string** | Canada Post Account Contract ID | +**Nickname** | **string** | Nickname | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectCarrierRequestBody.md b/docs/models/ConnectCarrierRequestBody.md new file mode 100644 index 00000000..227cdb07 --- /dev/null +++ b/docs/models/ConnectCarrierRequestBody.md @@ -0,0 +1,9 @@ +# ShipEngineSDK.Model.ConnectCarrierRequestBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectCarrierResponseBody.md b/docs/models/ConnectCarrierResponseBody.md new file mode 100644 index 00000000..f908046c --- /dev/null +++ b/docs/models/ConnectCarrierResponseBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.ConnectCarrierResponseBody +A connect account response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierId** | **string** | A string that uniquely identifies the carrier | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectDhlEcommerceRequestBody.md b/docs/models/ConnectDhlEcommerceRequestBody.md new file mode 100644 index 00000000..b8eb92ec --- /dev/null +++ b/docs/models/ConnectDhlEcommerceRequestBody.md @@ -0,0 +1,25 @@ +# ShipEngineSDK.Model.ConnectDhlEcommerceRequestBody +A DHL Ecommerce account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | **string** | The client id | +**DistributionCenter** | **string** | The distribution center | +**Nickname** | **string** | A nickname to help you identify this account | +**Password** | **string** | The account password | +**PickupNumber** | **string** | The pickup number | +**Username** | **string** | The account username | +**AccountNumber** | **string** | Account number | [optional] +**AncillaryEndorsement** | **AncillaryServiceEndorsement** | | [optional] +**ApiKey** | **string** | The DHL E-Commerce API key. This field is optional, but if not set you will not be able to get rates for this account. | [optional] +**ApiSecret** | **string** | The DHL E-Commerce API secret. This field is optional, but if not set you will not be able to get rates for this account. | [optional] +**FtpPassword** | **string** | FTP password | [optional] +**FtpUsername** | **string** | FTP username | [optional] +**RegistrationId** | **string** | | [optional] +**SoftwareName** | **string** | | [optional] +**SoldTo** | **string** | Sold To field | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectDhlExpressAuRequestBody.md b/docs/models/ConnectDhlExpressAuRequestBody.md new file mode 100644 index 00000000..78109d0c --- /dev/null +++ b/docs/models/ConnectDhlExpressAuRequestBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.ConnectDhlExpressAuRequestBody +A DHL Express AU account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountNumber** | **string** | Account number | +**Nickname** | **string** | Nickname | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectDhlExpressCaRequestBody.md b/docs/models/ConnectDhlExpressCaRequestBody.md new file mode 100644 index 00000000..a7aef443 --- /dev/null +++ b/docs/models/ConnectDhlExpressCaRequestBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.ConnectDhlExpressCaRequestBody +A DHL Express CA account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountNumber** | **string** | Account number | +**Nickname** | **string** | Nickname | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectDhlExpressRequestBody.md b/docs/models/ConnectDhlExpressRequestBody.md new file mode 100644 index 00000000..1e5ac8b7 --- /dev/null +++ b/docs/models/ConnectDhlExpressRequestBody.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.ConnectDhlExpressRequestBody +A DHL express account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountNumber** | **string** | Account number | +**Nickname** | **string** | Nickname | +**CountryCode** | **string** | A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) | [optional] +**Password** | **string** | Required if site id is provided | [optional] +**SiteId** | **string** | Required if password is provided | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectDhlExpressUkRequestBody.md b/docs/models/ConnectDhlExpressUkRequestBody.md new file mode 100644 index 00000000..70e8a37b --- /dev/null +++ b/docs/models/ConnectDhlExpressUkRequestBody.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.ConnectDhlExpressUkRequestBody +A DHL Express UK account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountNumber** | **string** | Account number | +**Nickname** | **string** | Nickname | +**Password** | **string** | Password | +**SiteId** | **string** | A string that uniquely identifies the site | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectDpdRequestBody.md b/docs/models/ConnectDpdRequestBody.md new file mode 100644 index 00000000..49426e0d --- /dev/null +++ b/docs/models/ConnectDpdRequestBody.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.ConnectDpdRequestBody +A DPD account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountNumber** | **string** | Account number | +**Nickname** | **string** | Nickname | +**Password** | **string** | Password | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectEndiciaRequestBody.md b/docs/models/ConnectEndiciaRequestBody.md new file mode 100644 index 00000000..b84f81d5 --- /dev/null +++ b/docs/models/ConnectEndiciaRequestBody.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.ConnectEndiciaRequestBody +An Endicia account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Account** | **string** | Account | +**Nickname** | **string** | Nickname | +**Passphrase** | **string** | Passphrase | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectFedexRequestBody.md b/docs/models/ConnectFedexRequestBody.md new file mode 100644 index 00000000..12de0bbe --- /dev/null +++ b/docs/models/ConnectFedexRequestBody.md @@ -0,0 +1,25 @@ +# ShipEngineSDK.Model.ConnectFedexRequestBody +A Fedex account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountNumber** | **string** | Account number | +**Address1** | **string** | Address | +**AgreeToEula** | **bool** | Boolean signaling agreement to the Fedex End User License Agreement | +**City** | **string** | The city | +**CountryCode** | **string** | Country code | +**Email** | **string** | The email address | +**FirstName** | **string** | First name | +**LastName** | **string** | Last name | +**Nickname** | **string** | Nickname | +**Phone** | **string** | Phone number | +**PostalCode** | **string** | Postal Code | +**State** | **string** | State | +**Address2** | **string** | Address | [optional] +**Company** | **string** | The company | [optional] +**MeterNumber** | **string** | Meter number | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectFedexUkRequestBody.md b/docs/models/ConnectFedexUkRequestBody.md new file mode 100644 index 00000000..1a0138d8 --- /dev/null +++ b/docs/models/ConnectFedexUkRequestBody.md @@ -0,0 +1,25 @@ +# ShipEngineSDK.Model.ConnectFedexUkRequestBody +A Fedex UK account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountNumber** | **string** | Account number | +**Address1** | **string** | Address | +**AgreeToEula** | **bool** | Boolean signaling agreement to the Fedex End User License Agreement | +**City** | **string** | The city | +**CountryCode** | **string** | Country code | +**Email** | **string** | The email address | +**FirstName** | **string** | First name | +**LastName** | **string** | Last name | +**Nickname** | **string** | Nickname | +**Phone** | **string** | Phone number | +**PostalCode** | **string** | Postal Code | +**State** | **string** | State | +**Address2** | **string** | Address | [optional] +**Company** | **string** | The company | [optional] +**MeterNumber** | **string** | Meter number | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectFirstmileRequestBody.md b/docs/models/ConnectFirstmileRequestBody.md new file mode 100644 index 00000000..4218bce0 --- /dev/null +++ b/docs/models/ConnectFirstmileRequestBody.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.ConnectFirstmileRequestBody +A First Mile account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MailerId** | **string** | A string that uniquely identifies the mailer | +**Nickname** | **string** | Nickname | +**Password** | **string** | Password | +**ProfileName** | **string** | Profile name | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectImexRequestBody.md b/docs/models/ConnectImexRequestBody.md new file mode 100644 index 00000000..216391e7 --- /dev/null +++ b/docs/models/ConnectImexRequestBody.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.ConnectImexRequestBody +An Imex account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nickname** | **string** | Nickname | +**Password** | **string** | Password | +**Username** | **string** | Username | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectInsurerRequestBody.md b/docs/models/ConnectInsurerRequestBody.md new file mode 100644 index 00000000..4c191d35 --- /dev/null +++ b/docs/models/ConnectInsurerRequestBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.ConnectInsurerRequestBody +A create shipsurance connection request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Email** | **string** | An email address. | +**PolicyId** | **string** | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectLasershipRequestBody.md b/docs/models/ConnectLasershipRequestBody.md new file mode 100644 index 00000000..eaee5452 --- /dev/null +++ b/docs/models/ConnectLasershipRequestBody.md @@ -0,0 +1,36 @@ +# ShipEngineSDK.Model.ConnectLasershipRequestBody +A Lasership account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Address** | **String** | Address | +**City** | **String** | City | +**CustomerBranch** | **string** | Customer Branch | +**LasershipCriticalEntryTime** | **String** | Critical Entry Time (local time) | +**LasershipCriticalPullTime** | **String** | Critical Pull Time (local time) | +**Nickname** | **string** | Nickname | +**PostalCode** | **String** | PostalCode | +**State** | **String** | State | +**WebServicesId** | **string** | Web Service ID (WSID) | +**WebServicesKey** | **string** | Web Service Key (WSKey) | +**Address2** | **String** | Address2 | [optional] +**AttrAlcohol** | **Boolean** | Set this to true if your shipments will always contain Alcohol | [optional] +**AttrControlledSubstance** | **Boolean** | Set this to true if your shipments will always contain Controlled Substances | [optional] +**AttrDryIce** | **Boolean** | Set this to true if your shipments will always contain DryIce | [optional] +**AttrExplosive** | **Boolean** | Set this to true if your shipments will always contain Explosives | [optional] +**AttrHazmat** | **Boolean** | Set this to true if your shipments will always contain Hazmat | [optional] +**AttrNoRTS** | **Boolean** | Set this to true if your shipments will always use \"No Return To Sender\" | [optional] +**AttrPerishable** | **Boolean** | Set this to true if your shipments will always be Perishable | [optional] +**AttrRefrigerated** | **Boolean** | Set this to true if your shipments will always require Refrigeration | [optional] +**AttrTwoPersons** | **Boolean** | Set this to true if your shipments will always require Two Persons | [optional] +**Country** | **String** | Country | [optional] +**DeclarePieceAttributesSeparatelyForEveryShipment** | **Boolean** | Declare piece attributes separately for every shipment, overrides individual attribute below. | [optional] +**Email** | **String** | Email | [optional] +**FacilityCode** | **String** | Facility Code | [optional] +**Instructions** | **String** | Instructions | [optional] +**Phone** | **String** | Phone | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectNewgisticsRequestBody.md b/docs/models/ConnectNewgisticsRequestBody.md new file mode 100644 index 00000000..c79666e0 --- /dev/null +++ b/docs/models/ConnectNewgisticsRequestBody.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.ConnectNewgisticsRequestBody +A Newgistics account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InductionSite** | **string** | Induction site | +**Nickname** | **string** | Nickname | +**MailerId** | **int** | Mailer id | [optional] +**MerchantId** | **int** | Merchant id | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectOntracRequestBody.md b/docs/models/ConnectOntracRequestBody.md new file mode 100644 index 00000000..cdaa9155 --- /dev/null +++ b/docs/models/ConnectOntracRequestBody.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.ConnectOntracRequestBody +An Ontrac account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountNumber** | **string** | Account number | +**Nickname** | **string** | Nickname | +**Password** | **string** | Password | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectPurolatorRequestBody.md b/docs/models/ConnectPurolatorRequestBody.md new file mode 100644 index 00000000..6662b8f2 --- /dev/null +++ b/docs/models/ConnectPurolatorRequestBody.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.ConnectPurolatorRequestBody +A Purolator account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountNumber** | **string** | Account number | +**ActivationKey** | **string** | Activation key | +**Nickname** | **string** | Nickname | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectRoyalMailRequestBody.md b/docs/models/ConnectRoyalMailRequestBody.md new file mode 100644 index 00000000..593d7d18 --- /dev/null +++ b/docs/models/ConnectRoyalMailRequestBody.md @@ -0,0 +1,22 @@ +# ShipEngineSDK.Model.ConnectRoyalMailRequestBody +A Royal Mail account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountNumber** | **string** | Account number | +**City** | **string** | City | +**ContactName** | **string** | Contact name | +**Nickname** | **string** | Nickname | +**PostalCode** | **string** | Postal code | +**CompanyName** | **string** | Company name | [optional] +**Email** | **string** | The email address | [optional] +**ObaEmail** | **string** | The oba email address | [optional] +**Phone** | **string** | Phone | [optional] +**StreetLine1** | **string** | Street line1 | [optional] +**StreetLine2** | **string** | Street line2 | [optional] +**StreetLine3** | **string** | Street line3 | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectRrDonnelleyRequestBody.md b/docs/models/ConnectRrDonnelleyRequestBody.md new file mode 100644 index 00000000..0ca1a856 --- /dev/null +++ b/docs/models/ConnectRrDonnelleyRequestBody.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.ConnectRrDonnelleyRequestBody +A RR Donnelley account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nickname** | **string** | Nickname | +**Password** | **string** | Password | +**Username** | **string** | Username | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectSekoRequestBody.md b/docs/models/ConnectSekoRequestBody.md new file mode 100644 index 00000000..c74af586 --- /dev/null +++ b/docs/models/ConnectSekoRequestBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.ConnectSekoRequestBody +A SEKO account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessKey** | **string** | Seko Account Access Key | +**Nickname** | **string** | Nickname | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectSendleRequestBody.md b/docs/models/ConnectSendleRequestBody.md new file mode 100644 index 00000000..d1914e73 --- /dev/null +++ b/docs/models/ConnectSendleRequestBody.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.ConnectSendleRequestBody +A Sendle account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApiKey** | **string** | API key | +**Nickname** | **string** | Nickname | +**SendleId** | **string** | A string that uniquely identifies the sendle | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectStampsRequestBody.md b/docs/models/ConnectStampsRequestBody.md new file mode 100644 index 00000000..a17fac57 --- /dev/null +++ b/docs/models/ConnectStampsRequestBody.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.ConnectStampsRequestBody +A Stamps account information request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nickname** | **string** | Nickname | +**Password** | **string** | Password | +**Username** | **string** | Username | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ConnectUpsRequestBody.md b/docs/models/ConnectUpsRequestBody.md new file mode 100644 index 00000000..f6004def --- /dev/null +++ b/docs/models/ConnectUpsRequestBody.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.ConnectUpsRequestBody +A UPS account information request body. The location header from this call should be used to redirect to UPS for sign in. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountCountryCode** | **string** | Account Country Code | +**AccountNumber** | **string** | Account number | +**AccountPostalCode** | **string** | Account Postal Code | +**Nickname** | **string** | Nickname | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ContactDetails.md b/docs/models/ContactDetails.md new file mode 100644 index 00000000..a6257b17 --- /dev/null +++ b/docs/models/ContactDetails.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.ContactDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Email** | **string** | An email address. | +**Name** | **string** | | +**Phone** | **string** | Phone number associated | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateAccountSettingsImageRequestBody.md b/docs/models/CreateAccountSettingsImageRequestBody.md new file mode 100644 index 00000000..3a64deb3 --- /dev/null +++ b/docs/models/CreateAccountSettingsImageRequestBody.md @@ -0,0 +1,17 @@ +# ShipEngineSDK.Model.CreateAccountSettingsImageRequestBody +A ShipEngine account settings images request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ImageContentType** | **string** | The image type | +**ImageData** | **string** | A base64 encoded string representation of the image. | +**Name** | **string** | A human readable name for the image. | +**CreatedAt** | **DateTimeOffset** | The date and time that the image was created in ShipEngine. | [optional] [readonly] +**IsDefault** | **bool** | Indicates whether this image is set as default. | [optional] +**LabelImageId** | **string** | A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. | [optional] [readonly] +**ModifiedAt** | **DateTimeOffset** | The date and time that the image was modified in ShipEngine. | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateAndProcessBatchRequestBody.md b/docs/models/CreateAndProcessBatchRequestBody.md new file mode 100644 index 00000000..a7663a2b --- /dev/null +++ b/docs/models/CreateAndProcessBatchRequestBody.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.CreateAndProcessBatchRequestBody +A create and process batch request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchNotes** | **string** | Add custom messages for a particular batch | [optional] +**ExternalBatchId** | **string** | A string that uniquely identifies the external batch | [optional] +**ProcessLabels** | [**CreateAndProcessBatchRequestBodyProcessLabels**](CreateAndProcessBatchRequestBodyProcessLabels.md) | | [optional] +**RateIds** | **List<string>** | Array of rate IDs used in the batch | [optional] +**ShipmentIds** | **List<string>** | Array of shipment IDs used in the batch | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateAndProcessBatchRequestBodyProcessLabels.md b/docs/models/CreateAndProcessBatchRequestBodyProcessLabels.md new file mode 100644 index 00000000..120fdcdd --- /dev/null +++ b/docs/models/CreateAndProcessBatchRequestBodyProcessLabels.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.CreateAndProcessBatchRequestBodyProcessLabels +The information used to process the batch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreateBatchAndProcessLabels** | **bool** | When 'true', the batch will be enqueued for processing | [optional] +**DisplayScheme** | **DisplayScheme** | The display format that the label should be shown in. | [optional] +**LabelFormat** | **LabelFormat** | | [optional] +**LabelLayout** | **LabelLayout** | | [optional] [default to "4x6"] +**ShipDate** | **DateTimeOffset** | The Ship date the batch is being processed for | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateAndValidateShipment.md b/docs/models/CreateAndValidateShipment.md new file mode 100644 index 00000000..72993dcb --- /dev/null +++ b/docs/models/CreateAndValidateShipment.md @@ -0,0 +1,39 @@ +# ShipEngineSDK.Model.CreateAndValidateShipment +A create and validate shipment resource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddressValidation** | [**AddressValidationResult**](AddressValidationResult.md) | The address validation | [optional] +**AdvancedOptions** | [**AdvancedShipmentOptions**](AdvancedShipmentOptions.md) | Advanced shipment options. These are entirely optional. | [optional] +**CarrierId** | **string** | The carrier account that is billed for the shipping charges | [optional] +**ComparisonRateType** | **string** | Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. | [optional] +**Confirmation** | **DeliveryConfirmation** | The type of delivery confirmation that is required for this shipment. | [optional] +**CreatedAt** | **DateTimeOffset** | The date and time that the shipment was created in ShipEngine. | [optional] [readonly] +**Customs** | [**InternationalShipmentOptions**](InternationalShipmentOptions.md) | Customs information. This is usually only needed for international shipments. | [optional] +**Errors** | **List<string>** | An array of errors that occurred while creating shipment. | [optional] [readonly] +**ExternalOrderId** | **string** | ID that the Order Source assigned | [optional] +**ExternalShipmentId** | **string** | A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**InsuranceProvider** | **InsuranceProvider** | The insurance provider to use for any insured packages in the shipment. | [optional] +**IsReturn** | **bool** | An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. | [optional] [default to false] +**Items** | [**List<ShipmentItem>**](ShipmentItem.md) | Describe the packages included in this shipment as related to potential metadata that was imported from external order sources | [optional] +**ModifiedAt** | **DateTimeOffset** | The date and time that the shipment was created or last modified. | [optional] [readonly] +**OrderSourceCode** | **OrderSourceName** | | [optional] +**Packages** | [**List<Package>**](Package.md) | The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. | [optional] +**ReturnTo** | [**ShippingAddress**](ShippingAddress.md) | The return address for this shipment. Defaults to the `ship_from` address. | [optional] +**ServiceCode** | **string** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | [optional] +**ShipDate** | **DateTimeOffset** | The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | [optional] +**ShipFrom** | [**ShippingAddress**](ShippingAddress.md) | The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. | [optional] +**ShipTo** | [**ShippingAddressTo**](ShippingAddressTo.md) | The recipient's mailing address | [optional] +**ShipmentId** | **string** | A string that uniquely identifies the shipment | [optional] [readonly] +**ShipmentNumber** | **string** | A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**ShipmentStatus** | **ShipmentStatus** | The current status of the shipment | [optional] [readonly] +**ShippingRuleId** | **string** | ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment | [optional] +**Tags** | [**List<Tag>**](Tag.md) | Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. | [optional] [readonly] +**TaxIdentifiers** | [**List<TaxIdentifier>**](TaxIdentifier.md) | | [optional] +**TotalWeight** | [**Weight**](Weight.md) | The combined weight of all packages in the shipment | [optional] [readonly] +**WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateBatchRequest.md b/docs/models/CreateBatchRequest.md new file mode 100644 index 00000000..c0f541ff --- /dev/null +++ b/docs/models/CreateBatchRequest.md @@ -0,0 +1,9 @@ +# ShipEngineSDK.Model.CreateBatchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateBatchRequestBody.md b/docs/models/CreateBatchRequestBody.md new file mode 100644 index 00000000..05dbbeb4 --- /dev/null +++ b/docs/models/CreateBatchRequestBody.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.CreateBatchRequestBody +A create batch request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchNotes** | **string** | Add custom messages for a particular batch | [optional] +**ExternalBatchId** | **string** | A string that uniquely identifies the external batch | [optional] +**RateIds** | **List<string>** | Array of rate IDs used in the batch | [optional] +**ShipmentIds** | **List<string>** | Array of shipment IDs used in the batch | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateBatchResponseBody.md b/docs/models/CreateBatchResponseBody.md new file mode 100644 index 00000000..f756c8c0 --- /dev/null +++ b/docs/models/CreateBatchResponseBody.md @@ -0,0 +1,31 @@ +# ShipEngineSDK.Model.CreateBatchResponseBody +A create batch response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchErrorsUrl** | [**OptionalLink**](OptionalLink.md) | Link to batch errors endpoint | [readonly] +**BatchId** | **string** | A string that uniquely identifies the batch | [readonly] +**BatchLabelsUrl** | [**OptionalLink**](OptionalLink.md) | Link to batch labels query | +**BatchNumber** | **string** | The batch number. | [readonly] +**BatchShipmentsUrl** | [**OptionalLink**](OptionalLink.md) | The batch shipments endpoint | +**Completed** | **int** | The number of labels generated in the batch | [readonly] +**Count** | **int** | The total of errors, warnings, and completed properties | [readonly] +**CreatedAt** | **DateTimeOffset** | The date and time the batch was created in ShipEngine | [readonly] +**Errors** | **int** | The number of errors that occurred while generating the batch | [readonly] +**FormDownload** | [**OptionalLink**](OptionalLink.md) | The form download for any customs that are needed | [readonly] +**Forms** | **int** | The number of forms for customs that are available for download | [readonly] +**LabelDownload** | [**LabelDownload**](LabelDownload.md) | The label download for the batch | [readonly] +**LabelFormat** | **LabelFormat** | | [readonly] +**LabelLayout** | **LabelLayout** | label layout | [readonly] +**PaperlessDownload** | [**PaperlessDownload**](PaperlessDownload.md) | The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. | [readonly] +**ProcessErrors** | [**List<Error>**](Error.md) | The errors associated with the failed API call | [readonly] +**Status** | **BatchStatus** | | [readonly] +**Warnings** | **int** | The number of warnings that occurred while generating the batch | [readonly] +**BatchNotes** | **string** | Custom notes you can add for each created batch | [readonly] [default to ""] +**ExternalBatchId** | **string** | A string that uniquely identifies the external batch | [readonly] +**ProcessedAt** | **DateTimeOffset** | The date and time the batch was processed in ShipEngine | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateLabelFromRateRequestBody.md b/docs/models/CreateLabelFromRateRequestBody.md new file mode 100644 index 00000000..5f7e7a3c --- /dev/null +++ b/docs/models/CreateLabelFromRateRequestBody.md @@ -0,0 +1,18 @@ +# ShipEngineSDK.Model.CreateLabelFromRateRequestBody +A purchase label without shipment request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomField1** | **string** | Optional - Value will be saved in the shipment's advanced_options > custom_field1 | [optional] +**CustomField2** | **string** | Optional - Value will be saved in the shipment's advanced_options > custom_field2 | [optional] +**CustomField3** | **string** | Optional - Value will be saved in the shipment's advanced_options > custom_field3 | [optional] +**DisplayScheme** | **DisplayScheme** | The display format that the label should be shown in. | [optional] +**LabelDownloadType** | **LabelDownloadType** | | [optional] +**LabelFormat** | **LabelFormat** | | [optional] +**LabelLayout** | **LabelLayout** | | [optional] +**ValidateAddress** | **ValidateAddress** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateLabelFromRateResponseBody.md b/docs/models/CreateLabelFromRateResponseBody.md new file mode 100644 index 00000000..9ce72b50 --- /dev/null +++ b/docs/models/CreateLabelFromRateResponseBody.md @@ -0,0 +1,49 @@ +# ShipEngineSDK.Model.CreateLabelFromRateResponseBody +A create label from rate response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AlternativeIdentifiers** | [**List<AlternativeIdentifier>**](AlternativeIdentifier.md) | Additional information some carriers may provide by which to identify a given label in their system. | [optional] [readonly] +**BatchId** | **string** | If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. | [optional] [readonly] +**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] +**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] +**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. | [optional] [readonly] +**InsuranceCost** | [**MonetaryValue**](MonetaryValue.md) | The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. | [optional] [readonly] +**IsInternational** | **bool** | Indicates whether this is an international shipment. That is, the originating country and destination country are different. | [optional] [readonly] +**IsReturnLabel** | **bool** | Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. | [optional] +**LabelDownload** | [**LabelDownload**](LabelDownload.md) | | [optional] [readonly] +**LabelDownloadType** | **LabelDownloadType** | | [optional] +**LabelFormat** | **LabelFormat** | 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. | [optional] +**LabelId** | **string** | A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. | [optional] [readonly] +**LabelImageId** | **string** | The label image resource that was used to create a custom label image. | [optional] +**LabelLayout** | **LabelLayout** | 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. | [optional] +**OutboundLabelId** | **string** | The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. | [optional] +**PackageCode** | **string** | The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. | [optional] [readonly] +**Packages** | [**List<LabelPackagesInner>**](LabelPackagesInner.md) | The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. | [optional] [readonly] +**PaperlessDownload** | [**PaperlessDownload**](PaperlessDownload.md) | The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. | [optional] [readonly] +**RateDetails** | [**List<RateDetail>**](RateDetail.md) | A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. | [optional] [readonly] +**RequestedComparisonAmount** | [**MonetaryValue**](MonetaryValue.md) | The total shipping cost for the specified comparison_rate_type. | [optional] [readonly] +**RmaNumber** | **string** | An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. | [optional] +**ServiceCode** | **string** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | [optional] [readonly] +**ShipDate** | **DateTimeOffset** | The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | [optional] [readonly] +**Shipment** | [**Shipment**](Shipment.md) | The shipment information used to generate the label | [optional] +**ShipmentCost** | [**MonetaryValue**](MonetaryValue.md) | The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. | [optional] [readonly] +**ShipmentId** | **string** | The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) | [optional] [readonly] +**Status** | **LabelStatus** | | [optional] [readonly] +**TestLabel** | **bool** | Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. | [optional] [default to false] +**Trackable** | **bool** | Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. | [optional] [readonly] +**TrackingNumber** | **string** | The tracking number for the package. Tracking number formats vary across carriers. | [optional] [readonly] +**TrackingStatus** | **TrackingStatus** | The current status of the package, such as `in_transit` or `delivered` | [optional] [readonly] +**TrackingUrl** | **string** | The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. | [optional] [readonly] +**ValidateAddress** | **ValidateAddress** | | [optional] +**Voided** | **bool** | Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) | [optional] [readonly] +**VoidedAt** | **DateTimeOffset** | The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateLabelFromShipmentRequestBody.md b/docs/models/CreateLabelFromShipmentRequestBody.md new file mode 100644 index 00000000..630455ec --- /dev/null +++ b/docs/models/CreateLabelFromShipmentRequestBody.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.CreateLabelFromShipmentRequestBody +A purchase label without shipment request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayScheme** | **DisplayScheme** | The display format that the label should be shown in. | [optional] +**LabelDownloadType** | **LabelDownloadType** | | [optional] +**LabelFormat** | **LabelFormat** | | [optional] +**LabelLayout** | **LabelLayout** | | [optional] +**ValidateAddress** | **ValidateAddress** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateLabelFromShipmentResponseBody.md b/docs/models/CreateLabelFromShipmentResponseBody.md new file mode 100644 index 00000000..86517d99 --- /dev/null +++ b/docs/models/CreateLabelFromShipmentResponseBody.md @@ -0,0 +1,49 @@ +# ShipEngineSDK.Model.CreateLabelFromShipmentResponseBody +A create label from shipment response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AlternativeIdentifiers** | [**List<AlternativeIdentifier>**](AlternativeIdentifier.md) | Additional information some carriers may provide by which to identify a given label in their system. | [optional] [readonly] +**BatchId** | **string** | If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. | [optional] [readonly] +**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] +**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] +**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. | [optional] [readonly] +**InsuranceCost** | [**MonetaryValue**](MonetaryValue.md) | The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. | [optional] [readonly] +**IsInternational** | **bool** | Indicates whether this is an international shipment. That is, the originating country and destination country are different. | [optional] [readonly] +**IsReturnLabel** | **bool** | Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. | [optional] +**LabelDownload** | [**LabelDownload**](LabelDownload.md) | | [optional] [readonly] +**LabelDownloadType** | **LabelDownloadType** | | [optional] +**LabelFormat** | **LabelFormat** | 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. | [optional] +**LabelId** | **string** | A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. | [optional] [readonly] +**LabelImageId** | **string** | The label image resource that was used to create a custom label image. | [optional] +**LabelLayout** | **LabelLayout** | 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. | [optional] +**OutboundLabelId** | **string** | The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. | [optional] +**PackageCode** | **string** | The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. | [optional] [readonly] +**Packages** | [**List<LabelPackagesInner>**](LabelPackagesInner.md) | The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. | [optional] [readonly] +**PaperlessDownload** | [**PaperlessDownload**](PaperlessDownload.md) | The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. | [optional] [readonly] +**RateDetails** | [**List<RateDetail>**](RateDetail.md) | A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. | [optional] [readonly] +**RequestedComparisonAmount** | [**MonetaryValue**](MonetaryValue.md) | The total shipping cost for the specified comparison_rate_type. | [optional] [readonly] +**RmaNumber** | **string** | An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. | [optional] +**ServiceCode** | **string** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | [optional] [readonly] +**ShipDate** | **DateTimeOffset** | The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | [optional] [readonly] +**Shipment** | [**Shipment**](Shipment.md) | The shipment information used to generate the label | [optional] +**ShipmentCost** | [**MonetaryValue**](MonetaryValue.md) | The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. | [optional] [readonly] +**ShipmentId** | **string** | The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) | [optional] [readonly] +**Status** | **LabelStatus** | | [optional] [readonly] +**TestLabel** | **bool** | Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. | [optional] [default to false] +**Trackable** | **bool** | Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. | [optional] [readonly] +**TrackingNumber** | **string** | The tracking number for the package. Tracking number formats vary across carriers. | [optional] [readonly] +**TrackingStatus** | **TrackingStatus** | The current status of the package, such as `in_transit` or `delivered` | [optional] [readonly] +**TrackingUrl** | **string** | The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. | [optional] [readonly] +**ValidateAddress** | **ValidateAddress** | | [optional] +**Voided** | **bool** | Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) | [optional] [readonly] +**VoidedAt** | **DateTimeOffset** | The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateLabelRequestBody.md b/docs/models/CreateLabelRequestBody.md new file mode 100644 index 00000000..1b37db62 --- /dev/null +++ b/docs/models/CreateLabelRequestBody.md @@ -0,0 +1,24 @@ +# ShipEngineSDK.Model.CreateLabelRequestBody +A purchase label request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Shipment** | [**ShipmentRequest**](ShipmentRequest.md) | The shipment information used to generate the label | +**ChargeEvent** | **LabelChargeEvent** | The label charge event. | [optional] +**DisplayScheme** | **DisplayScheme** | The display format that the label should be shown in. | [optional] +**IsReturnLabel** | **bool** | Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. | [optional] +**LabelDownloadType** | **LabelDownloadType** | | [optional] +**LabelFormat** | **LabelFormat** | 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. | [optional] +**LabelImageId** | **string** | The label image resource that was used to create a custom label image. | [optional] +**LabelLayout** | **LabelLayout** | 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. | [optional] +**OutboundLabelId** | **string** | The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. | [optional] +**RmaNumber** | **string** | An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. | [optional] +**ShipFromServicePointId** | **string** | A unique identifier for a carrier drop off point where a merchant plans to deliver packages. This will take precedence over a shipment's ship from address. | [optional] +**ShipToServicePointId** | **string** | A unique identifier for a carrier service point where the shipment will be delivered by the carrier. This will take precedence over a shipment's ship to address. | [optional] +**TestLabel** | **bool** | Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. | [optional] [default to false] +**ValidateAddress** | **ValidateAddress** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateLabelResponseBody.md b/docs/models/CreateLabelResponseBody.md new file mode 100644 index 00000000..019d1219 --- /dev/null +++ b/docs/models/CreateLabelResponseBody.md @@ -0,0 +1,49 @@ +# ShipEngineSDK.Model.CreateLabelResponseBody +A create label response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchId** | **string** | If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. | [readonly] +**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. | [readonly] +**CarrierId** | **string** | The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label | [readonly] +**ChargeEvent** | **LabelChargeEvent** | The label charge event. | +**CreatedAt** | **DateTimeOffset** | The date and time that the label was created in ShipEngine. | [readonly] +**DisplayScheme** | **DisplayScheme** | The display format that the label should be shown in. | +**InsuranceCost** | [**MonetaryValue**](MonetaryValue.md) | The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. | [readonly] +**IsInternational** | **bool** | Indicates whether this is an international shipment. That is, the originating country and destination country are different. | [readonly] +**IsReturnLabel** | **bool** | Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. | +**LabelDownload** | [**LabelDownload**](LabelDownload.md) | | [readonly] +**LabelFormat** | **LabelFormat** | 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. | +**LabelId** | **string** | A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. | [readonly] +**LabelLayout** | **LabelLayout** | 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. | +**PackageCode** | **string** | The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. | [readonly] +**Packages** | [**List<LabelPackagesInner>**](LabelPackagesInner.md) | The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. | [readonly] +**ServiceCode** | **string** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | [readonly] +**ShipDate** | **DateTimeOffset** | The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | [readonly] +**ShipmentCost** | [**MonetaryValue**](MonetaryValue.md) | The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. | [readonly] +**ShipmentId** | **string** | The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) | [readonly] +**Status** | **LabelStatus** | | [readonly] +**Trackable** | **bool** | Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. | [readonly] +**TrackingNumber** | **string** | The tracking number for the package. Tracking number formats vary across carriers. | [readonly] +**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] +**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] +**LabelImageId** | **string** | The label image resource that was used to create a custom label image. | +**OutboundLabelId** | **string** | The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. | [optional] +**PaperlessDownload** | [**PaperlessDownload**](PaperlessDownload.md) | The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. | [readonly] +**RateDetails** | [**List<RateDetail>**](RateDetail.md) | A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. | [optional] [readonly] +**RequestedComparisonAmount** | [**MonetaryValue**](MonetaryValue.md) | The total shipping cost for the specified comparison_rate_type. | [optional] [readonly] +**RmaNumber** | **string** | An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. | +**Shipment** | [**Shipment**](Shipment.md) | The shipment information used to generate the label | [optional] +**TestLabel** | **bool** | Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. | [optional] [default to false] +**TrackingUrl** | **string** | The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. | [optional] [readonly] +**ValidateAddress** | **ValidateAddress** | | [optional] +**VoidedAt** | **DateTimeOffset** | The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateManifestByObjectRequestBody.md b/docs/models/CreateManifestByObjectRequestBody.md new file mode 100644 index 00000000..f89edd55 --- /dev/null +++ b/docs/models/CreateManifestByObjectRequestBody.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.CreateManifestByObjectRequestBody +A create manifest request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierId** | **string** | A string that uniquely identifies the carrier | +**ShipDate** | **DateTimeOffset** | The ship date that the shipment will be sent out on | +**WarehouseId** | **string** | A string that uniquely identifies the warehouse | +**ExcludedLabelIds** | **List<string>** | The list of label ids to exclude from the manifest | [optional] +**LabelIds** | **List<string>** | The list of label ids to include for the manifest | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateManifestLabelIdsRequestBody.md b/docs/models/CreateManifestLabelIdsRequestBody.md new file mode 100644 index 00000000..b1e35eb3 --- /dev/null +++ b/docs/models/CreateManifestLabelIdsRequestBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.CreateManifestLabelIdsRequestBody +A create manifest request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LabelIds** | **List<string>** | The list of label ids to include in the manifest | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateManifestRequestBody.md b/docs/models/CreateManifestRequestBody.md new file mode 100644 index 00000000..278ff30b --- /dev/null +++ b/docs/models/CreateManifestRequestBody.md @@ -0,0 +1,9 @@ +# ShipEngineSDK.Model.CreateManifestRequestBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateManifestResponseBody.md b/docs/models/CreateManifestResponseBody.md new file mode 100644 index 00000000..ac6abdc0 --- /dev/null +++ b/docs/models/CreateManifestResponseBody.md @@ -0,0 +1,24 @@ +# ShipEngineSDK.Model.CreateManifestResponseBody +A create manifest response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierId** | **string** | A string that uniquely identifies the carrier | +**CreatedAt** | **DateTimeOffset** | The date-time that the manifest was created | +**Errors** | [**List<Error>**](Error.md) | The errors associated with the failed API call | [readonly] +**FormId** | **string** | A string that uniquely identifies the form | +**ManifestDownload** | [**ManifestDownload**](ManifestDownload.md) | | +**ManifestId** | **string** | A string that uniquely identifies the manifest | +**RequestId** | **Guid** | A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur | +**ShipDate** | **DateTimeOffset** | The date-time that the manifests shipments will be picked up | +**Shipments** | **int** | The number of shipments that are included in this manifest | [readonly] +**SubmissionId** | **string** | A string that uniquely identifies the submission | +**WarehouseId** | **string** | A string that uniquely identifies the warehouse | +**LabelIds** | **List<string>** | An array of the label ids used in this manifest. | [optional] [readonly] +**ManifestRequests** | [**List<ManifestRequest>**](ManifestRequest.md) | Resulting manifest requests with statuses | [optional] +**Manifests** | [**List<Manifest>**](Manifest.md) | Resulting Manifests | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreatePackageTypeRequestBody.md b/docs/models/CreatePackageTypeRequestBody.md new file mode 100644 index 00000000..fba42ca1 --- /dev/null +++ b/docs/models/CreatePackageTypeRequestBody.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.CreatePackageTypeRequestBody +A create package type request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | | +**PackageCode** | **string** | A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. | +**Description** | **string** | Provides a helpful description for the custom package. | [optional] +**Dimensions** | [**Dimensions**](Dimensions.md) | The custom dimensions for the package. | [optional] +**PackageId** | **string** | A string that uniquely identifies the package. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreatePackageTypeResponseBody.md b/docs/models/CreatePackageTypeResponseBody.md new file mode 100644 index 00000000..c5486cb5 --- /dev/null +++ b/docs/models/CreatePackageTypeResponseBody.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.CreatePackageTypeResponseBody +A create package type response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | | +**PackageCode** | **string** | A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. | +**Description** | **string** | Provides a helpful description for the custom package. | [optional] +**Dimensions** | [**Dimensions**](Dimensions.md) | The custom dimensions for the package. | [optional] +**PackageId** | **string** | A string that uniquely identifies the package. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateReturnLabelRequestBody.md b/docs/models/CreateReturnLabelRequestBody.md new file mode 100644 index 00000000..51d06985 --- /dev/null +++ b/docs/models/CreateReturnLabelRequestBody.md @@ -0,0 +1,16 @@ +# ShipEngineSDK.Model.CreateReturnLabelRequestBody +A create return label request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ChargeEvent** | **LabelChargeEvent** | The label charge event. | [optional] +**DisplayScheme** | **DisplayScheme** | The display format that the label should be shown in. | [optional] +**LabelDownloadType** | **LabelDownloadType** | | [optional] +**LabelFormat** | **LabelFormat** | 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. | [optional] +**LabelImageId** | **string** | The label image resource that was used to create a custom label image. | [optional] +**LabelLayout** | **LabelLayout** | 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. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateReturnLabelResponseBody.md b/docs/models/CreateReturnLabelResponseBody.md new file mode 100644 index 00000000..e02fad2b --- /dev/null +++ b/docs/models/CreateReturnLabelResponseBody.md @@ -0,0 +1,49 @@ +# ShipEngineSDK.Model.CreateReturnLabelResponseBody +A create return label response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AlternativeIdentifiers** | [**List<AlternativeIdentifier>**](AlternativeIdentifier.md) | Additional information some carriers may provide by which to identify a given label in their system. | [optional] [readonly] +**BatchId** | **string** | If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. | [optional] [readonly] +**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] +**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] +**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. | [optional] [readonly] +**InsuranceCost** | [**MonetaryValue**](MonetaryValue.md) | The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. | [optional] [readonly] +**IsInternational** | **bool** | Indicates whether this is an international shipment. That is, the originating country and destination country are different. | [optional] [readonly] +**IsReturnLabel** | **bool** | Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. | [optional] +**LabelDownload** | [**LabelDownload**](LabelDownload.md) | | [optional] [readonly] +**LabelDownloadType** | **LabelDownloadType** | | [optional] +**LabelFormat** | **LabelFormat** | 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. | [optional] +**LabelId** | **string** | A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. | [optional] [readonly] +**LabelImageId** | **string** | The label image resource that was used to create a custom label image. | [optional] +**LabelLayout** | **LabelLayout** | 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. | [optional] +**OutboundLabelId** | **string** | The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. | [optional] +**PackageCode** | **string** | The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. | [optional] [readonly] +**Packages** | [**List<LabelPackagesInner>**](LabelPackagesInner.md) | The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. | [optional] [readonly] +**PaperlessDownload** | [**PaperlessDownload**](PaperlessDownload.md) | The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. | [optional] [readonly] +**RateDetails** | [**List<RateDetail>**](RateDetail.md) | A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. | [optional] [readonly] +**RequestedComparisonAmount** | [**MonetaryValue**](MonetaryValue.md) | The total shipping cost for the specified comparison_rate_type. | [optional] [readonly] +**RmaNumber** | **string** | An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. | [optional] +**ServiceCode** | **string** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | [optional] [readonly] +**ShipDate** | **DateTimeOffset** | The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | [optional] [readonly] +**Shipment** | [**Shipment**](Shipment.md) | The shipment information used to generate the label | [optional] +**ShipmentCost** | [**MonetaryValue**](MonetaryValue.md) | The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. | [optional] [readonly] +**ShipmentId** | **string** | The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) | [optional] [readonly] +**Status** | **LabelStatus** | | [optional] [readonly] +**TestLabel** | **bool** | Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. | [optional] [default to false] +**Trackable** | **bool** | Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. | [optional] [readonly] +**TrackingNumber** | **string** | The tracking number for the package. Tracking number formats vary across carriers. | [optional] [readonly] +**TrackingStatus** | **TrackingStatus** | The current status of the package, such as `in_transit` or `delivered` | [optional] [readonly] +**TrackingUrl** | **string** | The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. | [optional] [readonly] +**ValidateAddress** | **ValidateAddress** | | [optional] +**Voided** | **bool** | Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) | [optional] [readonly] +**VoidedAt** | **DateTimeOffset** | The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateShipmentResponseBodyFields.md b/docs/models/CreateShipmentResponseBodyFields.md new file mode 100644 index 00000000..12dfd4cf --- /dev/null +++ b/docs/models/CreateShipmentResponseBodyFields.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.CreateShipmentResponseBodyFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddressValidation** | [**AddressValidationResult**](AddressValidationResult.md) | The address validation | [optional] +**Errors** | **List<string>** | An array of errors that occurred while creating shipment. | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateShipmentsRequestBody.md b/docs/models/CreateShipmentsRequestBody.md new file mode 100644 index 00000000..1be3c9e7 --- /dev/null +++ b/docs/models/CreateShipmentsRequestBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.CreateShipmentsRequestBody +A create shipments request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Shipments** | [**List<AddressValidatingShipment>**](AddressValidatingShipment.md) | An array of shipments to be created. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateShipmentsResponseBody.md b/docs/models/CreateShipmentsResponseBody.md new file mode 100644 index 00000000..06a1a951 --- /dev/null +++ b/docs/models/CreateShipmentsResponseBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.CreateShipmentsResponseBody +A create shipments response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Shipments** | [**List<CreateAndValidateShipment>**](CreateAndValidateShipment.md) | An array of shipments that were created. | +**HasErrors** | **bool** | Indicates if errors occured while creating the shipments | [default to false] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateTagResponseBody.md b/docs/models/CreateTagResponseBody.md new file mode 100644 index 00000000..c31a5f6e --- /dev/null +++ b/docs/models/CreateTagResponseBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.CreateTagResponseBody +Response body for creating tags + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The tag name. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateWarehouseRequestBody.md b/docs/models/CreateWarehouseRequestBody.md new file mode 100644 index 00000000..05a66ad8 --- /dev/null +++ b/docs/models/CreateWarehouseRequestBody.md @@ -0,0 +1,16 @@ +# ShipEngineSDK.Model.CreateWarehouseRequestBody +A create warehouse request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Name of the warehouse | +**OriginAddress** | [**Address**](Address.md) | The origin address of the warehouse | +**CreatedAt** | **DateTimeOffset** | Timestamp that indicates when the warehouse was created | [optional] [readonly] +**IsDefault** | **bool** | Designates which single warehouse is the default on the account | [optional] [default to false] +**ReturnAddress** | [**Address**](Address.md) | The return address associated with the warehouse | [optional] +**WarehouseId** | **string** | A string that uniquely identifies the warehouse | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateWarehouseResponseBody.md b/docs/models/CreateWarehouseResponseBody.md new file mode 100644 index 00000000..1473ff52 --- /dev/null +++ b/docs/models/CreateWarehouseResponseBody.md @@ -0,0 +1,16 @@ +# ShipEngineSDK.Model.CreateWarehouseResponseBody +A create warehouse response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedAt** | **DateTimeOffset** | Timestamp that indicates when the warehouse was created | [readonly] +**Name** | **string** | Name of the warehouse | +**OriginAddress** | [**Address**](Address.md) | The origin address of the warehouse | +**ReturnAddress** | [**Address**](Address.md) | The return address associated with the warehouse | +**WarehouseId** | **string** | A string that uniquely identifies the warehouse | [readonly] +**IsDefault** | **bool** | Designates which single warehouse is the default on the account | [optional] [default to false] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateWebhookRequestBody.md b/docs/models/CreateWebhookRequestBody.md new file mode 100644 index 00000000..1d556bae --- /dev/null +++ b/docs/models/CreateWebhookRequestBody.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.CreateWebhookRequestBody +A create webhook request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Event** | **WebhookEvent** | | +**Url** | **string** | The url that the webhook sends the request to | +**Headers** | [**List<WebhookHeader>**](WebhookHeader.md) | Array of custom webhook headers | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CreateWebhookResponseBody.md b/docs/models/CreateWebhookResponseBody.md new file mode 100644 index 00000000..e0dff4a0 --- /dev/null +++ b/docs/models/CreateWebhookResponseBody.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.CreateWebhookResponseBody +A webhook response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Event** | **WebhookEvent** | | +**Url** | **string** | The url that the webhook sends the request to | +**WebhookId** | **string** | A string that uniquely identifies the webhook | [readonly] +**Headers** | [**List<WebhookHeader>**](WebhookHeader.md) | Array of custom webhook headers | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/CustomsItem.md b/docs/models/CustomsItem.md new file mode 100644 index 00000000..1ec4cdea --- /dev/null +++ b/docs/models/CustomsItem.md @@ -0,0 +1,21 @@ +# ShipEngineSDK.Model.CustomsItem +The customs declaration for a single item in the shipment. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomsItemId** | **string** | A string that uniquely identifies the customs item | [readonly] +**CountryOfOrigin** | **string** | The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated | [optional] +**Description** | **string** | A description of the item | [optional] +**HarmonizedTariffCode** | **string** | The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item. | [optional] +**Quantity** | **int** | The quantity of this item in the shipment. | [optional] [default to 0] +**Sku** | **string** | The SKU (Stock Keeping Unit) of the customs item | [optional] +**SkuDescription** | **string** | Description of the Custom Item's SKU | [optional] +**UnitOfMeasure** | **string** | | [optional] +**Value** | **decimal** | The monetary amount, in the specified currency. | [optional] +**ValueCurrency** | **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] +**Weight** | [**Weight**](Weight.md) | The item weight | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/DangerousAmount.md b/docs/models/DangerousAmount.md new file mode 100644 index 00000000..86226d6e --- /dev/null +++ b/docs/models/DangerousAmount.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.DangerousAmount +This model represents the amount of the dangerous goods.. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Amount** | **decimal** | The amount of dangerous goods. | [optional] [default to 0M] +**Unit** | **string** | The unit of dangerous goods. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/DangerousGoods.md b/docs/models/DangerousGoods.md new file mode 100644 index 00000000..c2acbbf5 --- /dev/null +++ b/docs/models/DangerousGoods.md @@ -0,0 +1,29 @@ +# ShipEngineSDK.Model.DangerousGoods +Dangerous goods attribute associated with the product + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AdditionalDescription** | **string** | Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier | [optional] +**DangerousAmount** | [**DangerousAmount**](DangerousAmount.md) | This model represents the amount of the dangerous goods. | [optional] +**IdNumber** | **string** | UN number to identify the dangerous goods. | [optional] +**PackagingGroup** | **PackagingGroup** | | [optional] +**PackagingInstruction** | **string** | The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container. | [optional] +**PackagingInstructionSection** | **PackagingInstructionSection** | | [optional] +**PackagingType** | **string** | The type of exterior packaging used to contain the dangerous good. | [optional] +**ProductClass** | **string** | Dangerous goods product class based on regulation. | [optional] +**ProductClassSubsidiary** | **string** | A secondary of product class for substances presenting more than one particular hazard | [optional] +**Quantity** | **int** | Quantity of dangerous goods. | [optional] [default to 0] +**Radioactive** | **bool** | Indication if the substance is radioactive. | [optional] +**RegulationAuthority** | **string** | Name of the regulatory authority. | [optional] +**RegulationLevel** | **RegulationLevel** | | [optional] +**ReportableQuantity** | **bool** | Indication if the substance needs to be reported to regulatory authority based on the quantity. | [optional] +**ShippingName** | **string** | Trade description of the dangerous goods. | [optional] +**TechnicalName** | **string** | Recognized Technical or chemical name of dangerous goods. | [optional] +**TransportCategory** | **string** | Transport category assign to dangerous goods for the transport purpose. | [optional] +**TransportMean** | **TransportMean** | | [optional] +**TunnelCode** | **string** | Defines which types of tunnels the shipment is allowed to go through | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/DefaultLabelLayout.md b/docs/models/DefaultLabelLayout.md new file mode 100644 index 00000000..adfb8a6e --- /dev/null +++ b/docs/models/DefaultLabelLayout.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.DefaultLabelLayout +The possible default label layout values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/DeletePickupByIdResponseBody.md b/docs/models/DeletePickupByIdResponseBody.md new file mode 100644 index 00000000..9a3f412d --- /dev/null +++ b/docs/models/DeletePickupByIdResponseBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.DeletePickupByIdResponseBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Errors** | [**List<Error>**](Error.md) | The errors associated with the failed API call | [readonly] +**PickupId** | **string** | Pickup Resource ID | +**RequestId** | **Guid** | A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/DeleteScheduledPickupResponseBody.md b/docs/models/DeleteScheduledPickupResponseBody.md new file mode 100644 index 00000000..27a45f0d --- /dev/null +++ b/docs/models/DeleteScheduledPickupResponseBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.DeleteScheduledPickupResponseBody +A delete scheduled pickup response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PickupId** | **string** | Pickup Resource ID | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/DeliveryConfirmation.md b/docs/models/DeliveryConfirmation.md new file mode 100644 index 00000000..59faf7eb --- /dev/null +++ b/docs/models/DeliveryConfirmation.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.DeliveryConfirmation +The possible delivery confirmation values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/DeprecatedManifest.md b/docs/models/DeprecatedManifest.md new file mode 100644 index 00000000..fed530cf --- /dev/null +++ b/docs/models/DeprecatedManifest.md @@ -0,0 +1,20 @@ +# ShipEngineSDK.Model.DeprecatedManifest +Deprecated manifest resource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierId** | **string** | A string that uniquely identifies the carrier | [optional] +**CreatedAt** | **DateTimeOffset** | The date-time that the manifest was created | [optional] +**FormId** | **string** | A string that uniquely identifies the form | [optional] +**LabelIds** | **List<string>** | An array of the label ids used in this manifest. | [optional] [readonly] +**ManifestDownload** | [**ManifestDownload**](ManifestDownload.md) | | [optional] +**ManifestId** | **string** | A string that uniquely identifies the manifest | [optional] +**ShipDate** | **DateTimeOffset** | The date-time that the manifests shipments will be picked up | [optional] +**Shipments** | **int** | The number of shipments that are included in this manifest | [optional] [readonly] +**SubmissionId** | **string** | A string that uniquely identifies the submission | [optional] +**WarehouseId** | **string** | A string that uniquely identifies the warehouse | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/DhlExpressAccountSettings.md b/docs/models/DhlExpressAccountSettings.md new file mode 100644 index 00000000..51ff150a --- /dev/null +++ b/docs/models/DhlExpressAccountSettings.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.DhlExpressAccountSettings +A DHL Express account settings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsPrimaryAccount** | **bool** | Indicates if this is primary account | [optional] +**Nickname** | **string** | Account nickname | [optional] +**ShouldHideAccountNumberOnArchiveDoc** | **bool** | Indicates if the account number should be hidden on the archive documentation | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/DhlExpressSettingsResponseBody.md b/docs/models/DhlExpressSettingsResponseBody.md new file mode 100644 index 00000000..b808b2c2 --- /dev/null +++ b/docs/models/DhlExpressSettingsResponseBody.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.DhlExpressSettingsResponseBody +A DHL Express response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsPrimaryAccount** | **bool** | Indicates if this is primary account | [optional] +**Nickname** | **string** | Account nickname | [optional] +**ShouldHideAccountNumberOnArchiveDoc** | **bool** | Indicates if the account number should be hidden on the archive documentation | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/DimensionUnit.md b/docs/models/DimensionUnit.md new file mode 100644 index 00000000..41cce7fd --- /dev/null +++ b/docs/models/DimensionUnit.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.DimensionUnit +The dimension units that are supported by ShipEngine. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Dimensions.md b/docs/models/Dimensions.md new file mode 100644 index 00000000..b43ab138 --- /dev/null +++ b/docs/models/Dimensions.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.Dimensions +The dimensions of a package + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Unit** | **DimensionUnit** | | +**Height** | **decimal** | The height of the package, in the specified unit | [default to 0M] +**Length** | **decimal** | The length of the package, in the specified unit | [default to 0M] +**Width** | **decimal** | The width of the package, in the specified unit | [default to 0M] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/DisplayScheme.md b/docs/models/DisplayScheme.md new file mode 100644 index 00000000..02a3a037 --- /dev/null +++ b/docs/models/DisplayScheme.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.DisplayScheme +The display format that the label should be shown in. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Error.md b/docs/models/Error.md new file mode 100644 index 00000000..1654a873 --- /dev/null +++ b/docs/models/Error.md @@ -0,0 +1,17 @@ +# ShipEngineSDK.Model.Error +The error structure that gets returned with almost all failed API calls + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ErrorCode** | **ErrorCode** | | +**ErrorSource** | **ErrorSource** | | +**ErrorType** | **ErrorType** | | +**Message** | **string** | An error message associated with the failed API call | [readonly] +**CarrierCode** | **string** | The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc. | [optional] [readonly] +**CarrierId** | **string** | A string that uniquely identifies the carrier that generated the error. | [optional] [readonly] +**FieldName** | **string** | The name of the field that caused the error | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ErrorCode.md b/docs/models/ErrorCode.md new file mode 100644 index 00000000..448fbeb3 --- /dev/null +++ b/docs/models/ErrorCode.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.ErrorCode +The error code specified for the failed API Call + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ErrorResponseBody.md b/docs/models/ErrorResponseBody.md new file mode 100644 index 00000000..5aa4eb43 --- /dev/null +++ b/docs/models/ErrorResponseBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.ErrorResponseBody +An error response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Errors** | [**List<Error>**](Error.md) | The errors associated with the failed API call | [readonly] +**RequestId** | **Guid** | A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ErrorSource.md b/docs/models/ErrorSource.md new file mode 100644 index 00000000..960cfc2e --- /dev/null +++ b/docs/models/ErrorSource.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.ErrorSource +The source of the error, as indicated by the name this informs us if the API call failed because of the carrier, the order source, or the ShipEngine API itself. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ErrorType.md b/docs/models/ErrorType.md new file mode 100644 index 00000000..640606f3 --- /dev/null +++ b/docs/models/ErrorType.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.ErrorType +The type of error + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ErrorWithLabelIdResponseBody.md b/docs/models/ErrorWithLabelIdResponseBody.md new file mode 100644 index 00000000..c5ac2ef3 --- /dev/null +++ b/docs/models/ErrorWithLabelIdResponseBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.ErrorWithLabelIdResponseBody +An error response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Errors** | [**List<Error>**](Error.md) | The errors associated with the failed API call | [readonly] +**RequestId** | **Guid** | A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/EstimateRatesRequestBody.md b/docs/models/EstimateRatesRequestBody.md new file mode 100644 index 00000000..e068ab33 --- /dev/null +++ b/docs/models/EstimateRatesRequestBody.md @@ -0,0 +1,23 @@ +# ShipEngineSDK.Model.EstimateRatesRequestBody +A rate estimate request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FromCityLocality** | **string** | from postal code | +**FromCountryCode** | **string** | A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) | +**FromPostalCode** | **string** | postal code | +**FromStateProvince** | **string** | From state province | +**ShipDate** | **DateTimeOffset** | ship date | +**ToCityLocality** | **string** | The city locality the package is being shipped to | +**ToCountryCode** | **string** | A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) | +**ToPostalCode** | **string** | postal code | +**ToStateProvince** | **string** | To state province | +**Weight** | [**Weight**](Weight.md) | The weight of the package | +**AddressResidentialIndicator** | **AddressResidentialIndicator** | | [optional] +**Confirmation** | **DeliveryConfirmation** | | [optional] +**Dimensions** | [**Dimensions**](Dimensions.md) | The dimensions of the package | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/FedexAccountSettings.md b/docs/models/FedexAccountSettings.md new file mode 100644 index 00000000..8d1df898 --- /dev/null +++ b/docs/models/FedexAccountSettings.md @@ -0,0 +1,17 @@ +# ShipEngineSDK.Model.FedexAccountSettings +A Fedex account settings request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsPrimaryAccount** | **bool** | | [optional] +**LetterheadImage** | **string** | | [optional] +**Nickname** | **string** | Account nickname | [optional] +**PickupType** | **FedexPickupType** | | [optional] +**SignatureImage** | **string** | | [optional] +**SmartPostEndorsement** | **AncillaryServiceEndorsement** | | [optional] +**SmartPostHub** | **SmartPostHub** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/FedexAccountSettingsRequestBody.md b/docs/models/FedexAccountSettingsRequestBody.md new file mode 100644 index 00000000..5b32ee65 --- /dev/null +++ b/docs/models/FedexAccountSettingsRequestBody.md @@ -0,0 +1,17 @@ +# ShipEngineSDK.Model.FedexAccountSettingsRequestBody +A Fedex account settings request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsPrimaryAccount** | **bool** | | [optional] +**LetterheadImage** | **string** | | [optional] +**Nickname** | **string** | Account nickname | [optional] +**PickupType** | **FedexPickupType** | | [optional] +**SignatureImage** | **string** | | [optional] +**SmartPostEndorsement** | **AncillaryServiceEndorsement** | | [optional] +**SmartPostHub** | **SmartPostHub** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/FedexPickupType.md b/docs/models/FedexPickupType.md new file mode 100644 index 00000000..73b38180 --- /dev/null +++ b/docs/models/FedexPickupType.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.FedexPickupType +Tax identifier type for customs declaration |Pickup Type |Description |- -- -- -- -- -- -- -- -- -- -- -- -- -|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`none` | Not specified |`regular_pickup` | You already have a daily pickup scheduled with FedEx |`request_courier` | You will call FedEx to request a courier |`drop_box` | You will drop-off packages in a FedEx drop box |`business_service_center` | You will drop-off packages at an authorized FedEx business service center |`station` | You will drop-off the package at a FedEx Station + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/FedexSettingsResponseBody.md b/docs/models/FedexSettingsResponseBody.md new file mode 100644 index 00000000..b785a759 --- /dev/null +++ b/docs/models/FedexSettingsResponseBody.md @@ -0,0 +1,17 @@ +# ShipEngineSDK.Model.FedexSettingsResponseBody +A Fedex settings response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsPrimaryAccount** | **bool** | | [optional] +**LetterheadImage** | **string** | | [optional] +**Nickname** | **string** | Account nickname | [optional] +**PickupType** | **FedexPickupType** | | [optional] +**SignatureImage** | **string** | | [optional] +**SmartPostEndorsement** | **AncillaryServiceEndorsement** | | [optional] +**SmartPostHub** | **SmartPostHub** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetAccountSettingsImagesResponseBody.md b/docs/models/GetAccountSettingsImagesResponseBody.md new file mode 100644 index 00000000..d7732ffd --- /dev/null +++ b/docs/models/GetAccountSettingsImagesResponseBody.md @@ -0,0 +1,17 @@ +# ShipEngineSDK.Model.GetAccountSettingsImagesResponseBody +A get account images by id response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedAt** | **DateTimeOffset** | The date and time that the image was created in ShipEngine. | [optional] [readonly] +**ImageContentType** | **string** | The image type | [optional] +**ImageData** | **string** | A base64 encoded string representation of the image. | [optional] +**IsDefault** | **bool** | Indicates whether this image is set as default. | [optional] +**LabelImageId** | **string** | A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. | [optional] [readonly] +**ModifiedAt** | **DateTimeOffset** | The date and time that the image was modified in ShipEngine. | [optional] [readonly] +**Name** | **string** | A human readable name for the image. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetAccountSettingsResponseBody.md b/docs/models/GetAccountSettingsResponseBody.md new file mode 100644 index 00000000..c9656e10 --- /dev/null +++ b/docs/models/GetAccountSettingsResponseBody.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.GetAccountSettingsResponseBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DefaultLabelLayout** | **DefaultLabelLayout** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetBatchByExternalIdResponseBody.md b/docs/models/GetBatchByExternalIdResponseBody.md new file mode 100644 index 00000000..aa8eff33 --- /dev/null +++ b/docs/models/GetBatchByExternalIdResponseBody.md @@ -0,0 +1,31 @@ +# ShipEngineSDK.Model.GetBatchByExternalIdResponseBody +A get batch by external id response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchErrorsUrl** | [**OptionalLink**](OptionalLink.md) | Link to batch errors endpoint | [readonly] +**BatchId** | **string** | A string that uniquely identifies the batch | [readonly] +**BatchLabelsUrl** | [**OptionalLink**](OptionalLink.md) | Link to batch labels query | +**BatchNumber** | **string** | The batch number. | [readonly] +**BatchShipmentsUrl** | [**OptionalLink**](OptionalLink.md) | The batch shipments endpoint | +**Completed** | **int** | The number of labels generated in the batch | [readonly] +**Count** | **int** | The total of errors, warnings, and completed properties | [readonly] +**CreatedAt** | **DateTimeOffset** | The date and time the batch was created in ShipEngine | [readonly] +**Errors** | **int** | The number of errors that occurred while generating the batch | [readonly] +**FormDownload** | [**OptionalLink**](OptionalLink.md) | The form download for any customs that are needed | [readonly] +**Forms** | **int** | The number of forms for customs that are available for download | [readonly] +**LabelDownload** | [**LabelDownload**](LabelDownload.md) | The label download for the batch | [readonly] +**LabelFormat** | **LabelFormat** | | [readonly] +**LabelLayout** | **LabelLayout** | label layout | [readonly] +**PaperlessDownload** | [**PaperlessDownload**](PaperlessDownload.md) | The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. | [readonly] +**ProcessErrors** | [**List<Error>**](Error.md) | The errors associated with the failed API call | [readonly] +**Status** | **BatchStatus** | | [readonly] +**Warnings** | **int** | The number of warnings that occurred while generating the batch | [readonly] +**BatchNotes** | **string** | Custom notes you can add for each created batch | [readonly] [default to ""] +**ExternalBatchId** | **string** | A string that uniquely identifies the external batch | [readonly] +**ProcessedAt** | **DateTimeOffset** | The date and time the batch was processed in ShipEngine | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetBatchByIdResponseBody.md b/docs/models/GetBatchByIdResponseBody.md new file mode 100644 index 00000000..67d54d49 --- /dev/null +++ b/docs/models/GetBatchByIdResponseBody.md @@ -0,0 +1,31 @@ +# ShipEngineSDK.Model.GetBatchByIdResponseBody +A get batch by id response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchErrorsUrl** | [**OptionalLink**](OptionalLink.md) | Link to batch errors endpoint | [readonly] +**BatchId** | **string** | A string that uniquely identifies the batch | [readonly] +**BatchLabelsUrl** | [**OptionalLink**](OptionalLink.md) | Link to batch labels query | +**BatchNumber** | **string** | The batch number. | [readonly] +**BatchShipmentsUrl** | [**OptionalLink**](OptionalLink.md) | The batch shipments endpoint | +**Completed** | **int** | The number of labels generated in the batch | [readonly] +**Count** | **int** | The total of errors, warnings, and completed properties | [readonly] +**CreatedAt** | **DateTimeOffset** | The date and time the batch was created in ShipEngine | [readonly] +**Errors** | **int** | The number of errors that occurred while generating the batch | [readonly] +**FormDownload** | [**OptionalLink**](OptionalLink.md) | The form download for any customs that are needed | [readonly] +**Forms** | **int** | The number of forms for customs that are available for download | [readonly] +**LabelDownload** | [**LabelDownload**](LabelDownload.md) | The label download for the batch | [readonly] +**LabelFormat** | **LabelFormat** | | [readonly] +**LabelLayout** | **LabelLayout** | label layout | [readonly] +**PaperlessDownload** | [**PaperlessDownload**](PaperlessDownload.md) | The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. | [readonly] +**ProcessErrors** | [**List<Error>**](Error.md) | The errors associated with the failed API call | [readonly] +**Status** | **BatchStatus** | | [readonly] +**Warnings** | **int** | The number of warnings that occurred while generating the batch | [readonly] +**BatchNotes** | **string** | Custom notes you can add for each created batch | [readonly] [default to ""] +**ExternalBatchId** | **string** | A string that uniquely identifies the external batch | [readonly] +**ProcessedAt** | **DateTimeOffset** | The date and time the batch was processed in ShipEngine | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetCarrierByIdResponseBody.md b/docs/models/GetCarrierByIdResponseBody.md new file mode 100644 index 00000000..b48cab12 --- /dev/null +++ b/docs/models/GetCarrierByIdResponseBody.md @@ -0,0 +1,25 @@ +# ShipEngineSDK.Model.GetCarrierByIdResponseBody +A get carrier by id response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountNumber** | **string** | The account number that the carrier is connected to. | [optional] [readonly] +**Balance** | **decimal** | Current available balance | [optional] [readonly] +**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** | A string that uniquely identifies the carrier. | [optional] [readonly] +**DisabledByBillingPlan** | **bool** | The carrier is disabled by the current ShipEngine account's billing plan. | [optional] [readonly] +**FriendlyName** | **string** | Screen readable name | [optional] [readonly] +**FundingSourceId** | **string** | Funding source ID for the carrier | [optional] [readonly] +**HasMultiPackageSupportingServices** | **bool** | Carrier supports multiple packages per shipment | [optional] [readonly] +**Nickname** | **string** | Nickname given to the account when initially setting up the carrier. | [optional] [readonly] +**Options** | [**List<CarrierAdvancedOption>**](CarrierAdvancedOption.md) | A list of options that are available to that carrier | [optional] [readonly] +**Packages** | [**List<PackageType>**](PackageType.md) | A list of package types that are supported by the carrier | [optional] [readonly] +**Primary** | **bool** | Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation | [optional] [readonly] +**RequiresFundedAmount** | **bool** | Indicates whether the carrier requires funding to use its services | [optional] [readonly] +**Services** | [**List<Service>**](Service.md) | A list of services that are offered by the carrier | [optional] [readonly] +**SupportsLabelMessages** | **bool** | The carrier supports adding custom label messages to an order. | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetCarrierOptionsResponseBody.md b/docs/models/GetCarrierOptionsResponseBody.md new file mode 100644 index 00000000..99a4c144 --- /dev/null +++ b/docs/models/GetCarrierOptionsResponseBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.GetCarrierOptionsResponseBody +A carrier list options response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Options** | [**List<CarrierAdvancedOption>**](CarrierAdvancedOption.md) | AN array of carrier options | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetCarrierSettingsResponseBody.md b/docs/models/GetCarrierSettingsResponseBody.md new file mode 100644 index 00000000..db8e4c60 --- /dev/null +++ b/docs/models/GetCarrierSettingsResponseBody.md @@ -0,0 +1,9 @@ +# ShipEngineSDK.Model.GetCarrierSettingsResponseBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetCarriersResponseBody.md b/docs/models/GetCarriersResponseBody.md new file mode 100644 index 00000000..c49ca53a --- /dev/null +++ b/docs/models/GetCarriersResponseBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.GetCarriersResponseBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Carriers** | [**List<Carrier>**](Carrier.md) | The carrier response body | [readonly] +**Errors** | [**List<Error>**](Error.md) | The errors associated with the failed API call | [readonly] +**RequestId** | **Guid** | A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetInsuranceBalanceResponseBody.md b/docs/models/GetInsuranceBalanceResponseBody.md new file mode 100644 index 00000000..290135fe --- /dev/null +++ b/docs/models/GetInsuranceBalanceResponseBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.GetInsuranceBalanceResponseBody +A get insurance balance response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Amount** | **decimal** | The monetary amount, in the specified currency. | +**Currency** | **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 | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetLabelByExternalShipmentIdResponseBody.md b/docs/models/GetLabelByExternalShipmentIdResponseBody.md new file mode 100644 index 00000000..8d6a57ab --- /dev/null +++ b/docs/models/GetLabelByExternalShipmentIdResponseBody.md @@ -0,0 +1,49 @@ +# ShipEngineSDK.Model.GetLabelByExternalShipmentIdResponseBody +A get label by external shipment id response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AlternativeIdentifiers** | [**List<AlternativeIdentifier>**](AlternativeIdentifier.md) | Additional information some carriers may provide by which to identify a given label in their system. | [optional] [readonly] +**BatchId** | **string** | If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. | [optional] [readonly] +**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] +**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] +**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. | [optional] [readonly] +**InsuranceCost** | [**MonetaryValue**](MonetaryValue.md) | The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. | [optional] [readonly] +**IsInternational** | **bool** | Indicates whether this is an international shipment. That is, the originating country and destination country are different. | [optional] [readonly] +**IsReturnLabel** | **bool** | Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. | [optional] +**LabelDownload** | [**LabelDownload**](LabelDownload.md) | | [optional] [readonly] +**LabelDownloadType** | **LabelDownloadType** | | [optional] +**LabelFormat** | **LabelFormat** | 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. | [optional] +**LabelId** | **string** | A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. | [optional] [readonly] +**LabelImageId** | **string** | The label image resource that was used to create a custom label image. | [optional] +**LabelLayout** | **LabelLayout** | 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. | [optional] +**OutboundLabelId** | **string** | The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. | [optional] +**PackageCode** | **string** | The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. | [optional] [readonly] +**Packages** | [**List<LabelPackagesInner>**](LabelPackagesInner.md) | The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. | [optional] [readonly] +**PaperlessDownload** | [**PaperlessDownload**](PaperlessDownload.md) | The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. | [optional] [readonly] +**RateDetails** | [**List<RateDetail>**](RateDetail.md) | A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. | [optional] [readonly] +**RequestedComparisonAmount** | [**MonetaryValue**](MonetaryValue.md) | The total shipping cost for the specified comparison_rate_type. | [optional] [readonly] +**RmaNumber** | **string** | An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. | [optional] +**ServiceCode** | **string** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | [optional] [readonly] +**ShipDate** | **DateTimeOffset** | The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | [optional] [readonly] +**Shipment** | [**Shipment**](Shipment.md) | The shipment information used to generate the label | [optional] +**ShipmentCost** | [**MonetaryValue**](MonetaryValue.md) | The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. | [optional] [readonly] +**ShipmentId** | **string** | The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) | [optional] [readonly] +**Status** | **LabelStatus** | | [optional] [readonly] +**TestLabel** | **bool** | Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. | [optional] [default to false] +**Trackable** | **bool** | Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. | [optional] [readonly] +**TrackingNumber** | **string** | The tracking number for the package. Tracking number formats vary across carriers. | [optional] [readonly] +**TrackingStatus** | **TrackingStatus** | The current status of the package, such as `in_transit` or `delivered` | [optional] [readonly] +**TrackingUrl** | **string** | The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. | [optional] [readonly] +**ValidateAddress** | **ValidateAddress** | | [optional] +**Voided** | **bool** | Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) | [optional] [readonly] +**VoidedAt** | **DateTimeOffset** | The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetLabelByIdResponseBody.md b/docs/models/GetLabelByIdResponseBody.md new file mode 100644 index 00000000..1f08c551 --- /dev/null +++ b/docs/models/GetLabelByIdResponseBody.md @@ -0,0 +1,49 @@ +# ShipEngineSDK.Model.GetLabelByIdResponseBody +A get label by id response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AlternativeIdentifiers** | [**List<AlternativeIdentifier>**](AlternativeIdentifier.md) | Additional information some carriers may provide by which to identify a given label in their system. | [optional] [readonly] +**BatchId** | **string** | If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. | [optional] [readonly] +**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] +**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] +**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. | [optional] [readonly] +**InsuranceCost** | [**MonetaryValue**](MonetaryValue.md) | The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. | [optional] [readonly] +**IsInternational** | **bool** | Indicates whether this is an international shipment. That is, the originating country and destination country are different. | [optional] [readonly] +**IsReturnLabel** | **bool** | Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. | [optional] +**LabelDownload** | [**LabelDownload**](LabelDownload.md) | | [optional] [readonly] +**LabelDownloadType** | **LabelDownloadType** | | [optional] +**LabelFormat** | **LabelFormat** | 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. | [optional] +**LabelId** | **string** | A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. | [optional] [readonly] +**LabelImageId** | **string** | The label image resource that was used to create a custom label image. | [optional] +**LabelLayout** | **LabelLayout** | 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. | [optional] +**OutboundLabelId** | **string** | The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. | [optional] +**PackageCode** | **string** | The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. | [optional] [readonly] +**Packages** | [**List<LabelPackagesInner>**](LabelPackagesInner.md) | The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. | [optional] [readonly] +**PaperlessDownload** | [**PaperlessDownload**](PaperlessDownload.md) | The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. | [optional] [readonly] +**RateDetails** | [**List<RateDetail>**](RateDetail.md) | A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. | [optional] [readonly] +**RequestedComparisonAmount** | [**MonetaryValue**](MonetaryValue.md) | The total shipping cost for the specified comparison_rate_type. | [optional] [readonly] +**RmaNumber** | **string** | An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. | [optional] +**ServiceCode** | **string** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | [optional] [readonly] +**ShipDate** | **DateTimeOffset** | The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | [optional] [readonly] +**Shipment** | [**Shipment**](Shipment.md) | The shipment information used to generate the label | [optional] +**ShipmentCost** | [**MonetaryValue**](MonetaryValue.md) | The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. | [optional] [readonly] +**ShipmentId** | **string** | The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) | [optional] [readonly] +**Status** | **LabelStatus** | | [optional] [readonly] +**TestLabel** | **bool** | Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. | [optional] [default to false] +**Trackable** | **bool** | Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. | [optional] [readonly] +**TrackingNumber** | **string** | The tracking number for the package. Tracking number formats vary across carriers. | [optional] [readonly] +**TrackingStatus** | **TrackingStatus** | The current status of the package, such as `in_transit` or `delivered` | [optional] [readonly] +**TrackingUrl** | **string** | The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. | [optional] [readonly] +**ValidateAddress** | **ValidateAddress** | | [optional] +**Voided** | **bool** | Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) | [optional] [readonly] +**VoidedAt** | **DateTimeOffset** | The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetManifestByIdResponseBody.md b/docs/models/GetManifestByIdResponseBody.md new file mode 100644 index 00000000..fd2c7b22 --- /dev/null +++ b/docs/models/GetManifestByIdResponseBody.md @@ -0,0 +1,20 @@ +# ShipEngineSDK.Model.GetManifestByIdResponseBody +A get manifest by id response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierId** | **string** | A string that uniquely identifies the carrier | [readonly] +**CreatedAt** | **DateTimeOffset** | The date-time that the manifest was created | [readonly] +**FormId** | **string** | A string that uniquely identifies the form | [readonly] +**LabelIds** | **List<string>** | An array of the label ids used in this manifest. | [readonly] +**ManifestDownload** | [**ManifestDownload**](ManifestDownload.md) | | [readonly] +**ManifestId** | **string** | A string that uniquely identifies the manifest | [readonly] +**ShipDate** | **DateTimeOffset** | The date-time that the manifests shipments will be picked up | [readonly] +**Shipments** | **int** | The number of shipments that are included in this manifest | [readonly] +**SubmissionId** | **string** | A string that uniquely identifies the submission | [readonly] +**WarehouseId** | **string** | A string that uniquely identifies the warehouse | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetPackageTypeByIdResponseBody.md b/docs/models/GetPackageTypeByIdResponseBody.md new file mode 100644 index 00000000..17c6dc0e --- /dev/null +++ b/docs/models/GetPackageTypeByIdResponseBody.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.GetPackageTypeByIdResponseBody +A get package type by id response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | | +**PackageCode** | **string** | A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. | +**Description** | **string** | Provides a helpful description for the custom package. | [optional] +**Dimensions** | [**Dimensions**](Dimensions.md) | The custom dimensions for the package. | [optional] +**PackageId** | **string** | A string that uniquely identifies the package. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetPickupByIdResponseBody.md b/docs/models/GetPickupByIdResponseBody.md new file mode 100644 index 00000000..ca65d186 --- /dev/null +++ b/docs/models/GetPickupByIdResponseBody.md @@ -0,0 +1,23 @@ +# ShipEngineSDK.Model.GetPickupByIdResponseBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierId** | **string** | The carrier_id associated with the pickup | [readonly] +**ContactDetails** | [**ContactDetails**](ContactDetails.md) | | +**CreatedAt** | **DateTimeOffset** | The date and time that the pickup was created in ShipEngine. | [readonly] +**Errors** | [**List<Error>**](Error.md) | The errors associated with the failed API call | [readonly] +**LabelIds** | **List<string>** | Label IDs that will be included in the pickup request | +**PickupAddress** | [**Address**](Address.md) | | [readonly] +**PickupId** | **string** | Pickup Resource ID | [readonly] +**PickupWindow** | [**PickupWindow**](PickupWindow.md) | | +**RequestId** | **Guid** | A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur | +**WarehouseId** | **string** | The warehouse_id associated with the pickup | [readonly] +**CancelledAt** | **DateTimeOffset** | The date and time that the pickup was cancelled in ShipEngine. | [optional] [readonly] +**ConfirmationNumber** | **string** | The carrier confirmation number for the scheduled pickup. | [readonly] +**PickupNotes** | **string** | Used by some carriers to give special instructions for a package pickup | [optional] +**PickupWindows** | [**List<PickupWindows>**](PickupWindows.md) | An array of available pickup windows. Carriers can return multiple times that they will pickup packages. | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetPickupsResponseBody.md b/docs/models/GetPickupsResponseBody.md new file mode 100644 index 00000000..33b36fff --- /dev/null +++ b/docs/models/GetPickupsResponseBody.md @@ -0,0 +1,16 @@ +# ShipEngineSDK.Model.GetPickupsResponseBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Errors** | [**List<Error>**](Error.md) | The errors associated with the failed API call | [readonly] +**Links** | [**PaginationLink**](PaginationLink.md) | Helpful links to other pages of results | [readonly] +**Page** | **int** | Current page of the list pickups results | [readonly] +**Pages** | **int** | Total number of pages for list pickups results | [readonly] +**Pickups** | [**List<Pickup>**](Pickup.md) | An array of pickups associated with the user's account. | +**RequestId** | **Guid** | A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur | +**Total** | **long** | The total number of pickups returned | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetRateByIdResponseBody.md b/docs/models/GetRateByIdResponseBody.md new file mode 100644 index 00000000..40d4904f --- /dev/null +++ b/docs/models/GetRateByIdResponseBody.md @@ -0,0 +1,37 @@ +# ShipEngineSDK.Model.GetRateByIdResponseBody +A rate response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierCode** | **string** | carrier code | [readonly] +**CarrierFriendlyName** | **string** | carrier friendly name | [readonly] +**CarrierId** | **string** | A string that uniquely identifies the carrier | [readonly] +**CarrierNickname** | **string** | carrier nickname | [readonly] +**ConfirmationAmount** | [**MonetaryValue**](MonetaryValue.md) | The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price. | [readonly] +**ErrorMessages** | **List<string>** | The error messages | [readonly] +**GuaranteedService** | **bool** | Indicates if the rate is guaranteed. | [readonly] +**InsuranceAmount** | [**MonetaryValue**](MonetaryValue.md) | The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. | [readonly] +**NegotiatedRate** | **bool** | Indicates if the rates been negotiated | [readonly] +**OtherAmount** | [**MonetaryValue**](MonetaryValue.md) | Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. | [readonly] +**RateId** | **string** | A string that uniquely identifies the rate | [readonly] +**RateType** | **RateType** | | [readonly] +**ServiceCode** | **string** | service code for the rate | [readonly] +**ServiceType** | **string** | service type | [readonly] +**ShippingAmount** | [**MonetaryValue**](MonetaryValue.md) | The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. | [readonly] +**Trackable** | **bool** | Indicates if rate is trackable | [readonly] +**ValidationStatus** | **ValidationStatus** | | [readonly] +**WarningMessages** | **List<string>** | The warning messages | [readonly] +**CarrierDeliveryDays** | **string** | The carrier delivery days | [optional] [readonly] +**DeliveryDays** | **int** | The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday | [optional] [readonly] +**EstimatedDeliveryDate** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. | [optional] [readonly] +**PackageType** | **string** | package type that this rate was estimated for | [readonly] +**RateDetails** | [**List<RateDetail>**](RateDetail.md) | A list of rate details that are associated with this rate. This is useful for displaying a breakdown of the rate to the user. | [optional] [readonly] +**RequestedComparisonAmount** | [**MonetaryValue**](MonetaryValue.md) | The total shipping cost for the specified comparison_rate_type. | [optional] [readonly] +**ShipDate** | **DateTimeOffset** | ship date | [optional] [readonly] +**TaxAmount** | [**MonetaryValue**](MonetaryValue.md) | Tariff and additional taxes associated with an international shipment. | [optional] [readonly] +**Zone** | **int** | Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetServicePointByIdResponseBody.md b/docs/models/GetServicePointByIdResponseBody.md new file mode 100644 index 00000000..8ebe9953 --- /dev/null +++ b/docs/models/GetServicePointByIdResponseBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.GetServicePointByIdResponseBody +A get service point by ID response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ServicePoint** | [**GetServicePointByIdResponseBodyServicePoint**](GetServicePointByIdResponseBodyServicePoint.md) | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetServicePointByIdResponseBodyServicePoint.md b/docs/models/GetServicePointByIdResponseBodyServicePoint.md new file mode 100644 index 00000000..616d5d2c --- /dev/null +++ b/docs/models/GetServicePointByIdResponseBodyServicePoint.md @@ -0,0 +1,24 @@ +# ShipEngineSDK.Model.GetServicePointByIdResponseBodyServicePoint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddressLine1** | **string** | The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. | [optional] +**CarrierCode** | **string** | A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. | [optional] +**CityLocality** | **string** | The name of the city or locality | [optional] +**CompanyName** | **string** | If this is a business address, then the company name should be specified here. | [optional] +**CountryCode** | **string** | A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) | [optional] +**Features** | **List<GetServicePointByIdResponseBodyServicePoint.FeaturesEnum>** | Service features | [optional] +**HoursOfOperation** | [**ListServicePointsResponseBodyServicePointsInnerHoursOfOperation**](ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.md) | | [optional] +**Lat** | **double** | The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html | [optional] +**Long** | **double** | The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html | [optional] +**PhoneNumber** | **string** | Phone number associated | [optional] +**PostalCode** | **string** | postal code | [optional] +**ServiceCodes** | **List<string>** | | [optional] +**ServicePointId** | **string** | A unique identifier for a carrier drop off point. | [optional] +**StateProvince** | **string** | The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. | [optional] +**Type** | **string** | Service point type | [optional] [default to TypeEnum.Pudo] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetServicePointsRequest.md b/docs/models/GetServicePointsRequest.md new file mode 100644 index 00000000..0851ff1d --- /dev/null +++ b/docs/models/GetServicePointsRequest.md @@ -0,0 +1,9 @@ +# ShipEngineSDK.Model.GetServicePointsRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetServicePointsRequestBody.md b/docs/models/GetServicePointsRequestBody.md new file mode 100644 index 00000000..43d5af7a --- /dev/null +++ b/docs/models/GetServicePointsRequestBody.md @@ -0,0 +1,18 @@ +# ShipEngineSDK.Model.GetServicePointsRequestBody +A get service points request body. Caller must provide exactly one of address_query, address, or lat / long pair. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Providers** | [**List<GetServicePointsRequestBodyProvidersInner>**](GetServicePointsRequestBodyProvidersInner.md) | An array of shipping service providers and service codes | +**Address** | [**GetServicePointsRequestBodyAddress**](GetServicePointsRequestBodyAddress.md) | | [optional] +**AddressQuery** | **string** | Unstructured text to search for service points by. | [optional] +**Lat** | **double** | The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html | [optional] +**Long** | **double** | The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html | [optional] +**MaxResults** | **int** | The maximum number of service points to return | [optional] +**Radius** | **int** | Search radius in kilometers | [optional] +**Shipment** | [**GetServicePointsRequestBodyShipment**](GetServicePointsRequestBodyShipment.md) | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetServicePointsRequestBodyAddress.md b/docs/models/GetServicePointsRequestBodyAddress.md new file mode 100644 index 00000000..deedea62 --- /dev/null +++ b/docs/models/GetServicePointsRequestBodyAddress.md @@ -0,0 +1,17 @@ +# ShipEngineSDK.Model.GetServicePointsRequestBodyAddress +Structured address to search by. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CountryCode** | **string** | A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) | +**AddressLine1** | **string** | The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. | [optional] +**AddressLine2** | **string** | | [optional] +**AddressLine3** | **string** | | [optional] +**CityLocality** | **string** | The name of the city or locality | [optional] +**PostalCode** | **string** | postal code | [optional] +**StateProvince** | **string** | The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetServicePointsRequestBodyProvidersInner.md b/docs/models/GetServicePointsRequestBodyProvidersInner.md new file mode 100644 index 00000000..8cbbf08d --- /dev/null +++ b/docs/models/GetServicePointsRequestBodyProvidersInner.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.GetServicePointsRequestBodyProvidersInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierId** | **string** | Uniquely identifies a carrier connection | [optional] +**ServiceCode** | **List<string>** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetServicePointsRequestBodyShipment.md b/docs/models/GetServicePointsRequestBodyShipment.md new file mode 100644 index 00000000..f84fdf2d --- /dev/null +++ b/docs/models/GetServicePointsRequestBodyShipment.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.GetServicePointsRequestBodyShipment +Shipment information to be used for service point selection + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Packages** | [**List<GetServicePointsRequestBodyShipmentPackagesInner>**](GetServicePointsRequestBodyShipmentPackagesInner.md) | An array of package dimensions | [optional] +**TotalWeight** | [**Weight**](Weight.md) | Shipment total weight | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetServicePointsRequestBodyShipmentPackagesInner.md b/docs/models/GetServicePointsRequestBodyShipmentPackagesInner.md new file mode 100644 index 00000000..f98c3049 --- /dev/null +++ b/docs/models/GetServicePointsRequestBodyShipmentPackagesInner.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.GetServicePointsRequestBodyShipmentPackagesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Dimensions** | [**Dimensions**](Dimensions.md) | The package dimensions | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetShipmentByExternalIdResponseBody.md b/docs/models/GetShipmentByExternalIdResponseBody.md new file mode 100644 index 00000000..ff54e09a --- /dev/null +++ b/docs/models/GetShipmentByExternalIdResponseBody.md @@ -0,0 +1,37 @@ +# ShipEngineSDK.Model.GetShipmentByExternalIdResponseBody +A get shipment by external id response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AdvancedOptions** | [**AdvancedShipmentOptions**](AdvancedShipmentOptions.md) | Advanced shipment options. These are entirely optional. | +**CarrierId** | **string** | The carrier account that is billed for the shipping charges | +**Confirmation** | **DeliveryConfirmation** | The type of delivery confirmation that is required for this shipment. | +**CreatedAt** | **DateTimeOffset** | The date and time that the shipment was created in ShipEngine. | [readonly] +**InsuranceProvider** | **InsuranceProvider** | The insurance provider to use for any insured packages in the shipment. | +**ModifiedAt** | **DateTimeOffset** | The date and time that the shipment was created or last modified. | [readonly] +**Packages** | [**List<Package>**](Package.md) | The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. | +**ReturnTo** | [**ShippingAddress**](ShippingAddress.md) | The return address for this shipment. Defaults to the `ship_from` address. | +**ServiceCode** | **string** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | +**ShipDate** | **DateTimeOffset** | The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | +**ShipFrom** | [**ShippingAddress**](ShippingAddress.md) | The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. | +**ShipTo** | [**ShippingAddressTo**](ShippingAddressTo.md) | The recipient's mailing address | +**ShipmentId** | **string** | A string that uniquely identifies the shipment | [readonly] +**ShipmentStatus** | **ShipmentStatus** | The current status of the shipment | [readonly] +**Tags** | [**List<Tag>**](Tag.md) | Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. | [readonly] +**TotalWeight** | [**Weight**](Weight.md) | The combined weight of all packages in the shipment | [readonly] +**ComparisonRateType** | **string** | Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. | [optional] +**Customs** | [**InternationalShipmentOptions**](InternationalShipmentOptions.md) | Customs information. This is usually only needed for international shipments. | +**ExternalOrderId** | **string** | ID that the Order Source assigned | [optional] +**ExternalShipmentId** | **string** | A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**IsReturn** | **bool** | An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. | [optional] [default to false] +**Items** | [**List<ShipmentItem>**](ShipmentItem.md) | Describe the packages included in this shipment as related to potential metadata that was imported from external order sources | [optional] +**OrderSourceCode** | **OrderSourceName** | | [optional] +**ShipmentNumber** | **string** | A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**ShippingRuleId** | **string** | ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment | [optional] +**TaxIdentifiers** | [**List<TaxIdentifier>**](TaxIdentifier.md) | | [optional] +**WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetShipmentByIdResponseBody.md b/docs/models/GetShipmentByIdResponseBody.md new file mode 100644 index 00000000..9fde878d --- /dev/null +++ b/docs/models/GetShipmentByIdResponseBody.md @@ -0,0 +1,37 @@ +# ShipEngineSDK.Model.GetShipmentByIdResponseBody +A get shipment by id response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AdvancedOptions** | [**AdvancedShipmentOptions**](AdvancedShipmentOptions.md) | Advanced shipment options. These are entirely optional. | +**CarrierId** | **string** | The carrier account that is billed for the shipping charges | +**Confirmation** | **DeliveryConfirmation** | The type of delivery confirmation that is required for this shipment. | +**CreatedAt** | **DateTimeOffset** | The date and time that the shipment was created in ShipEngine. | [readonly] +**InsuranceProvider** | **InsuranceProvider** | The insurance provider to use for any insured packages in the shipment. | +**ModifiedAt** | **DateTimeOffset** | The date and time that the shipment was created or last modified. | [readonly] +**Packages** | [**List<Package>**](Package.md) | The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. | +**ReturnTo** | [**ShippingAddress**](ShippingAddress.md) | The return address for this shipment. Defaults to the `ship_from` address. | +**ServiceCode** | **string** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | +**ShipDate** | **DateTimeOffset** | The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | +**ShipFrom** | [**ShippingAddress**](ShippingAddress.md) | The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. | +**ShipTo** | [**ShippingAddressTo**](ShippingAddressTo.md) | The recipient's mailing address | +**ShipmentId** | **string** | A string that uniquely identifies the shipment | [readonly] +**ShipmentStatus** | **ShipmentStatus** | The current status of the shipment | [readonly] +**Tags** | [**List<Tag>**](Tag.md) | Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. | [readonly] +**TotalWeight** | [**Weight**](Weight.md) | The combined weight of all packages in the shipment | [readonly] +**ComparisonRateType** | **string** | Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. | [optional] +**Customs** | [**InternationalShipmentOptions**](InternationalShipmentOptions.md) | Customs information. This is usually only needed for international shipments. | +**ExternalOrderId** | **string** | ID that the Order Source assigned | [optional] +**ExternalShipmentId** | **string** | A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**IsReturn** | **bool** | An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. | [optional] [default to false] +**Items** | [**List<ShipmentItem>**](ShipmentItem.md) | Describe the packages included in this shipment as related to potential metadata that was imported from external order sources | [optional] +**OrderSourceCode** | **OrderSourceName** | | [optional] +**ShipmentNumber** | **string** | A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**ShippingRuleId** | **string** | ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment | [optional] +**TaxIdentifiers** | [**List<TaxIdentifier>**](TaxIdentifier.md) | | [optional] +**WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetTrackingLogFromLabelResponseBody.md b/docs/models/GetTrackingLogFromLabelResponseBody.md new file mode 100644 index 00000000..2bf8bf3b --- /dev/null +++ b/docs/models/GetTrackingLogFromLabelResponseBody.md @@ -0,0 +1,26 @@ +# ShipEngineSDK.Model.GetTrackingLogFromLabelResponseBody +A get tracking log from label response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierStatusCode** | **string** | Carrier status code | [readonly] +**Events** | [**List<TrackEvent>**](TrackEvent.md) | The events that have occured during the lifetime of this tracking number. | [readonly] +**StatusCode** | **StatusCode** | | +**TrackingNumber** | **string** | A tracking number for a package. The format depends on the carrier. | +**ActualDeliveryDate** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. | [optional] +**CarrierCode** | **string** | A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. | [optional] +**CarrierDetailCode** | **string** | Carrier detail code | [optional] [readonly] +**CarrierId** | **int** | The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label | [optional] [readonly] +**CarrierStatusDescription** | **string** | carrier status description | [optional] [readonly] +**EstimatedDeliveryDate** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. | [optional] +**ExceptionDescription** | **string** | Exception description | [optional] [readonly] +**ShipDate** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. | [optional] +**StatusDescription** | **string** | Status description | [optional] [readonly] +**StatusDetailCode** | **StatusDetailCode** | | [optional] +**StatusDetailDescription** | **string** | Status detail description | [optional] [readonly] +**TrackingUrl** | **string** | Carrier Tracking Url, if available | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetTrackingLogResponseBody.md b/docs/models/GetTrackingLogResponseBody.md new file mode 100644 index 00000000..65edc88a --- /dev/null +++ b/docs/models/GetTrackingLogResponseBody.md @@ -0,0 +1,26 @@ +# ShipEngineSDK.Model.GetTrackingLogResponseBody +A get tracking log response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierCode** | **string** | A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. | +**CarrierDetailCode** | **string** | Carrier detail code | [readonly] +**CarrierId** | **int** | The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label | [readonly] +**CarrierStatusCode** | **string** | Carrier status code | [readonly] +**Events** | [**List<TrackEvent>**](TrackEvent.md) | The events that have occured during the lifetime of this tracking number. | [readonly] +**StatusCode** | **StatusCode** | | +**TrackingNumber** | **string** | A tracking number for a package. The format depends on the carrier. | +**TrackingUrl** | **string** | Carrier Tracking Url, if available | [readonly] +**ActualDeliveryDate** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. | [optional] +**CarrierStatusDescription** | **string** | carrier status description | [optional] [readonly] +**EstimatedDeliveryDate** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. | [optional] +**ExceptionDescription** | **string** | Exception description | [optional] [readonly] +**ShipDate** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. | [optional] +**StatusDescription** | **string** | Status description | [optional] [readonly] +**StatusDetailCode** | **StatusDetailCode** | | [optional] +**StatusDetailDescription** | **string** | Status detail description | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetWarehouseByIdResponseBody.md b/docs/models/GetWarehouseByIdResponseBody.md new file mode 100644 index 00000000..d0ee28d3 --- /dev/null +++ b/docs/models/GetWarehouseByIdResponseBody.md @@ -0,0 +1,16 @@ +# ShipEngineSDK.Model.GetWarehouseByIdResponseBody +A get warehouse by id response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedAt** | **DateTimeOffset** | Timestamp that indicates when the warehouse was created | [readonly] +**Name** | **string** | Name of the warehouse | +**OriginAddress** | [**Address**](Address.md) | The origin address of the warehouse | +**ReturnAddress** | [**Address**](Address.md) | The return address associated with the warehouse | +**WarehouseId** | **string** | A string that uniquely identifies the warehouse | [readonly] +**IsDefault** | **bool** | Designates which single warehouse is the default on the account | [optional] [default to false] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/GetWebhookByIdResponseBody.md b/docs/models/GetWebhookByIdResponseBody.md new file mode 100644 index 00000000..e90468bc --- /dev/null +++ b/docs/models/GetWebhookByIdResponseBody.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.GetWebhookByIdResponseBody +A get webhook id response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Event** | **WebhookEvent** | | +**Url** | **string** | The url that the webhook sends the request to | +**WebhookId** | **string** | A string that uniquely identifies the webhook | [readonly] +**Headers** | [**List<WebhookHeader>**](WebhookHeader.md) | Array of custom webhook headers | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/IdentifierType.md b/docs/models/IdentifierType.md new file mode 100644 index 00000000..6af513b8 --- /dev/null +++ b/docs/models/IdentifierType.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.IdentifierType +Tax identifier type for customs declaration |Pickup Type | Description |- -- -- -- -- -- -- --|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`vat` | The tax identifier is a Value Added Tax. |`eori` | The tax identifier is an Economic Operators Registration and Identification Number (EORI). |`ssn` | The tax identifier is a Social Security Number. |`ein` | The tax identifier is an Employer Identification Number (EIN). |`tin` | The tax identifier is a Tax Identification Number (TIN). |`ioss` | The tax identifier is an Import One-Stop Shop (IOSS). |`pan` | The tax identifier is a Permanent Account Number (PAN). |`voec` | The tax identifier is a Norwegian VAT On E-Commerce(VOEC). |`pccc` | The tax identifier is a Personal Customs Clearance Code (PCCC). |`oss` | The tax identifier is an One-Stop Shop (OSS). |`passport` | The tax identifier is a Passport Number. |`abn` | The tax identifier is an Australian Business Number. |`ukims` | The tax identifier is an UK Internal Market Scheme number. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ImporterOfRecords.md b/docs/models/ImporterOfRecords.md new file mode 100644 index 00000000..b43fe4c6 --- /dev/null +++ b/docs/models/ImporterOfRecords.md @@ -0,0 +1,21 @@ +# ShipEngineSDK.Model.ImporterOfRecords +importer of records address, anywhere in the world. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddressLine1** | **string** | The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. | +**CityLocality** | **string** | The name of the city or locality | +**CountryCode** | **string** | The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) | +**Name** | **string** | The name of a contact person at this address. Either `name` or the `company_name` field should always be set. | +**PostalCode** | **string** | postal code | +**AddressLine2** | **string** | The second line of the street address. For some addresses, this line may not be needed. | [optional] +**AddressLine3** | **string** | The third line of the street address. For some addresses, this line may not be needed. | [optional] +**CompanyName** | **string** | If this is a business address, then the company name should be specified here. Either `name` or the `company_name` field should always be set. | [optional] +**Email** | **string** | Email for the address owner. | [optional] +**Phone** | **string** | The phone number of a contact person at this address. The format of this phone number varies depending on the country. | [optional] +**StateProvince** | **string** | The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/InsuranceProvider.md b/docs/models/InsuranceProvider.md new file mode 100644 index 00000000..56f6aa1e --- /dev/null +++ b/docs/models/InsuranceProvider.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.InsuranceProvider +The possible insurance provider values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/InternationalShipmentOptions.md b/docs/models/InternationalShipmentOptions.md new file mode 100644 index 00000000..370d474f --- /dev/null +++ b/docs/models/InternationalShipmentOptions.md @@ -0,0 +1,18 @@ +# ShipEngineSDK.Model.InternationalShipmentOptions +Options for international shipments, such as customs declarations. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Contents** | **PackageContents** | The type of contents in this shipment. This may impact import duties or customs treatment. | +**NonDelivery** | **NonDelivery** | Indicates what to do if a package is unable to be delivered. | +**ContentsExplanation** | **string** | Explanation for contents (required if the `contents` is provided as `other`) | [optional] +**CustomsItems** | [**List<CustomsItem>**](CustomsItem.md) | Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`) | [optional] +**Declaration** | **string** | Declaration statement to be placed on the commercial invoice | [optional] +**ImporterOfRecord** | [**ImporterOfRecords**](ImporterOfRecords.md) | | [optional] +**InvoiceAdditionalDetails** | [**InvoiceAdditionalDetails**](InvoiceAdditionalDetails.md) | | [optional] +**TermsOfTradeCode** | **AllowedIncoterms** | Specifies the supported terms of trade code (incoterms) | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/InvoiceAdditionalDetails.md b/docs/models/InvoiceAdditionalDetails.md new file mode 100644 index 00000000..38e48291 --- /dev/null +++ b/docs/models/InvoiceAdditionalDetails.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.InvoiceAdditionalDetails +The additional information to put on commercial invoice + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Discount** | [**MonetaryValue**](MonetaryValue.md) | Discount for shipment. | [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] +**OtherChargeDescription** | **string** | Description for the other charge (if provided). | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Label.md b/docs/models/Label.md new file mode 100644 index 00000000..a2571a55 --- /dev/null +++ b/docs/models/Label.md @@ -0,0 +1,49 @@ +# ShipEngineSDK.Model.Label +A label represents the physical sticker that you affix to a package to ship it. ShipEngine makes it easy for you to [create labels](https://www.shipengine.com/docs/labels/create-a-label/) and then download them in PDF, PNG, or ZPL format so you can print them. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AlternativeIdentifiers** | [**List<AlternativeIdentifier>**](AlternativeIdentifier.md) | Additional information some carriers may provide by which to identify a given label in their system. | [optional] [readonly] +**BatchId** | **string** | If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. | [optional] [readonly] +**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] +**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] +**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. | [optional] [readonly] +**InsuranceCost** | [**MonetaryValue**](MonetaryValue.md) | The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. | [optional] [readonly] +**IsInternational** | **bool** | Indicates whether this is an international shipment. That is, the originating country and destination country are different. | [optional] [readonly] +**IsReturnLabel** | **bool** | Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. | [optional] +**LabelDownload** | [**LabelDownload**](LabelDownload.md) | | [optional] [readonly] +**LabelDownloadType** | **LabelDownloadType** | | [optional] +**LabelFormat** | **LabelFormat** | 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. | [optional] +**LabelId** | **string** | A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. | [optional] [readonly] +**LabelImageId** | **string** | The label image resource that was used to create a custom label image. | [optional] +**LabelLayout** | **LabelLayout** | 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. | [optional] +**OutboundLabelId** | **string** | The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. | [optional] +**PackageCode** | **string** | The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. | [optional] [readonly] +**Packages** | [**List<LabelPackagesInner>**](LabelPackagesInner.md) | The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. | [optional] [readonly] +**PaperlessDownload** | [**PaperlessDownload**](PaperlessDownload.md) | The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. | [optional] [readonly] +**RateDetails** | [**List<RateDetail>**](RateDetail.md) | A list of rate details that are associated with shipping cost. This is useful for displaying a breakdown of the rate to the user. | [optional] [readonly] +**RequestedComparisonAmount** | [**MonetaryValue**](MonetaryValue.md) | The total shipping cost for the specified comparison_rate_type. | [optional] [readonly] +**RmaNumber** | **string** | An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. | [optional] +**ServiceCode** | **string** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | [optional] [readonly] +**ShipDate** | **DateTimeOffset** | The date that the package was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | [optional] [readonly] +**Shipment** | [**Shipment**](Shipment.md) | The shipment information used to generate the label | [optional] +**ShipmentCost** | [**MonetaryValue**](MonetaryValue.md) | The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. | [optional] [readonly] +**ShipmentId** | **string** | The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) | [optional] [readonly] +**Status** | **LabelStatus** | | [optional] [readonly] +**TestLabel** | **bool** | Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. | [optional] [default to false] +**Trackable** | **bool** | Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. | [optional] [readonly] +**TrackingNumber** | **string** | The tracking number for the package. Tracking number formats vary across carriers. | [optional] [readonly] +**TrackingStatus** | **TrackingStatus** | The current status of the package, such as `in_transit` or `delivered` | [optional] [readonly] +**TrackingUrl** | **string** | The URL to track the package. This URL is provided by the carrier and is unique to the tracking number. | [optional] [readonly] +**ValidateAddress** | **ValidateAddress** | | [optional] +**Voided** | **bool** | Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) | [optional] [readonly] +**VoidedAt** | **DateTimeOffset** | The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/LabelChargeEvent.md b/docs/models/LabelChargeEvent.md new file mode 100644 index 00000000..22b5a3d7 --- /dev/null +++ b/docs/models/LabelChargeEvent.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.LabelChargeEvent +Determines when the user's account will be charged for the label. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/LabelDownload.md b/docs/models/LabelDownload.md new file mode 100644 index 00000000..c98ab089 --- /dev/null +++ b/docs/models/LabelDownload.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.LabelDownload +Reference to the various downloadable file formats for the generated label + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Href** | **string** | The URL of the linked resource, if any | [optional] +**Pdf** | **string** | The URL for the pdf generated label | [optional] +**Png** | **string** | The URL for the png generated label | [optional] +**Zpl** | **string** | The URL for the zpl generated label | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/LabelDownloadType.md b/docs/models/LabelDownloadType.md new file mode 100644 index 00000000..3b7577aa --- /dev/null +++ b/docs/models/LabelDownloadType.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.LabelDownloadType +There are two different ways to [download a label](https://www.shipengine.com/docs/labels/downloading/): |Label Download Type | Description |- -- -- -- -- -- -- -- -- -- -|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- - |`url` |You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days.

This is the default if `label_download_type` is unspecified. |`inline` |You will receive the Base64-encoded label as part of the response. No need for a second request to download the label. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/LabelFormat.md b/docs/models/LabelFormat.md new file mode 100644 index 00000000..fbaff6c7 --- /dev/null +++ b/docs/models/LabelFormat.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.LabelFormat +The possible file formats in which shipping labels can be downloaded. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. |Label Format | Supported Carriers |- -- -- -- -- -- -- -|- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`pdf` | All carriers |`png` | `fedex`
`stamps_com`
`ups`
`usps` |`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps` + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/LabelLayout.md b/docs/models/LabelLayout.md new file mode 100644 index 00000000..31b83808 --- /dev/null +++ b/docs/models/LabelLayout.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.LabelLayout +The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/LabelMessages.md b/docs/models/LabelMessages.md new file mode 100644 index 00000000..ae5c0927 --- /dev/null +++ b/docs/models/LabelMessages.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.LabelMessages +Custom messages to print on the shipping label for the package. These are typically used to print invoice numbers, product numbers, or other internal reference numbers. Not all carriers support label messages. The number of lines and the maximum length of each line also varies by carrier. |Carrier |Max lines |Max line length |- -- -- -- -- -- -- -- -- --|- -- -- -- -- -|- -- -- -- -- -- -- -- -- -- - |USPS (Stamps.com) |3 |60 |FedEx |3 |35 for the first line. 30 for additional lines. |UPS |2 |35 |OnTrac |2 |25 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Reference1** | **string** | The first line of the custom label message. Some carriers may prefix this line with something like \"REF\", \"Reference\", \"Trx Ref No.\", etc. | +**Reference2** | **string** | The second line of the custom label message. Some carriers may prefix this line with something like \"INV\", \"Reference 2\", \"Trx Ref No.\", etc. | +**Reference3** | **string** | The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/LabelPackage.md b/docs/models/LabelPackage.md new file mode 100644 index 00000000..a8f70930 --- /dev/null +++ b/docs/models/LabelPackage.md @@ -0,0 +1,28 @@ +# ShipEngineSDK.Model.LabelPackage +A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Weight** | [**Weight**](Weight.md) | The package weight | +**ContentDescription** | **string** | A short description of the package content. Required for shipments moving to, from, and through Mexico. | [optional] +**Dimensions** | [**Dimensions**](Dimensions.md) | The package dimensions | [optional] +**ExternalPackageId** | **string** | An external package id. | [optional] +**FormDownload** | [**OptionalLink**](OptionalLink.md) | The form download for any customs that are needed | [optional] [readonly] +**HasFormDocuments** | **bool** | Whether the package has form documents available for download | [optional] +**HasLabelDocuments** | **bool** | Whether the package has label documents available for download | [optional] +**HasPaperlessLabelDocuments** | **bool** | Whether the package has paperless documents available for download | [optional] +**HasQrCodeDocuments** | **bool** | Whether the package has QR code documents available for download | [optional] +**InsuredValue** | [**MonetaryValue**](MonetaryValue.md) | The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. | [optional] +**LabelDownload** | [**LabelDownload**](LabelDownload.md) | The label download for the package | [optional] [readonly] +**LabelMessages** | [**LabelMessages**](LabelMessages.md) | | [optional] +**PackageCode** | **string** | The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. | [optional] +**PackageId** | **int** | The shipment package id | [optional] [readonly] +**PaperlessDownload** | [**PaperlessDownload**](PaperlessDownload.md) | The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. | [optional] [readonly] +**QrCodeDownload** | [**OptionalLink**](OptionalLink.md) | The QR code download for the package | [optional] [readonly] +**Sequence** | **int** | Package sequence | [optional] [readonly] +**TrackingNumber** | **string** | The tracking number for the package. The format depends on the carrier. | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/LabelPackagesInner.md b/docs/models/LabelPackagesInner.md new file mode 100644 index 00000000..e7b301f2 --- /dev/null +++ b/docs/models/LabelPackagesInner.md @@ -0,0 +1,28 @@ +# ShipEngineSDK.Model.LabelPackagesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Weight** | [**Weight**](Weight.md) | The package weight | +**AlternativeIdentifiers** | [**List<AlternativeIdentifier>**](AlternativeIdentifier.md) | Alternative identifiers associated with this package. | [optional] [readonly] +**ContentDescription** | **string** | A short description of the package content. Required for shipments moving to, from, and through Mexico. | [optional] +**Dimensions** | [**Dimensions**](Dimensions.md) | The package dimensions | [optional] +**ExternalPackageId** | **string** | An external package id. | [optional] +**FormDownload** | [**OptionalLink**](OptionalLink.md) | The form download for any customs that are needed | [optional] [readonly] +**HasFormDocuments** | **bool** | Whether the package has form documents available for download | [optional] +**HasLabelDocuments** | **bool** | Whether the package has label documents available for download | [optional] +**HasPaperlessLabelDocuments** | **bool** | Whether the package has paperless documents available for download | [optional] +**HasQrCodeDocuments** | **bool** | Whether the package has QR code documents available for download | [optional] +**InsuredValue** | [**MonetaryValue**](MonetaryValue.md) | The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. | [optional] +**LabelDownload** | [**LabelDownload**](LabelDownload.md) | The label download for the package | [optional] [readonly] +**LabelMessages** | [**LabelMessages**](LabelMessages.md) | | [optional] +**PackageCode** | **string** | The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. | [optional] +**PackageId** | **int** | The shipment package id | [optional] [readonly] +**PaperlessDownload** | [**PaperlessDownload**](PaperlessDownload.md) | The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. | [optional] [readonly] +**QrCodeDownload** | [**OptionalLink**](OptionalLink.md) | The QR code download for the package | [optional] [readonly] +**Sequence** | **int** | Package sequence | [optional] [readonly] +**TrackingNumber** | **string** | The tracking number for the package. The format depends on the carrier. | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/LabelRequest.md b/docs/models/LabelRequest.md new file mode 100644 index 00000000..159d20de --- /dev/null +++ b/docs/models/LabelRequest.md @@ -0,0 +1,22 @@ +# ShipEngineSDK.Model.LabelRequest +A label represents the physical sticker that you affix to a package to ship it. ShipEngine makes it easy for you to [create labels](https://www.shipengine.com/docs/labels/create-a-label/) and then download them in PDF, PNG, or ZPL format so you can print them. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ChargeEvent** | **LabelChargeEvent** | The label charge event. | [optional] +**DisplayScheme** | **DisplayScheme** | The display format that the label should be shown in. | [optional] +**IsReturnLabel** | **bool** | Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. | [optional] +**LabelDownloadType** | **LabelDownloadType** | | [optional] +**LabelFormat** | **LabelFormat** | 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. | [optional] +**LabelImageId** | **string** | The label image resource that was used to create a custom label image. | [optional] +**LabelLayout** | **LabelLayout** | 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. | [optional] +**OutboundLabelId** | **string** | The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. | [optional] +**RmaNumber** | **string** | An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. | [optional] +**Shipment** | [**ShipmentRequest**](ShipmentRequest.md) | The shipment information used to generate the label | [optional] +**TestLabel** | **bool** | Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. | [optional] [default to false] +**ValidateAddress** | **ValidateAddress** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/LabelStatus.md b/docs/models/LabelStatus.md new file mode 100644 index 00000000..c816d4d5 --- /dev/null +++ b/docs/models/LabelStatus.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.LabelStatus +The possible statuses that a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/) can be in. |Status |Description |:- -- -- -- -- -- -|:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`processing` |When labels are created in a [batch](https://www.shipengine.com/docs/labels/bulk/), it may take a few minutes for all of the labels in the batch to be created. During this period, they will be in `processing` status. |`completed` |The label was successfully created |`error` |The label could not be created due to an error, such as an invalid delivery address |`voided` |The label has been [voided](https://www.shipengine.com/docs/labels/voiding/) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Link.md b/docs/models/Link.md new file mode 100644 index 00000000..4d7eb5a3 --- /dev/null +++ b/docs/models/Link.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.Link +A link to a related resource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Href** | **string** | The URL of the linked resource, if any | +**Type** | **string** | The type of resource, or the type of relationship to the parent resource | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListAccountImagesResponseBody.md b/docs/models/ListAccountImagesResponseBody.md new file mode 100644 index 00000000..2a776edd --- /dev/null +++ b/docs/models/ListAccountImagesResponseBody.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.ListAccountImagesResponseBody +A list account images response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Images** | **List<Object>** | Image List | [readonly] +**Links** | [**PaginationLink**](PaginationLink.md) | | +**Page** | **int** | The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. | +**Pages** | **int** | The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero. | +**Total** | **int** | The total number of items across all pages of results | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListAccountSettingsBody.md b/docs/models/ListAccountSettingsBody.md new file mode 100644 index 00000000..642b8c28 --- /dev/null +++ b/docs/models/ListAccountSettingsBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.ListAccountSettingsBody +An account settings list response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DefaultLabelLayout** | **DefaultLabelLayout** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListAccountSettingsImagesResponseBody.md b/docs/models/ListAccountSettingsImagesResponseBody.md new file mode 100644 index 00000000..cc9583bf --- /dev/null +++ b/docs/models/ListAccountSettingsImagesResponseBody.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.ListAccountSettingsImagesResponseBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Images** | **List<Object>** | Image List | [readonly] +**Links** | [**PaginationLink**](PaginationLink.md) | | +**Page** | **int** | The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. | +**Pages** | **int** | The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero. | +**Total** | **int** | The total number of items across all pages of results | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListBatchErrorsResponseBody.md b/docs/models/ListBatchErrorsResponseBody.md new file mode 100644 index 00000000..3ff20a12 --- /dev/null +++ b/docs/models/ListBatchErrorsResponseBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.ListBatchErrorsResponseBody +A batch errors response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Errors** | [**List<BatchResponseError>**](BatchResponseError.md) | The errors currently associated with the batch | [readonly] +**Links** | [**PaginationLink**](PaginationLink.md) | | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListBatchesResponseBody.md b/docs/models/ListBatchesResponseBody.md new file mode 100644 index 00000000..67571b26 --- /dev/null +++ b/docs/models/ListBatchesResponseBody.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.ListBatchesResponseBody +A list batch response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Batches** | [**List<Batch>**](Batch.md) | Batch List | [readonly] +**Links** | [**PaginationLink**](PaginationLink.md) | | [readonly] +**Page** | **int** | The page that is currently being read | [readonly] +**Pages** | **int** | The total number of batch pages the API call returned | [readonly] +**Total** | **long** | The total number of batches the API call returned | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListCarrierPackageTypesResponseBody.md b/docs/models/ListCarrierPackageTypesResponseBody.md new file mode 100644 index 00000000..30122a5e --- /dev/null +++ b/docs/models/ListCarrierPackageTypesResponseBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.ListCarrierPackageTypesResponseBody +A list carrier package types response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Packages** | [**List<PackageType>**](PackageType.md) | An array of custom package types | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListCarrierServicesResponseBody.md b/docs/models/ListCarrierServicesResponseBody.md new file mode 100644 index 00000000..54186e2b --- /dev/null +++ b/docs/models/ListCarrierServicesResponseBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.ListCarrierServicesResponseBody +A carrier list services response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Services** | [**List<Service>**](Service.md) | An array of services associated with the carrier | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListCarriersResponseBody.md b/docs/models/ListCarriersResponseBody.md new file mode 100644 index 00000000..6583aba5 --- /dev/null +++ b/docs/models/ListCarriersResponseBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.ListCarriersResponseBody +A carrier list response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Carriers** | [**List<Carrier>**](Carrier.md) | The carrier response body | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListLabelsResponseBody.md b/docs/models/ListLabelsResponseBody.md new file mode 100644 index 00000000..ba7c328b --- /dev/null +++ b/docs/models/ListLabelsResponseBody.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.ListLabelsResponseBody +A list label response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Labels** | **List<Object>** | The labels that matched the query criteria. If no matching labels were found, then this array is empty; otherwise, it contains one page of results. The last page of results may have fewer labels than the `page_size`. | +**Links** | [**PaginationLink**](PaginationLink.md) | | +**Page** | **int** | The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. | +**Pages** | **int** | The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero. | +**Total** | **int** | The total number of items across all pages of results | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListManifestsResponseBody.md b/docs/models/ListManifestsResponseBody.md new file mode 100644 index 00000000..d136a3b4 --- /dev/null +++ b/docs/models/ListManifestsResponseBody.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.ListManifestsResponseBody +A list manifests response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | [**PaginationLink**](PaginationLink.md) | Helpful links to other pages of results | [readonly] +**Manifests** | [**List<Manifest>**](Manifest.md) | The list of available manifests | [readonly] +**Page** | **int** | Current page of the list manifests results | [readonly] +**Pages** | **int** | Total number of pages for list manifests results | [readonly] +**Total** | **long** | The total number of manifests returned | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListPackageTypesResponseBody.md b/docs/models/ListPackageTypesResponseBody.md new file mode 100644 index 00000000..42e3c097 --- /dev/null +++ b/docs/models/ListPackageTypesResponseBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.ListPackageTypesResponseBody +A list package types response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Packages** | [**List<PackageType>**](PackageType.md) | An array of custom package types | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListPickupResponseBody.md b/docs/models/ListPickupResponseBody.md new file mode 100644 index 00000000..e89ff9b7 --- /dev/null +++ b/docs/models/ListPickupResponseBody.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.ListPickupResponseBody +A list pickup response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | [**PaginationLink**](PaginationLink.md) | Helpful links to other pages of results | [readonly] +**Page** | **int** | Current page of the list pickups results | [readonly] +**Pages** | **int** | Total number of pages for list pickups results | [readonly] +**Pickups** | [**List<Pickup>**](Pickup.md) | An array of pickups associated with the user's account. | +**Total** | **long** | The total number of pickups returned | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListServicePointsResponseBody.md b/docs/models/ListServicePointsResponseBody.md new file mode 100644 index 00000000..85c2ea68 --- /dev/null +++ b/docs/models/ListServicePointsResponseBody.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.ListServicePointsResponseBody +A list service points response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Errors** | [**List<Error>**](Error.md) | The errors associated with the failed API call | [optional] [readonly] +**Lat** | **double** | The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html | [optional] +**Long** | **double** | The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html | [optional] +**ServicePoints** | [**List<ListServicePointsResponseBodyServicePointsInner>**](ListServicePointsResponseBodyServicePointsInner.md) | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListServicePointsResponseBodyServicePointsInner.md b/docs/models/ListServicePointsResponseBodyServicePointsInner.md new file mode 100644 index 00000000..59c37a82 --- /dev/null +++ b/docs/models/ListServicePointsResponseBodyServicePointsInner.md @@ -0,0 +1,25 @@ +# ShipEngineSDK.Model.ListServicePointsResponseBodyServicePointsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddressLine1** | **string** | The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. | [optional] +**CarrierCode** | **string** | A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. | [optional] +**CityLocality** | **string** | The name of the city or locality | [optional] +**CompanyName** | **string** | If this is a business address, then the company name should be specified here. | [optional] +**CountryCode** | **string** | A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) | [optional] +**DistanceInMeters** | **double** | Distance in meters | [optional] +**Features** | **List<ListServicePointsResponseBodyServicePointsInner.FeaturesEnum>** | Service features | [optional] +**HoursOfOperation** | [**ListServicePointsResponseBodyServicePointsInnerHoursOfOperation**](ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.md) | | [optional] +**Lat** | **double** | The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html | [optional] +**Long** | **double** | The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html | [optional] +**PhoneNumber** | **string** | Phone number associated | [optional] +**PostalCode** | **string** | postal code | [optional] +**ServiceCodes** | **List<string>** | | [optional] +**ServicePointId** | **string** | A unique identifier for a carrier drop off point. | [optional] +**StateProvince** | **string** | The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. | [optional] +**Type** | **string** | Service point type | [optional] [default to TypeEnum.Pudo] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.md b/docs/models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.md new file mode 100644 index 00000000..eb6ed092 --- /dev/null +++ b/docs/models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.md @@ -0,0 +1,17 @@ +# ShipEngineSDK.Model.ListServicePointsResponseBodyServicePointsInnerHoursOfOperation +Hours of operation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Friday** | [**List<ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner>**](ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md) | | [optional] +**Monday** | [**List<ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner>**](ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md) | | [optional] +**Saturday** | [**List<ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner>**](ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md) | | [optional] +**Sunday** | [**List<ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner>**](ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md) | | [optional] +**Thursday** | [**List<ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner>**](ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md) | | [optional] +**Tuesday** | [**List<ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner>**](ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md) | | [optional] +**Wednesday** | [**List<ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner>**](ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md) | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md b/docs/models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md new file mode 100644 index 00000000..08f61488 --- /dev/null +++ b/docs/models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Close** | **string** | Closing time | [optional] +**Open** | **string** | Opening time | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListShipmentRatesResponseBody.md b/docs/models/ListShipmentRatesResponseBody.md new file mode 100644 index 00000000..547691de --- /dev/null +++ b/docs/models/ListShipmentRatesResponseBody.md @@ -0,0 +1,17 @@ +# ShipEngineSDK.Model.ListShipmentRatesResponseBody +A list shipment rates response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedAt** | **string** | When the rate was created | +**Errors** | [**List<Error>**](Error.md) | | +**InvalidRates** | [**List<Rate>**](Rate.md) | An array of invalid shipment rates | [readonly] +**RateRequestId** | **string** | A string that uniquely identifies the rate request | [readonly] +**Rates** | [**List<Rate>**](Rate.md) | An array of shipment rates | [readonly] +**ShipmentId** | **string** | A string that uniquely identifies the shipment | [readonly] +**Status** | **RateResponseStatus** | | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListShipmentsResponseBody.md b/docs/models/ListShipmentsResponseBody.md new file mode 100644 index 00000000..04aa267d --- /dev/null +++ b/docs/models/ListShipmentsResponseBody.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.ListShipmentsResponseBody +A list shipment response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | [**PaginationLink**](PaginationLink.md) | | [readonly] +**Page** | **int** | | [readonly] +**Pages** | **int** | | [readonly] +**Shipments** | [**List<Shipment>**](Shipment.md) | The list of shipments returned by the api call | [readonly] +**Total** | **long** | Total number of shipments returned by the api call | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListTagsResponseBody.md b/docs/models/ListTagsResponseBody.md new file mode 100644 index 00000000..0c53be83 --- /dev/null +++ b/docs/models/ListTagsResponseBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.ListTagsResponseBody +Response body from a successful GET /tags API call + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Tags** | [**List<Tag>**](Tag.md) | The array of tags returned by the API call | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ListWarehousesResponseBody.md b/docs/models/ListWarehousesResponseBody.md new file mode 100644 index 00000000..d48778f7 --- /dev/null +++ b/docs/models/ListWarehousesResponseBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.ListWarehousesResponseBody +A warehouse list response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Warehouses** | [**List<Warehouse>**](Warehouse.md) | The array of warehouses returned by the API call | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Manifest.md b/docs/models/Manifest.md new file mode 100644 index 00000000..28bb2f1b --- /dev/null +++ b/docs/models/Manifest.md @@ -0,0 +1,20 @@ +# ShipEngineSDK.Model.Manifest +Used for combining packages into one scannable form that a carrier can use when picking up a large number of shipments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierId** | **string** | A string that uniquely identifies the carrier | [optional] [readonly] +**CreatedAt** | **DateTimeOffset** | The date-time that the manifest was created | [optional] [readonly] +**FormId** | **string** | A string that uniquely identifies the form | [optional] [readonly] +**LabelIds** | **List<string>** | An array of the label ids used in this manifest. | [optional] [readonly] +**ManifestDownload** | [**ManifestDownload**](ManifestDownload.md) | | [optional] [readonly] +**ManifestId** | **string** | A string that uniquely identifies the manifest | [optional] [readonly] +**ShipDate** | **DateTimeOffset** | The date-time that the manifests shipments will be picked up | [optional] [readonly] +**Shipments** | **int** | The number of shipments that are included in this manifest | [optional] [readonly] +**SubmissionId** | **string** | A string that uniquely identifies the submission | [optional] [readonly] +**WarehouseId** | **string** | A string that uniquely identifies the warehouse | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ManifestDownload.md b/docs/models/ManifestDownload.md new file mode 100644 index 00000000..d96f2e0d --- /dev/null +++ b/docs/models/ManifestDownload.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.ManifestDownload +Object containing the href link to download the manifest file + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Href** | **string** | The URL of the linked resource, if any | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ManifestRequest.md b/docs/models/ManifestRequest.md new file mode 100644 index 00000000..9bc2fe86 --- /dev/null +++ b/docs/models/ManifestRequest.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.ManifestRequest +A reference to the manifest request + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ManifestRequestId** | **string** | A string that uniquely identifies a manifest request | [optional] [readonly] +**Status** | **ManifestRequestStatus** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ManifestRequestStatus.md b/docs/models/ManifestRequestStatus.md new file mode 100644 index 00000000..72782c83 --- /dev/null +++ b/docs/models/ManifestRequestStatus.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.ManifestRequestStatus +The possible statuses of a manifest request + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Manifests.md b/docs/models/Manifests.md new file mode 100644 index 00000000..4453ee2b --- /dev/null +++ b/docs/models/Manifests.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.Manifests +An array of manifest resources + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarManifests** | [**List<Manifest>**](Manifest.md) | Resulting Manifests | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ManifestsRequests.md b/docs/models/ManifestsRequests.md new file mode 100644 index 00000000..61000aa0 --- /dev/null +++ b/docs/models/ManifestsRequests.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.ManifestsRequests +An array of manifest requests + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ManifestRequests** | [**List<ManifestRequest>**](ManifestRequest.md) | Resulting manifest requests with statuses | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ModifyBatch.md b/docs/models/ModifyBatch.md new file mode 100644 index 00000000..ceea43cd --- /dev/null +++ b/docs/models/ModifyBatch.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.ModifyBatch +A modify batch object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RateIds** | **List<string>** | Array of Rate IDs to be modifed on the batch | [optional] +**ShipmentIds** | **List<string>** | The Shipment Ids to be modified on the batch | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/MonetaryValue.md b/docs/models/MonetaryValue.md new file mode 100644 index 00000000..87eac086 --- /dev/null +++ b/docs/models/MonetaryValue.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.MonetaryValue +A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Amount** | **decimal** | The monetary amount, in the specified currency. | +**Currency** | **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 | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/NonDelivery.md b/docs/models/NonDelivery.md new file mode 100644 index 00000000..4100991b --- /dev/null +++ b/docs/models/NonDelivery.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.NonDelivery +The possible non delivery values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/OptionalLink.md b/docs/models/OptionalLink.md new file mode 100644 index 00000000..d54cb2ea --- /dev/null +++ b/docs/models/OptionalLink.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.OptionalLink +A link to a related resource, or an empty object if there is no resource to link to + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Href** | **string** | The URL of the linked resource, if any | [optional] +**Type** | **string** | The type of resource, or the type of relationship to the parent resource | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/OrderSourceName.md b/docs/models/OrderSourceName.md new file mode 100644 index 00000000..50f6ee3b --- /dev/null +++ b/docs/models/OrderSourceName.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.OrderSourceName +The order sources that are supported by ShipEngine + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/OriginType.md b/docs/models/OriginType.md new file mode 100644 index 00000000..e5b32544 --- /dev/null +++ b/docs/models/OriginType.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.OriginType +Indicates if the package will be picked up or dropped off by the carrier + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Package.md b/docs/models/Package.md new file mode 100644 index 00000000..5c0ab329 --- /dev/null +++ b/docs/models/Package.md @@ -0,0 +1,22 @@ +# ShipEngineSDK.Model.Package +A package associated with a shipment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Weight** | [**Weight**](Weight.md) | The package weight | +**ContentDescription** | **string** | A short description of the package content. Required for shipments moving to, from, and through Mexico. | [optional] +**Dimensions** | [**Dimensions**](Dimensions.md) | The package dimensions | [optional] +**ExternalPackageId** | **string** | An external package id. | [optional] +**InsuredValue** | [**MonetaryValue**](MonetaryValue.md) | The insured value of the package. Requires the `insurance_provider` field of the shipment to be set. | [optional] +**LabelMessages** | [**LabelMessages**](LabelMessages.md) | | [optional] +**PackageCode** | **string** | The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. | [optional] +**PackageId** | **string** | A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/) | [optional] +**PackageName** | **string** | The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/) | [optional] +**Products** | [**List<Products>**](Products.md) | Details about products inside packages (Information provided would be used on custom documentation) | [optional] +**ShipmentPackageId** | **string** | A string that uniquely identifies this shipment package | [optional] [readonly] +**TrackingNumber** | **string** | The tracking number for the package. The format depends on the carrier. | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PackageContents.md b/docs/models/PackageContents.md new file mode 100644 index 00000000..22912757 --- /dev/null +++ b/docs/models/PackageContents.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.PackageContents +The possible package contents values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PackageType.md b/docs/models/PackageType.md new file mode 100644 index 00000000..8cb76c01 --- /dev/null +++ b/docs/models/PackageType.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.PackageType +A package type that a carrier supports for shipment. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | | +**PackageCode** | **string** | A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. | +**Description** | **string** | Provides a helpful description for the custom package. | [optional] +**Dimensions** | [**Dimensions**](Dimensions.md) | The custom dimensions for the package. | [optional] +**PackageId** | **string** | A string that uniquely identifies the package. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PackagingGroup.md b/docs/models/PackagingGroup.md new file mode 100644 index 00000000..107c7f7f --- /dev/null +++ b/docs/models/PackagingGroup.md @@ -0,0 +1,9 @@ +# ShipEngineSDK.Model.PackagingGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PackagingInstructionSection.md b/docs/models/PackagingInstructionSection.md new file mode 100644 index 00000000..a53af93b --- /dev/null +++ b/docs/models/PackagingInstructionSection.md @@ -0,0 +1,9 @@ +# ShipEngineSDK.Model.PackagingInstructionSection + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PagedListResponseBody.md b/docs/models/PagedListResponseBody.md new file mode 100644 index 00000000..5fd40054 --- /dev/null +++ b/docs/models/PagedListResponseBody.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.PagedListResponseBody +Many ShipEngine endpoints return a paged list of items. In addition to the returned items, these responses also include information about the total number of items, the number of pages of results, and URLs of other pages of results. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Links** | [**PaginationLink**](PaginationLink.md) | | +**Page** | **int** | The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. | +**Pages** | **int** | The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero. | +**Total** | **int** | The total number of items across all pages of results | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PaginationLink.md b/docs/models/PaginationLink.md new file mode 100644 index 00000000..9c561d72 --- /dev/null +++ b/docs/models/PaginationLink.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.PaginationLink +Helpful links to other pages of results + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**First** | [**Link**](Link.md) | The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items. | +**Last** | [**Link**](Link.md) | The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items. | +**Next** | [**OptionalLink**](OptionalLink.md) | The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`. | +**Prev** | [**OptionalLink**](OptionalLink.md) | The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PaperlessDownload.md b/docs/models/PaperlessDownload.md new file mode 100644 index 00000000..999c235c --- /dev/null +++ b/docs/models/PaperlessDownload.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.PaperlessDownload +The paperless details which may contain elements like `href`, `instructions` and `handoff_code`. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HandoffCode** | **string** | The handoff code for the paperless download. | [optional] +**Href** | **string** | The URL of the linked resource, if any | [optional] +**Instructions** | **string** | The instructions for the paperless download. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ParseAddressRequestBody.md b/docs/models/ParseAddressRequestBody.md new file mode 100644 index 00000000..93ca4513 --- /dev/null +++ b/docs/models/ParseAddressRequestBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.ParseAddressRequestBody +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. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Text** | **string** | The unstructured text that contains address-related entities | +**Address** | [**PartialAddress**](PartialAddress.md) | You can optionally provide any already-known address 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. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ParseAddressResponseBody.md b/docs/models/ParseAddressResponseBody.md new file mode 100644 index 00000000..d0ad89ea --- /dev/null +++ b/docs/models/ParseAddressResponseBody.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.ParseAddressResponseBody +The parsed address, as well as a confidence score and a list of all the entities that were recognized in the text. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Address** | [**PartialAddress**](PartialAddress.md) | The parsed address. This address may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The address-recognition API does not currently perform any validation of the parsed address, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the address is correct. | +**Entities** | [**List<RecognizedEntity>**](RecognizedEntity.md) | All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, or an address line. Each entity includes the original text and the parsed value. | +**Score** | **double** | A confidence score between zero and one that indicates how certain the API is that it understood the text. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ParseShipmentRequestBody.md b/docs/models/ParseShipmentRequestBody.md new file mode 100644 index 00000000..d68be319 --- /dev/null +++ b/docs/models/ParseShipmentRequestBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.ParseShipmentRequestBody +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. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Text** | **string** | The unstructured text that contains shipping-related entities | +**Shipment** | [**PartialShipment**](PartialShipment.md) | You can optionally provide a `shipment` object 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. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ParseShipmentResponseBody.md b/docs/models/ParseShipmentResponseBody.md new file mode 100644 index 00000000..130af7a3 --- /dev/null +++ b/docs/models/ParseShipmentResponseBody.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.ParseShipmentResponseBody +The parsed shipment, as well as a confidence score and a list of all the shipping entities that were recognized in the text. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Entities** | [**List<RecognizedEntity>**](RecognizedEntity.md) | All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, a carrier name, or a package weight. Each entity includes the original text and the parsed value. | +**Score** | **double** | A confidence score between zero and one that indicates how certain the API is that it understood the text. | +**Shipment** | [**PartialShipment**](PartialShipment.md) | The parsed shipment. This shipment may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The shipment-recognition API does not currently perform any validation of the parsed addresses, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the addresses are correct. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PartialAddress.md b/docs/models/PartialAddress.md new file mode 100644 index 00000000..005f15f4 --- /dev/null +++ b/docs/models/PartialAddress.md @@ -0,0 +1,22 @@ +# ShipEngineSDK.Model.PartialAddress +A complete or partial mailing address. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddressLine1** | **string** | The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. | [optional] +**AddressLine2** | **string** | The second line of the street address. For some addresses, this line may not be needed. | [optional] +**AddressLine3** | **string** | The third line of the street address. For some addresses, this line may not be needed. | [optional] +**AddressResidentialIndicator** | **AddressResidentialIndicator** | Indicates whether this is a residential address. | [optional] +**CityLocality** | **string** | The name of the city or locality | [optional] +**CompanyName** | **string** | If this is a business address, then the company name should be specified here. | [optional] +**CountryCode** | **string** | The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) | [optional] +**Email** | **string** | Email for the address owner. | [optional] +**Name** | **string** | The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. | [optional] +**Phone** | **string** | The phone number of a contact person at this address. The format of this phone number varies depending on the country. | [optional] +**PostalCode** | **string** | postal code | [optional] +**StateProvince** | **string** | The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PartialShipment.md b/docs/models/PartialShipment.md new file mode 100644 index 00000000..259329db --- /dev/null +++ b/docs/models/PartialShipment.md @@ -0,0 +1,37 @@ +# ShipEngineSDK.Model.PartialShipment +The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AdvancedOptions** | [**AdvancedShipmentOptions**](AdvancedShipmentOptions.md) | Advanced shipment options. These are entirely optional. | [optional] +**CarrierId** | **string** | The carrier account that is billed for the shipping charges | [optional] +**ComparisonRateType** | **string** | Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. | [optional] +**Confirmation** | **DeliveryConfirmation** | The type of delivery confirmation that is required for this shipment. | [optional] +**CreatedAt** | **DateTimeOffset** | The date and time that the shipment was created in ShipEngine. | [optional] [readonly] +**Customs** | [**InternationalShipmentOptions**](InternationalShipmentOptions.md) | Customs information. This is usually only needed for international shipments. | [optional] +**ExternalOrderId** | **string** | ID that the Order Source assigned | [optional] +**ExternalShipmentId** | **string** | A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**InsuranceProvider** | **InsuranceProvider** | The insurance provider to use for any insured packages in the shipment. | [optional] +**IsReturn** | **bool** | An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. | [optional] [default to false] +**Items** | [**List<ShipmentItem>**](ShipmentItem.md) | Describe the packages included in this shipment as related to potential metadata that was imported from external order sources | [optional] +**ModifiedAt** | **DateTimeOffset** | The date and time that the shipment was created or last modified. | [optional] [readonly] +**OrderSourceCode** | **OrderSourceName** | | [optional] +**Packages** | [**List<Package>**](Package.md) | The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. | [optional] +**ReturnTo** | [**ShippingAddress**](ShippingAddress.md) | The return address for this shipment. Defaults to the `ship_from` address. | [optional] +**ServiceCode** | **string** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | [optional] +**ShipDate** | **DateTimeOffset** | The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | [optional] +**ShipFrom** | [**ShippingAddress**](ShippingAddress.md) | The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. | [optional] +**ShipTo** | [**ShippingAddressTo**](ShippingAddressTo.md) | The recipient's mailing address | [optional] +**ShipmentId** | **string** | A string that uniquely identifies the shipment | [optional] [readonly] +**ShipmentNumber** | **string** | A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**ShipmentStatus** | **ShipmentStatus** | The current status of the shipment | [optional] [readonly] +**ShippingRuleId** | **string** | ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment | [optional] +**Tags** | [**List<Tag>**](Tag.md) | Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. | [optional] [readonly] +**TaxIdentifiers** | [**List<TaxIdentifier>**](TaxIdentifier.md) | | [optional] +**TotalWeight** | [**Weight**](Weight.md) | The combined weight of all packages in the shipment | [optional] [readonly] +**WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PartialShippingAddress.md b/docs/models/PartialShippingAddress.md new file mode 100644 index 00000000..6211b0e8 --- /dev/null +++ b/docs/models/PartialShippingAddress.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.PartialShippingAddress +A complete or partial mailing address. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Instructions** | **string** | Additional text about how to handle the shipment at this address. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PartialShippingAddressTo.md b/docs/models/PartialShippingAddressTo.md new file mode 100644 index 00000000..cd79e267 --- /dev/null +++ b/docs/models/PartialShippingAddressTo.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.PartialShippingAddressTo +A complete or partial mailing address. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Geolocation** | [**List<PartialShippingAddressToGeolocationInner>**](PartialShippingAddressToGeolocationInner.md) | | [optional] +**Instructions** | **string** | Additional text about how to handle the shipment at this address. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PartialShippingAddressToGeolocationInner.md b/docs/models/PartialShippingAddressToGeolocationInner.md new file mode 100644 index 00000000..c9b628f0 --- /dev/null +++ b/docs/models/PartialShippingAddressToGeolocationInner.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.PartialShippingAddressToGeolocationInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Enum of available type of geolocation items: - 'what3words' functionality allows to specify a location by providing 3 words that have been assign to the specific location see [link](https://what3words.com/business) for more details. | [optional] +**Value** | **string** | value of the geolocation item | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PaymentAmount.md b/docs/models/PaymentAmount.md new file mode 100644 index 00000000..74e5e482 --- /dev/null +++ b/docs/models/PaymentAmount.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.PaymentAmount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Amount** | **decimal** | | [optional] +**Currency** | **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] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Pickup.md b/docs/models/Pickup.md new file mode 100644 index 00000000..99f3ec54 --- /dev/null +++ b/docs/models/Pickup.md @@ -0,0 +1,22 @@ +# ShipEngineSDK.Model.Pickup +The information necessary to schedule a package pickup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CancelledAt** | **DateTimeOffset** | The date and time that the pickup was cancelled in ShipEngine. | [optional] [readonly] +**CarrierId** | **string** | The carrier_id associated with the pickup | [optional] [readonly] +**ConfirmationNumber** | **string** | The carrier confirmation number for the scheduled pickup. | [optional] [readonly] +**ContactDetails** | [**ContactDetails**](ContactDetails.md) | | [optional] +**CreatedAt** | **DateTimeOffset** | The date and time that the pickup was created in ShipEngine. | [optional] [readonly] +**LabelIds** | **List<string>** | Label IDs that will be included in the pickup request | [optional] +**PickupAddress** | [**Address**](Address.md) | | [optional] [readonly] +**PickupId** | **string** | Pickup Resource ID | [optional] [readonly] +**PickupNotes** | **string** | Used by some carriers to give special instructions for a package pickup | [optional] +**PickupWindow** | [**PickupWindow**](PickupWindow.md) | | [optional] +**PickupWindows** | [**List<PickupWindows>**](PickupWindows.md) | An array of available pickup windows. Carriers can return multiple times that they will pickup packages. | [optional] [readonly] +**WarehouseId** | **string** | The warehouse_id associated with the pickup | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PickupResponseBody.md b/docs/models/PickupResponseBody.md new file mode 100644 index 00000000..ccc561e8 --- /dev/null +++ b/docs/models/PickupResponseBody.md @@ -0,0 +1,22 @@ +# ShipEngineSDK.Model.PickupResponseBody +A pickup response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierId** | **string** | The carrier_id associated with the pickup | [readonly] +**ContactDetails** | [**ContactDetails**](ContactDetails.md) | | +**CreatedAt** | **DateTimeOffset** | The date and time that the pickup was created in ShipEngine. | [readonly] +**LabelIds** | **List<string>** | Label IDs that will be included in the pickup request | +**PickupAddress** | [**Address**](Address.md) | | [readonly] +**PickupId** | **string** | Pickup Resource ID | [readonly] +**PickupWindow** | [**PickupWindow**](PickupWindow.md) | | +**WarehouseId** | **string** | The warehouse_id associated with the pickup | [readonly] +**CancelledAt** | **DateTimeOffset** | The date and time that the pickup was cancelled in ShipEngine. | [optional] [readonly] +**ConfirmationNumber** | **string** | The carrier confirmation number for the scheduled pickup. | [readonly] +**PickupNotes** | **string** | Used by some carriers to give special instructions for a package pickup | [optional] +**PickupWindows** | [**List<PickupWindows>**](PickupWindows.md) | An array of available pickup windows. Carriers can return multiple times that they will pickup packages. | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PickupWindow.md b/docs/models/PickupWindow.md new file mode 100644 index 00000000..49e56e9e --- /dev/null +++ b/docs/models/PickupWindow.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.PickupWindow +The desired time range for the package pickup. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EndAt** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. | +**StartAt** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PickupWindows.md b/docs/models/PickupWindows.md new file mode 100644 index 00000000..7b768b16 --- /dev/null +++ b/docs/models/PickupWindows.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.PickupWindows + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EndAt** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. | [optional] +**StartAt** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ProcessBatchRequestBody.md b/docs/models/ProcessBatchRequestBody.md new file mode 100644 index 00000000..4d16250f --- /dev/null +++ b/docs/models/ProcessBatchRequestBody.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.ProcessBatchRequestBody +A process batch request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayScheme** | **DisplayScheme** | The display format that the label should be shown in. | [optional] +**LabelFormat** | **LabelFormat** | | [optional] +**LabelLayout** | **LabelLayout** | | [optional] [default to "4x6"] +**ShipDate** | **DateTimeOffset** | The Ship date the batch is being processed for | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Products.md b/docs/models/Products.md new file mode 100644 index 00000000..0c578aba --- /dev/null +++ b/docs/models/Products.md @@ -0,0 +1,24 @@ +# ShipEngineSDK.Model.Products +The customs declaration for a single item in the shipment. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CountryOfOrigin** | **string** | The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated | [optional] +**DangerousGoods** | [**List<DangerousGoods>**](DangerousGoods.md) | Details about dangerous goods inside products | [optional] +**Description** | **string** | A description of the item | [optional] +**ExtendedDetails** | **Dictionary<string, Object>** | Additional details about products | [optional] +**HarmonizedTariffCode** | **string** | The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item. | [optional] +**MidCode** | **string** | Manufacturers Identification code | [optional] +**ProductUrl** | **string** | link to the item on the seller website | [optional] +**Quantity** | **int** | The quantity of this item in the shipment. | [optional] [default to 0] +**Sku** | **string** | The SKU (Stock Keeping Unit) of the item | [optional] +**SkuDescription** | **string** | Description of the Custom Item's SKU | [optional] +**UnitOfMeasure** | **string** | | [optional] +**Value** | [**MonetaryValue**](MonetaryValue.md) | The declared value of each item | [optional] +**VatRate** | **decimal** | VAT rate applicable to the item | [optional] +**Weight** | [**Weight**](Weight.md) | The item weight | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/PurchaseLabelWithoutShipment.md b/docs/models/PurchaseLabelWithoutShipment.md new file mode 100644 index 00000000..83b5b2d0 --- /dev/null +++ b/docs/models/PurchaseLabelWithoutShipment.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.PurchaseLabelWithoutShipment +A purchase label without shipment resource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayScheme** | **DisplayScheme** | The display format that the label should be shown in. | [optional] +**LabelDownloadType** | **LabelDownloadType** | | [optional] +**LabelFormat** | **LabelFormat** | | [optional] +**LabelLayout** | **LabelLayout** | | [optional] +**ValidateAddress** | **ValidateAddress** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Rate.md b/docs/models/Rate.md new file mode 100644 index 00000000..f176ac33 --- /dev/null +++ b/docs/models/Rate.md @@ -0,0 +1,37 @@ +# ShipEngineSDK.Model.Rate +A rate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierCode** | **string** | carrier code | [readonly] +**CarrierFriendlyName** | **string** | carrier friendly name | [readonly] +**CarrierId** | **string** | A string that uniquely identifies the carrier | [readonly] +**CarrierNickname** | **string** | carrier nickname | [readonly] +**ConfirmationAmount** | [**MonetaryValue**](MonetaryValue.md) | The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price. | [readonly] +**ErrorMessages** | **List<string>** | The error messages | [readonly] +**GuaranteedService** | **bool** | Indicates if the rate is guaranteed. | [readonly] +**InsuranceAmount** | [**MonetaryValue**](MonetaryValue.md) | The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price. | [readonly] +**NegotiatedRate** | **bool** | Indicates if the rates been negotiated | [readonly] +**OtherAmount** | [**MonetaryValue**](MonetaryValue.md) | Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price. | [readonly] +**RateId** | **string** | A string that uniquely identifies the rate | [readonly] +**RateType** | **RateType** | | [readonly] +**ServiceCode** | **string** | service code for the rate | [readonly] +**ServiceType** | **string** | service type | [readonly] +**ShippingAmount** | [**MonetaryValue**](MonetaryValue.md) | The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price. | [readonly] +**Trackable** | **bool** | Indicates if rate is trackable | [readonly] +**ValidationStatus** | **ValidationStatus** | | [readonly] +**WarningMessages** | **List<string>** | The warning messages | [readonly] +**CarrierDeliveryDays** | **string** | The carrier delivery days | [optional] [readonly] +**DeliveryDays** | **int** | The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday | [optional] [readonly] +**EstimatedDeliveryDate** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. | [optional] [readonly] +**PackageType** | **string** | package type that this rate was estimated for | [readonly] +**RateDetails** | [**List<RateDetail>**](RateDetail.md) | A list of rate details that are associated with this rate. This is useful for displaying a breakdown of the rate to the user. | [optional] [readonly] +**RequestedComparisonAmount** | [**MonetaryValue**](MonetaryValue.md) | The total shipping cost for the specified comparison_rate_type. | [optional] [readonly] +**ShipDate** | **DateTimeOffset** | ship date | [optional] [readonly] +**TaxAmount** | [**MonetaryValue**](MonetaryValue.md) | Tariff and additional taxes associated with an international shipment. | [optional] [readonly] +**Zone** | **int** | Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RateDetail.md b/docs/models/RateDetail.md new file mode 100644 index 00000000..9e592aa9 --- /dev/null +++ b/docs/models/RateDetail.md @@ -0,0 +1,17 @@ +# ShipEngineSDK.Model.RateDetail +Represents detailed information about a shipping cost + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Amount** | [**MonetaryValue**](MonetaryValue.md) | | [optional] +**BillingSource** | **string** | The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance | [optional] +**CarrierBillingCode** | **string** | A rate detail code defined by a carrier | [optional] +**CarrierDescription** | **string** | A rate detail description defined by a carrier | [optional] +**CarrierMemo** | **string** | Contains any additional information | [optional] +**RateDetailAttributes** | [**RateDetailAttributes**](RateDetailAttributes.md) | If applicable, contains additional data about a rate detail of a specific type, e.g. VAT | [optional] +**RateDetailType** | **RateDetailType** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RateDetailAttributes.md b/docs/models/RateDetailAttributes.md new file mode 100644 index 00000000..11d20660 --- /dev/null +++ b/docs/models/RateDetailAttributes.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.RateDetailAttributes +Represents detailed information about a tax (e.g. VAT) contained in a shipping cost. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TaxCode** | **string** | Code for a specific tax type | [optional] +**TaxPercentage** | **decimal** | Tax percentage, e.g. 20 for 20%, added to the shipping cost | [optional] +**TaxType** | **TaxType** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RateDetailType.md b/docs/models/RateDetailType.md new file mode 100644 index 00000000..a3de1ad9 --- /dev/null +++ b/docs/models/RateDetailType.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.RateDetailType +The possible rate detail type values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RateEstimate.md b/docs/models/RateEstimate.md new file mode 100644 index 00000000..2f39b0d2 --- /dev/null +++ b/docs/models/RateEstimate.md @@ -0,0 +1,34 @@ +# ShipEngineSDK.Model.RateEstimate +A rate estimate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierCode** | **string** | A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. | [readonly] +**CarrierFriendlyName** | **string** | carrier friendly name | [readonly] +**CarrierId** | **string** | A string that uniquely identifies the carrier | [readonly] +**CarrierNickname** | **string** | carrier nickname | [readonly] +**ConfirmationAmount** | [**MonetaryValue**](MonetaryValue.md) | The confirmation amount | [readonly] +**ErrorMessages** | **List<string>** | The error messages | [readonly] +**GuaranteedService** | **bool** | Indicates if the rate is guaranteed. | [readonly] +**InsuranceAmount** | [**MonetaryValue**](MonetaryValue.md) | The insurance amount | [readonly] +**NegotiatedRate** | **bool** | Indicates if the rates been negotiated | [readonly] +**OtherAmount** | [**MonetaryValue**](MonetaryValue.md) | Any other charges associated with this rate | [readonly] +**RateType** | **RateType** | | [readonly] +**ServiceCode** | **string** | service code for the rate | [readonly] +**ServiceType** | **string** | service type | [readonly] +**ShippingAmount** | [**MonetaryValue**](MonetaryValue.md) | The shipping amount | [readonly] +**Trackable** | **bool** | Indicates if rate is trackable | [readonly] +**ValidationStatus** | **ValidationStatus** | | [readonly] +**WarningMessages** | **List<string>** | The warning messages | [readonly] +**CarrierDeliveryDays** | **string** | The carrier delivery days | [optional] [readonly] +**DeliveryDays** | **int** | The number of days estimated for delivery, this will show the _actual_ delivery time if for example, the package gets shipped on a Friday | [optional] [readonly] +**EstimatedDeliveryDate** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine. | [optional] [readonly] +**PackageType** | **string** | package type that this rate was estimated for | [readonly] +**ShipDate** | **DateTimeOffset** | ship date | [optional] [readonly] +**TaxAmount** | [**MonetaryValue**](MonetaryValue.md) | Tariff and additional taxes associated with an international shipment. | [optional] [readonly] +**Zone** | **int** | Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location | [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RateEstimateByCarrierId.md b/docs/models/RateEstimateByCarrierId.md new file mode 100644 index 00000000..1b11d104 --- /dev/null +++ b/docs/models/RateEstimateByCarrierId.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.RateEstimateByCarrierId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierId** | **string** | A string that uniquely identifies the carrier | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RateEstimateByCarrierIds.md b/docs/models/RateEstimateByCarrierIds.md new file mode 100644 index 00000000..7e345d17 --- /dev/null +++ b/docs/models/RateEstimateByCarrierIds.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.RateEstimateByCarrierIds + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierIds** | **List<string>** | Array of Carrier Ids | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RateEstimateOptions.md b/docs/models/RateEstimateOptions.md new file mode 100644 index 00000000..11efabfd --- /dev/null +++ b/docs/models/RateEstimateOptions.md @@ -0,0 +1,22 @@ +# ShipEngineSDK.Model.RateEstimateOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddressResidentialIndicator** | **AddressResidentialIndicator** | | [optional] +**Confirmation** | **DeliveryConfirmation** | | [optional] +**Dimensions** | [**Dimensions**](Dimensions.md) | The dimensions of the package | [optional] +**FromCityLocality** | **string** | from postal code | [optional] +**FromCountryCode** | **string** | A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) | [optional] +**FromPostalCode** | **string** | postal code | [optional] +**FromStateProvince** | **string** | From state province | [optional] +**ShipDate** | **DateTimeOffset** | ship date | [optional] +**ToCityLocality** | **string** | The city locality the package is being shipped to | [optional] +**ToCountryCode** | **string** | A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) | [optional] +**ToPostalCode** | **string** | postal code | [optional] +**ToStateProvince** | **string** | To state province | [optional] +**Weight** | [**Weight**](Weight.md) | The weight of the package | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RateRequestBody.md b/docs/models/RateRequestBody.md new file mode 100644 index 00000000..ab1c00dc --- /dev/null +++ b/docs/models/RateRequestBody.md @@ -0,0 +1,16 @@ +# ShipEngineSDK.Model.RateRequestBody +A rate request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierIds** | **List<string>** | Array of carrier ids to get rates for | +**CalculateTaxAmount** | **bool** | Calculate the duties and tariffs for cross border shipments. | [optional] +**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] +**ServiceCodes** | **List<string>** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RateRequestByShipmentIds.md b/docs/models/RateRequestByShipmentIds.md new file mode 100644 index 00000000..eb985e0b --- /dev/null +++ b/docs/models/RateRequestByShipmentIds.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.RateRequestByShipmentIds + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ShipmentIds** | **List<string>** | The array of shipment IDs | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RateRequestByShipments.md b/docs/models/RateRequestByShipments.md new file mode 100644 index 00000000..fb7986f5 --- /dev/null +++ b/docs/models/RateRequestByShipments.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.RateRequestByShipments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Shipments** | [**List<AddressValidatingShipment>**](AddressValidatingShipment.md) | The array of shipments to get bulk rate estimates for | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RateRequestOptions.md b/docs/models/RateRequestOptions.md new file mode 100644 index 00000000..561b7427 --- /dev/null +++ b/docs/models/RateRequestOptions.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.RateRequestOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RateOptions** | [**RateRequestBody**](RateRequestBody.md) | The rate options | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RateRequestRateOptions.md b/docs/models/RateRequestRateOptions.md new file mode 100644 index 00000000..10cb755d --- /dev/null +++ b/docs/models/RateRequestRateOptions.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.RateRequestRateOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RateOptions** | [**RateRequestBody**](RateRequestBody.md) | The rate options | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RateResponse.md b/docs/models/RateResponse.md new file mode 100644 index 00000000..3221997f --- /dev/null +++ b/docs/models/RateResponse.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.RateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarRateResponse** | [**RatesInformation**](RatesInformation.md) | The rates response | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RateResponseStatus.md b/docs/models/RateResponseStatus.md new file mode 100644 index 00000000..2cf1a07b --- /dev/null +++ b/docs/models/RateResponseStatus.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.RateResponseStatus +The possible rate response status values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RateShipmentRequest.md b/docs/models/RateShipmentRequest.md new file mode 100644 index 00000000..06c217f5 --- /dev/null +++ b/docs/models/RateShipmentRequest.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.RateShipmentRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Shipment** | [**AddressValidatingShipment**](AddressValidatingShipment.md) | The shipment object | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RateType.md b/docs/models/RateType.md new file mode 100644 index 00000000..1c63a1ed --- /dev/null +++ b/docs/models/RateType.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.RateType +The possible rate type values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RatesInformation.md b/docs/models/RatesInformation.md new file mode 100644 index 00000000..7327188b --- /dev/null +++ b/docs/models/RatesInformation.md @@ -0,0 +1,17 @@ +# ShipEngineSDK.Model.RatesInformation +A rates information resource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedAt** | **string** | When the rate was created | [optional] +**Errors** | [**List<Error>**](Error.md) | | [optional] +**InvalidRates** | [**List<Rate>**](Rate.md) | An array of invalid shipment rates | [optional] [readonly] +**RateRequestId** | **string** | A string that uniquely identifies the rate request | [optional] [readonly] +**Rates** | [**List<Rate>**](Rate.md) | An array of shipment rates | [optional] [readonly] +**ShipmentId** | **string** | A string that uniquely identifies the shipment | [optional] [readonly] +**Status** | **RateResponseStatus** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ReasonCode.md b/docs/models/ReasonCode.md new file mode 100644 index 00000000..777a595a --- /dev/null +++ b/docs/models/ReasonCode.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.ReasonCode +The possible normalized reasons a label void request may not have been approved + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RecognizedEntity.md b/docs/models/RecognizedEntity.md new file mode 100644 index 00000000..fe102ec1 --- /dev/null +++ b/docs/models/RecognizedEntity.md @@ -0,0 +1,16 @@ +# ShipEngineSDK.Model.RecognizedEntity +An entity is a single piece of data that was recognized in unstructured text. For example, a city, a postal code, package dimensions, insured value, etc. Each entity includes the original text and the parsed value. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EndIndex** | **int** | The index of the last character of this entity within the original text | +**Score** | **double** | A confidence score between zero and one that indicates how certain the API is that it correctly recognized this entity | +**StartIndex** | **int** | The index of the first character of this entity within the original text | +**Text** | **string** | The substring from the original text that was recognized as this entity | +**Type** | **string** | The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.) | +**Result** | **Dictionary<string, Object>** | The normalized value of the entity. Most entity results have a `value` field, which is the normalized value of the entity. For example, if the substring \"john doe\" was recognized as a \"person\" entity, then the value might be normalized to have proper capitalization (e.g. \"John Doe\"). Or if the substring \"ft worth\" was recognized as a \"city\" entity, then the value might be normalized to \"Fort Worth\". Some entities have other information in addition to, or instead of a `value`. For example, a \"dimensions\" entity will have separate fields for `length`, `width`, `height`, and `unit`. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Redirect.md b/docs/models/Redirect.md new file mode 100644 index 00000000..623a8aa9 --- /dev/null +++ b/docs/models/Redirect.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.Redirect +The resource to return a redirect URL to. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RegulationLevel.md b/docs/models/RegulationLevel.md new file mode 100644 index 00000000..63c8aaa7 --- /dev/null +++ b/docs/models/RegulationLevel.md @@ -0,0 +1,9 @@ +# ShipEngineSDK.Model.RegulationLevel + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/RemoveFromBatchRequestBody.md b/docs/models/RemoveFromBatchRequestBody.md new file mode 100644 index 00000000..611793c6 --- /dev/null +++ b/docs/models/RemoveFromBatchRequestBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.RemoveFromBatchRequestBody +A modify batch request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RateIds** | **List<string>** | Array of Rate IDs to be modifed on the batch | [optional] +**ShipmentIds** | **List<string>** | The Shipment Ids to be modified on the batch | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ResponseMessage.md b/docs/models/ResponseMessage.md new file mode 100644 index 00000000..e44fc15d --- /dev/null +++ b/docs/models/ResponseMessage.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.ResponseMessage +A response message that displays when additional info is needed for an address validation request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Code** | **AddressValidationCode** | | [readonly] +**Message** | **string** | Message explaining the address validation error | [readonly] +**Type** | **AddressValidationMessageType** | | [readonly] +**DetailCode** | **AddressValidationDetailCode** | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/SchedulePickupRequestBody.md b/docs/models/SchedulePickupRequestBody.md new file mode 100644 index 00000000..785485d9 --- /dev/null +++ b/docs/models/SchedulePickupRequestBody.md @@ -0,0 +1,22 @@ +# ShipEngineSDK.Model.SchedulePickupRequestBody +A schedule pickup request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContactDetails** | [**ContactDetails**](ContactDetails.md) | | +**LabelIds** | **List<string>** | Label IDs that will be included in the pickup request | +**PickupWindow** | [**PickupWindow**](PickupWindow.md) | | +**CancelledAt** | **DateTimeOffset** | The date and time that the pickup was cancelled in ShipEngine. | [optional] [readonly] +**CarrierId** | **string** | The carrier_id associated with the pickup | [optional] [readonly] +**ConfirmationNumber** | **string** | The carrier confirmation number for the scheduled pickup. | [optional] [readonly] +**CreatedAt** | **DateTimeOffset** | The date and time that the pickup was created in ShipEngine. | [optional] [readonly] +**PickupAddress** | [**Address**](Address.md) | | [optional] [readonly] +**PickupId** | **string** | Pickup Resource ID | [optional] [readonly] +**PickupNotes** | **string** | Used by some carriers to give special instructions for a package pickup | [optional] +**PickupWindows** | [**List<PickupWindows>**](PickupWindows.md) | An array of available pickup windows. Carriers can return multiple times that they will pickup packages. | [optional] [readonly] +**WarehouseId** | **string** | The warehouse_id associated with the pickup | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/SchedulePickupResponseBody.md b/docs/models/SchedulePickupResponseBody.md new file mode 100644 index 00000000..4f8f0d2e --- /dev/null +++ b/docs/models/SchedulePickupResponseBody.md @@ -0,0 +1,23 @@ +# ShipEngineSDK.Model.SchedulePickupResponseBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Errors** | [**List<Error>**](Error.md) | The errors associated with the failed API call | [readonly] +**RequestId** | **Guid** | A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur | +**CancelledAt** | **DateTimeOffset** | The date and time that the pickup was cancelled in ShipEngine. | [optional] [readonly] +**CarrierId** | **string** | The carrier_id associated with the pickup | [optional] [readonly] +**ConfirmationNumber** | **string** | The carrier confirmation number for the scheduled pickup. | [optional] [readonly] +**ContactDetails** | [**ContactDetails**](ContactDetails.md) | | [optional] +**CreatedAt** | **DateTimeOffset** | The date and time that the pickup was created in ShipEngine. | [optional] [readonly] +**LabelIds** | **List<string>** | Label IDs that will be included in the pickup request | [optional] +**PickupAddress** | [**Address**](Address.md) | | [optional] [readonly] +**PickupId** | **string** | Pickup Resource ID | [optional] [readonly] +**PickupNotes** | **string** | Used by some carriers to give special instructions for a package pickup | [optional] +**PickupWindow** | [**PickupWindow**](PickupWindow.md) | | [optional] +**PickupWindows** | [**List<PickupWindows>**](PickupWindows.md) | An array of available pickup windows. Carriers can return multiple times that they will pickup packages. | [optional] [readonly] +**WarehouseId** | **string** | The warehouse_id associated with the pickup | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Service.md b/docs/models/Service.md new file mode 100644 index 00000000..5c8345f7 --- /dev/null +++ b/docs/models/Service.md @@ -0,0 +1,17 @@ +# ShipEngineSDK.Model.Service +A service offered by the carrier + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierCode** | **string** | A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc. | [optional] +**CarrierId** | **string** | A string that uniquely identifies the carrier | [optional] [readonly] +**Domestic** | **bool** | Supports domestic shipping | [optional] [readonly] +**International** | **bool** | Supports international shipping. | [optional] [readonly] +**IsMultiPackageSupported** | **bool** | Carrier supports multiple packages per shipment | [optional] [readonly] +**Name** | **string** | User friendly service name | [optional] [readonly] +**ServiceCode** | **string** | service code | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Shipment.md b/docs/models/Shipment.md new file mode 100644 index 00000000..c266d6ff --- /dev/null +++ b/docs/models/Shipment.md @@ -0,0 +1,37 @@ +# ShipEngineSDK.Model.Shipment +The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight. > **Note:** Either `ship_from` or `warehouse_id` must be set. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AdvancedOptions** | [**AdvancedShipmentOptions**](AdvancedShipmentOptions.md) | Advanced shipment options. These are entirely optional. | +**CarrierId** | **string** | The carrier account that is billed for the shipping charges | +**Confirmation** | **DeliveryConfirmation** | The type of delivery confirmation that is required for this shipment. | +**CreatedAt** | **DateTimeOffset** | The date and time that the shipment was created in ShipEngine. | [readonly] +**InsuranceProvider** | **InsuranceProvider** | The insurance provider to use for any insured packages in the shipment. | +**ModifiedAt** | **DateTimeOffset** | The date and time that the shipment was created or last modified. | [readonly] +**Packages** | [**List<Package>**](Package.md) | The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. | +**ReturnTo** | [**ShippingAddress**](ShippingAddress.md) | The return address for this shipment. Defaults to the `ship_from` address. | +**ServiceCode** | **string** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | +**ShipDate** | **DateTimeOffset** | The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | +**ShipFrom** | [**ShippingAddress**](ShippingAddress.md) | The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. | +**ShipTo** | [**ShippingAddressTo**](ShippingAddressTo.md) | The recipient's mailing address | +**ShipmentId** | **string** | A string that uniquely identifies the shipment | [readonly] +**ShipmentStatus** | **ShipmentStatus** | The current status of the shipment | [readonly] +**Tags** | [**List<Tag>**](Tag.md) | Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. | [readonly] +**TotalWeight** | [**Weight**](Weight.md) | The combined weight of all packages in the shipment | [readonly] +**ComparisonRateType** | **string** | Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. | [optional] +**Customs** | [**InternationalShipmentOptions**](InternationalShipmentOptions.md) | Customs information. This is usually only needed for international shipments. | +**ExternalOrderId** | **string** | ID that the Order Source assigned | [optional] +**ExternalShipmentId** | **string** | A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**IsReturn** | **bool** | An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. | [optional] [default to false] +**Items** | [**List<ShipmentItem>**](ShipmentItem.md) | Describe the packages included in this shipment as related to potential metadata that was imported from external order sources | [optional] +**OrderSourceCode** | **OrderSourceName** | | [optional] +**ShipmentNumber** | **string** | A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**ShippingRuleId** | **string** | ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment | [optional] +**TaxIdentifiers** | [**List<TaxIdentifier>**](TaxIdentifier.md) | | [optional] +**WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ShipmentIdRequest.md b/docs/models/ShipmentIdRequest.md new file mode 100644 index 00000000..c653f77c --- /dev/null +++ b/docs/models/ShipmentIdRequest.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.ShipmentIdRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ShipmentId** | **string** | A string that uniquely identifies the shipment | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ShipmentItem.md b/docs/models/ShipmentItem.md new file mode 100644 index 00000000..153bf554 --- /dev/null +++ b/docs/models/ShipmentItem.md @@ -0,0 +1,19 @@ +# ShipEngineSDK.Model.ShipmentItem +A shipment item + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Asin** | **string** | Amazon Standard Identification Number | [optional] +**ExternalOrderId** | **string** | external order id | [optional] +**ExternalOrderItemId** | **string** | external order item id | [optional] +**Name** | **string** | item name | [optional] +**OrderSourceCode** | **OrderSourceName** | | [optional] +**Quantity** | **int** | The quantity of this item included in the shipment | [optional] +**SalesOrderId** | **string** | sales order id | [optional] +**SalesOrderItemId** | **string** | sales order item id | [optional] +**Sku** | **string** | Item Stock Keeping Unit | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ShipmentRequest.md b/docs/models/ShipmentRequest.md new file mode 100644 index 00000000..2fea4dd0 --- /dev/null +++ b/docs/models/ShipmentRequest.md @@ -0,0 +1,31 @@ +# ShipEngineSDK.Model.ShipmentRequest +The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight. > **Note:** Either `ship_from` or `warehouse_id` must be set. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierId** | **string** | The carrier account that is billed for the shipping charges | +**Packages** | [**List<Package>**](Package.md) | The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. | +**ServiceCode** | **string** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | +**ShipTo** | [**ShippingAddressTo**](ShippingAddressTo.md) | The recipient's mailing address | +**AdvancedOptions** | [**AdvancedShipmentOptions**](AdvancedShipmentOptions.md) | Advanced shipment options. These are entirely optional. | [optional] +**ComparisonRateType** | **string** | Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. | [optional] +**Confirmation** | **DeliveryConfirmation** | The type of delivery confirmation that is required for this shipment. | [optional] +**Customs** | [**InternationalShipmentOptions**](InternationalShipmentOptions.md) | Customs information. This is usually only needed for international shipments. | [optional] +**ExternalOrderId** | **string** | ID that the Order Source assigned | [optional] +**ExternalShipmentId** | **string** | A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**InsuranceProvider** | **InsuranceProvider** | The insurance provider to use for any insured packages in the shipment. | [optional] +**IsReturn** | **bool** | An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. | [optional] [default to false] +**Items** | [**List<ShipmentItem>**](ShipmentItem.md) | Describe the packages included in this shipment as related to potential metadata that was imported from external order sources | [optional] +**OrderSourceCode** | **OrderSourceName** | | [optional] +**ReturnTo** | [**ShippingAddress**](ShippingAddress.md) | The return address for this shipment. Defaults to the `ship_from` address. | [optional] +**ShipDate** | **DateTimeOffset** | The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | [optional] +**ShipFrom** | [**ShippingAddressFrom**](ShippingAddressFrom.md) | The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. | [optional] +**ShipmentNumber** | **string** | A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**ShippingRuleId** | **string** | ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment | [optional] +**TaxIdentifiers** | [**List<TaxIdentifier>**](TaxIdentifier.md) | | [optional] +**WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ShipmentStatus.md b/docs/models/ShipmentStatus.md new file mode 100644 index 00000000..a18e7c3c --- /dev/null +++ b/docs/models/ShipmentStatus.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.ShipmentStatus +The possible shipment status values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ShipmentsSortBy.md b/docs/models/ShipmentsSortBy.md new file mode 100644 index 00000000..412a132e --- /dev/null +++ b/docs/models/ShipmentsSortBy.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.ShipmentsSortBy +The possible shipments sort by values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ShippingAddress.md b/docs/models/ShippingAddress.md new file mode 100644 index 00000000..381edf4a --- /dev/null +++ b/docs/models/ShippingAddress.md @@ -0,0 +1,22 @@ +# ShipEngineSDK.Model.ShippingAddress + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddressLine1** | **string** | The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. | +**CityLocality** | **string** | The name of the city or locality | +**Name** | **string** | The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. | +**PostalCode** | **string** | postal code | +**StateProvince** | **string** | The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. | +**AddressLine2** | **string** | The second line of the street address. For some addresses, this line may not be needed. | [optional] +**AddressLine3** | **string** | The third line of the street address. For some addresses, this line may not be needed. | [optional] +**AddressResidentialIndicator** | **AddressResidentialIndicator** | Indicates whether this is a residential address. | [optional] +**CompanyName** | **string** | If this is a business address, then the company name should be specified here. | [optional] +**CountryCode** | **string** | The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) | [optional] +**Email** | **string** | Email for the address owner. | [optional] +**Instructions** | **string** | Additional text about how to handle the shipment at this address. | [optional] +**Phone** | **string** | The phone number of a contact person at this address. The format of this phone number varies depending on the country. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ShippingAddressFrom.md b/docs/models/ShippingAddressFrom.md new file mode 100644 index 00000000..4d554f40 --- /dev/null +++ b/docs/models/ShippingAddressFrom.md @@ -0,0 +1,22 @@ +# ShipEngineSDK.Model.ShippingAddressFrom + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddressLine1** | **string** | The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. | +**CityLocality** | **string** | The name of the city or locality | +**CountryCode** | **string** | The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) | +**Name** | **string** | The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. | +**Phone** | **string** | The phone number of a contact person at this address. The format of this phone number varies depending on the country. | +**PostalCode** | **string** | postal code | +**StateProvince** | **string** | The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. | +**AddressLine2** | **string** | The second line of the street address. For some addresses, this line may not be needed. | [optional] +**AddressLine3** | **string** | The third line of the street address. For some addresses, this line may not be needed. | [optional] +**AddressResidentialIndicator** | **AddressResidentialIndicator** | Indicates whether this is a residential address. | [optional] +**CompanyName** | **string** | If this is a business address, then the company name should be specified here. | [optional] +**Email** | **string** | Email for the address owner. | [optional] +**Instructions** | **string** | Additional text about how to handle the shipment at this address. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ShippingAddressTo.md b/docs/models/ShippingAddressTo.md new file mode 100644 index 00000000..55ff3b0a --- /dev/null +++ b/docs/models/ShippingAddressTo.md @@ -0,0 +1,23 @@ +# ShipEngineSDK.Model.ShippingAddressTo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddressLine1** | **string** | The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. | +**CityLocality** | **string** | The name of the city or locality | +**Name** | **string** | The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. | +**PostalCode** | **string** | postal code | +**StateProvince** | **string** | The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. | +**AddressLine2** | **string** | The second line of the street address. For some addresses, this line may not be needed. | [optional] +**AddressLine3** | **string** | The third line of the street address. For some addresses, this line may not be needed. | [optional] +**AddressResidentialIndicator** | **AddressResidentialIndicator** | Indicates whether this is a residential address. | [optional] +**CompanyName** | **string** | If this is a business address, then the company name should be specified here. | [optional] +**CountryCode** | **string** | The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) | [optional] +**Email** | **string** | Email for the address owner. | [optional] +**Geolocation** | [**List<PartialShippingAddressToGeolocationInner>**](PartialShippingAddressToGeolocationInner.md) | | [optional] +**Instructions** | **string** | Additional text about how to handle the shipment at this address. | [optional] +**Phone** | **string** | The phone number of a contact person at this address. The format of this phone number varies depending on the country. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/SmartPostHub.md b/docs/models/SmartPostHub.md new file mode 100644 index 00000000..405c4c25 --- /dev/null +++ b/docs/models/SmartPostHub.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.SmartPostHub +The possible smart post hub values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/SortDir.md b/docs/models/SortDir.md new file mode 100644 index 00000000..40799365 --- /dev/null +++ b/docs/models/SortDir.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.SortDir +Controls the sort order of queries |Value |Description |:- -- -- -- --|:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`asc` |Return results in ascending order |`desc` |Return results in descending order + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/StatusCode.md b/docs/models/StatusCode.md new file mode 100644 index 00000000..fddc991b --- /dev/null +++ b/docs/models/StatusCode.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.StatusCode +The tracking status codes |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`UN` | Unknown |`AC` | Accepted |`IT` | In Transit |`DE` | Delivered |`EX` | Exception |`AT` | Delivery Attempt |`NY` | Not Yet In System |`SP` | Delivered To Collection Location + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/StatusDetailCode.md b/docs/models/StatusDetailCode.md new file mode 100644 index 00000000..095e3a78 --- /dev/null +++ b/docs/models/StatusDetailCode.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.StatusDetailCode +The tracking status detail codes |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- | `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates. | `SHIPMENT_CREATED` | Your tracking number is ready. Your parcel is waiting to be registered in the carrier system and scheduled for pickup. | `AWAITING_PICKUP_DROP_OFF` | Your parcel is waiting to be handed over to the carrier. | `DROPPED_OFF` | Your parcel has been dropped off and is ready for carrier processing. | `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system. | `PICKED_UP` | Your parcel has been picked up by the carrier. | `CUSTOMS_CLEARED` | Your parcel has cleared customs and is continuing its journey. | `CUSTOMS_PROCESSING` | Your parcel is currently being processed by customs. | `DELIVERY_ARRANGED_WITH_RECIPIENT` | Your parcel's delivery has been arranged with the carrier. | `HUB_SCAN_OUT` | Your parcel has left the carrier's hub. | `HUB_SCAN_IN` | Your parcel has arrived at the carrier's hub for processing. | `IN_TRANSIT` | Your shipment is on its way between the carrier hubs. | `INFORMATION` | The carrier has shared additional information about your parcel. | `PARCEL_OVER_LABELLED` | Your parcel's label has been updated by the carrier, which may affect tracking visibility. | `PARCEL_UPDATE_NOTIFICATION` | The carrier has sent you an update on your parcel status via SMS or email. | `RECEIVED_BY_CARRIER` | Your parcel has been received by the carrier and is beginning its journey. | `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your parcel has arrived at the local delivery depot and is almost ready for delivery. | `SUB_CONTRACTOR_EVENT` | The carrier has shared additional information about your parcel's handling by a delivery partner. | `SUB_CONTRACTOR_RECEIVED` | Your parcel has been received by the carrier's local delivery partner. | `PARCEL_REDIRECTED` | Your parcel has been redirected to a new delivery address per your request. | `DELIVERY_SCHEDULED` | Your parcel's delivery has been scheduled and will soon be out for delivery. | `HUB_PROCESSING` | Your parcel is being processed at a carrier hub. | `DELIVERY_RESCHEDULED` | Your parcel's delivery has been rescheduled due to operational issues. | `ATTEMPTED_DELIVERY` | The carrier attempted to deliver your parcel but was unable to complete delivery. | `ATTEMPTED_DELIVERY_FINAL` | The carrier made a final attempt to deliver your parcel but was unable to complete delivery. Please check the carrier's instructions for next steps. | `COD_AMOUNT_PAID` | Cash on delivery payment received. | `CUSTOMER_CARDED` | Delivery attempt failed. Please follow delivery instructions left by the carrier. | `OUT_FOR_DELIVERY` | Your parcel is on its way and will be delivered today. | `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your parcel is ready for collection at the selected pickup point. | `COLLECT_AT_LOCAL_PO` | Your parcel is ready for collection at your local post office. | `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your parcel is available for collection from the carrier's local delivery unit. | `DELIVERED_TO_RECEPTION` | Your parcel has been delivered to your building's reception or designated mail area. | `DELIVERED` | Your parcel has been successfully delivered. | `DELIVERED_DAMAGED` | Your parcel was delivered but arrived with visible damage. | `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest. | `DELIVERED_SPECIFIED_SAFE_PLACE` | Your parcel has been delivered to your specified safe place. | `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your parcel was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details. | `DELIVERED_TO_NEIGHBOUR` | Your parcel was delivered to your neighbor. | `DELIVERED_TO_PO_BOX` | Your parcel has been delivered to your specified PO Box. | `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the pick up point. | `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery. | `PROOF_OF_DELIVERY` | The carrier has confirmed delivery with proof, such as a signature or photo. | `PICKUP_FAILED` | Parcel pickup failed. The delivery company will try again soon. | `NOT_YET_RECEIVED_BY_CARRIER` | The carrier has not yet received your parcel, which may cause a delay. | `PARCEL_DAMAGED` | Your parcel was damaged in transit but will still be delivered. | `ADDRESS_QUERY` | There is an issue with the delivery address, which may delay your parcel. | `CARRIER_DELAYS` | Your parcel is delayed due to issues within the carrier network. | `DELAYED_NOT_CARRIER` | Your parcel is delayed due to circumstances beyond the carrier's control. | `HELD_BY_CARRIER` | Your parcel is being held due to an operational issue. Contact with the carrier for more information. | `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your parcel is being held by the carrier for customs documentation checks. This may occur when the carrier must confirm documentation before the parcel can continue its journey. | `HELD_BY_CUSTOMS` | Your parcel is being held at customs, which may delay delivery. | `HELD_BY_EXPORT_CUSTOMS` | Your parcel is held at export customs, which may delay delivery. | `HELD_BY_IMPORT_CUSTOMS` | Your parcel is held at import customs and may require action to proceed. | `INCORRECT_DECLARATION` | Your parcel has been incorrectly declared but is still moving forward for delivery. | `MISROUTED` | Your parcel was sent to the wrong place due to a routing error but is being redirected. | `PARCEL_REPACKED` | Your parcel was repackaged by the carrier due to damage and will still be delivered. | `RECD_BY_CARRIER_NO_ELEC_ADVICE` | Your parcel has been received by the carrier but may experience delays due to missing pre-advice. | `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please follow carrier instructions. | `CUSTOMER_IDENTIFICATION_FAILED` | Delivery couldn't be completed as identification requirements were not met. | `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | The carrier couldn't access the delivery location due to restricted entry. | `CANCELLED` | Your parcel has been cancelled. | `CUSTOMER_MOVED` | Delivery failed as the recipient is no longer at the specified address. Your parcel is being returned. | `HAZARDOUS_PROHIBITED` | Your parcel contains restricted items and will not be delivered. | `NOT_COLLECTED_FROM_PICKUP_POINT` | Your parcel was not collected from the pickup point within the designated time and will be returned. | `NOT_DELIVERED` | All delivery attempts failed. Your parcel is being returned to the sender. | `NOT_DELIVERED_ADDRESSEE_DECEASED` | The parcel could not be delivered as the addressee is reported deceased. | `PARCEL_DISPOSED` | Your parcel has been disposed of due to its contents or condition and will not be delivered. | `PARCEL_LOST` | The carrier has reported that your parcel is lost and will not be delivered. | `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | The parcel cannot be delivered as it exceeds the carrier's service limits. | `REFUSED_BY_CUSTOMER` | You have refused the parcel, and it will be returned to the sender. | `RETURN_TO_SENDER` | Your parcel is being returned to the sender due to delivery issues. | `UNSPECIFIED_EXCEPTION` | The carrier has reported an issue with your parcel, but details are unavailable. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Tag.md b/docs/models/Tag.md new file mode 100644 index 00000000..20bc0d3b --- /dev/null +++ b/docs/models/Tag.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.Tag +Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The tag name. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/TagShipmentResponseBody.md b/docs/models/TagShipmentResponseBody.md new file mode 100644 index 00000000..b3204152 --- /dev/null +++ b/docs/models/TagShipmentResponseBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.TagShipmentResponseBody +Get shipment tags response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Tags** | **List<string>** | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/TaxIdentifier.md b/docs/models/TaxIdentifier.md new file mode 100644 index 00000000..c87ec78f --- /dev/null +++ b/docs/models/TaxIdentifier.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.TaxIdentifier +A tax identifier object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentifierType** | **IdentifierType** | | +**IssuingAuthority** | **string** | The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code. | +**TaxableEntityType** | **TaxableEntityType** | | +**Value** | **string** | The value of the identifier | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/TaxType.md b/docs/models/TaxType.md new file mode 100644 index 00000000..780fe4ae --- /dev/null +++ b/docs/models/TaxType.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.TaxType +Type of a tax added to shipping cost + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/TaxableEntityType.md b/docs/models/TaxableEntityType.md new file mode 100644 index 00000000..2dc94941 --- /dev/null +++ b/docs/models/TaxableEntityType.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.TaxableEntityType +The taxable entity type for this tax item. Valid values include the following |Value |Description |:- -- -- -- -- |:- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- |`shipper` | The shipper is responsible for this tax. |`recipient` | The recipient of the shipment is responsible for this tax. |`ior` | The importer of records is responsible for tax. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/TokensGetEphemeralTokenResponseBodyYaml.md b/docs/models/TokensGetEphemeralTokenResponseBodyYaml.md new file mode 100644 index 00000000..ef1b0672 --- /dev/null +++ b/docs/models/TokensGetEphemeralTokenResponseBodyYaml.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.TokensGetEphemeralTokenResponseBodyYaml + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RedirectUrl** | **string** | The redirect url formatted with the requested token. | [optional] +**Token** | **string** | The requested token that expires in 10 seconds. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/TrackEvent.md b/docs/models/TrackEvent.md new file mode 100644 index 00000000..8d3df63f --- /dev/null +++ b/docs/models/TrackEvent.md @@ -0,0 +1,29 @@ +# ShipEngineSDK.Model.TrackEvent +A track event + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CarrierDetailCode** | **string** | Carrier detail code | [readonly] +**CarrierStatusCode** | **string** | Carrier status code | [readonly] +**CarrierStatusDescription** | **string** | carrier status description | [readonly] +**CityLocality** | **string** | City locality | [readonly] +**OccurredAt** | **DateTimeOffset** | Timestamp for carrier event | +**PostalCode** | **string** | Postal code | [readonly] +**StateProvince** | **string** | State province | [readonly] +**StatusCode** | **StatusCode** | | +**StatusDescription** | **string** | Event Status Description | [readonly] +**CarrierOccurredAt** | **DateTimeOffset** | Carrier timestamp for the event, it is assumed to be the local time of where the event occurred. | [optional] +**CompanyName** | **string** | Company Name | [optional] [readonly] +**CountryCode** | **string** | A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) | [optional] +**Description** | **string** | Event description | [optional] [readonly] +**EventCode** | **string** | Event Code | [optional] +**Latitude** | **double** | Latitude coordinate of tracking event. | [optional] +**Longitude** | **double** | Longitude coordinate of tracking event. | [optional] +**Signer** | **string** | Signer information | [optional] [readonly] +**StatusDetailCode** | **StatusDetailCode** | | [optional] +**StatusDetailDescription** | **string** | Event Status Detail Description | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/TrackingInformation.md b/docs/models/TrackingInformation.md new file mode 100644 index 00000000..8378ed63 --- /dev/null +++ b/docs/models/TrackingInformation.md @@ -0,0 +1,26 @@ +# ShipEngineSDK.Model.TrackingInformation +A tracking information resource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ActualDeliveryDate** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. | [optional] +**CarrierCode** | **string** | A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. | [optional] +**CarrierDetailCode** | **string** | Carrier detail code | [optional] [readonly] +**CarrierId** | **int** | The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label | [optional] [readonly] +**CarrierStatusCode** | **string** | Carrier status code | [optional] [readonly] +**CarrierStatusDescription** | **string** | carrier status description | [optional] [readonly] +**EstimatedDeliveryDate** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. | [optional] +**Events** | [**List<TrackEvent>**](TrackEvent.md) | The events that have occured during the lifetime of this tracking number. | [optional] [readonly] +**ExceptionDescription** | **string** | Exception description | [optional] [readonly] +**ShipDate** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. | [optional] +**StatusCode** | **StatusCode** | | [optional] +**StatusDescription** | **string** | Status description | [optional] [readonly] +**StatusDetailCode** | **StatusDetailCode** | | [optional] +**StatusDetailDescription** | **string** | Status detail description | [optional] [readonly] +**TrackingNumber** | **string** | A tracking number for a package. The format depends on the carrier. | [optional] +**TrackingUrl** | **string** | Carrier Tracking Url, if available | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/TrackingStatus.md b/docs/models/TrackingStatus.md new file mode 100644 index 00000000..ef841298 --- /dev/null +++ b/docs/models/TrackingStatus.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.TrackingStatus +The different statuses that can apply to a shipment. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/TransportMean.md b/docs/models/TransportMean.md new file mode 100644 index 00000000..f776b5e6 --- /dev/null +++ b/docs/models/TransportMean.md @@ -0,0 +1,9 @@ +# ShipEngineSDK.Model.TransportMean + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpdateAccountSettingsImageRequestBody.md b/docs/models/UpdateAccountSettingsImageRequestBody.md new file mode 100644 index 00000000..e8b801ca --- /dev/null +++ b/docs/models/UpdateAccountSettingsImageRequestBody.md @@ -0,0 +1,17 @@ +# ShipEngineSDK.Model.UpdateAccountSettingsImageRequestBody +A ShipEngine account settings images request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsDefault** | **bool** | Indicates whether this image is set as default. | +**CreatedAt** | **DateTimeOffset** | The date and time that the image was created in ShipEngine. | [optional] [readonly] +**ImageContentType** | **string** | The image type | [optional] +**ImageData** | **string** | A base64 encoded string representation of the image. | [optional] +**LabelImageId** | **string** | A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. | [optional] [readonly] +**ModifiedAt** | **DateTimeOffset** | The date and time that the image was modified in ShipEngine. | [optional] [readonly] +**Name** | **string** | A human readable name for the image. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpdateAmazonBuyShippingRequestBody.md b/docs/models/UpdateAmazonBuyShippingRequestBody.md new file mode 100644 index 00000000..5b6868b6 --- /dev/null +++ b/docs/models/UpdateAmazonBuyShippingRequestBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.UpdateAmazonBuyShippingRequestBody +An amazon buy shipping account settings request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Email** | **string** | Email | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpdateCarrierSettingsRequestBody.md b/docs/models/UpdateCarrierSettingsRequestBody.md new file mode 100644 index 00000000..e9c8e81c --- /dev/null +++ b/docs/models/UpdateCarrierSettingsRequestBody.md @@ -0,0 +1,9 @@ +# ShipEngineSDK.Model.UpdateCarrierSettingsRequestBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpdateDhlExpressSettingsRequestBody.md b/docs/models/UpdateDhlExpressSettingsRequestBody.md new file mode 100644 index 00000000..5e1a8999 --- /dev/null +++ b/docs/models/UpdateDhlExpressSettingsRequestBody.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.UpdateDhlExpressSettingsRequestBody +An update dhl express settings request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsPrimaryAccount** | **bool** | Indicates if this is primary account | [optional] +**Nickname** | **string** | Account nickname | [optional] +**ShouldHideAccountNumberOnArchiveDoc** | **bool** | Indicates if the account number should be hidden on the archive documentation | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpdateFedexSettingsRequestBody.md b/docs/models/UpdateFedexSettingsRequestBody.md new file mode 100644 index 00000000..3b485263 --- /dev/null +++ b/docs/models/UpdateFedexSettingsRequestBody.md @@ -0,0 +1,17 @@ +# ShipEngineSDK.Model.UpdateFedexSettingsRequestBody +An update Fedex settings request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsPrimaryAccount** | **bool** | | [optional] +**LetterheadImage** | **string** | | [optional] +**Nickname** | **string** | Account nickname | [optional] +**PickupType** | **FedexPickupType** | | [optional] +**SignatureImage** | **string** | | [optional] +**SmartPostEndorsement** | **AncillaryServiceEndorsement** | | [optional] +**SmartPostHub** | **SmartPostHub** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpdateNewgisticsSettingsRequestBody.md b/docs/models/UpdateNewgisticsSettingsRequestBody.md new file mode 100644 index 00000000..80dfc573 --- /dev/null +++ b/docs/models/UpdateNewgisticsSettingsRequestBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.UpdateNewgisticsSettingsRequestBody +A newgistics account settings request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludeBarcodeWithOrderNumber** | **bool** | | [optional] +**ReceiveEmailOnManifestProcessing** | **bool** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpdatePackageTypeRequestBody.md b/docs/models/UpdatePackageTypeRequestBody.md new file mode 100644 index 00000000..37a795f3 --- /dev/null +++ b/docs/models/UpdatePackageTypeRequestBody.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.UpdatePackageTypeRequestBody +An update package type request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | | +**PackageCode** | **string** | A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types. | +**Description** | **string** | Provides a helpful description for the custom package. | [optional] +**Dimensions** | [**Dimensions**](Dimensions.md) | The custom dimensions for the package. | [optional] +**PackageId** | **string** | A string that uniquely identifies the package. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpdateShipmentFields.md b/docs/models/UpdateShipmentFields.md new file mode 100644 index 00000000..f8930a07 --- /dev/null +++ b/docs/models/UpdateShipmentFields.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.UpdateShipmentFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ValidateAddress** | **ValidateAddress** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpdateShipmentRequestBody.md b/docs/models/UpdateShipmentRequestBody.md new file mode 100644 index 00000000..ac4dbcd3 --- /dev/null +++ b/docs/models/UpdateShipmentRequestBody.md @@ -0,0 +1,38 @@ +# ShipEngineSDK.Model.UpdateShipmentRequestBody +An update shipment request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ShipFrom** | [**ShippingAddress**](ShippingAddress.md) | The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. | +**ShipTo** | [**ShippingAddressTo**](ShippingAddressTo.md) | The recipient's mailing address | +**AdvancedOptions** | [**AdvancedShipmentOptions**](AdvancedShipmentOptions.md) | Advanced shipment options. These are entirely optional. | [optional] +**CarrierId** | **string** | The carrier account that is billed for the shipping charges | [optional] +**ComparisonRateType** | **string** | Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. | [optional] +**Confirmation** | **DeliveryConfirmation** | The type of delivery confirmation that is required for this shipment. | [optional] +**CreatedAt** | **DateTimeOffset** | The date and time that the shipment was created in ShipEngine. | [optional] [readonly] +**Customs** | [**InternationalShipmentOptions**](InternationalShipmentOptions.md) | Customs information. This is usually only needed for international shipments. | [optional] +**ExternalOrderId** | **string** | ID that the Order Source assigned | [optional] +**ExternalShipmentId** | **string** | A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**InsuranceProvider** | **InsuranceProvider** | The insurance provider to use for any insured packages in the shipment. | [optional] +**IsReturn** | **bool** | An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. | [optional] [default to false] +**Items** | [**List<ShipmentItem>**](ShipmentItem.md) | Describe the packages included in this shipment as related to potential metadata that was imported from external order sources | [optional] +**ModifiedAt** | **DateTimeOffset** | The date and time that the shipment was created or last modified. | [optional] [readonly] +**OrderSourceCode** | **OrderSourceName** | | [optional] +**Packages** | [**List<Package>**](Package.md) | The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. | [optional] +**ReturnTo** | [**ShippingAddress**](ShippingAddress.md) | The return address for this shipment. Defaults to the `ship_from` address. | [optional] +**ServiceCode** | **string** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | [optional] +**ShipDate** | **DateTimeOffset** | The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | [optional] +**ShipmentId** | **string** | A string that uniquely identifies the shipment | [optional] [readonly] +**ShipmentNumber** | **string** | A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**ShipmentStatus** | **ShipmentStatus** | The current status of the shipment | [optional] [readonly] +**ShippingRuleId** | **string** | ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment | [optional] +**Tags** | [**List<Tag>**](Tag.md) | Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. | [optional] [readonly] +**TaxIdentifiers** | [**List<TaxIdentifier>**](TaxIdentifier.md) | | [optional] +**TotalWeight** | [**Weight**](Weight.md) | The combined weight of all packages in the shipment | [optional] [readonly] +**ValidateAddress** | **ValidateAddress** | | [optional] +**WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpdateShipmentResponseBody.md b/docs/models/UpdateShipmentResponseBody.md new file mode 100644 index 00000000..8d3883f6 --- /dev/null +++ b/docs/models/UpdateShipmentResponseBody.md @@ -0,0 +1,39 @@ +# ShipEngineSDK.Model.UpdateShipmentResponseBody +An update shipment response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddressValidation** | [**AddressValidationResult**](AddressValidationResult.md) | The address validation | +**AdvancedOptions** | [**AdvancedShipmentOptions**](AdvancedShipmentOptions.md) | Advanced shipment options. These are entirely optional. | +**CarrierId** | **string** | The carrier account that is billed for the shipping charges | +**Confirmation** | **DeliveryConfirmation** | The type of delivery confirmation that is required for this shipment. | +**CreatedAt** | **DateTimeOffset** | The date and time that the shipment was created in ShipEngine. | [readonly] +**Errors** | **List<string>** | An array of errors that occurred while creating shipment. | [readonly] +**InsuranceProvider** | **InsuranceProvider** | The insurance provider to use for any insured packages in the shipment. | +**Packages** | [**List<Package>**](Package.md) | The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. | +**ReturnTo** | [**ShippingAddress**](ShippingAddress.md) | The return address for this shipment. Defaults to the `ship_from` address. | +**ServiceCode** | **string** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | +**ShipDate** | **DateTimeOffset** | The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | +**ShipFrom** | [**ShippingAddress**](ShippingAddress.md) | The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time. | +**ShipTo** | [**ShippingAddressTo**](ShippingAddressTo.md) | The recipient's mailing address | +**ShipmentId** | **string** | A string that uniquely identifies the shipment | [readonly] +**ShipmentStatus** | **ShipmentStatus** | The current status of the shipment | [readonly] +**Tags** | [**List<Tag>**](Tag.md) | Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. | [readonly] +**TotalWeight** | [**Weight**](Weight.md) | The combined weight of all packages in the shipment | [readonly] +**ComparisonRateType** | **string** | Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. | [optional] +**Customs** | [**InternationalShipmentOptions**](InternationalShipmentOptions.md) | Customs information. This is usually only needed for international shipments. | +**ExternalOrderId** | **string** | ID that the Order Source assigned | [optional] +**ExternalShipmentId** | **string** | A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**IsReturn** | **bool** | An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. | [optional] [default to false] +**Items** | [**List<ShipmentItem>**](ShipmentItem.md) | Describe the packages included in this shipment as related to potential metadata that was imported from external order sources | [optional] +**ModifiedAt** | **DateTimeOffset** | The date and time that the shipment was created or last modified. | [optional] [readonly] +**OrderSourceCode** | **OrderSourceName** | | [optional] +**ShipmentNumber** | **string** | A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. | [optional] +**ShippingRuleId** | **string** | ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment | [optional] +**TaxIdentifiers** | [**List<TaxIdentifier>**](TaxIdentifier.md) | | [optional] +**WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpdateShipmentsTags.md b/docs/models/UpdateShipmentsTags.md new file mode 100644 index 00000000..8f232098 --- /dev/null +++ b/docs/models/UpdateShipmentsTags.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.UpdateShipmentsTags + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ShipmentsTags** | [**List<UpdateShipmentsTagsShipmentsTagsInner>**](UpdateShipmentsTagsShipmentsTagsInner.md) | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpdateShipmentsTagsRequestBody.md b/docs/models/UpdateShipmentsTagsRequestBody.md new file mode 100644 index 00000000..a52a00d0 --- /dev/null +++ b/docs/models/UpdateShipmentsTagsRequestBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.UpdateShipmentsTagsRequestBody +A request body with shipments and tags + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ShipmentsTags** | [**List<UpdateShipmentsTagsShipmentsTagsInner>**](UpdateShipmentsTagsShipmentsTagsInner.md) | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpdateShipmentsTagsShipmentsTagsInner.md b/docs/models/UpdateShipmentsTagsShipmentsTagsInner.md new file mode 100644 index 00000000..719737f2 --- /dev/null +++ b/docs/models/UpdateShipmentsTagsShipmentsTagsInner.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.UpdateShipmentsTagsShipmentsTagsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ShipmentId** | **string** | | [optional] +**Tags** | **List<string>** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpdateUpsSettingsRequestBody.md b/docs/models/UpdateUpsSettingsRequestBody.md new file mode 100644 index 00000000..75628d46 --- /dev/null +++ b/docs/models/UpdateUpsSettingsRequestBody.md @@ -0,0 +1,22 @@ +# ShipEngineSDK.Model.UpdateUpsSettingsRequestBody +An update UPS settings request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountPostalCode** | **string** | account postal code | [optional] +**Invoice** | [**UpsInvoice**](UpsInvoice.md) | The invoice | [optional] +**IsPrimaryAccount** | **bool** | Indicates if this is the primary UPS account | [optional] +**MailInnovationsCostCenter** | **string** | mail innovations cost center | [optional] +**MailInnovationsEndorsement** | **AncillaryServiceEndorsement** | | [optional] +**Nickname** | **string** | nickname | [optional] +**PickupType** | **UpsPickupType** | | [optional] +**UseCarbonNeutralShippingProgram** | **bool** | The use carbon neutral shipping program | [optional] +**UseConsolidationServices** | **bool** | The use consolidation services | [optional] +**UseGroundFreightPricing** | **bool** | The use ground freight pricing | [optional] +**UseNegotiatedRates** | **bool** | The use negotiated rates | [optional] +**UseOrderNumberOnMailInnovationsLabels** | **bool** | The use order number on mail innovations labels | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpdateWarehouseRequestBody.md b/docs/models/UpdateWarehouseRequestBody.md new file mode 100644 index 00000000..2dd2e121 --- /dev/null +++ b/docs/models/UpdateWarehouseRequestBody.md @@ -0,0 +1,16 @@ +# ShipEngineSDK.Model.UpdateWarehouseRequestBody +An update warehouse request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Name of the warehouse | +**OriginAddress** | [**Address**](Address.md) | The origin address of the warehouse | +**CreatedAt** | **DateTimeOffset** | Timestamp that indicates when the warehouse was created | [optional] [readonly] +**IsDefault** | **bool** | Designates which single warehouse is the default on the account | [optional] [default to false] +**ReturnAddress** | [**Address**](Address.md) | The return address associated with the warehouse | [optional] +**WarehouseId** | **string** | A string that uniquely identifies the warehouse | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpdateWarehouseSettingsRequestBody.md b/docs/models/UpdateWarehouseSettingsRequestBody.md new file mode 100644 index 00000000..e860bfe4 --- /dev/null +++ b/docs/models/UpdateWarehouseSettingsRequestBody.md @@ -0,0 +1,11 @@ +# ShipEngineSDK.Model.UpdateWarehouseSettingsRequestBody +An update warehouse settings request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsDefault** | **bool** | The default property on the warehouse. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpdateWebhookRequestBody.md b/docs/models/UpdateWebhookRequestBody.md new file mode 100644 index 00000000..c0923c0c --- /dev/null +++ b/docs/models/UpdateWebhookRequestBody.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.UpdateWebhookRequestBody +An update webhook request body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Headers** | [**List<WebhookHeader>**](WebhookHeader.md) | Array of custom webhook headers | [optional] +**Url** | **string** | The url that the wehbook sends the request | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpsAccountSettings.md b/docs/models/UpsAccountSettings.md new file mode 100644 index 00000000..96d03167 --- /dev/null +++ b/docs/models/UpsAccountSettings.md @@ -0,0 +1,22 @@ +# ShipEngineSDK.Model.UpsAccountSettings +UPS account settings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountPostalCode** | **string** | account postal code | [optional] +**Invoice** | [**UpsInvoice**](UpsInvoice.md) | The invoice | [optional] +**IsPrimaryAccount** | **bool** | Indicates if this is the primary UPS account | [optional] +**MailInnovationsCostCenter** | **string** | mail innovations cost center | [optional] +**MailInnovationsEndorsement** | **AncillaryServiceEndorsement** | | [optional] +**Nickname** | **string** | nickname | [optional] +**PickupType** | **UpsPickupType** | | [optional] +**UseCarbonNeutralShippingProgram** | **bool** | The use carbon neutral shipping program | [optional] +**UseConsolidationServices** | **bool** | The use consolidation services | [optional] +**UseGroundFreightPricing** | **bool** | The use ground freight pricing | [optional] +**UseNegotiatedRates** | **bool** | The use negotiated rates | [optional] +**UseOrderNumberOnMailInnovationsLabels** | **bool** | The use order number on mail innovations labels | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpsInvoice.md b/docs/models/UpsInvoice.md new file mode 100644 index 00000000..1b3515a1 --- /dev/null +++ b/docs/models/UpsInvoice.md @@ -0,0 +1,15 @@ +# ShipEngineSDK.Model.UpsInvoice +UPS invoice + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ControlId** | **string** | A string that uniquely identifies the control | [optional] +**InvoiceAmount** | **decimal** | | [optional] +**InvoiceCurrencyCode** | **string** | | [optional] +**InvoiceDate** | **DateTimeOffset** | invoice date | [optional] +**InvoiceNumber** | **string** | invoice number | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpsPickupType.md b/docs/models/UpsPickupType.md new file mode 100644 index 00000000..cee9e2d0 --- /dev/null +++ b/docs/models/UpsPickupType.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.UpsPickupType +The possible ups pickup type values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/UpsSettingsResponseBody.md b/docs/models/UpsSettingsResponseBody.md new file mode 100644 index 00000000..f35e57f5 --- /dev/null +++ b/docs/models/UpsSettingsResponseBody.md @@ -0,0 +1,22 @@ +# ShipEngineSDK.Model.UpsSettingsResponseBody +A UPS settings response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountPostalCode** | **string** | account postal code | [optional] +**Invoice** | [**UpsInvoice**](UpsInvoice.md) | The invoice | [optional] +**IsPrimaryAccount** | **bool** | Indicates if this is the primary UPS account | [optional] +**MailInnovationsCostCenter** | **string** | mail innovations cost center | [optional] +**MailInnovationsEndorsement** | **AncillaryServiceEndorsement** | | [optional] +**Nickname** | **string** | nickname | [optional] +**PickupType** | **UpsPickupType** | | [optional] +**UseCarbonNeutralShippingProgram** | **bool** | The use carbon neutral shipping program | [optional] +**UseConsolidationServices** | **bool** | The use consolidation services | [optional] +**UseGroundFreightPricing** | **bool** | The use ground freight pricing | [optional] +**UseNegotiatedRates** | **bool** | The use negotiated rates | [optional] +**UseOrderNumberOnMailInnovationsLabels** | **bool** | The use order number on mail innovations labels | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ValidateAddress.md b/docs/models/ValidateAddress.md new file mode 100644 index 00000000..50de9e85 --- /dev/null +++ b/docs/models/ValidateAddress.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.ValidateAddress +The possible validate address values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ValidateShipmentFields.md b/docs/models/ValidateShipmentFields.md new file mode 100644 index 00000000..595f0da3 --- /dev/null +++ b/docs/models/ValidateShipmentFields.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.ValidateShipmentFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ValidateAddress** | **ValidateAddress** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/ValidationStatus.md b/docs/models/ValidationStatus.md new file mode 100644 index 00000000..a0bf339b --- /dev/null +++ b/docs/models/ValidationStatus.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.ValidationStatus +The possible validation status values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/VoidLabelResponseBody.md b/docs/models/VoidLabelResponseBody.md new file mode 100644 index 00000000..e9f5a9f3 --- /dev/null +++ b/docs/models/VoidLabelResponseBody.md @@ -0,0 +1,13 @@ +# ShipEngineSDK.Model.VoidLabelResponseBody +A void label response body + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | **bool** | Indicates whether the attempt to void the label was successful | [readonly] +**Message** | **string** | | [readonly] +**ReasonCode** | **ReasonCode** | Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later. | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Warehouse.md b/docs/models/Warehouse.md new file mode 100644 index 00000000..4e6cd16b --- /dev/null +++ b/docs/models/Warehouse.md @@ -0,0 +1,16 @@ +# ShipEngineSDK.Model.Warehouse +A warehouse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedAt** | **DateTimeOffset** | Timestamp that indicates when the warehouse was created | [optional] [readonly] +**IsDefault** | **bool** | Designates which single warehouse is the default on the account | [optional] [default to false] +**Name** | **string** | Name of the warehouse | [optional] +**OriginAddress** | [**Address**](Address.md) | The origin address of the warehouse | [optional] +**ReturnAddress** | [**Address**](Address.md) | The return address associated with the warehouse | [optional] +**WarehouseId** | **string** | A string that uniquely identifies the warehouse | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Webhook.md b/docs/models/Webhook.md new file mode 100644 index 00000000..408dcf31 --- /dev/null +++ b/docs/models/Webhook.md @@ -0,0 +1,14 @@ +# ShipEngineSDK.Model.Webhook +A webhook + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Event** | **WebhookEvent** | | [optional] +**Headers** | [**List<WebhookHeader>**](WebhookHeader.md) | Array of custom webhook headers | [optional] +**Url** | **string** | The url that the webhook sends the request to | [optional] +**WebhookId** | **string** | A string that uniquely identifies the webhook | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/WebhookEvent.md b/docs/models/WebhookEvent.md new file mode 100644 index 00000000..db867e07 --- /dev/null +++ b/docs/models/WebhookEvent.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.WebhookEvent +The possible webook event values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/WebhookHeader.md b/docs/models/WebhookHeader.md new file mode 100644 index 00000000..a49ab549 --- /dev/null +++ b/docs/models/WebhookHeader.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.WebhookHeader +Optional header to be specified in webhook + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **string** | Key/name of a header | +**Value** | **string** | Value of a header | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/Weight.md b/docs/models/Weight.md new file mode 100644 index 00000000..b69fa94d --- /dev/null +++ b/docs/models/Weight.md @@ -0,0 +1,12 @@ +# ShipEngineSDK.Model.Weight +The weight of a package + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Unit** | **WeightUnit** | | +**Value** | **decimal** | The weight, in the specified unit | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/docs/models/WeightUnit.md b/docs/models/WeightUnit.md new file mode 100644 index 00000000..dce05419 --- /dev/null +++ b/docs/models/WeightUnit.md @@ -0,0 +1,10 @@ +# ShipEngineSDK.Model.WeightUnit +The possible weight unit values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + diff --git a/generation/templates/README.mustache b/generation/templates/README.solution.mustache similarity index 86% rename from generation/templates/README.mustache rename to generation/templates/README.solution.mustache index d56a86e8..7cfb5ae7 100644 --- a/generation/templates/README.mustache +++ b/generation/templates/README.solution.mustache @@ -32,9 +32,6 @@ var shipengine = new ShipEngine("___YOUR_API_KEY_HERE__"); ## Overview -{{#appDescriptionWithNewLines}} -{{{.}}} -{{/appDescriptionWithNewLines}} This C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: @@ -54,31 +51,27 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap {{#netStandard}} - .NET Core >=1.0 - .NET Framework >=4.6 -- Mono/Xamarin >=vNext {{/netStandard}} -## Documentation for API Endpoints +## Methods -All URIs are relative to *{{{basePath}}}* - -API | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- -{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{{summary}}} +API | Method | Description +------------ | ------------- | ------------- +{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{baseName}}* | [**{{operationId}}**]({{apiDocPath}}/{{classname}}.md#{{operationIdLowerCase}}) | {{{summary}}} {{/operation}}{{/operations}}{{/apis}}{{/apiInfo}} -## Documentation for Models +## Models {{#modelPackage}} -{{#models}}{{#model}} - [{{{modelPackage}}}.{{{classname}}}]({{modelDocPath}}{{{classname}}}.md) +{{#models}}{{#model}} - [{{{classname}}}]({{modelDocPath}}/{{{classname}}}.md) {{/model}}{{/models}} {{/modelPackage}} {{^modelPackage}} No model defined in this package {{/modelPackage}} - ## Legacy Methods These methods have been deprecated in favor of the methods listed above, but are still in the SDK. @@ -124,8 +117,7 @@ To build the project locally on your computer: ### Generating from OpenAPI To regenerate the SDK from the OpenAPI spec, you will first need to get the latest version of the spec. It can be downloaded from the [online documentation](https://shipengine.github.io/shipengine-openapi/) -and should be saved to `./generation/swagger.json`. Then run `npm run generate` from the command line. This will regenerate all the API calls, models, and documentation. It will NOT -regenerate tests, so you will need to manually update those as needed. +and should be saved to `./generation/swagger.json`. Then run `npm run generate` from the command line. This will regenerate all the API calls and models, but not docs or tests. The templates for autogeneration were extracted using the command: ```bash @@ -137,11 +129,10 @@ Create a [fork](https://docs.github.com/en/get-started/quickstart/contributing-t Update the [Changelog](./CHANGELOG.md) with any relevant new features or bug fixes and modify the `packageVersion` property in the `.openapitools.json` file to match the new version. -In the `ShipEngineSDK.csproj` file, update to the desired version (using [semantic versioning](https://semver.org/)) and push to your fork. +In the `ShipEngine.csproj` file, update to the desired version (using [semantic versioning](https://semver.org/)) and push to your fork. Run `dotnet format` Create a pull request. Once a member of the ShipEngine team reviews your PR and it's merged to main, the build pipeline will handle all the necessary github tags and nuget packaging and publishing. - diff --git a/generation/templates/api_doc.mustache b/generation/templates/api_doc.mustache index 0a6b787d..54d90fc5 100644 --- a/generation/templates/api_doc.mustache +++ b/generation/templates/api_doc.mustache @@ -1,7 +1,7 @@ -# {{packageName}}.{{apiPackage}}.{{classname}}{{#description}} -{{.}}{{/description}} -All URIs are relative to *{{{basePath}}}* + +# {{baseName}} Methods{{#description}} +{{.}}{{/description}} | Method | HTTP request | Description | |--------|--------------|-------------| @@ -15,7 +15,11 @@ All URIs are relative to *{{{basePath}}}* {{#operation}} # **{{{operationId}}}** -> {{returnType}}{{^returnType}}void{{/returnType}} {{operationId}} ({{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}}) +```csharp +{{returnType}}{{^returnType}}void{{/returnType}} {{operationId}} ({{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}{{/allParams}}, CancellationToken cancellationToken = default) + +{{returnType}}{{^returnType}}void{{/returnType}} {{operationId}} (HttpClient methodClient, {{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}{{/allParams}}, CancellationToken cancellationToken = default) +``` {{{summary}}}{{#notes}} @@ -40,10 +44,10 @@ namespace Example var shipEngine = new ShipEngine("api_key"); {{#allParams}} {{#isPrimitiveType}} - var {{paramName}} = {{{example}}}; // {{{dataType}}} | {{{description}}}{{^required}} (optional) {{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} + var {{paramName}} = {{{example}}}; {{/isPrimitiveType}} {{^isPrimitiveType}} - var {{paramName}} = new {{{dataType}}}(); // {{{dataType}}} | {{{description}}}{{^required}} (optional) {{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} + var {{paramName}} = new {{{dataType}}}(); {{/isPrimitiveType}} {{/allParams}} @@ -67,37 +71,17 @@ namespace Example ``` ### Parameters -{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}} | Name | Type | Description | Notes | |------|------|-------------|-------| -{{/-last}} -{{/allParams}} +| **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. | | {{#allParams}} | **{{paramName}}** | {{#isFile}}**{{dataType}}**{{/isFile}}{{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isFile}}[**{{dataType}}**]({{#isContainer}}{{baseType}}{{/isContainer}}{{^isContainer}}{{dataType}}{{/isContainer}}.md){{/isFile}}{{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#defaultValue}}[default to {{.}}]{{/defaultValue}} | {{/allParams}} +| **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 -{{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{returnType}}**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}void (empty response body){{/returnType}} - -### Authorization - -{{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{{name}}}](../README.md#{{{name}}}){{^-last}}, {{/-last}}{{/authMethods}} - -### HTTP request headers - - - **Content-Type**: {{#consumes}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/consumes}}{{^consumes}}Not defined{{/consumes}} - - **Accept**: {{#produces}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/produces}}{{^produces}}Not defined{{/produces}} - -{{#responses.0}} - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -{{#responses}} -| **{{code}}** | {{message}} | {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}} | -{{/responses}} -{{/responses.0}} +{{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{returnType}}**](../models/{{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}void (empty response body){{/returnType}} [[Back to top]](#) [[Back to API list]](../{{#useGenericHost}}../{{/useGenericHost}}README.md#documentation-for-api-endpoints) [[Back to Model list]](../{{#useGenericHost}}../{{/useGenericHost}}README.md#documentation-for-models) [[Back to README]](../{{#useGenericHost}}../{{/useGenericHost}}README.md) diff --git a/openapitools.json b/openapitools.json index 5145f332..e8b126b9 100644 --- a/openapitools.json +++ b/openapitools.json @@ -14,14 +14,16 @@ "ignoreFileOverride": "./.openapi-generator-ignore", "library": "generichost", "additionalProperties": { - "packageVersion": "3.0.0-beta.17", + "packageVersion": "3.0.0", "targetFramework": "netstandard2.0", "validatable": false, "sourceFolder": "", "optionalProjectFile": false, "nullableReferenceTypes": true, "useDateTimeOffset": true, - "modelPropertySorting": "alphabetical" + "modelPropertySorting": "alphabetical", + "apiDocPath": "docs/apis/", + "modelDocPath": "docs/models/" } } } From 01a24ddd4968196df5b22943b5df471296bdbc0a Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Wed, 5 Feb 2025 10:43:23 -0600 Subject: [PATCH 37/42] Fix some of the API doc gen --- README.md | 5 +-- docs/apis/AccountApi.md | 30 ++++++++-------- docs/apis/AddressesApi.md | 10 +++--- docs/apis/BatchesApi.md | 46 ++++++++++++------------ docs/apis/CarrierAccountsApi.md | 30 ++++++++-------- docs/apis/CarriersApi.md | 28 +++++++-------- docs/apis/DownloadsApi.md | 12 +++---- docs/apis/InsuranceApi.md | 22 ++++++------ docs/apis/LabelsApi.md | 48 ++++++++++++------------- docs/apis/ManifestsApi.md | 18 +++++----- docs/apis/PackagePickupsApi.md | 18 +++++----- docs/apis/PackageTypesApi.md | 24 ++++++------- docs/apis/RatesApi.md | 14 ++++---- docs/apis/ServicePointsApi.md | 14 ++++---- docs/apis/ShipmentsApi.md | 50 +++++++++++++-------------- docs/apis/TagsApi.md | 22 ++++++------ docs/apis/TokensApi.md | 8 ++--- docs/apis/TrackingApi.md | 24 ++++++------- docs/apis/WarehousesApi.md | 30 ++++++++-------- docs/apis/WebhooksApi.md | 24 ++++++------- generation/templates/api_doc.mustache | 12 +++---- 21 files changed, 223 insertions(+), 266 deletions(-) diff --git a/README.md b/README.md index 789c1371..04026636 100644 --- a/README.md +++ b/README.md @@ -28,8 +28,6 @@ The only configuration requirement is an [API key](https://www.shipengine.com/do using ShipEngineSDK; var shipengine = new ShipEngine("___YOUR_API_KEY_HERE__"); - -var carriers = await shipengine.ListCarriers(CancellationToken.Default); ``` @@ -462,7 +460,6 @@ API | Method | Description - [WeightUnit](docs//models/WeightUnit.md) - ## Legacy Methods These methods have been deprecated in favor of the methods listed above, but are still in the SDK. @@ -489,7 +486,7 @@ To build the project locally on your computer: 1. **Clone this repo**
`git clone https://github.com/ShipEngine/shipengine-dotnet.git` -2. **Install [.NET 8.x](https://dotnet.microsoft.com/download)** +2. **Install [.NET 5.x](https://dotnet.microsoft.com/download)** 3. **Install dependencies**
`dotnet restore` diff --git a/docs/apis/AccountApi.md b/docs/apis/AccountApi.md index 6c6b8dfe..1d966d84 100644 --- a/docs/apis/AccountApi.md +++ b/docs/apis/AccountApi.md @@ -1,15 +1,13 @@ - - # Account Methods -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**CreateAccountImage**](AccountApi.md#createaccountimage) | **POST** /v1/account/settings/images | Create an Account Image | -| [**DeleteAccountImageById**](AccountApi.md#deleteaccountimagebyid) | **DELETE** /v1/account/settings/images/{label_image_id} | Delete Account Image By Id | -| [**GetAccountSettingsImagesById**](AccountApi.md#getaccountsettingsimagesbyid) | **GET** /v1/account/settings/images/{label_image_id} | Get Account Image By ID | -| [**ListAccountImages**](AccountApi.md#listaccountimages) | **GET** /v1/account/settings/images | List Account Images | -| [**ListAccountSettings**](AccountApi.md#listaccountsettings) | **GET** /v1/account/settings | List Account Settings | -| [**UpdateAccountSettingsImagesById**](AccountApi.md#updateaccountsettingsimagesbyid) | **PUT** /v1/account/settings/images/{label_image_id} | Update Account Image By ID | +| Method | Description | +|--------|-------------| +| [**CreateAccountImage**](AccountApi.md#createaccountimage) | Create an Account Image | +| [**DeleteAccountImageById**](AccountApi.md#deleteaccountimagebyid) | Delete Account Image By Id | +| [**GetAccountSettingsImagesById**](AccountApi.md#getaccountsettingsimagesbyid) | Get Account Image By ID | +| [**ListAccountImages**](AccountApi.md#listaccountimages) | List Account Images | +| [**ListAccountSettings**](AccountApi.md#listaccountsettings) | List Account Settings | +| [**UpdateAccountSettingsImagesById**](AccountApi.md#updateaccountsettingsimagesbyid) | Update Account Image By ID | # **CreateAccountImage** @@ -188,9 +186,9 @@ namespace Example # **ListAccountImages** ```csharp -ListAccountSettingsImagesResponseBody ListAccountImages (, CancellationToken cancellationToken = default) +ListAccountSettingsImagesResponseBody ListAccountImages (CancellationToken cancellationToken = default) -ListAccountSettingsImagesResponseBody ListAccountImages (HttpClient methodClient, , CancellationToken cancellationToken = default) +ListAccountSettingsImagesResponseBody ListAccountImages (HttpClient methodClient, CancellationToken cancellationToken = default) ``` List Account Images @@ -244,9 +242,9 @@ namespace Example # **ListAccountSettings** ```csharp -GetAccountSettingsResponseBody ListAccountSettings (, CancellationToken cancellationToken = default) +GetAccountSettingsResponseBody ListAccountSettings (CancellationToken cancellationToken = default) -GetAccountSettingsResponseBody ListAccountSettings (HttpClient methodClient, , CancellationToken cancellationToken = default) +GetAccountSettingsResponseBody ListAccountSettings (HttpClient methodClient, CancellationToken cancellationToken = default) ``` List Account Settings @@ -300,9 +298,9 @@ namespace Example # **UpdateAccountSettingsImagesById** ```csharp -string UpdateAccountSettingsImagesById (UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBodystring labelImageId, CancellationToken cancellationToken = default) +string UpdateAccountSettingsImagesById (UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, string labelImageId, CancellationToken cancellationToken = default) -string UpdateAccountSettingsImagesById (HttpClient methodClient, UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBodystring labelImageId, CancellationToken cancellationToken = default) +string UpdateAccountSettingsImagesById (HttpClient methodClient, UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, string labelImageId, CancellationToken cancellationToken = default) ``` Update Account Image By ID diff --git a/docs/apis/AddressesApi.md b/docs/apis/AddressesApi.md index 19ab4757..ab160055 100644 --- a/docs/apis/AddressesApi.md +++ b/docs/apis/AddressesApi.md @@ -1,11 +1,9 @@ - - # Addresses Methods -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**ParseAddress**](AddressesApi.md#parseaddress) | **PUT** /v1/addresses/recognize | Parse an address | -| [**ValidateAddress**](AddressesApi.md#validateaddress) | **POST** /v1/addresses/validate | Validate An Address | +| Method | Description | +|--------|-------------| +| [**ParseAddress**](AddressesApi.md#parseaddress) | Parse an address | +| [**ValidateAddress**](AddressesApi.md#validateaddress) | Validate An Address | # **ParseAddress** diff --git a/docs/apis/BatchesApi.md b/docs/apis/BatchesApi.md index d824347b..5174c4e8 100644 --- a/docs/apis/BatchesApi.md +++ b/docs/apis/BatchesApi.md @@ -1,26 +1,24 @@ - - # Batches Methods -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**AddToBatch**](BatchesApi.md#addtobatch) | **POST** /v1/batches/{batch_id}/add | Add to a Batch | -| [**CreateBatch**](BatchesApi.md#createbatch) | **POST** /v1/batches | Create A Batch | -| [**DeleteBatch**](BatchesApi.md#deletebatch) | **DELETE** /v1/batches/{batch_id} | Delete Batch By Id | -| [**GetBatchByExternalId**](BatchesApi.md#getbatchbyexternalid) | **GET** /v1/batches/external_batch_id/{external_batch_id} | Get Batch By External ID | -| [**GetBatchById**](BatchesApi.md#getbatchbyid) | **GET** /v1/batches/{batch_id} | Get Batch By ID | -| [**ListBatchErrors**](BatchesApi.md#listbatcherrors) | **GET** /v1/batches/{batch_id}/errors | Get Batch Errors | -| [**ListBatches**](BatchesApi.md#listbatches) | **GET** /v1/batches | List Batches | -| [**ProcessBatch**](BatchesApi.md#processbatch) | **POST** /v1/batches/{batch_id}/process/labels | Process Batch ID Labels | -| [**RemoveFromBatch**](BatchesApi.md#removefrombatch) | **POST** /v1/batches/{batch_id}/remove | Remove From Batch | -| [**UpdateBatch**](BatchesApi.md#updatebatch) | **PUT** /v1/batches/{batch_id} | Update Batch By Id | +| Method | Description | +|--------|-------------| +| [**AddToBatch**](BatchesApi.md#addtobatch) | Add to a Batch | +| [**CreateBatch**](BatchesApi.md#createbatch) | Create A Batch | +| [**DeleteBatch**](BatchesApi.md#deletebatch) | Delete Batch By Id | +| [**GetBatchByExternalId**](BatchesApi.md#getbatchbyexternalid) | Get Batch By External ID | +| [**GetBatchById**](BatchesApi.md#getbatchbyid) | Get Batch By ID | +| [**ListBatchErrors**](BatchesApi.md#listbatcherrors) | Get Batch Errors | +| [**ListBatches**](BatchesApi.md#listbatches) | List Batches | +| [**ProcessBatch**](BatchesApi.md#processbatch) | Process Batch ID Labels | +| [**RemoveFromBatch**](BatchesApi.md#removefrombatch) | Remove From Batch | +| [**UpdateBatch**](BatchesApi.md#updatebatch) | Update Batch By Id | # **AddToBatch** ```csharp -string AddToBatch (AddToBatchRequestBody addToBatchRequestBodystring batchId, CancellationToken cancellationToken = default) +string AddToBatch (AddToBatchRequestBody addToBatchRequestBody, string batchId, CancellationToken cancellationToken = default) -string AddToBatch (HttpClient methodClient, AddToBatchRequestBody addToBatchRequestBodystring batchId, CancellationToken cancellationToken = default) +string AddToBatch (HttpClient methodClient, AddToBatchRequestBody addToBatchRequestBody, string batchId, CancellationToken cancellationToken = default) ``` Add to a Batch @@ -310,9 +308,9 @@ namespace Example # **ListBatchErrors** ```csharp -ListBatchErrorsResponseBody ListBatchErrors (string batchIdint pagesize = nullint page = null, CancellationToken cancellationToken = default) +ListBatchErrorsResponseBody ListBatchErrors (string batchId, int pagesize = null, int page = null, CancellationToken cancellationToken = default) -ListBatchErrorsResponseBody ListBatchErrors (HttpClient methodClient, string batchIdint pagesize = nullint page = null, CancellationToken cancellationToken = default) +ListBatchErrorsResponseBody ListBatchErrors (HttpClient methodClient, string batchId, int pagesize = null, int page = null, CancellationToken cancellationToken = default) ``` Get Batch Errors @@ -372,9 +370,9 @@ namespace Example # **ListBatches** ```csharp -ListBatchesResponseBody ListBatches (BatchStatus status = nullBatchesSortBy sortBy = nullSortDir sortDir = nullstring batchNumber = nullint page = nullint pageSize = null, CancellationToken cancellationToken = default) +ListBatchesResponseBody ListBatches (BatchStatus status = null, BatchesSortBy sortBy = null, SortDir sortDir = null, string batchNumber = null, int page = null, int pageSize = null, CancellationToken cancellationToken = default) -ListBatchesResponseBody ListBatches (HttpClient methodClient, BatchStatus status = nullBatchesSortBy sortBy = nullSortDir sortDir = nullstring batchNumber = nullint page = nullint pageSize = null, CancellationToken cancellationToken = default) +ListBatchesResponseBody ListBatches (HttpClient methodClient, BatchStatus status = null, BatchesSortBy sortBy = null, SortDir sortDir = null, string batchNumber = null, int page = null, int pageSize = null, CancellationToken cancellationToken = default) ``` List Batches @@ -440,9 +438,9 @@ namespace Example # **ProcessBatch** ```csharp -string ProcessBatch (ProcessBatchRequestBody processBatchRequestBodystring batchId, CancellationToken cancellationToken = default) +string ProcessBatch (ProcessBatchRequestBody processBatchRequestBody, string batchId, CancellationToken cancellationToken = default) -string ProcessBatch (HttpClient methodClient, ProcessBatchRequestBody processBatchRequestBodystring batchId, CancellationToken cancellationToken = default) +string ProcessBatch (HttpClient methodClient, ProcessBatchRequestBody processBatchRequestBody, string batchId, CancellationToken cancellationToken = default) ``` Process Batch ID Labels @@ -500,9 +498,9 @@ namespace Example # **RemoveFromBatch** ```csharp -string RemoveFromBatch (RemoveFromBatchRequestBody removeFromBatchRequestBodystring batchId, CancellationToken cancellationToken = default) +string RemoveFromBatch (RemoveFromBatchRequestBody removeFromBatchRequestBody, string batchId, CancellationToken cancellationToken = default) -string RemoveFromBatch (HttpClient methodClient, RemoveFromBatchRequestBody removeFromBatchRequestBodystring batchId, CancellationToken cancellationToken = default) +string RemoveFromBatch (HttpClient methodClient, RemoveFromBatchRequestBody removeFromBatchRequestBody, string batchId, CancellationToken cancellationToken = default) ``` Remove From Batch diff --git a/docs/apis/CarrierAccountsApi.md b/docs/apis/CarrierAccountsApi.md index f8c43e2e..41316f7c 100644 --- a/docs/apis/CarrierAccountsApi.md +++ b/docs/apis/CarrierAccountsApi.md @@ -1,20 +1,18 @@ - - # CarrierAccounts Methods -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**ConnectCarrier**](CarrierAccountsApi.md#connectcarrier) | **POST** /v1/connections/carriers/{carrier_name} | Connect a carrier account | -| [**DisconnectCarrier**](CarrierAccountsApi.md#disconnectcarrier) | **DELETE** /v1/connections/carriers/{carrier_name}/{carrier_id} | Disconnect a carrier | -| [**GetCarrierSettings**](CarrierAccountsApi.md#getcarriersettings) | **GET** /v1/connections/carriers/{carrier_name}/{carrier_id}/settings | Get carrier settings | -| [**UpdateCarrierSettings**](CarrierAccountsApi.md#updatecarriersettings) | **PUT** /v1/connections/carriers/{carrier_name}/{carrier_id}/settings | Update carrier settings | +| Method | Description | +|--------|-------------| +| [**ConnectCarrier**](CarrierAccountsApi.md#connectcarrier) | Connect a carrier account | +| [**DisconnectCarrier**](CarrierAccountsApi.md#disconnectcarrier) | Disconnect a carrier | +| [**GetCarrierSettings**](CarrierAccountsApi.md#getcarriersettings) | Get carrier settings | +| [**UpdateCarrierSettings**](CarrierAccountsApi.md#updatecarriersettings) | Update carrier settings | # **ConnectCarrier** ```csharp -ConnectCarrierResponseBody ConnectCarrier (CarrierName carrierNameConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default) +ConnectCarrierResponseBody ConnectCarrier (CarrierName carrierName, ConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default) -ConnectCarrierResponseBody ConnectCarrier (HttpClient methodClient, CarrierName carrierNameConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default) +ConnectCarrierResponseBody ConnectCarrier (HttpClient methodClient, CarrierName carrierName, ConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default) ``` Connect a carrier account @@ -72,9 +70,9 @@ namespace Example # **DisconnectCarrier** ```csharp -string DisconnectCarrier (CarrierName carrierNamestring carrierId, CancellationToken cancellationToken = default) +string DisconnectCarrier (CarrierName carrierName, string carrierId, CancellationToken cancellationToken = default) -string DisconnectCarrier (HttpClient methodClient, CarrierName carrierNamestring carrierId, CancellationToken cancellationToken = default) +string DisconnectCarrier (HttpClient methodClient, CarrierName carrierName, string carrierId, CancellationToken cancellationToken = default) ``` Disconnect a carrier @@ -132,9 +130,9 @@ namespace Example # **GetCarrierSettings** ```csharp -GetCarrierSettingsResponseBody GetCarrierSettings (CarrierNameWithSettings carrierNamestring carrierId, CancellationToken cancellationToken = default) +GetCarrierSettingsResponseBody GetCarrierSettings (CarrierNameWithSettings carrierName, string carrierId, CancellationToken cancellationToken = default) -GetCarrierSettingsResponseBody GetCarrierSettings (HttpClient methodClient, CarrierNameWithSettings carrierNamestring carrierId, CancellationToken cancellationToken = default) +GetCarrierSettingsResponseBody GetCarrierSettings (HttpClient methodClient, CarrierNameWithSettings carrierName, string carrierId, CancellationToken cancellationToken = default) ``` Get carrier settings @@ -192,9 +190,9 @@ namespace Example # **UpdateCarrierSettings** ```csharp -string UpdateCarrierSettings (CarrierNameWithSettings carrierNameUpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBodystring carrierId, CancellationToken cancellationToken = default) +string UpdateCarrierSettings (CarrierNameWithSettings carrierName, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, string carrierId, CancellationToken cancellationToken = default) -string UpdateCarrierSettings (HttpClient methodClient, CarrierNameWithSettings carrierNameUpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBodystring carrierId, CancellationToken cancellationToken = default) +string UpdateCarrierSettings (HttpClient methodClient, CarrierNameWithSettings carrierName, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, string carrierId, CancellationToken cancellationToken = default) ``` Update carrier settings diff --git a/docs/apis/CarriersApi.md b/docs/apis/CarriersApi.md index 15b49f1c..ab606d2f 100644 --- a/docs/apis/CarriersApi.md +++ b/docs/apis/CarriersApi.md @@ -1,23 +1,21 @@ - - # Carriers Methods -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**AddFundsToCarrier**](CarriersApi.md#addfundstocarrier) | **PUT** /v1/carriers/{carrier_id}/add_funds | Add Funds To Carrier | -| [**DisconnectCarrierById**](CarriersApi.md#disconnectcarrierbyid) | **DELETE** /v1/carriers/{carrier_id} | Disconnect Carrier by ID | -| [**GetCarrierById**](CarriersApi.md#getcarrierbyid) | **GET** /v1/carriers/{carrier_id} | Get Carrier By ID | -| [**GetCarrierOptions**](CarriersApi.md#getcarrieroptions) | **GET** /v1/carriers/{carrier_id}/options | Get Carrier Options | -| [**ListCarrierPackageTypes**](CarriersApi.md#listcarrierpackagetypes) | **GET** /v1/carriers/{carrier_id}/packages | List Carrier Package Types | -| [**ListCarrierServices**](CarriersApi.md#listcarrierservices) | **GET** /v1/carriers/{carrier_id}/services | List Carrier Services | -| [**ListCarriers**](CarriersApi.md#listcarriers) | **GET** /v1/carriers | List Carriers | +| Method | Description | +|--------|-------------| +| [**AddFundsToCarrier**](CarriersApi.md#addfundstocarrier) | Add Funds To Carrier | +| [**DisconnectCarrierById**](CarriersApi.md#disconnectcarrierbyid) | Disconnect Carrier by ID | +| [**GetCarrierById**](CarriersApi.md#getcarrierbyid) | Get Carrier By ID | +| [**GetCarrierOptions**](CarriersApi.md#getcarrieroptions) | Get Carrier Options | +| [**ListCarrierPackageTypes**](CarriersApi.md#listcarrierpackagetypes) | List Carrier Package Types | +| [**ListCarrierServices**](CarriersApi.md#listcarrierservices) | List Carrier Services | +| [**ListCarriers**](CarriersApi.md#listcarriers) | List Carriers | # **AddFundsToCarrier** ```csharp -AddFundsToCarrierResponseBody AddFundsToCarrier (AddFundsToCarrierRequestBody addFundsToCarrierRequestBodystring carrierId, CancellationToken cancellationToken = default) +AddFundsToCarrierResponseBody AddFundsToCarrier (AddFundsToCarrierRequestBody addFundsToCarrierRequestBody, string carrierId, CancellationToken cancellationToken = default) -AddFundsToCarrierResponseBody AddFundsToCarrier (HttpClient methodClient, AddFundsToCarrierRequestBody addFundsToCarrierRequestBodystring carrierId, CancellationToken cancellationToken = default) +AddFundsToCarrierResponseBody AddFundsToCarrier (HttpClient methodClient, AddFundsToCarrierRequestBody addFundsToCarrierRequestBody, string carrierId, CancellationToken cancellationToken = default) ``` Add Funds To Carrier @@ -365,9 +363,9 @@ namespace Example # **ListCarriers** ```csharp -GetCarriersResponseBody ListCarriers (, CancellationToken cancellationToken = default) +GetCarriersResponseBody ListCarriers (CancellationToken cancellationToken = default) -GetCarriersResponseBody ListCarriers (HttpClient methodClient, , CancellationToken cancellationToken = default) +GetCarriersResponseBody ListCarriers (HttpClient methodClient, CancellationToken cancellationToken = default) ``` List Carriers diff --git a/docs/apis/DownloadsApi.md b/docs/apis/DownloadsApi.md index 92fae193..dadec60e 100644 --- a/docs/apis/DownloadsApi.md +++ b/docs/apis/DownloadsApi.md @@ -1,17 +1,15 @@ - - # Downloads Methods -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**DownloadFile**](DownloadsApi.md#downloadfile) | **GET** /v1/downloads/{dir}/{subdir}/{filename} | Download File | +| Method | Description | +|--------|-------------| +| [**DownloadFile**](DownloadsApi.md#downloadfile) | Download File | # **DownloadFile** ```csharp -System.IO.Stream DownloadFile (string subdirstring filenamestring dirint rotation = nullstring download = null, CancellationToken cancellationToken = default) +System.IO.Stream DownloadFile (string subdir, string filename, string dir, int rotation = null, string download = null, CancellationToken cancellationToken = default) -System.IO.Stream DownloadFile (HttpClient methodClient, string subdirstring filenamestring dirint rotation = nullstring download = null, CancellationToken cancellationToken = default) +System.IO.Stream DownloadFile (HttpClient methodClient, string subdir, string filename, string dir, int rotation = null, string download = null, CancellationToken cancellationToken = default) ``` Download File diff --git a/docs/apis/InsuranceApi.md b/docs/apis/InsuranceApi.md index 40363665..93249dcd 100644 --- a/docs/apis/InsuranceApi.md +++ b/docs/apis/InsuranceApi.md @@ -1,13 +1,11 @@ - - # Insurance Methods -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**AddFundsToInsurance**](InsuranceApi.md#addfundstoinsurance) | **PATCH** /v1/insurance/shipsurance/add_funds | Add Funds To Insurance | -| [**ConnectInsurer**](InsuranceApi.md#connectinsurer) | **POST** /v1/connections/insurance/shipsurance | Connect a Shipsurance Account | -| [**DisconnectInsurer**](InsuranceApi.md#disconnectinsurer) | **DELETE** /v1/connections/insurance/shipsurance | Disconnect a Shipsurance Account | -| [**GetInsuranceBalance**](InsuranceApi.md#getinsurancebalance) | **GET** /v1/insurance/shipsurance/balance | Get Insurance Funds Balance | +| Method | Description | +|--------|-------------| +| [**AddFundsToInsurance**](InsuranceApi.md#addfundstoinsurance) | Add Funds To Insurance | +| [**ConnectInsurer**](InsuranceApi.md#connectinsurer) | Connect a Shipsurance Account | +| [**DisconnectInsurer**](InsuranceApi.md#disconnectinsurer) | Disconnect a Shipsurance Account | +| [**GetInsuranceBalance**](InsuranceApi.md#getinsurancebalance) | Get Insurance Funds Balance | # **AddFundsToInsurance** @@ -128,9 +126,9 @@ namespace Example # **DisconnectInsurer** ```csharp -Object DisconnectInsurer (, CancellationToken cancellationToken = default) +Object DisconnectInsurer (CancellationToken cancellationToken = default) -Object DisconnectInsurer (HttpClient methodClient, , CancellationToken cancellationToken = default) +Object DisconnectInsurer (HttpClient methodClient, CancellationToken cancellationToken = default) ``` Disconnect a Shipsurance Account @@ -184,9 +182,9 @@ namespace Example # **GetInsuranceBalance** ```csharp -GetInsuranceBalanceResponseBody GetInsuranceBalance (, CancellationToken cancellationToken = default) +GetInsuranceBalanceResponseBody GetInsuranceBalance (CancellationToken cancellationToken = default) -GetInsuranceBalanceResponseBody GetInsuranceBalance (HttpClient methodClient, , CancellationToken cancellationToken = default) +GetInsuranceBalanceResponseBody GetInsuranceBalance (HttpClient methodClient, CancellationToken cancellationToken = default) ``` Get Insurance Funds Balance diff --git a/docs/apis/LabelsApi.md b/docs/apis/LabelsApi.md index b3e36504..49340286 100644 --- a/docs/apis/LabelsApi.md +++ b/docs/apis/LabelsApi.md @@ -1,18 +1,16 @@ - - # Labels Methods -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**CreateLabel**](LabelsApi.md#createlabel) | **POST** /v1/labels | Purchase Label | -| [**CreateLabelFromRate**](LabelsApi.md#createlabelfromrate) | **POST** /v1/labels/rates/{rate_id} | Purchase Label with Rate ID | -| [**CreateLabelFromShipment**](LabelsApi.md#createlabelfromshipment) | **POST** /v1/labels/shipment/{shipment_id} | Purchase Label with Shipment ID | -| [**CreateReturnLabel**](LabelsApi.md#createreturnlabel) | **POST** /v1/labels/{label_id}/return | Create a return label | -| [**GetLabelByExternalShipmentId**](LabelsApi.md#getlabelbyexternalshipmentid) | **GET** /v1/labels/external_shipment_id/{external_shipment_id} | Get Label By External Shipment ID | -| [**GetLabelById**](LabelsApi.md#getlabelbyid) | **GET** /v1/labels/{label_id} | Get Label By ID | -| [**GetTrackingLogFromLabel**](LabelsApi.md#gettrackinglogfromlabel) | **GET** /v1/labels/{label_id}/track | Get Label Tracking Information | -| [**ListLabels**](LabelsApi.md#listlabels) | **GET** /v1/labels | List labels | -| [**VoidLabel**](LabelsApi.md#voidlabel) | **PUT** /v1/labels/{label_id}/void | Void a Label By ID | +| Method | Description | +|--------|-------------| +| [**CreateLabel**](LabelsApi.md#createlabel) | Purchase Label | +| [**CreateLabelFromRate**](LabelsApi.md#createlabelfromrate) | Purchase Label with Rate ID | +| [**CreateLabelFromShipment**](LabelsApi.md#createlabelfromshipment) | Purchase Label with Shipment ID | +| [**CreateReturnLabel**](LabelsApi.md#createreturnlabel) | Create a return label | +| [**GetLabelByExternalShipmentId**](LabelsApi.md#getlabelbyexternalshipmentid) | Get Label By External Shipment ID | +| [**GetLabelById**](LabelsApi.md#getlabelbyid) | Get Label By ID | +| [**GetTrackingLogFromLabel**](LabelsApi.md#gettrackinglogfromlabel) | Get Label Tracking Information | +| [**ListLabels**](LabelsApi.md#listlabels) | List labels | +| [**VoidLabel**](LabelsApi.md#voidlabel) | Void a Label By ID | # **CreateLabel** @@ -75,9 +73,9 @@ namespace Example # **CreateLabelFromRate** ```csharp -CreateLabelFromRateResponseBody CreateLabelFromRate (CreateLabelFromRateRequestBody createLabelFromRateRequestBodystring rateId, CancellationToken cancellationToken = default) +CreateLabelFromRateResponseBody CreateLabelFromRate (CreateLabelFromRateRequestBody createLabelFromRateRequestBody, string rateId, CancellationToken cancellationToken = default) -CreateLabelFromRateResponseBody CreateLabelFromRate (HttpClient methodClient, CreateLabelFromRateRequestBody createLabelFromRateRequestBodystring rateId, CancellationToken cancellationToken = default) +CreateLabelFromRateResponseBody CreateLabelFromRate (HttpClient methodClient, CreateLabelFromRateRequestBody createLabelFromRateRequestBody, string rateId, CancellationToken cancellationToken = default) ``` Purchase Label with Rate ID @@ -135,9 +133,9 @@ namespace Example # **CreateLabelFromShipment** ```csharp -CreateLabelFromShipmentResponseBody CreateLabelFromShipment (CreateLabelFromShipmentRequestBody createLabelFromShipmentRequestBodystring shipmentId, CancellationToken cancellationToken = default) +CreateLabelFromShipmentResponseBody CreateLabelFromShipment (CreateLabelFromShipmentRequestBody createLabelFromShipmentRequestBody, string shipmentId, CancellationToken cancellationToken = default) -CreateLabelFromShipmentResponseBody CreateLabelFromShipment (HttpClient methodClient, CreateLabelFromShipmentRequestBody createLabelFromShipmentRequestBodystring shipmentId, CancellationToken cancellationToken = default) +CreateLabelFromShipmentResponseBody CreateLabelFromShipment (HttpClient methodClient, CreateLabelFromShipmentRequestBody createLabelFromShipmentRequestBody, string shipmentId, CancellationToken cancellationToken = default) ``` Purchase Label with Shipment ID @@ -195,9 +193,9 @@ namespace Example # **CreateReturnLabel** ```csharp -CreateReturnLabelResponseBody CreateReturnLabel (CreateReturnLabelRequestBody createReturnLabelRequestBodystring labelId, CancellationToken cancellationToken = default) +CreateReturnLabelResponseBody CreateReturnLabel (CreateReturnLabelRequestBody createReturnLabelRequestBody, string labelId, CancellationToken cancellationToken = default) -CreateReturnLabelResponseBody CreateReturnLabel (HttpClient methodClient, CreateReturnLabelRequestBody createReturnLabelRequestBodystring labelId, CancellationToken cancellationToken = default) +CreateReturnLabelResponseBody CreateReturnLabel (HttpClient methodClient, CreateReturnLabelRequestBody createReturnLabelRequestBody, string labelId, CancellationToken cancellationToken = default) ``` Create a return label @@ -255,9 +253,9 @@ namespace Example # **GetLabelByExternalShipmentId** ```csharp -GetLabelByExternalShipmentIdResponseBody GetLabelByExternalShipmentId (string externalShipmentIdLabelDownloadType labelDownloadType = null, CancellationToken cancellationToken = default) +GetLabelByExternalShipmentIdResponseBody GetLabelByExternalShipmentId (string externalShipmentId, LabelDownloadType labelDownloadType = null, CancellationToken cancellationToken = default) -GetLabelByExternalShipmentIdResponseBody GetLabelByExternalShipmentId (HttpClient methodClient, string externalShipmentIdLabelDownloadType labelDownloadType = null, CancellationToken cancellationToken = default) +GetLabelByExternalShipmentIdResponseBody GetLabelByExternalShipmentId (HttpClient methodClient, string externalShipmentId, LabelDownloadType labelDownloadType = null, CancellationToken cancellationToken = default) ``` Get Label By External Shipment ID @@ -315,9 +313,9 @@ namespace Example # **GetLabelById** ```csharp -GetLabelByIdResponseBody GetLabelById (string labelIdLabelDownloadType labelDownloadType = null, CancellationToken cancellationToken = default) +GetLabelByIdResponseBody GetLabelById (string labelId, LabelDownloadType labelDownloadType = null, CancellationToken cancellationToken = default) -GetLabelByIdResponseBody GetLabelById (HttpClient methodClient, string labelIdLabelDownloadType labelDownloadType = null, CancellationToken cancellationToken = default) +GetLabelByIdResponseBody GetLabelById (HttpClient methodClient, string labelId, LabelDownloadType labelDownloadType = null, CancellationToken cancellationToken = default) ``` Get Label By ID @@ -433,9 +431,9 @@ namespace Example # **ListLabels** ```csharp -ListLabelsResponseBody ListLabels (DateTimeOffset createdAtStart = nullDateTimeOffset createdAtEnd = nullLabelStatus labelStatus = nullSortDir sortDir = nullstring serviceCode = nullstring carrierId = nullstring trackingNumber = nullstring batchId = nullstring rateId = nullstring shipmentId = nullstring warehouseId = nullint page = nullint pageSize = nullstring sortBy = null, CancellationToken cancellationToken = default) +ListLabelsResponseBody ListLabels (DateTimeOffset createdAtStart = null, DateTimeOffset createdAtEnd = null, LabelStatus labelStatus = null, SortDir sortDir = null, string serviceCode = null, string carrierId = null, string trackingNumber = null, string batchId = null, string rateId = null, string shipmentId = null, string warehouseId = null, int page = null, int pageSize = null, string sortBy = null, CancellationToken cancellationToken = default) -ListLabelsResponseBody ListLabels (HttpClient methodClient, DateTimeOffset createdAtStart = nullDateTimeOffset createdAtEnd = nullLabelStatus labelStatus = nullSortDir sortDir = nullstring serviceCode = nullstring carrierId = nullstring trackingNumber = nullstring batchId = nullstring rateId = nullstring shipmentId = nullstring warehouseId = nullint page = nullint pageSize = nullstring sortBy = null, CancellationToken cancellationToken = default) +ListLabelsResponseBody ListLabels (HttpClient methodClient, DateTimeOffset createdAtStart = null, DateTimeOffset createdAtEnd = null, LabelStatus labelStatus = null, SortDir sortDir = null, string serviceCode = null, string carrierId = null, string trackingNumber = null, string batchId = null, string rateId = null, string shipmentId = null, string warehouseId = null, int page = null, int pageSize = null, string sortBy = null, CancellationToken cancellationToken = default) ``` List labels diff --git a/docs/apis/ManifestsApi.md b/docs/apis/ManifestsApi.md index 68d0a1cf..e64a3115 100644 --- a/docs/apis/ManifestsApi.md +++ b/docs/apis/ManifestsApi.md @@ -1,13 +1,11 @@ - - # Manifests Methods -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**CreateManifest**](ManifestsApi.md#createmanifest) | **POST** /v1/manifests | Create Manifest | -| [**GetManifestById**](ManifestsApi.md#getmanifestbyid) | **GET** /v1/manifests/{manifest_id} | Get Manifest By Id | -| [**GetManifestRequestById**](ManifestsApi.md#getmanifestrequestbyid) | **GET** /v1/manifests/requests/{manifest_request_id} | Get Manifest Request By Id | -| [**ListManifests**](ManifestsApi.md#listmanifests) | **GET** /v1/manifests | List Manifests | +| Method | Description | +|--------|-------------| +| [**CreateManifest**](ManifestsApi.md#createmanifest) | Create Manifest | +| [**GetManifestById**](ManifestsApi.md#getmanifestbyid) | Get Manifest By Id | +| [**GetManifestRequestById**](ManifestsApi.md#getmanifestrequestbyid) | Get Manifest Request By Id | +| [**ListManifests**](ManifestsApi.md#listmanifests) | List Manifests | # **CreateManifest** @@ -186,9 +184,9 @@ namespace Example # **ListManifests** ```csharp -ListManifestsResponseBody ListManifests (DateTimeOffset shipDateStart = nullDateTimeOffset shipDateEnd = nullDateTimeOffset createdAtStart = nullDateTimeOffset createdAtEnd = nullList labelIds = nullstring warehouseId = nullstring carrierId = nullint page = nullint pageSize = null, CancellationToken cancellationToken = default) +ListManifestsResponseBody ListManifests (DateTimeOffset shipDateStart = null, DateTimeOffset shipDateEnd = null, DateTimeOffset createdAtStart = null, DateTimeOffset createdAtEnd = null, List labelIds = null, string warehouseId = null, string carrierId = null, int page = null, int pageSize = null, CancellationToken cancellationToken = default) -ListManifestsResponseBody ListManifests (HttpClient methodClient, DateTimeOffset shipDateStart = nullDateTimeOffset shipDateEnd = nullDateTimeOffset createdAtStart = nullDateTimeOffset createdAtEnd = nullList labelIds = nullstring warehouseId = nullstring carrierId = nullint page = nullint pageSize = null, CancellationToken cancellationToken = default) +ListManifestsResponseBody ListManifests (HttpClient methodClient, DateTimeOffset shipDateStart = null, DateTimeOffset shipDateEnd = null, DateTimeOffset createdAtStart = null, DateTimeOffset createdAtEnd = null, List labelIds = null, string warehouseId = null, string carrierId = null, int page = null, int pageSize = null, CancellationToken cancellationToken = default) ``` List Manifests diff --git a/docs/apis/PackagePickupsApi.md b/docs/apis/PackagePickupsApi.md index 97e7553c..e0681655 100644 --- a/docs/apis/PackagePickupsApi.md +++ b/docs/apis/PackagePickupsApi.md @@ -1,13 +1,11 @@ - - # PackagePickups Methods -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**DeleteScheduledPickup**](PackagePickupsApi.md#deletescheduledpickup) | **DELETE** /v1/pickups/{pickup_id} | Delete a Scheduled Pickup | -| [**GetPickupById**](PackagePickupsApi.md#getpickupbyid) | **GET** /v1/pickups/{pickup_id} | Get Pickup By ID | -| [**ListScheduledPickups**](PackagePickupsApi.md#listscheduledpickups) | **GET** /v1/pickups | List Scheduled Pickups | -| [**SchedulePickup**](PackagePickupsApi.md#schedulepickup) | **POST** /v1/pickups | Schedule a Pickup | +| Method | Description | +|--------|-------------| +| [**DeleteScheduledPickup**](PackagePickupsApi.md#deletescheduledpickup) | Delete a Scheduled Pickup | +| [**GetPickupById**](PackagePickupsApi.md#getpickupbyid) | Get Pickup By ID | +| [**ListScheduledPickups**](PackagePickupsApi.md#listscheduledpickups) | List Scheduled Pickups | +| [**SchedulePickup**](PackagePickupsApi.md#schedulepickup) | Schedule a Pickup | # **DeleteScheduledPickup** @@ -128,9 +126,9 @@ namespace Example # **ListScheduledPickups** ```csharp -GetPickupsResponseBody ListScheduledPickups (DateTimeOffset createdAtStart = nullDateTimeOffset createdAtEnd = nullstring carrierId = nullstring warehouseId = nullint page = nullint pageSize = null, CancellationToken cancellationToken = default) +GetPickupsResponseBody ListScheduledPickups (DateTimeOffset createdAtStart = null, DateTimeOffset createdAtEnd = null, string carrierId = null, string warehouseId = null, int page = null, int pageSize = null, CancellationToken cancellationToken = default) -GetPickupsResponseBody ListScheduledPickups (HttpClient methodClient, DateTimeOffset createdAtStart = nullDateTimeOffset createdAtEnd = nullstring carrierId = nullstring warehouseId = nullint page = nullint pageSize = null, CancellationToken cancellationToken = default) +GetPickupsResponseBody ListScheduledPickups (HttpClient methodClient, DateTimeOffset createdAtStart = null, DateTimeOffset createdAtEnd = null, string carrierId = null, string warehouseId = null, int page = null, int pageSize = null, CancellationToken cancellationToken = default) ``` List Scheduled Pickups diff --git a/docs/apis/PackageTypesApi.md b/docs/apis/PackageTypesApi.md index 1bced23a..f70f4e1c 100644 --- a/docs/apis/PackageTypesApi.md +++ b/docs/apis/PackageTypesApi.md @@ -1,14 +1,12 @@ - - # PackageTypes Methods -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**CreatePackageType**](PackageTypesApi.md#createpackagetype) | **POST** /v1/packages | Create Custom Package Type | -| [**DeletePackageType**](PackageTypesApi.md#deletepackagetype) | **DELETE** /v1/packages/{package_id} | Delete A Custom Package By ID | -| [**GetPackageTypeById**](PackageTypesApi.md#getpackagetypebyid) | **GET** /v1/packages/{package_id} | Get Custom Package Type By ID | -| [**ListPackageTypes**](PackageTypesApi.md#listpackagetypes) | **GET** /v1/packages | List Custom Package Types | -| [**UpdatePackageType**](PackageTypesApi.md#updatepackagetype) | **PUT** /v1/packages/{package_id} | Update Custom Package Type By ID | +| Method | Description | +|--------|-------------| +| [**CreatePackageType**](PackageTypesApi.md#createpackagetype) | Create Custom Package Type | +| [**DeletePackageType**](PackageTypesApi.md#deletepackagetype) | Delete A Custom Package By ID | +| [**GetPackageTypeById**](PackageTypesApi.md#getpackagetypebyid) | Get Custom Package Type By ID | +| [**ListPackageTypes**](PackageTypesApi.md#listpackagetypes) | List Custom Package Types | +| [**UpdatePackageType**](PackageTypesApi.md#updatepackagetype) | Update Custom Package Type By ID | # **CreatePackageType** @@ -187,9 +185,9 @@ namespace Example # **ListPackageTypes** ```csharp -ListPackageTypesResponseBody ListPackageTypes (, CancellationToken cancellationToken = default) +ListPackageTypesResponseBody ListPackageTypes (CancellationToken cancellationToken = default) -ListPackageTypesResponseBody ListPackageTypes (HttpClient methodClient, , CancellationToken cancellationToken = default) +ListPackageTypesResponseBody ListPackageTypes (HttpClient methodClient, CancellationToken cancellationToken = default) ``` List Custom Package Types @@ -243,9 +241,9 @@ namespace Example # **UpdatePackageType** ```csharp -string UpdatePackageType (UpdatePackageTypeRequestBody updatePackageTypeRequestBodystring packageId, CancellationToken cancellationToken = default) +string UpdatePackageType (UpdatePackageTypeRequestBody updatePackageTypeRequestBody, string packageId, CancellationToken cancellationToken = default) -string UpdatePackageType (HttpClient methodClient, UpdatePackageTypeRequestBody updatePackageTypeRequestBodystring packageId, CancellationToken cancellationToken = default) +string UpdatePackageType (HttpClient methodClient, UpdatePackageTypeRequestBody updatePackageTypeRequestBody, string packageId, CancellationToken cancellationToken = default) ``` Update Custom Package Type By ID diff --git a/docs/apis/RatesApi.md b/docs/apis/RatesApi.md index 502ad6eb..08a39517 100644 --- a/docs/apis/RatesApi.md +++ b/docs/apis/RatesApi.md @@ -1,13 +1,11 @@ - - # Rates Methods -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**CalculateRates**](RatesApi.md#calculaterates) | **POST** /v1/rates | Get Shipping Rates | -| [**CompareBulkRates**](RatesApi.md#comparebulkrates) | **POST** /v1/rates/bulk | Get Bulk Rates | -| [**EstimateRates**](RatesApi.md#estimaterates) | **POST** /v1/rates/estimate | Estimate Rates | -| [**GetRateById**](RatesApi.md#getratebyid) | **GET** /v1/rates/{rate_id} | Get Rate By ID | +| Method | Description | +|--------|-------------| +| [**CalculateRates**](RatesApi.md#calculaterates) | Get Shipping Rates | +| [**CompareBulkRates**](RatesApi.md#comparebulkrates) | Get Bulk Rates | +| [**EstimateRates**](RatesApi.md#estimaterates) | Estimate Rates | +| [**GetRateById**](RatesApi.md#getratebyid) | Get Rate By ID | # **CalculateRates** diff --git a/docs/apis/ServicePointsApi.md b/docs/apis/ServicePointsApi.md index 1d459dc8..5cd3af7a 100644 --- a/docs/apis/ServicePointsApi.md +++ b/docs/apis/ServicePointsApi.md @@ -1,18 +1,16 @@ - - # ServicePoints Methods -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**ServicePointsGetById**](ServicePointsApi.md#servicepointsgetbyid) | **GET** /v1/service_points/{carrier_code}/{country_code}/{service_point_id} | Get Service Point By ID | -| [**ServicePointsList**](ServicePointsApi.md#servicepointslist) | **POST** /v1/service_points/list | List Service Points | +| Method | Description | +|--------|-------------| +| [**ServicePointsGetById**](ServicePointsApi.md#servicepointsgetbyid) | Get Service Point By ID | +| [**ServicePointsList**](ServicePointsApi.md#servicepointslist) | List Service Points | # **ServicePointsGetById** ```csharp -GetServicePointByIdResponseBody ServicePointsGetById (string carrierCodestring countryCodestring servicePointId, CancellationToken cancellationToken = default) +GetServicePointByIdResponseBody ServicePointsGetById (string carrierCode, string countryCode, string servicePointId, CancellationToken cancellationToken = default) -GetServicePointByIdResponseBody ServicePointsGetById (HttpClient methodClient, string carrierCodestring countryCodestring servicePointId, CancellationToken cancellationToken = default) +GetServicePointByIdResponseBody ServicePointsGetById (HttpClient methodClient, string carrierCode, string countryCode, string servicePointId, CancellationToken cancellationToken = default) ``` Get Service Point By ID diff --git a/docs/apis/ShipmentsApi.md b/docs/apis/ShipmentsApi.md index b3ae8362..c27006aa 100644 --- a/docs/apis/ShipmentsApi.md +++ b/docs/apis/ShipmentsApi.md @@ -1,21 +1,19 @@ - - # Shipments Methods -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**CancelShipments**](ShipmentsApi.md#cancelshipments) | **PUT** /v1/shipments/{shipment_id}/cancel | Cancel a Shipment | -| [**CreateShipments**](ShipmentsApi.md#createshipments) | **POST** /v1/shipments | Create Shipments | -| [**GetShipmentByExternalId**](ShipmentsApi.md#getshipmentbyexternalid) | **GET** /v1/shipments/external_shipment_id/{external_shipment_id} | Get Shipment By External ID | -| [**GetShipmentById**](ShipmentsApi.md#getshipmentbyid) | **GET** /v1/shipments/{shipment_id} | Get Shipment By ID | -| [**ListShipmentRates**](ShipmentsApi.md#listshipmentrates) | **GET** /v1/shipments/{shipment_id}/rates | Get Shipment Rates | -| [**ListShipments**](ShipmentsApi.md#listshipments) | **GET** /v1/shipments | List Shipments | -| [**ParseShipment**](ShipmentsApi.md#parseshipment) | **PUT** /v1/shipments/recognize | Parse shipping info | -| [**ShipmentsListTags**](ShipmentsApi.md#shipmentslisttags) | **GET** /v1/shipments/{shipment_id}/tags | Get Shipment Tags | -| [**ShipmentsUpdateTags**](ShipmentsApi.md#shipmentsupdatetags) | **PUT** /v1/shipments/tags | Update Shipments Tags | -| [**TagShipment**](ShipmentsApi.md#tagshipment) | **POST** /v1/shipments/{shipment_id}/tags/{tag_name} | Add Tag to Shipment | -| [**UntagShipment**](ShipmentsApi.md#untagshipment) | **DELETE** /v1/shipments/{shipment_id}/tags/{tag_name} | Remove Tag from Shipment | -| [**UpdateShipment**](ShipmentsApi.md#updateshipment) | **PUT** /v1/shipments/{shipment_id} | Update Shipment By ID | +| Method | Description | +|--------|-------------| +| [**CancelShipments**](ShipmentsApi.md#cancelshipments) | Cancel a Shipment | +| [**CreateShipments**](ShipmentsApi.md#createshipments) | Create Shipments | +| [**GetShipmentByExternalId**](ShipmentsApi.md#getshipmentbyexternalid) | Get Shipment By External ID | +| [**GetShipmentById**](ShipmentsApi.md#getshipmentbyid) | Get Shipment By ID | +| [**ListShipmentRates**](ShipmentsApi.md#listshipmentrates) | Get Shipment Rates | +| [**ListShipments**](ShipmentsApi.md#listshipments) | List Shipments | +| [**ParseShipment**](ShipmentsApi.md#parseshipment) | Parse shipping info | +| [**ShipmentsListTags**](ShipmentsApi.md#shipmentslisttags) | Get Shipment Tags | +| [**ShipmentsUpdateTags**](ShipmentsApi.md#shipmentsupdatetags) | Update Shipments Tags | +| [**TagShipment**](ShipmentsApi.md#tagshipment) | Add Tag to Shipment | +| [**UntagShipment**](ShipmentsApi.md#untagshipment) | Remove Tag from Shipment | +| [**UpdateShipment**](ShipmentsApi.md#updateshipment) | Update Shipment By ID | # **CancelShipments** @@ -252,9 +250,9 @@ namespace Example # **ListShipmentRates** ```csharp -ListShipmentRatesResponseBody ListShipmentRates (string shipmentIdDateTimeOffset createdAtStart = null, CancellationToken cancellationToken = default) +ListShipmentRatesResponseBody ListShipmentRates (string shipmentId, DateTimeOffset createdAtStart = null, CancellationToken cancellationToken = default) -ListShipmentRatesResponseBody ListShipmentRates (HttpClient methodClient, string shipmentIdDateTimeOffset createdAtStart = null, CancellationToken cancellationToken = default) +ListShipmentRatesResponseBody ListShipmentRates (HttpClient methodClient, string shipmentId, DateTimeOffset createdAtStart = null, CancellationToken cancellationToken = default) ``` Get Shipment Rates @@ -312,9 +310,9 @@ namespace Example # **ListShipments** ```csharp -ListShipmentsResponseBody ListShipments (DateTimeOffset createdAtStart = nullDateTimeOffset createdAtEnd = nullDateTimeOffset modifiedAtStart = nullDateTimeOffset modifiedAtEnd = nullShipmentStatus shipmentStatus = nullShipmentsSortBy sortBy = nullSortDir sortDir = nullstring batchId = nullstring tag = nullstring salesOrderId = nullint page = nullint pageSize = null, CancellationToken cancellationToken = default) +ListShipmentsResponseBody ListShipments (DateTimeOffset createdAtStart = null, DateTimeOffset createdAtEnd = null, DateTimeOffset modifiedAtStart = null, DateTimeOffset modifiedAtEnd = null, ShipmentStatus shipmentStatus = null, ShipmentsSortBy sortBy = null, SortDir sortDir = null, string batchId = null, string tag = null, string salesOrderId = null, int page = null, int pageSize = null, CancellationToken cancellationToken = default) -ListShipmentsResponseBody ListShipments (HttpClient methodClient, DateTimeOffset createdAtStart = nullDateTimeOffset createdAtEnd = nullDateTimeOffset modifiedAtStart = nullDateTimeOffset modifiedAtEnd = nullShipmentStatus shipmentStatus = nullShipmentsSortBy sortBy = nullSortDir sortDir = nullstring batchId = nullstring tag = nullstring salesOrderId = nullint page = nullint pageSize = null, CancellationToken cancellationToken = default) +ListShipmentsResponseBody ListShipments (HttpClient methodClient, DateTimeOffset createdAtStart = null, DateTimeOffset createdAtEnd = null, DateTimeOffset modifiedAtStart = null, DateTimeOffset modifiedAtEnd = null, ShipmentStatus shipmentStatus = null, ShipmentsSortBy sortBy = null, SortDir sortDir = null, string batchId = null, string tag = null, string salesOrderId = null, int page = null, int pageSize = null, CancellationToken cancellationToken = default) ``` List Shipments @@ -565,9 +563,9 @@ void (empty response body) # **TagShipment** ```csharp -TagShipmentResponseBody TagShipment (string shipmentIdstring tagName, CancellationToken cancellationToken = default) +TagShipmentResponseBody TagShipment (string shipmentId, string tagName, CancellationToken cancellationToken = default) -TagShipmentResponseBody TagShipment (HttpClient methodClient, string shipmentIdstring tagName, CancellationToken cancellationToken = default) +TagShipmentResponseBody TagShipment (HttpClient methodClient, string shipmentId, string tagName, CancellationToken cancellationToken = default) ``` Add Tag to Shipment @@ -625,9 +623,9 @@ namespace Example # **UntagShipment** ```csharp -string UntagShipment (string shipmentIdstring tagName, CancellationToken cancellationToken = default) +string UntagShipment (string shipmentId, string tagName, CancellationToken cancellationToken = default) -string UntagShipment (HttpClient methodClient, string shipmentIdstring tagName, CancellationToken cancellationToken = default) +string UntagShipment (HttpClient methodClient, string shipmentId, string tagName, CancellationToken cancellationToken = default) ``` Remove Tag from Shipment @@ -685,9 +683,9 @@ namespace Example # **UpdateShipment** ```csharp -UpdateShipmentResponseBody UpdateShipment (UpdateShipmentRequestBody updateShipmentRequestBodystring shipmentId, CancellationToken cancellationToken = default) +UpdateShipmentResponseBody UpdateShipment (UpdateShipmentRequestBody updateShipmentRequestBody, string shipmentId, CancellationToken cancellationToken = default) -UpdateShipmentResponseBody UpdateShipment (HttpClient methodClient, UpdateShipmentRequestBody updateShipmentRequestBodystring shipmentId, CancellationToken cancellationToken = default) +UpdateShipmentResponseBody UpdateShipment (HttpClient methodClient, UpdateShipmentRequestBody updateShipmentRequestBody, string shipmentId, CancellationToken cancellationToken = default) ``` Update Shipment By ID diff --git a/docs/apis/TagsApi.md b/docs/apis/TagsApi.md index c1538616..934ee3e7 100644 --- a/docs/apis/TagsApi.md +++ b/docs/apis/TagsApi.md @@ -1,13 +1,11 @@ - - # Tags Methods -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**CreateTag**](TagsApi.md#createtag) | **POST** /v1/tags/{tag_name} | Create a New Tag | -| [**DeleteTag**](TagsApi.md#deletetag) | **DELETE** /v1/tags/{tag_name} | Delete Tag | -| [**ListTags**](TagsApi.md#listtags) | **GET** /v1/tags | Get Tags | -| [**RenameTag**](TagsApi.md#renametag) | **PUT** /v1/tags/{tag_name}/{new_tag_name} | Update Tag Name | +| Method | Description | +|--------|-------------| +| [**CreateTag**](TagsApi.md#createtag) | Create a New Tag | +| [**DeleteTag**](TagsApi.md#deletetag) | Delete Tag | +| [**ListTags**](TagsApi.md#listtags) | Get Tags | +| [**RenameTag**](TagsApi.md#renametag) | Update Tag Name | # **CreateTag** @@ -128,9 +126,9 @@ namespace Example # **ListTags** ```csharp -ListTagsResponseBody ListTags (, CancellationToken cancellationToken = default) +ListTagsResponseBody ListTags (CancellationToken cancellationToken = default) -ListTagsResponseBody ListTags (HttpClient methodClient, , CancellationToken cancellationToken = default) +ListTagsResponseBody ListTags (HttpClient methodClient, CancellationToken cancellationToken = default) ``` Get Tags @@ -184,9 +182,9 @@ namespace Example # **RenameTag** ```csharp -string RenameTag (string tagNamestring newTagName, CancellationToken cancellationToken = default) +string RenameTag (string tagName, string newTagName, CancellationToken cancellationToken = default) -string RenameTag (HttpClient methodClient, string tagNamestring newTagName, CancellationToken cancellationToken = default) +string RenameTag (HttpClient methodClient, string tagName, string newTagName, CancellationToken cancellationToken = default) ``` Update Tag Name diff --git a/docs/apis/TokensApi.md b/docs/apis/TokensApi.md index 1c8d5c48..3dce7ed8 100644 --- a/docs/apis/TokensApi.md +++ b/docs/apis/TokensApi.md @@ -1,10 +1,8 @@ - - # Tokens Methods -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**TokensGetEphemeralToken**](TokensApi.md#tokensgetephemeraltoken) | **POST** /v1/tokens/ephemeral | Get Ephemeral Token | +| Method | Description | +|--------|-------------| +| [**TokensGetEphemeralToken**](TokensApi.md#tokensgetephemeraltoken) | Get Ephemeral Token | # **TokensGetEphemeralToken** diff --git a/docs/apis/TrackingApi.md b/docs/apis/TrackingApi.md index b47a4a8f..69c86ee5 100644 --- a/docs/apis/TrackingApi.md +++ b/docs/apis/TrackingApi.md @@ -1,19 +1,17 @@ - - # Tracking Methods -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**GetTrackingLog**](TrackingApi.md#gettrackinglog) | **GET** /v1/tracking | Get Tracking Information | -| [**StartTracking**](TrackingApi.md#starttracking) | **POST** /v1/tracking/start | Start Tracking a Package | -| [**StopTracking**](TrackingApi.md#stoptracking) | **POST** /v1/tracking/stop | Stop Tracking a Package | +| Method | Description | +|--------|-------------| +| [**GetTrackingLog**](TrackingApi.md#gettrackinglog) | Get Tracking Information | +| [**StartTracking**](TrackingApi.md#starttracking) | Start Tracking a Package | +| [**StopTracking**](TrackingApi.md#stoptracking) | Stop Tracking a Package | # **GetTrackingLog** ```csharp -GetTrackingLogResponseBody GetTrackingLog (string carrierCode = nullstring trackingNumber = null, CancellationToken cancellationToken = default) +GetTrackingLogResponseBody GetTrackingLog (string carrierCode = null, string trackingNumber = null, CancellationToken cancellationToken = default) -GetTrackingLogResponseBody GetTrackingLog (HttpClient methodClient, string carrierCode = nullstring trackingNumber = null, CancellationToken cancellationToken = default) +GetTrackingLogResponseBody GetTrackingLog (HttpClient methodClient, string carrierCode = null, string trackingNumber = null, CancellationToken cancellationToken = default) ``` Get Tracking Information @@ -71,9 +69,9 @@ namespace Example # **StartTracking** ```csharp -string StartTracking (string carrierCode = nullstring trackingNumber = null, CancellationToken cancellationToken = default) +string StartTracking (string carrierCode = null, string trackingNumber = null, CancellationToken cancellationToken = default) -string StartTracking (HttpClient methodClient, string carrierCode = nullstring trackingNumber = null, CancellationToken cancellationToken = default) +string StartTracking (HttpClient methodClient, string carrierCode = null, string trackingNumber = null, CancellationToken cancellationToken = default) ``` Start Tracking a Package @@ -131,9 +129,9 @@ namespace Example # **StopTracking** ```csharp -string StopTracking (string carrierCode = nullstring trackingNumber = null, CancellationToken cancellationToken = default) +string StopTracking (string carrierCode = null, string trackingNumber = null, CancellationToken cancellationToken = default) -string StopTracking (HttpClient methodClient, string carrierCode = nullstring trackingNumber = null, CancellationToken cancellationToken = default) +string StopTracking (HttpClient methodClient, string carrierCode = null, string trackingNumber = null, CancellationToken cancellationToken = default) ``` Stop Tracking a Package diff --git a/docs/apis/WarehousesApi.md b/docs/apis/WarehousesApi.md index ae32fc95..6ec3a375 100644 --- a/docs/apis/WarehousesApi.md +++ b/docs/apis/WarehousesApi.md @@ -1,15 +1,13 @@ - - # Warehouses Methods -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**CreateWarehouse**](WarehousesApi.md#createwarehouse) | **POST** /v1/warehouses | Create Warehouse | -| [**DeleteWarehouse**](WarehousesApi.md#deletewarehouse) | **DELETE** /v1/warehouses/{warehouse_id} | Delete Warehouse By ID | -| [**GetWarehouseById**](WarehousesApi.md#getwarehousebyid) | **GET** /v1/warehouses/{warehouse_id} | Get Warehouse By Id | -| [**ListWarehouses**](WarehousesApi.md#listwarehouses) | **GET** /v1/warehouses | List Warehouses | -| [**UpdateWarehouse**](WarehousesApi.md#updatewarehouse) | **PUT** /v1/warehouses/{warehouse_id} | Update Warehouse By Id | -| [**UpdateWarehouseSettings**](WarehousesApi.md#updatewarehousesettings) | **PUT** /v1/warehouses/{warehouse_id}/settings | Update Warehouse Settings | +| Method | Description | +|--------|-------------| +| [**CreateWarehouse**](WarehousesApi.md#createwarehouse) | Create Warehouse | +| [**DeleteWarehouse**](WarehousesApi.md#deletewarehouse) | Delete Warehouse By ID | +| [**GetWarehouseById**](WarehousesApi.md#getwarehousebyid) | Get Warehouse By Id | +| [**ListWarehouses**](WarehousesApi.md#listwarehouses) | List Warehouses | +| [**UpdateWarehouse**](WarehousesApi.md#updatewarehouse) | Update Warehouse By Id | +| [**UpdateWarehouseSettings**](WarehousesApi.md#updatewarehousesettings) | Update Warehouse Settings | # **CreateWarehouse** @@ -188,9 +186,9 @@ namespace Example # **ListWarehouses** ```csharp -ListWarehousesResponseBody ListWarehouses (, CancellationToken cancellationToken = default) +ListWarehousesResponseBody ListWarehouses (CancellationToken cancellationToken = default) -ListWarehousesResponseBody ListWarehouses (HttpClient methodClient, , CancellationToken cancellationToken = default) +ListWarehousesResponseBody ListWarehouses (HttpClient methodClient, CancellationToken cancellationToken = default) ``` List Warehouses @@ -244,9 +242,9 @@ namespace Example # **UpdateWarehouse** ```csharp -string UpdateWarehouse (UpdateWarehouseRequestBody updateWarehouseRequestBodystring warehouseId, CancellationToken cancellationToken = default) +string UpdateWarehouse (UpdateWarehouseRequestBody updateWarehouseRequestBody, string warehouseId, CancellationToken cancellationToken = default) -string UpdateWarehouse (HttpClient methodClient, UpdateWarehouseRequestBody updateWarehouseRequestBodystring warehouseId, CancellationToken cancellationToken = default) +string UpdateWarehouse (HttpClient methodClient, UpdateWarehouseRequestBody updateWarehouseRequestBody, string warehouseId, CancellationToken cancellationToken = default) ``` Update Warehouse By Id @@ -304,9 +302,9 @@ namespace Example # **UpdateWarehouseSettings** ```csharp -string UpdateWarehouseSettings (UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBodystring warehouseId, CancellationToken cancellationToken = default) +string UpdateWarehouseSettings (UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBody, string warehouseId, CancellationToken cancellationToken = default) -string UpdateWarehouseSettings (HttpClient methodClient, UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBodystring warehouseId, CancellationToken cancellationToken = default) +string UpdateWarehouseSettings (HttpClient methodClient, UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBody, string warehouseId, CancellationToken cancellationToken = default) ``` Update Warehouse Settings diff --git a/docs/apis/WebhooksApi.md b/docs/apis/WebhooksApi.md index 55e539fc..23ed9e75 100644 --- a/docs/apis/WebhooksApi.md +++ b/docs/apis/WebhooksApi.md @@ -1,14 +1,12 @@ - - # Webhooks Methods -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**CreateWebhook**](WebhooksApi.md#createwebhook) | **POST** /v1/environment/webhooks | Create a Webhook | -| [**DeleteWebhook**](WebhooksApi.md#deletewebhook) | **DELETE** /v1/environment/webhooks/{webhook_id} | Delete Webhook By ID | -| [**GetWebhookById**](WebhooksApi.md#getwebhookbyid) | **GET** /v1/environment/webhooks/{webhook_id} | Get Webhook By ID | -| [**ListWebhooks**](WebhooksApi.md#listwebhooks) | **GET** /v1/environment/webhooks | List Webhooks | -| [**UpdateWebhook**](WebhooksApi.md#updatewebhook) | **PUT** /v1/environment/webhooks/{webhook_id} | Update a Webhook | +| Method | Description | +|--------|-------------| +| [**CreateWebhook**](WebhooksApi.md#createwebhook) | Create a Webhook | +| [**DeleteWebhook**](WebhooksApi.md#deletewebhook) | Delete Webhook By ID | +| [**GetWebhookById**](WebhooksApi.md#getwebhookbyid) | Get Webhook By ID | +| [**ListWebhooks**](WebhooksApi.md#listwebhooks) | List Webhooks | +| [**UpdateWebhook**](WebhooksApi.md#updatewebhook) | Update a Webhook | # **CreateWebhook** @@ -187,9 +185,9 @@ namespace Example # **ListWebhooks** ```csharp -List<Webhook> ListWebhooks (, CancellationToken cancellationToken = default) +List<Webhook> ListWebhooks (CancellationToken cancellationToken = default) -List<Webhook> ListWebhooks (HttpClient methodClient, , CancellationToken cancellationToken = default) +List<Webhook> ListWebhooks (HttpClient methodClient, CancellationToken cancellationToken = default) ``` List Webhooks @@ -243,9 +241,9 @@ namespace Example # **UpdateWebhook** ```csharp -string UpdateWebhook (UpdateWebhookRequestBody updateWebhookRequestBodystring webhookId, CancellationToken cancellationToken = default) +string UpdateWebhook (UpdateWebhookRequestBody updateWebhookRequestBody, string webhookId, CancellationToken cancellationToken = default) -string UpdateWebhook (HttpClient methodClient, UpdateWebhookRequestBody updateWebhookRequestBodystring webhookId, CancellationToken cancellationToken = default) +string UpdateWebhook (HttpClient methodClient, UpdateWebhookRequestBody updateWebhookRequestBody, string webhookId, CancellationToken cancellationToken = default) ``` Update a Webhook diff --git a/generation/templates/api_doc.mustache b/generation/templates/api_doc.mustache index 54d90fc5..ae9377ba 100644 --- a/generation/templates/api_doc.mustache +++ b/generation/templates/api_doc.mustache @@ -1,13 +1,11 @@ - - # {{baseName}} Methods{{#description}} {{.}}{{/description}} -| Method | HTTP request | Description | -|--------|--------------|-------------| +| Method | Description | +|--------|-------------| {{#operations}} {{#operation}} -| [**{{operationId}}**]({{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{summary}} | +| [**{{operationId}}**]({{classname}}.md#{{operationIdLowerCase}}) | {{summary}} | {{/operation}} {{/operations}} @@ -16,9 +14,9 @@ # **{{{operationId}}}** ```csharp -{{returnType}}{{^returnType}}void{{/returnType}} {{operationId}} ({{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}{{/allParams}}, CancellationToken cancellationToken = default) +{{returnType}}{{^returnType}}void{{/returnType}} {{operationId}} ({{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}, {{/allParams}}CancellationToken cancellationToken = default) -{{returnType}}{{^returnType}}void{{/returnType}} {{operationId}} (HttpClient methodClient, {{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}{{/allParams}}, CancellationToken cancellationToken = default) +{{returnType}}{{^returnType}}void{{/returnType}} {{operationId}} (HttpClient methodClient, {{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}, {{/allParams}}CancellationToken cancellationToken = default) ``` {{{summary}}}{{#notes}} From 48214c1035e04b39a1fe73f5c1b6e55ca3475b79 Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Wed, 5 Feb 2025 10:52:21 -0600 Subject: [PATCH 38/42] Remove noise and fix some links --- README.md | 314 ------------------ docs/apis/AccountApi.md | 16 +- docs/apis/AddressesApi.md | 8 +- docs/apis/BatchesApi.md | 28 +- docs/apis/CarrierAccountsApi.md | 12 +- docs/apis/CarriersApi.md | 16 +- docs/apis/DownloadsApi.md | 2 - docs/apis/InsuranceApi.md | 12 +- docs/apis/LabelsApi.md | 26 +- docs/apis/ManifestsApi.md | 12 +- docs/apis/PackagePickupsApi.md | 10 +- docs/apis/PackageTypesApi.md | 14 +- docs/apis/RatesApi.md | 14 +- docs/apis/ServicePointsApi.md | 6 +- docs/apis/ShipmentsApi.md | 32 +- docs/apis/TagsApi.md | 8 - docs/apis/TokensApi.md | 2 - docs/apis/TrackingApi.md | 6 - docs/apis/WarehousesApi.md | 18 +- docs/apis/WebhooksApi.md | 14 +- docs/models/AccountSettings.md | 2 - docs/models/AccountSettingsImages.md | 2 - docs/models/AddFundsToCarrierRequestBody.md | 2 - docs/models/AddFundsToCarrierResponseBody.md | 2 - docs/models/AddFundsToInsuranceRequestBody.md | 2 - .../models/AddFundsToInsuranceResponseBody.md | 2 - docs/models/AddToBatchRequestBody.md | 2 - docs/models/Address.md | 2 - docs/models/AddressResidentialIndicator.md | 2 - docs/models/AddressToValidate.md | 2 - docs/models/AddressValidatingShipment.md | 2 - docs/models/AddressValidationCode.md | 2 - docs/models/AddressValidationDetailCode.md | 2 - docs/models/AddressValidationMessageType.md | 2 - docs/models/AddressValidationResult.md | 2 - docs/models/AddressValidationStatus.md | 2 - docs/models/AdvancedShipmentOptions.md | 2 - ...cedShipmentOptionsDangerousGoodsContact.md | 2 - .../AdvancedShipmentOptionsFedexFreight.md | 2 - ...dShipmentOptionsWindsorFrameworkDetails.md | 2 - docs/models/AllowedIncoterms.md | 2 - docs/models/AlternativeIdentifier.md | 2 - docs/models/AlternativeIdentifiers.md | 2 - docs/models/AncillaryServiceEndorsement.md | 2 - docs/models/Batch.md | 2 - docs/models/BatchResponseError.md | 2 - docs/models/BatchStatus.md | 2 - docs/models/BatchesSortBy.md | 2 - docs/models/BillToParty.md | 2 - docs/models/BulkRate.md | 2 - docs/models/CalculateRatesRequestBody.md | 2 - docs/models/CalculateRatesResponseBody.md | 2 - docs/models/Carrier.md | 2 - docs/models/CarrierAdvancedOption.md | 2 - docs/models/CarrierName.md | 2 - docs/models/CarrierNameWithSettings.md | 2 - docs/models/CollectOnDelivery.md | 2 - docs/models/CollectOnDeliveryPaymentType.md | 2 - docs/models/CompareBulkRatesRequestBody.md | 2 - .../ConnectAccessWorldwideRequestBody.md | 2 - .../ConnectAmazonBuyShippingRequestBody.md | 2 - docs/models/ConnectAmazonShippingUk.md | 2 - docs/models/ConnectApcRequestBody.md | 2 - docs/models/ConnectAsendiaRequestBody.md | 2 - .../models/ConnectAustraliaPostRequestBody.md | 2 - docs/models/ConnectCanadaPostRequestBody.md | 2 - docs/models/ConnectCarrierRequestBody.md | 2 - docs/models/ConnectCarrierResponseBody.md | 2 - docs/models/ConnectDhlEcommerceRequestBody.md | 2 - docs/models/ConnectDhlExpressAuRequestBody.md | 2 - docs/models/ConnectDhlExpressCaRequestBody.md | 2 - docs/models/ConnectDhlExpressRequestBody.md | 2 - docs/models/ConnectDhlExpressUkRequestBody.md | 2 - docs/models/ConnectDpdRequestBody.md | 2 - docs/models/ConnectEndiciaRequestBody.md | 2 - docs/models/ConnectFedexRequestBody.md | 2 - docs/models/ConnectFedexUkRequestBody.md | 2 - docs/models/ConnectFirstmileRequestBody.md | 2 - docs/models/ConnectImexRequestBody.md | 2 - docs/models/ConnectInsurerRequestBody.md | 2 - docs/models/ConnectLasershipRequestBody.md | 2 - docs/models/ConnectNewgisticsRequestBody.md | 2 - docs/models/ConnectOntracRequestBody.md | 2 - docs/models/ConnectPurolatorRequestBody.md | 2 - docs/models/ConnectRoyalMailRequestBody.md | 2 - docs/models/ConnectRrDonnelleyRequestBody.md | 2 - docs/models/ConnectSekoRequestBody.md | 2 - docs/models/ConnectSendleRequestBody.md | 2 - docs/models/ConnectStampsRequestBody.md | 2 - docs/models/ConnectUpsRequestBody.md | 2 - docs/models/ContactDetails.md | 2 - .../CreateAccountSettingsImageRequestBody.md | 2 - .../CreateAndProcessBatchRequestBody.md | 2 - ...AndProcessBatchRequestBodyProcessLabels.md | 2 - docs/models/CreateAndValidateShipment.md | 2 - docs/models/CreateBatchRequest.md | 2 - docs/models/CreateBatchRequestBody.md | 2 - docs/models/CreateBatchResponseBody.md | 2 - docs/models/CreateLabelFromRateRequestBody.md | 2 - .../models/CreateLabelFromRateResponseBody.md | 2 - .../CreateLabelFromShipmentRequestBody.md | 2 - .../CreateLabelFromShipmentResponseBody.md | 2 - docs/models/CreateLabelRequestBody.md | 2 - docs/models/CreateLabelResponseBody.md | 2 - .../CreateManifestByObjectRequestBody.md | 2 - .../CreateManifestLabelIdsRequestBody.md | 2 - docs/models/CreateManifestRequestBody.md | 2 - docs/models/CreateManifestResponseBody.md | 2 - docs/models/CreatePackageTypeRequestBody.md | 2 - docs/models/CreatePackageTypeResponseBody.md | 2 - docs/models/CreateReturnLabelRequestBody.md | 2 - docs/models/CreateReturnLabelResponseBody.md | 2 - .../CreateShipmentResponseBodyFields.md | 2 - docs/models/CreateShipmentsRequestBody.md | 2 - docs/models/CreateShipmentsResponseBody.md | 2 - docs/models/CreateTagResponseBody.md | 2 - docs/models/CreateWarehouseRequestBody.md | 2 - docs/models/CreateWarehouseResponseBody.md | 2 - docs/models/CreateWebhookRequestBody.md | 2 - docs/models/CreateWebhookResponseBody.md | 2 - docs/models/CustomsItem.md | 2 - docs/models/DangerousAmount.md | 2 - docs/models/DangerousGoods.md | 2 - docs/models/DefaultLabelLayout.md | 2 - docs/models/DeletePickupByIdResponseBody.md | 2 - .../DeleteScheduledPickupResponseBody.md | 2 - docs/models/DeliveryConfirmation.md | 2 - docs/models/DeprecatedManifest.md | 2 - docs/models/DhlExpressAccountSettings.md | 2 - docs/models/DhlExpressSettingsResponseBody.md | 2 - docs/models/DimensionUnit.md | 2 - docs/models/Dimensions.md | 2 - docs/models/DisplayScheme.md | 2 - docs/models/Error.md | 2 - docs/models/ErrorCode.md | 2 - docs/models/ErrorResponseBody.md | 2 - docs/models/ErrorSource.md | 2 - docs/models/ErrorType.md | 2 - docs/models/ErrorWithLabelIdResponseBody.md | 2 - docs/models/EstimateRatesRequestBody.md | 2 - docs/models/FedexAccountSettings.md | 2 - .../models/FedexAccountSettingsRequestBody.md | 2 - docs/models/FedexPickupType.md | 2 - docs/models/FedexSettingsResponseBody.md | 2 - .../GetAccountSettingsImagesResponseBody.md | 2 - docs/models/GetAccountSettingsResponseBody.md | 2 - .../GetBatchByExternalIdResponseBody.md | 2 - docs/models/GetBatchByIdResponseBody.md | 2 - docs/models/GetCarrierByIdResponseBody.md | 2 - docs/models/GetCarrierOptionsResponseBody.md | 2 - docs/models/GetCarrierSettingsResponseBody.md | 2 - docs/models/GetCarriersResponseBody.md | 2 - .../models/GetInsuranceBalanceResponseBody.md | 2 - ...etLabelByExternalShipmentIdResponseBody.md | 2 - docs/models/GetLabelByIdResponseBody.md | 2 - docs/models/GetManifestByIdResponseBody.md | 2 - docs/models/GetPackageTypeByIdResponseBody.md | 2 - docs/models/GetPickupByIdResponseBody.md | 2 - docs/models/GetPickupsResponseBody.md | 2 - docs/models/GetRateByIdResponseBody.md | 2 - .../models/GetServicePointByIdResponseBody.md | 2 - ...ervicePointByIdResponseBodyServicePoint.md | 2 - docs/models/GetServicePointsRequest.md | 2 - docs/models/GetServicePointsRequestBody.md | 2 - .../GetServicePointsRequestBodyAddress.md | 2 - ...tServicePointsRequestBodyProvidersInner.md | 2 - .../GetServicePointsRequestBodyShipment.md | 2 - ...ePointsRequestBodyShipmentPackagesInner.md | 2 - .../GetShipmentByExternalIdResponseBody.md | 2 - docs/models/GetShipmentByIdResponseBody.md | 2 - .../GetTrackingLogFromLabelResponseBody.md | 2 - docs/models/GetTrackingLogResponseBody.md | 2 - docs/models/GetWarehouseByIdResponseBody.md | 2 - docs/models/GetWebhookByIdResponseBody.md | 2 - docs/models/IdentifierType.md | 2 - docs/models/ImporterOfRecords.md | 2 - docs/models/InsuranceProvider.md | 2 - docs/models/InternationalShipmentOptions.md | 2 - docs/models/InvoiceAdditionalDetails.md | 2 - docs/models/Label.md | 2 - docs/models/LabelChargeEvent.md | 2 - docs/models/LabelDownload.md | 2 - docs/models/LabelDownloadType.md | 2 - docs/models/LabelFormat.md | 2 - docs/models/LabelLayout.md | 2 - docs/models/LabelMessages.md | 2 - docs/models/LabelPackage.md | 2 - docs/models/LabelPackagesInner.md | 2 - docs/models/LabelRequest.md | 2 - docs/models/LabelStatus.md | 2 - docs/models/Link.md | 2 - docs/models/ListAccountImagesResponseBody.md | 2 - docs/models/ListAccountSettingsBody.md | 2 - .../ListAccountSettingsImagesResponseBody.md | 2 - docs/models/ListBatchErrorsResponseBody.md | 2 - docs/models/ListBatchesResponseBody.md | 2 - .../ListCarrierPackageTypesResponseBody.md | 2 - .../models/ListCarrierServicesResponseBody.md | 2 - docs/models/ListCarriersResponseBody.md | 2 - docs/models/ListLabelsResponseBody.md | 2 - docs/models/ListManifestsResponseBody.md | 2 - docs/models/ListPackageTypesResponseBody.md | 2 - docs/models/ListPickupResponseBody.md | 2 - docs/models/ListServicePointsResponseBody.md | 2 - ...icePointsResponseBodyServicePointsInner.md | 2 - ...eBodyServicePointsInnerHoursOfOperation.md | 2 - ...ePointsInnerHoursOfOperationMondayInner.md | 2 - docs/models/ListShipmentRatesResponseBody.md | 2 - docs/models/ListShipmentsResponseBody.md | 2 - docs/models/ListTagsResponseBody.md | 2 - docs/models/ListWarehousesResponseBody.md | 2 - docs/models/Manifest.md | 2 - docs/models/ManifestDownload.md | 2 - docs/models/ManifestRequest.md | 2 - docs/models/ManifestRequestStatus.md | 2 - docs/models/Manifests.md | 2 - docs/models/ManifestsRequests.md | 2 - docs/models/ModifyBatch.md | 2 - docs/models/MonetaryValue.md | 2 - docs/models/NonDelivery.md | 2 - docs/models/OptionalLink.md | 2 - docs/models/OrderSourceName.md | 2 - docs/models/OriginType.md | 2 - docs/models/Package.md | 2 - docs/models/PackageContents.md | 2 - docs/models/PackageType.md | 2 - docs/models/PackagingGroup.md | 2 - docs/models/PackagingInstructionSection.md | 2 - docs/models/PagedListResponseBody.md | 2 - docs/models/PaginationLink.md | 2 - docs/models/PaperlessDownload.md | 2 - docs/models/ParseAddressRequestBody.md | 2 - docs/models/ParseAddressResponseBody.md | 2 - docs/models/ParseShipmentRequestBody.md | 2 - docs/models/ParseShipmentResponseBody.md | 2 - docs/models/PartialAddress.md | 2 - docs/models/PartialShipment.md | 2 - docs/models/PartialShippingAddress.md | 2 - docs/models/PartialShippingAddressTo.md | 2 - ...artialShippingAddressToGeolocationInner.md | 2 - docs/models/PaymentAmount.md | 2 - docs/models/Pickup.md | 2 - docs/models/PickupResponseBody.md | 2 - docs/models/PickupWindow.md | 2 - docs/models/PickupWindows.md | 2 - docs/models/ProcessBatchRequestBody.md | 2 - docs/models/Products.md | 2 - docs/models/PurchaseLabelWithoutShipment.md | 2 - docs/models/Rate.md | 2 - docs/models/RateDetail.md | 2 - docs/models/RateDetailAttributes.md | 2 - docs/models/RateDetailType.md | 2 - docs/models/RateEstimate.md | 2 - docs/models/RateEstimateByCarrierId.md | 2 - docs/models/RateEstimateByCarrierIds.md | 2 - docs/models/RateEstimateOptions.md | 2 - docs/models/RateRequestBody.md | 2 - docs/models/RateRequestByShipmentIds.md | 2 - docs/models/RateRequestByShipments.md | 2 - docs/models/RateRequestOptions.md | 2 - docs/models/RateRequestRateOptions.md | 2 - docs/models/RateResponse.md | 2 - docs/models/RateResponseStatus.md | 2 - docs/models/RateShipmentRequest.md | 2 - docs/models/RateType.md | 2 - docs/models/RatesInformation.md | 2 - docs/models/ReasonCode.md | 2 - docs/models/RecognizedEntity.md | 2 - docs/models/Redirect.md | 2 - docs/models/RegulationLevel.md | 2 - docs/models/RemoveFromBatchRequestBody.md | 2 - docs/models/ResponseMessage.md | 2 - docs/models/SchedulePickupRequestBody.md | 2 - docs/models/SchedulePickupResponseBody.md | 2 - docs/models/Service.md | 2 - docs/models/Shipment.md | 2 - docs/models/ShipmentIdRequest.md | 2 - docs/models/ShipmentItem.md | 2 - docs/models/ShipmentRequest.md | 2 - docs/models/ShipmentStatus.md | 2 - docs/models/ShipmentsSortBy.md | 2 - docs/models/ShippingAddress.md | 2 - docs/models/ShippingAddressFrom.md | 2 - docs/models/ShippingAddressTo.md | 2 - docs/models/SmartPostHub.md | 2 - docs/models/SortDir.md | 2 - docs/models/StatusCode.md | 2 - docs/models/StatusDetailCode.md | 2 - docs/models/Tag.md | 2 - docs/models/TagShipmentResponseBody.md | 2 - docs/models/TaxIdentifier.md | 2 - docs/models/TaxType.md | 2 - docs/models/TaxableEntityType.md | 2 - ...TokensGetEphemeralTokenResponseBodyYaml.md | 2 - docs/models/TrackEvent.md | 2 - docs/models/TrackingInformation.md | 2 - docs/models/TrackingStatus.md | 2 - docs/models/TransportMean.md | 2 - .../UpdateAccountSettingsImageRequestBody.md | 2 - .../UpdateAmazonBuyShippingRequestBody.md | 2 - .../UpdateCarrierSettingsRequestBody.md | 2 - .../UpdateDhlExpressSettingsRequestBody.md | 2 - docs/models/UpdateFedexSettingsRequestBody.md | 2 - .../UpdateNewgisticsSettingsRequestBody.md | 2 - docs/models/UpdatePackageTypeRequestBody.md | 2 - docs/models/UpdateShipmentFields.md | 2 - docs/models/UpdateShipmentRequestBody.md | 2 - docs/models/UpdateShipmentResponseBody.md | 2 - docs/models/UpdateShipmentsTags.md | 2 - docs/models/UpdateShipmentsTagsRequestBody.md | 2 - .../UpdateShipmentsTagsShipmentsTagsInner.md | 2 - docs/models/UpdateUpsSettingsRequestBody.md | 2 - docs/models/UpdateWarehouseRequestBody.md | 2 - .../UpdateWarehouseSettingsRequestBody.md | 2 - docs/models/UpdateWebhookRequestBody.md | 2 - docs/models/UpsAccountSettings.md | 2 - docs/models/UpsInvoice.md | 2 - docs/models/UpsPickupType.md | 2 - docs/models/UpsSettingsResponseBody.md | 2 - docs/models/ValidateAddress.md | 2 - docs/models/ValidateShipmentFields.md | 2 - docs/models/ValidationStatus.md | 2 - docs/models/VoidLabelResponseBody.md | 2 - docs/models/Warehouse.md | 2 - docs/models/Webhook.md | 2 - docs/models/WebhookEvent.md | 2 - docs/models/WebhookHeader.md | 2 - docs/models/Weight.md | 2 - docs/models/WeightUnit.md | 2 - generation/templates/README.solution.mustache | 11 - generation/templates/api_doc.mustache | 4 +- generation/templates/model_doc.mustache | 2 - 332 files changed, 36 insertions(+), 1169 deletions(-) diff --git a/README.md b/README.md index 04026636..840c1958 100644 --- a/README.md +++ b/README.md @@ -146,320 +146,6 @@ API | Method | Description *Webhooks* | [**UpdateWebhook**](docs//apis/WebhooksApi.md#updatewebhook) | Update a Webhook - -## Models - - - [AccountSettings](docs//models/AccountSettings.md) - - [AccountSettingsImages](docs//models/AccountSettingsImages.md) - - [AddFundsToCarrierRequestBody](docs//models/AddFundsToCarrierRequestBody.md) - - [AddFundsToCarrierResponseBody](docs//models/AddFundsToCarrierResponseBody.md) - - [AddFundsToInsuranceRequestBody](docs//models/AddFundsToInsuranceRequestBody.md) - - [AddFundsToInsuranceResponseBody](docs//models/AddFundsToInsuranceResponseBody.md) - - [AddToBatchRequestBody](docs//models/AddToBatchRequestBody.md) - - [Address](docs//models/Address.md) - - [AddressResidentialIndicator](docs//models/AddressResidentialIndicator.md) - - [AddressToValidate](docs//models/AddressToValidate.md) - - [AddressValidatingShipment](docs//models/AddressValidatingShipment.md) - - [AddressValidationCode](docs//models/AddressValidationCode.md) - - [AddressValidationDetailCode](docs//models/AddressValidationDetailCode.md) - - [AddressValidationMessageType](docs//models/AddressValidationMessageType.md) - - [AddressValidationResult](docs//models/AddressValidationResult.md) - - [AddressValidationStatus](docs//models/AddressValidationStatus.md) - - [AdvancedShipmentOptions](docs//models/AdvancedShipmentOptions.md) - - [AdvancedShipmentOptionsDangerousGoodsContact](docs//models/AdvancedShipmentOptionsDangerousGoodsContact.md) - - [AdvancedShipmentOptionsFedexFreight](docs//models/AdvancedShipmentOptionsFedexFreight.md) - - [AdvancedShipmentOptionsWindsorFrameworkDetails](docs//models/AdvancedShipmentOptionsWindsorFrameworkDetails.md) - - [AllowedIncoterms](docs//models/AllowedIncoterms.md) - - [AlternativeIdentifier](docs//models/AlternativeIdentifier.md) - - [AlternativeIdentifiers](docs//models/AlternativeIdentifiers.md) - - [AncillaryServiceEndorsement](docs//models/AncillaryServiceEndorsement.md) - - [Batch](docs//models/Batch.md) - - [BatchResponseError](docs//models/BatchResponseError.md) - - [BatchStatus](docs//models/BatchStatus.md) - - [BatchesSortBy](docs//models/BatchesSortBy.md) - - [BillToParty](docs//models/BillToParty.md) - - [BulkRate](docs//models/BulkRate.md) - - [CalculateRatesRequestBody](docs//models/CalculateRatesRequestBody.md) - - [CalculateRatesResponseBody](docs//models/CalculateRatesResponseBody.md) - - [Carrier](docs//models/Carrier.md) - - [CarrierAdvancedOption](docs//models/CarrierAdvancedOption.md) - - [CarrierName](docs//models/CarrierName.md) - - [CarrierNameWithSettings](docs//models/CarrierNameWithSettings.md) - - [CollectOnDelivery](docs//models/CollectOnDelivery.md) - - [CollectOnDeliveryPaymentType](docs//models/CollectOnDeliveryPaymentType.md) - - [CompareBulkRatesRequestBody](docs//models/CompareBulkRatesRequestBody.md) - - [ConnectAccessWorldwideRequestBody](docs//models/ConnectAccessWorldwideRequestBody.md) - - [ConnectAmazonBuyShippingRequestBody](docs//models/ConnectAmazonBuyShippingRequestBody.md) - - [ConnectAmazonShippingUk](docs//models/ConnectAmazonShippingUk.md) - - [ConnectApcRequestBody](docs//models/ConnectApcRequestBody.md) - - [ConnectAsendiaRequestBody](docs//models/ConnectAsendiaRequestBody.md) - - [ConnectAustraliaPostRequestBody](docs//models/ConnectAustraliaPostRequestBody.md) - - [ConnectCanadaPostRequestBody](docs//models/ConnectCanadaPostRequestBody.md) - - [ConnectCarrierRequestBody](docs//models/ConnectCarrierRequestBody.md) - - [ConnectCarrierResponseBody](docs//models/ConnectCarrierResponseBody.md) - - [ConnectDhlEcommerceRequestBody](docs//models/ConnectDhlEcommerceRequestBody.md) - - [ConnectDhlExpressAuRequestBody](docs//models/ConnectDhlExpressAuRequestBody.md) - - [ConnectDhlExpressCaRequestBody](docs//models/ConnectDhlExpressCaRequestBody.md) - - [ConnectDhlExpressRequestBody](docs//models/ConnectDhlExpressRequestBody.md) - - [ConnectDhlExpressUkRequestBody](docs//models/ConnectDhlExpressUkRequestBody.md) - - [ConnectDpdRequestBody](docs//models/ConnectDpdRequestBody.md) - - [ConnectEndiciaRequestBody](docs//models/ConnectEndiciaRequestBody.md) - - [ConnectFedexRequestBody](docs//models/ConnectFedexRequestBody.md) - - [ConnectFedexUkRequestBody](docs//models/ConnectFedexUkRequestBody.md) - - [ConnectFirstmileRequestBody](docs//models/ConnectFirstmileRequestBody.md) - - [ConnectImexRequestBody](docs//models/ConnectImexRequestBody.md) - - [ConnectInsurerRequestBody](docs//models/ConnectInsurerRequestBody.md) - - [ConnectLasershipRequestBody](docs//models/ConnectLasershipRequestBody.md) - - [ConnectNewgisticsRequestBody](docs//models/ConnectNewgisticsRequestBody.md) - - [ConnectOntracRequestBody](docs//models/ConnectOntracRequestBody.md) - - [ConnectPurolatorRequestBody](docs//models/ConnectPurolatorRequestBody.md) - - [ConnectRoyalMailRequestBody](docs//models/ConnectRoyalMailRequestBody.md) - - [ConnectRrDonnelleyRequestBody](docs//models/ConnectRrDonnelleyRequestBody.md) - - [ConnectSekoRequestBody](docs//models/ConnectSekoRequestBody.md) - - [ConnectSendleRequestBody](docs//models/ConnectSendleRequestBody.md) - - [ConnectStampsRequestBody](docs//models/ConnectStampsRequestBody.md) - - [ConnectUpsRequestBody](docs//models/ConnectUpsRequestBody.md) - - [ContactDetails](docs//models/ContactDetails.md) - - [CreateAccountSettingsImageRequestBody](docs//models/CreateAccountSettingsImageRequestBody.md) - - [CreateAndProcessBatchRequestBody](docs//models/CreateAndProcessBatchRequestBody.md) - - [CreateAndProcessBatchRequestBodyProcessLabels](docs//models/CreateAndProcessBatchRequestBodyProcessLabels.md) - - [CreateAndValidateShipment](docs//models/CreateAndValidateShipment.md) - - [CreateBatchRequest](docs//models/CreateBatchRequest.md) - - [CreateBatchRequestBody](docs//models/CreateBatchRequestBody.md) - - [CreateBatchResponseBody](docs//models/CreateBatchResponseBody.md) - - [CreateLabelFromRateRequestBody](docs//models/CreateLabelFromRateRequestBody.md) - - [CreateLabelFromRateResponseBody](docs//models/CreateLabelFromRateResponseBody.md) - - [CreateLabelFromShipmentRequestBody](docs//models/CreateLabelFromShipmentRequestBody.md) - - [CreateLabelFromShipmentResponseBody](docs//models/CreateLabelFromShipmentResponseBody.md) - - [CreateLabelRequestBody](docs//models/CreateLabelRequestBody.md) - - [CreateLabelResponseBody](docs//models/CreateLabelResponseBody.md) - - [CreateManifestByObjectRequestBody](docs//models/CreateManifestByObjectRequestBody.md) - - [CreateManifestLabelIdsRequestBody](docs//models/CreateManifestLabelIdsRequestBody.md) - - [CreateManifestRequestBody](docs//models/CreateManifestRequestBody.md) - - [CreateManifestResponseBody](docs//models/CreateManifestResponseBody.md) - - [CreatePackageTypeRequestBody](docs//models/CreatePackageTypeRequestBody.md) - - [CreatePackageTypeResponseBody](docs//models/CreatePackageTypeResponseBody.md) - - [CreateReturnLabelRequestBody](docs//models/CreateReturnLabelRequestBody.md) - - [CreateReturnLabelResponseBody](docs//models/CreateReturnLabelResponseBody.md) - - [CreateShipmentResponseBodyFields](docs//models/CreateShipmentResponseBodyFields.md) - - [CreateShipmentsRequestBody](docs//models/CreateShipmentsRequestBody.md) - - [CreateShipmentsResponseBody](docs//models/CreateShipmentsResponseBody.md) - - [CreateTagResponseBody](docs//models/CreateTagResponseBody.md) - - [CreateWarehouseRequestBody](docs//models/CreateWarehouseRequestBody.md) - - [CreateWarehouseResponseBody](docs//models/CreateWarehouseResponseBody.md) - - [CreateWebhookRequestBody](docs//models/CreateWebhookRequestBody.md) - - [CreateWebhookResponseBody](docs//models/CreateWebhookResponseBody.md) - - [CustomsItem](docs//models/CustomsItem.md) - - [DangerousAmount](docs//models/DangerousAmount.md) - - [DangerousGoods](docs//models/DangerousGoods.md) - - [DefaultLabelLayout](docs//models/DefaultLabelLayout.md) - - [DeletePickupByIdResponseBody](docs//models/DeletePickupByIdResponseBody.md) - - [DeleteScheduledPickupResponseBody](docs//models/DeleteScheduledPickupResponseBody.md) - - [DeliveryConfirmation](docs//models/DeliveryConfirmation.md) - - [DeprecatedManifest](docs//models/DeprecatedManifest.md) - - [DhlExpressAccountSettings](docs//models/DhlExpressAccountSettings.md) - - [DhlExpressSettingsResponseBody](docs//models/DhlExpressSettingsResponseBody.md) - - [DimensionUnit](docs//models/DimensionUnit.md) - - [Dimensions](docs//models/Dimensions.md) - - [DisplayScheme](docs//models/DisplayScheme.md) - - [Error](docs//models/Error.md) - - [ErrorCode](docs//models/ErrorCode.md) - - [ErrorResponseBody](docs//models/ErrorResponseBody.md) - - [ErrorSource](docs//models/ErrorSource.md) - - [ErrorType](docs//models/ErrorType.md) - - [ErrorWithLabelIdResponseBody](docs//models/ErrorWithLabelIdResponseBody.md) - - [EstimateRatesRequestBody](docs//models/EstimateRatesRequestBody.md) - - [FedexAccountSettings](docs//models/FedexAccountSettings.md) - - [FedexAccountSettingsRequestBody](docs//models/FedexAccountSettingsRequestBody.md) - - [FedexPickupType](docs//models/FedexPickupType.md) - - [FedexSettingsResponseBody](docs//models/FedexSettingsResponseBody.md) - - [GetAccountSettingsImagesResponseBody](docs//models/GetAccountSettingsImagesResponseBody.md) - - [GetAccountSettingsResponseBody](docs//models/GetAccountSettingsResponseBody.md) - - [GetBatchByExternalIdResponseBody](docs//models/GetBatchByExternalIdResponseBody.md) - - [GetBatchByIdResponseBody](docs//models/GetBatchByIdResponseBody.md) - - [GetCarrierByIdResponseBody](docs//models/GetCarrierByIdResponseBody.md) - - [GetCarrierOptionsResponseBody](docs//models/GetCarrierOptionsResponseBody.md) - - [GetCarrierSettingsResponseBody](docs//models/GetCarrierSettingsResponseBody.md) - - [GetCarriersResponseBody](docs//models/GetCarriersResponseBody.md) - - [GetInsuranceBalanceResponseBody](docs//models/GetInsuranceBalanceResponseBody.md) - - [GetLabelByExternalShipmentIdResponseBody](docs//models/GetLabelByExternalShipmentIdResponseBody.md) - - [GetLabelByIdResponseBody](docs//models/GetLabelByIdResponseBody.md) - - [GetManifestByIdResponseBody](docs//models/GetManifestByIdResponseBody.md) - - [GetPackageTypeByIdResponseBody](docs//models/GetPackageTypeByIdResponseBody.md) - - [GetPickupByIdResponseBody](docs//models/GetPickupByIdResponseBody.md) - - [GetPickupsResponseBody](docs//models/GetPickupsResponseBody.md) - - [GetRateByIdResponseBody](docs//models/GetRateByIdResponseBody.md) - - [GetServicePointByIdResponseBody](docs//models/GetServicePointByIdResponseBody.md) - - [GetServicePointByIdResponseBodyServicePoint](docs//models/GetServicePointByIdResponseBodyServicePoint.md) - - [GetServicePointsRequest](docs//models/GetServicePointsRequest.md) - - [GetServicePointsRequestBody](docs//models/GetServicePointsRequestBody.md) - - [GetServicePointsRequestBodyAddress](docs//models/GetServicePointsRequestBodyAddress.md) - - [GetServicePointsRequestBodyProvidersInner](docs//models/GetServicePointsRequestBodyProvidersInner.md) - - [GetServicePointsRequestBodyShipment](docs//models/GetServicePointsRequestBodyShipment.md) - - [GetServicePointsRequestBodyShipmentPackagesInner](docs//models/GetServicePointsRequestBodyShipmentPackagesInner.md) - - [GetShipmentByExternalIdResponseBody](docs//models/GetShipmentByExternalIdResponseBody.md) - - [GetShipmentByIdResponseBody](docs//models/GetShipmentByIdResponseBody.md) - - [GetTrackingLogFromLabelResponseBody](docs//models/GetTrackingLogFromLabelResponseBody.md) - - [GetTrackingLogResponseBody](docs//models/GetTrackingLogResponseBody.md) - - [GetWarehouseByIdResponseBody](docs//models/GetWarehouseByIdResponseBody.md) - - [GetWebhookByIdResponseBody](docs//models/GetWebhookByIdResponseBody.md) - - [IdentifierType](docs//models/IdentifierType.md) - - [ImporterOfRecords](docs//models/ImporterOfRecords.md) - - [InsuranceProvider](docs//models/InsuranceProvider.md) - - [InternationalShipmentOptions](docs//models/InternationalShipmentOptions.md) - - [InvoiceAdditionalDetails](docs//models/InvoiceAdditionalDetails.md) - - [Label](docs//models/Label.md) - - [LabelChargeEvent](docs//models/LabelChargeEvent.md) - - [LabelDownload](docs//models/LabelDownload.md) - - [LabelDownloadType](docs//models/LabelDownloadType.md) - - [LabelFormat](docs//models/LabelFormat.md) - - [LabelLayout](docs//models/LabelLayout.md) - - [LabelMessages](docs//models/LabelMessages.md) - - [LabelPackage](docs//models/LabelPackage.md) - - [LabelPackagesInner](docs//models/LabelPackagesInner.md) - - [LabelRequest](docs//models/LabelRequest.md) - - [LabelStatus](docs//models/LabelStatus.md) - - [Link](docs//models/Link.md) - - [ListAccountImagesResponseBody](docs//models/ListAccountImagesResponseBody.md) - - [ListAccountSettingsBody](docs//models/ListAccountSettingsBody.md) - - [ListAccountSettingsImagesResponseBody](docs//models/ListAccountSettingsImagesResponseBody.md) - - [ListBatchErrorsResponseBody](docs//models/ListBatchErrorsResponseBody.md) - - [ListBatchesResponseBody](docs//models/ListBatchesResponseBody.md) - - [ListCarrierPackageTypesResponseBody](docs//models/ListCarrierPackageTypesResponseBody.md) - - [ListCarrierServicesResponseBody](docs//models/ListCarrierServicesResponseBody.md) - - [ListCarriersResponseBody](docs//models/ListCarriersResponseBody.md) - - [ListLabelsResponseBody](docs//models/ListLabelsResponseBody.md) - - [ListManifestsResponseBody](docs//models/ListManifestsResponseBody.md) - - [ListPackageTypesResponseBody](docs//models/ListPackageTypesResponseBody.md) - - [ListPickupResponseBody](docs//models/ListPickupResponseBody.md) - - [ListServicePointsResponseBody](docs//models/ListServicePointsResponseBody.md) - - [ListServicePointsResponseBodyServicePointsInner](docs//models/ListServicePointsResponseBodyServicePointsInner.md) - - [ListServicePointsResponseBodyServicePointsInnerHoursOfOperation](docs//models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.md) - - [ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner](docs//models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md) - - [ListShipmentRatesResponseBody](docs//models/ListShipmentRatesResponseBody.md) - - [ListShipmentsResponseBody](docs//models/ListShipmentsResponseBody.md) - - [ListTagsResponseBody](docs//models/ListTagsResponseBody.md) - - [ListWarehousesResponseBody](docs//models/ListWarehousesResponseBody.md) - - [Manifest](docs//models/Manifest.md) - - [ManifestDownload](docs//models/ManifestDownload.md) - - [ManifestRequest](docs//models/ManifestRequest.md) - - [ManifestRequestStatus](docs//models/ManifestRequestStatus.md) - - [Manifests](docs//models/Manifests.md) - - [ManifestsRequests](docs//models/ManifestsRequests.md) - - [ModifyBatch](docs//models/ModifyBatch.md) - - [MonetaryValue](docs//models/MonetaryValue.md) - - [NonDelivery](docs//models/NonDelivery.md) - - [OptionalLink](docs//models/OptionalLink.md) - - [OrderSourceName](docs//models/OrderSourceName.md) - - [OriginType](docs//models/OriginType.md) - - [Package](docs//models/Package.md) - - [PackageContents](docs//models/PackageContents.md) - - [PackageType](docs//models/PackageType.md) - - [PackagingGroup](docs//models/PackagingGroup.md) - - [PackagingInstructionSection](docs//models/PackagingInstructionSection.md) - - [PagedListResponseBody](docs//models/PagedListResponseBody.md) - - [PaginationLink](docs//models/PaginationLink.md) - - [PaperlessDownload](docs//models/PaperlessDownload.md) - - [ParseAddressRequestBody](docs//models/ParseAddressRequestBody.md) - - [ParseAddressResponseBody](docs//models/ParseAddressResponseBody.md) - - [ParseShipmentRequestBody](docs//models/ParseShipmentRequestBody.md) - - [ParseShipmentResponseBody](docs//models/ParseShipmentResponseBody.md) - - [PartialAddress](docs//models/PartialAddress.md) - - [PartialShipment](docs//models/PartialShipment.md) - - [PartialShippingAddress](docs//models/PartialShippingAddress.md) - - [PartialShippingAddressTo](docs//models/PartialShippingAddressTo.md) - - [PartialShippingAddressToGeolocationInner](docs//models/PartialShippingAddressToGeolocationInner.md) - - [PaymentAmount](docs//models/PaymentAmount.md) - - [Pickup](docs//models/Pickup.md) - - [PickupResponseBody](docs//models/PickupResponseBody.md) - - [PickupWindow](docs//models/PickupWindow.md) - - [PickupWindows](docs//models/PickupWindows.md) - - [ProcessBatchRequestBody](docs//models/ProcessBatchRequestBody.md) - - [Products](docs//models/Products.md) - - [PurchaseLabelWithoutShipment](docs//models/PurchaseLabelWithoutShipment.md) - - [Rate](docs//models/Rate.md) - - [RateDetail](docs//models/RateDetail.md) - - [RateDetailAttributes](docs//models/RateDetailAttributes.md) - - [RateDetailType](docs//models/RateDetailType.md) - - [RateEstimate](docs//models/RateEstimate.md) - - [RateEstimateByCarrierId](docs//models/RateEstimateByCarrierId.md) - - [RateEstimateByCarrierIds](docs//models/RateEstimateByCarrierIds.md) - - [RateEstimateOptions](docs//models/RateEstimateOptions.md) - - [RateRequestBody](docs//models/RateRequestBody.md) - - [RateRequestByShipmentIds](docs//models/RateRequestByShipmentIds.md) - - [RateRequestByShipments](docs//models/RateRequestByShipments.md) - - [RateRequestOptions](docs//models/RateRequestOptions.md) - - [RateRequestRateOptions](docs//models/RateRequestRateOptions.md) - - [RateResponse](docs//models/RateResponse.md) - - [RateResponseStatus](docs//models/RateResponseStatus.md) - - [RateShipmentRequest](docs//models/RateShipmentRequest.md) - - [RateType](docs//models/RateType.md) - - [RatesInformation](docs//models/RatesInformation.md) - - [ReasonCode](docs//models/ReasonCode.md) - - [RecognizedEntity](docs//models/RecognizedEntity.md) - - [Redirect](docs//models/Redirect.md) - - [RegulationLevel](docs//models/RegulationLevel.md) - - [RemoveFromBatchRequestBody](docs//models/RemoveFromBatchRequestBody.md) - - [ResponseMessage](docs//models/ResponseMessage.md) - - [SchedulePickupRequestBody](docs//models/SchedulePickupRequestBody.md) - - [SchedulePickupResponseBody](docs//models/SchedulePickupResponseBody.md) - - [Service](docs//models/Service.md) - - [Shipment](docs//models/Shipment.md) - - [ShipmentIdRequest](docs//models/ShipmentIdRequest.md) - - [ShipmentItem](docs//models/ShipmentItem.md) - - [ShipmentRequest](docs//models/ShipmentRequest.md) - - [ShipmentStatus](docs//models/ShipmentStatus.md) - - [ShipmentsSortBy](docs//models/ShipmentsSortBy.md) - - [ShippingAddress](docs//models/ShippingAddress.md) - - [ShippingAddressFrom](docs//models/ShippingAddressFrom.md) - - [ShippingAddressTo](docs//models/ShippingAddressTo.md) - - [SmartPostHub](docs//models/SmartPostHub.md) - - [SortDir](docs//models/SortDir.md) - - [StatusCode](docs//models/StatusCode.md) - - [StatusDetailCode](docs//models/StatusDetailCode.md) - - [Tag](docs//models/Tag.md) - - [TagShipmentResponseBody](docs//models/TagShipmentResponseBody.md) - - [TaxIdentifier](docs//models/TaxIdentifier.md) - - [TaxType](docs//models/TaxType.md) - - [TaxableEntityType](docs//models/TaxableEntityType.md) - - [TokensGetEphemeralTokenResponseBodyYaml](docs//models/TokensGetEphemeralTokenResponseBodyYaml.md) - - [TrackEvent](docs//models/TrackEvent.md) - - [TrackingInformation](docs//models/TrackingInformation.md) - - [TrackingStatus](docs//models/TrackingStatus.md) - - [TransportMean](docs//models/TransportMean.md) - - [UpdateAccountSettingsImageRequestBody](docs//models/UpdateAccountSettingsImageRequestBody.md) - - [UpdateAmazonBuyShippingRequestBody](docs//models/UpdateAmazonBuyShippingRequestBody.md) - - [UpdateCarrierSettingsRequestBody](docs//models/UpdateCarrierSettingsRequestBody.md) - - [UpdateDhlExpressSettingsRequestBody](docs//models/UpdateDhlExpressSettingsRequestBody.md) - - [UpdateFedexSettingsRequestBody](docs//models/UpdateFedexSettingsRequestBody.md) - - [UpdateNewgisticsSettingsRequestBody](docs//models/UpdateNewgisticsSettingsRequestBody.md) - - [UpdatePackageTypeRequestBody](docs//models/UpdatePackageTypeRequestBody.md) - - [UpdateShipmentFields](docs//models/UpdateShipmentFields.md) - - [UpdateShipmentRequestBody](docs//models/UpdateShipmentRequestBody.md) - - [UpdateShipmentResponseBody](docs//models/UpdateShipmentResponseBody.md) - - [UpdateShipmentsTags](docs//models/UpdateShipmentsTags.md) - - [UpdateShipmentsTagsRequestBody](docs//models/UpdateShipmentsTagsRequestBody.md) - - [UpdateShipmentsTagsShipmentsTagsInner](docs//models/UpdateShipmentsTagsShipmentsTagsInner.md) - - [UpdateUpsSettingsRequestBody](docs//models/UpdateUpsSettingsRequestBody.md) - - [UpdateWarehouseRequestBody](docs//models/UpdateWarehouseRequestBody.md) - - [UpdateWarehouseSettingsRequestBody](docs//models/UpdateWarehouseSettingsRequestBody.md) - - [UpdateWebhookRequestBody](docs//models/UpdateWebhookRequestBody.md) - - [UpsAccountSettings](docs//models/UpsAccountSettings.md) - - [UpsInvoice](docs//models/UpsInvoice.md) - - [UpsPickupType](docs//models/UpsPickupType.md) - - [UpsSettingsResponseBody](docs//models/UpsSettingsResponseBody.md) - - [ValidateAddress](docs//models/ValidateAddress.md) - - [ValidateShipmentFields](docs//models/ValidateShipmentFields.md) - - [ValidationStatus](docs//models/ValidationStatus.md) - - [VoidLabelResponseBody](docs//models/VoidLabelResponseBody.md) - - [Warehouse](docs//models/Warehouse.md) - - [Webhook](docs//models/Webhook.md) - - [WebhookEvent](docs//models/WebhookEvent.md) - - [WebhookHeader](docs//models/WebhookHeader.md) - - [Weight](docs//models/Weight.md) - - [WeightUnit](docs//models/WeightUnit.md) - - ## Legacy Methods These methods have been deprecated in favor of the methods listed above, but are still in the SDK. diff --git a/docs/apis/AccountApi.md b/docs/apis/AccountApi.md index 1d966d84..5cecd504 100644 --- a/docs/apis/AccountApi.md +++ b/docs/apis/AccountApi.md @@ -58,15 +58,13 @@ 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**](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 [**GetAccountSettingsImagesResponseBody**](../models/GetAccountSettingsImagesResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **DeleteAccountImageById** ```csharp @@ -123,8 +121,6 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **GetAccountSettingsImagesById** ```csharp @@ -181,8 +177,6 @@ namespace Example [**GetAccountSettingsImagesResponseBody**](../models/GetAccountSettingsImagesResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ListAccountImages** ```csharp @@ -237,8 +231,6 @@ namespace Example [**ListAccountSettingsImagesResponseBody**](../models/ListAccountSettingsImagesResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ListAccountSettings** ```csharp @@ -293,8 +285,6 @@ namespace Example [**GetAccountSettingsResponseBody**](../models/GetAccountSettingsResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **UpdateAccountSettingsImagesById** ```csharp @@ -345,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**](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. | | @@ -353,5 +343,3 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - diff --git a/docs/apis/AddressesApi.md b/docs/apis/AddressesApi.md index ab160055..0a176066 100644 --- a/docs/apis/AddressesApi.md +++ b/docs/apis/AddressesApi.md @@ -54,15 +54,13 @@ 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**](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 [**ParseAddressResponseBody**](../models/ParseAddressResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ValidateAddress** ```csharp @@ -112,12 +110,10 @@ 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>**](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 [**List<AddressValidationResult>**](../models/AddressValidationResult.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - diff --git a/docs/apis/BatchesApi.md b/docs/apis/BatchesApi.md index 5174c4e8..25232c33 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**](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. | | @@ -71,8 +71,6 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **CreateBatch** ```csharp @@ -122,15 +120,13 @@ 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**](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 [**CreateBatchResponseBody**](../models/CreateBatchResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **DeleteBatch** ```csharp @@ -187,8 +183,6 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **GetBatchByExternalId** ```csharp @@ -245,8 +239,6 @@ namespace Example [**GetBatchByExternalIdResponseBody**](../models/GetBatchByExternalIdResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **GetBatchById** ```csharp @@ -303,8 +295,6 @@ namespace Example [**GetBatchByIdResponseBody**](../models/GetBatchByIdResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ListBatchErrors** ```csharp @@ -365,8 +355,6 @@ namespace Example [**ListBatchErrorsResponseBody**](../models/ListBatchErrorsResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ListBatches** ```csharp @@ -433,8 +421,6 @@ namespace Example [**ListBatchesResponseBody**](../models/ListBatchesResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ProcessBatch** ```csharp @@ -485,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**](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. | | @@ -493,8 +479,6 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **RemoveFromBatch** ```csharp @@ -545,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**](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. | | @@ -553,8 +537,6 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **UpdateBatch** ```csharp @@ -611,5 +593,3 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - diff --git a/docs/apis/CarrierAccountsApi.md b/docs/apis/CarrierAccountsApi.md index 41316f7c..1f2b1a75 100644 --- a/docs/apis/CarrierAccountsApi.md +++ b/docs/apis/CarrierAccountsApi.md @@ -58,15 +58,13 @@ 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**](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 [**ConnectCarrierResponseBody**](../models/ConnectCarrierResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **DisconnectCarrier** ```csharp @@ -125,8 +123,6 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **GetCarrierSettings** ```csharp @@ -185,8 +181,6 @@ namespace Example [**GetCarrierSettingsResponseBody**](../models/GetCarrierSettingsResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **UpdateCarrierSettings** ```csharp @@ -239,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**](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. | | @@ -247,5 +241,3 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - diff --git a/docs/apis/CarriersApi.md b/docs/apis/CarriersApi.md index ab606d2f..56a38434 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**](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. | | @@ -68,8 +68,6 @@ namespace Example [**AddFundsToCarrierResponseBody**](../models/AddFundsToCarrierResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **DisconnectCarrierById** ```csharp @@ -126,8 +124,6 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **GetCarrierById** ```csharp @@ -184,8 +180,6 @@ namespace Example [**GetCarrierByIdResponseBody**](../models/GetCarrierByIdResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **GetCarrierOptions** ```csharp @@ -242,8 +236,6 @@ namespace Example [**GetCarrierOptionsResponseBody**](../models/GetCarrierOptionsResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ListCarrierPackageTypes** ```csharp @@ -300,8 +292,6 @@ namespace Example [**ListCarrierPackageTypesResponseBody**](../models/ListCarrierPackageTypesResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ListCarrierServices** ```csharp @@ -358,8 +348,6 @@ namespace Example [**ListCarrierServicesResponseBody**](../models/ListCarrierServicesResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ListCarriers** ```csharp @@ -414,5 +402,3 @@ namespace Example [**GetCarriersResponseBody**](../models/GetCarriersResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - diff --git a/docs/apis/DownloadsApi.md b/docs/apis/DownloadsApi.md index dadec60e..3f443509 100644 --- a/docs/apis/DownloadsApi.md +++ b/docs/apis/DownloadsApi.md @@ -68,5 +68,3 @@ namespace Example **System.IO.Stream** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - diff --git a/docs/apis/InsuranceApi.md b/docs/apis/InsuranceApi.md index 93249dcd..61147e84 100644 --- a/docs/apis/InsuranceApi.md +++ b/docs/apis/InsuranceApi.md @@ -56,15 +56,13 @@ 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**](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 [**AddFundsToInsuranceResponseBody**](../models/AddFundsToInsuranceResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ConnectInsurer** ```csharp @@ -114,15 +112,13 @@ 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**](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 **Object** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **DisconnectInsurer** ```csharp @@ -177,8 +173,6 @@ namespace Example **Object** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **GetInsuranceBalance** ```csharp @@ -233,5 +227,3 @@ namespace Example [**GetInsuranceBalanceResponseBody**](../models/GetInsuranceBalanceResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - diff --git a/docs/apis/LabelsApi.md b/docs/apis/LabelsApi.md index 49340286..c5c302fa 100644 --- a/docs/apis/LabelsApi.md +++ b/docs/apis/LabelsApi.md @@ -61,15 +61,13 @@ 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**](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 [**CreateLabelResponseBody**](../models/CreateLabelResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **CreateLabelFromRate** ```csharp @@ -120,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. | | -| **createLabelFromRateRequestBody** | [**CreateLabelFromRateRequestBody**](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. | | @@ -128,8 +126,6 @@ namespace Example [**CreateLabelFromRateResponseBody**](../models/CreateLabelFromRateResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **CreateLabelFromShipment** ```csharp @@ -180,7 +176,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**](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. | | @@ -188,8 +184,6 @@ namespace Example [**CreateLabelFromShipmentResponseBody**](../models/CreateLabelFromShipmentResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **CreateReturnLabel** ```csharp @@ -240,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. | | -| **createReturnLabelRequestBody** | [**CreateReturnLabelRequestBody**](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. | | @@ -248,8 +242,6 @@ namespace Example [**CreateReturnLabelResponseBody**](../models/CreateReturnLabelResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **GetLabelByExternalShipmentId** ```csharp @@ -308,8 +300,6 @@ namespace Example [**GetLabelByExternalShipmentIdResponseBody**](../models/GetLabelByExternalShipmentIdResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **GetLabelById** ```csharp @@ -368,8 +358,6 @@ namespace Example [**GetLabelByIdResponseBody**](../models/GetLabelByIdResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **GetTrackingLogFromLabel** ```csharp @@ -426,8 +414,6 @@ namespace Example [**GetTrackingLogFromLabelResponseBody**](../models/GetTrackingLogFromLabelResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ListLabels** ```csharp @@ -510,8 +496,6 @@ namespace Example [**ListLabelsResponseBody**](../models/ListLabelsResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **VoidLabel** ```csharp @@ -568,5 +552,3 @@ namespace Example [**VoidLabelResponseBody**](../models/VoidLabelResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - diff --git a/docs/apis/ManifestsApi.md b/docs/apis/ManifestsApi.md index e64a3115..e5e15c63 100644 --- a/docs/apis/ManifestsApi.md +++ b/docs/apis/ManifestsApi.md @@ -56,15 +56,13 @@ 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**](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 [**CreateManifestResponseBody**](../models/CreateManifestResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **GetManifestById** ```csharp @@ -121,8 +119,6 @@ namespace Example [**GetManifestByIdResponseBody**](../models/GetManifestByIdResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **GetManifestRequestById** ```csharp @@ -179,8 +175,6 @@ namespace Example [**CreateManifestResponseBody**](../models/CreateManifestResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ListManifests** ```csharp @@ -242,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>**](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] | @@ -253,5 +247,3 @@ namespace Example [**ListManifestsResponseBody**](../models/ListManifestsResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - diff --git a/docs/apis/PackagePickupsApi.md b/docs/apis/PackagePickupsApi.md index e0681655..b5387d71 100644 --- a/docs/apis/PackagePickupsApi.md +++ b/docs/apis/PackagePickupsApi.md @@ -63,8 +63,6 @@ namespace Example [**DeletePickupByIdResponseBody**](../models/DeletePickupByIdResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **GetPickupById** ```csharp @@ -121,8 +119,6 @@ namespace Example [**GetPickupByIdResponseBody**](../models/GetPickupByIdResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ListScheduledPickups** ```csharp @@ -189,8 +185,6 @@ namespace Example [**GetPickupsResponseBody**](../models/GetPickupsResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **SchedulePickup** ```csharp @@ -240,12 +234,10 @@ 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**](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 [**SchedulePickupResponseBody**](../models/SchedulePickupResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - diff --git a/docs/apis/PackageTypesApi.md b/docs/apis/PackageTypesApi.md index f70f4e1c..4c269d07 100644 --- a/docs/apis/PackageTypesApi.md +++ b/docs/apis/PackageTypesApi.md @@ -57,15 +57,13 @@ 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**](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 [**CreatePackageTypeResponseBody**](../models/CreatePackageTypeResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **DeletePackageType** ```csharp @@ -122,8 +120,6 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **GetPackageTypeById** ```csharp @@ -180,8 +176,6 @@ namespace Example [**GetPackageTypeByIdResponseBody**](../models/GetPackageTypeByIdResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ListPackageTypes** ```csharp @@ -236,8 +230,6 @@ namespace Example [**ListPackageTypesResponseBody**](../models/ListPackageTypesResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **UpdatePackageType** ```csharp @@ -288,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**](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. | | @@ -296,5 +288,3 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - diff --git a/docs/apis/RatesApi.md b/docs/apis/RatesApi.md index 08a39517..60f105da 100644 --- a/docs/apis/RatesApi.md +++ b/docs/apis/RatesApi.md @@ -56,15 +56,13 @@ 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**](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 [**CalculateRatesResponseBody**](../models/CalculateRatesResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **CompareBulkRates** ```csharp @@ -114,15 +112,13 @@ 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**](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 [**List<BulkRate>**](../models/BulkRate.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **EstimateRates** ```csharp @@ -172,15 +168,13 @@ 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**](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 [**List<RateEstimate>**](../models/RateEstimate.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **GetRateById** ```csharp @@ -237,5 +231,3 @@ namespace Example [**GetRateByIdResponseBody**](../models/GetRateByIdResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - diff --git a/docs/apis/ServicePointsApi.md b/docs/apis/ServicePointsApi.md index 5cd3af7a..78ef682c 100644 --- a/docs/apis/ServicePointsApi.md +++ b/docs/apis/ServicePointsApi.md @@ -65,8 +65,6 @@ namespace Example [**GetServicePointByIdResponseBody**](../models/GetServicePointByIdResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ServicePointsList** ```csharp @@ -116,12 +114,10 @@ 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**](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 [**ListServicePointsResponseBody**](../models/ListServicePointsResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - diff --git a/docs/apis/ShipmentsApi.md b/docs/apis/ShipmentsApi.md index c27006aa..2885dac2 100644 --- a/docs/apis/ShipmentsApi.md +++ b/docs/apis/ShipmentsApi.md @@ -71,8 +71,6 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **CreateShipments** ```csharp @@ -122,15 +120,13 @@ 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**](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 [**CreateShipmentsResponseBody**](../models/CreateShipmentsResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **GetShipmentByExternalId** ```csharp @@ -187,8 +183,6 @@ namespace Example [**GetShipmentByExternalIdResponseBody**](../models/GetShipmentByExternalIdResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **GetShipmentById** ```csharp @@ -245,8 +239,6 @@ namespace Example [**GetShipmentByIdResponseBody**](../models/GetShipmentByIdResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ListShipmentRates** ```csharp @@ -305,8 +297,6 @@ namespace Example [**ListShipmentRatesResponseBody**](../models/ListShipmentRatesResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ListShipments** ```csharp @@ -385,8 +375,6 @@ namespace Example [**ListShipmentsResponseBody**](../models/ListShipmentsResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ParseShipment** ```csharp @@ -436,15 +424,13 @@ 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**](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 [**ParseShipmentResponseBody**](../models/ParseShipmentResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ShipmentsListTags** ```csharp @@ -501,8 +487,6 @@ namespace Example [**TagShipmentResponseBody**](../models/TagShipmentResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ShipmentsUpdateTags** ```csharp @@ -551,15 +535,13 @@ 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**](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 void (empty response body) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **TagShipment** ```csharp @@ -618,8 +600,6 @@ namespace Example [**TagShipmentResponseBody**](../models/TagShipmentResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **UntagShipment** ```csharp @@ -678,8 +658,6 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **UpdateShipment** ```csharp @@ -730,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**](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. | | @@ -738,5 +716,3 @@ namespace Example [**UpdateShipmentResponseBody**](../models/UpdateShipmentResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - diff --git a/docs/apis/TagsApi.md b/docs/apis/TagsApi.md index 934ee3e7..5e9041e0 100644 --- a/docs/apis/TagsApi.md +++ b/docs/apis/TagsApi.md @@ -63,8 +63,6 @@ namespace Example [**CreateTagResponseBody**](../models/CreateTagResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **DeleteTag** ```csharp @@ -121,8 +119,6 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ListTags** ```csharp @@ -177,8 +173,6 @@ namespace Example [**ListTagsResponseBody**](../models/ListTagsResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **RenameTag** ```csharp @@ -237,5 +231,3 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - diff --git a/docs/apis/TokensApi.md b/docs/apis/TokensApi.md index 3dce7ed8..44a80275 100644 --- a/docs/apis/TokensApi.md +++ b/docs/apis/TokensApi.md @@ -60,5 +60,3 @@ namespace Example [**TokensGetEphemeralTokenResponseBodyYaml**](../models/TokensGetEphemeralTokenResponseBodyYaml.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - diff --git a/docs/apis/TrackingApi.md b/docs/apis/TrackingApi.md index 69c86ee5..68421037 100644 --- a/docs/apis/TrackingApi.md +++ b/docs/apis/TrackingApi.md @@ -64,8 +64,6 @@ namespace Example [**GetTrackingLogResponseBody**](../models/GetTrackingLogResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **StartTracking** ```csharp @@ -124,8 +122,6 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **StopTracking** ```csharp @@ -184,5 +180,3 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - diff --git a/docs/apis/WarehousesApi.md b/docs/apis/WarehousesApi.md index 6ec3a375..07ddd9d9 100644 --- a/docs/apis/WarehousesApi.md +++ b/docs/apis/WarehousesApi.md @@ -58,15 +58,13 @@ 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**](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 [**CreateWarehouseResponseBody**](../models/CreateWarehouseResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **DeleteWarehouse** ```csharp @@ -123,8 +121,6 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **GetWarehouseById** ```csharp @@ -181,8 +177,6 @@ namespace Example [**GetWarehouseByIdResponseBody**](../models/GetWarehouseByIdResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ListWarehouses** ```csharp @@ -237,8 +231,6 @@ namespace Example [**ListWarehousesResponseBody**](../models/ListWarehousesResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **UpdateWarehouse** ```csharp @@ -289,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**](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. | | @@ -297,8 +289,6 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **UpdateWarehouseSettings** ```csharp @@ -349,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**](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. | | @@ -357,5 +347,3 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - diff --git a/docs/apis/WebhooksApi.md b/docs/apis/WebhooksApi.md index 23ed9e75..8638f7b8 100644 --- a/docs/apis/WebhooksApi.md +++ b/docs/apis/WebhooksApi.md @@ -57,15 +57,13 @@ 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**](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 [**CreateWebhookResponseBody**](../models/CreateWebhookResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **DeleteWebhook** ```csharp @@ -122,8 +120,6 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **GetWebhookById** ```csharp @@ -180,8 +176,6 @@ namespace Example [**GetWebhookByIdResponseBody**](../models/GetWebhookByIdResponseBody.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **ListWebhooks** ```csharp @@ -236,8 +230,6 @@ namespace Example [**List<Webhook>**](../models/Webhook.md) -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - # **UpdateWebhook** ```csharp @@ -288,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**](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. | | @@ -296,5 +288,3 @@ namespace Example **string** -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) - diff --git a/docs/models/AccountSettings.md b/docs/models/AccountSettings.md index 382b8eca..bc3938cd 100644 --- a/docs/models/AccountSettings.md +++ b/docs/models/AccountSettings.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DefaultLabelLayout** | **DefaultLabelLayout** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AccountSettingsImages.md b/docs/models/AccountSettingsImages.md index 6e82ddc6..0532d36b 100644 --- a/docs/models/AccountSettingsImages.md +++ b/docs/models/AccountSettingsImages.md @@ -13,5 +13,3 @@ Name | Type | Description | Notes **ModifiedAt** | **DateTimeOffset** | The date and time that the image was modified in ShipEngine. | [optional] [readonly] **Name** | **string** | A human readable name for the image. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AddFundsToCarrierRequestBody.md b/docs/models/AddFundsToCarrierRequestBody.md index a315e996..8c14280d 100644 --- a/docs/models/AddFundsToCarrierRequestBody.md +++ b/docs/models/AddFundsToCarrierRequestBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Amount** | **decimal** | The monetary amount, in the specified currency. | **Currency** | **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 | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AddFundsToCarrierResponseBody.md b/docs/models/AddFundsToCarrierResponseBody.md index 9704966c..ea8647e1 100644 --- a/docs/models/AddFundsToCarrierResponseBody.md +++ b/docs/models/AddFundsToCarrierResponseBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Balance** | [**MonetaryValue**](MonetaryValue.md) | The current balance of the account | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AddFundsToInsuranceRequestBody.md b/docs/models/AddFundsToInsuranceRequestBody.md index 6b36aa87..6eeb6222 100644 --- a/docs/models/AddFundsToInsuranceRequestBody.md +++ b/docs/models/AddFundsToInsuranceRequestBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Amount** | **decimal** | The monetary amount, in the specified currency. | **Currency** | **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 | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AddFundsToInsuranceResponseBody.md b/docs/models/AddFundsToInsuranceResponseBody.md index 9f25a289..836554e4 100644 --- a/docs/models/AddFundsToInsuranceResponseBody.md +++ b/docs/models/AddFundsToInsuranceResponseBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Amount** | **decimal** | The monetary amount, in the specified currency. | **Currency** | **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 | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AddToBatchRequestBody.md b/docs/models/AddToBatchRequestBody.md index 5403429e..7dd8aee0 100644 --- a/docs/models/AddToBatchRequestBody.md +++ b/docs/models/AddToBatchRequestBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **RateIds** | **List<string>** | Array of Rate IDs to be modifed on the batch | [optional] **ShipmentIds** | **List<string>** | The Shipment Ids to be modified on the batch | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Address.md b/docs/models/Address.md index 9c7149ee..3a74628f 100644 --- a/docs/models/Address.md +++ b/docs/models/Address.md @@ -18,5 +18,3 @@ Name | Type | Description | Notes **Email** | **string** | Email for the address owner. | [optional] **Phone** | **string** | The phone number of a contact person at this address. The format of this phone number varies depending on the country. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AddressResidentialIndicator.md b/docs/models/AddressResidentialIndicator.md index b2ca5c5f..76e32d1b 100644 --- a/docs/models/AddressResidentialIndicator.md +++ b/docs/models/AddressResidentialIndicator.md @@ -6,5 +6,3 @@ Indicates whether an address is residential. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AddressToValidate.md b/docs/models/AddressToValidate.md index 14045b22..0d99a543 100644 --- a/docs/models/AddressToValidate.md +++ b/docs/models/AddressToValidate.md @@ -18,5 +18,3 @@ Name | Type | Description | Notes **Phone** | **string** | The phone number of a contact person at this address. The format of this phone number varies depending on the country. | [optional] **PostalCode** | **string** | postal code | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AddressValidatingShipment.md b/docs/models/AddressValidatingShipment.md index 44f8efbc..997446a7 100644 --- a/docs/models/AddressValidatingShipment.md +++ b/docs/models/AddressValidatingShipment.md @@ -34,5 +34,3 @@ Name | Type | Description | Notes **ValidateAddress** | **ValidateAddress** | | [optional] **WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AddressValidationCode.md b/docs/models/AddressValidationCode.md index 683a4b36..117771b0 100644 --- a/docs/models/AddressValidationCode.md +++ b/docs/models/AddressValidationCode.md @@ -6,5 +6,3 @@ The error codes that can be returned by the address validation API Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AddressValidationDetailCode.md b/docs/models/AddressValidationDetailCode.md index cb3378c7..4fd32647 100644 --- a/docs/models/AddressValidationDetailCode.md +++ b/docs/models/AddressValidationDetailCode.md @@ -6,5 +6,3 @@ The detailed error codes that can be returned by the address validation API Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AddressValidationMessageType.md b/docs/models/AddressValidationMessageType.md index dd346af5..e60ed337 100644 --- a/docs/models/AddressValidationMessageType.md +++ b/docs/models/AddressValidationMessageType.md @@ -6,5 +6,3 @@ The different types of messages that can be returned by the address validation A Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AddressValidationResult.md b/docs/models/AddressValidationResult.md index cefd7627..4c823adf 100644 --- a/docs/models/AddressValidationResult.md +++ b/docs/models/AddressValidationResult.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **Status** | **AddressValidationStatus** | | **MatchedAddress** | [**Address**](Address.md) | The matched address found by the Shipengine API | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AddressValidationStatus.md b/docs/models/AddressValidationStatus.md index c5902a7e..8183eca6 100644 --- a/docs/models/AddressValidationStatus.md +++ b/docs/models/AddressValidationStatus.md @@ -6,5 +6,3 @@ The possible address validation status values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AdvancedShipmentOptions.md b/docs/models/AdvancedShipmentOptions.md index ca55a8bc..bd0c4db8 100644 --- a/docs/models/AdvancedShipmentOptions.md +++ b/docs/models/AdvancedShipmentOptions.md @@ -33,5 +33,3 @@ Name | Type | Description | Notes **UseUpsGroundFreightPricing** | **bool** | Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified. | [optional] **WindsorFrameworkDetails** | [**AdvancedShipmentOptionsWindsorFrameworkDetails**](AdvancedShipmentOptionsWindsorFrameworkDetails.md) | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AdvancedShipmentOptionsDangerousGoodsContact.md b/docs/models/AdvancedShipmentOptionsDangerousGoodsContact.md index 04739f87..36dbbe6b 100644 --- a/docs/models/AdvancedShipmentOptionsDangerousGoodsContact.md +++ b/docs/models/AdvancedShipmentOptionsDangerousGoodsContact.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Name** | **string** | Name of the contact | [optional] **Phone** | **string** | Phone number of the contact | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AdvancedShipmentOptionsFedexFreight.md b/docs/models/AdvancedShipmentOptionsFedexFreight.md index 0af9c3e2..e1e57df7 100644 --- a/docs/models/AdvancedShipmentOptionsFedexFreight.md +++ b/docs/models/AdvancedShipmentOptionsFedexFreight.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **BookingConfirmation** | **string** | | [optional] **ShipperLoadAndCount** | **string** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AdvancedShipmentOptionsWindsorFrameworkDetails.md b/docs/models/AdvancedShipmentOptionsWindsorFrameworkDetails.md index fa237cfd..cc921168 100644 --- a/docs/models/AdvancedShipmentOptionsWindsorFrameworkDetails.md +++ b/docs/models/AdvancedShipmentOptionsWindsorFrameworkDetails.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **MovementIndicator** | **string** | An indicator that will tell the carrier and HMRC the type of movement for the shipment. | [optional] **NotAtRisk** | **bool** | An indicator that allows a shipper to declare the shipment as not-at-risk. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AllowedIncoterms.md b/docs/models/AllowedIncoterms.md index 711314d4..b8a1f211 100644 --- a/docs/models/AllowedIncoterms.md +++ b/docs/models/AllowedIncoterms.md @@ -5,5 +5,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AlternativeIdentifier.md b/docs/models/AlternativeIdentifier.md index 5e30ee8a..aab4de65 100644 --- a/docs/models/AlternativeIdentifier.md +++ b/docs/models/AlternativeIdentifier.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Type** | **string** | The type of alternative_identifier that corresponds to the value. | [optional] **Value** | **string** | The value of the alternative_identifier. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AlternativeIdentifiers.md b/docs/models/AlternativeIdentifiers.md index b8f9eabc..55a61ed6 100644 --- a/docs/models/AlternativeIdentifiers.md +++ b/docs/models/AlternativeIdentifiers.md @@ -6,5 +6,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **VarAlternativeIdentifiers** | [**List<AlternativeIdentifier>**](AlternativeIdentifier.md) | Alternative identifiers associated with this package. | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/AncillaryServiceEndorsement.md b/docs/models/AncillaryServiceEndorsement.md index 6b07f67b..6026e15a 100644 --- a/docs/models/AncillaryServiceEndorsement.md +++ b/docs/models/AncillaryServiceEndorsement.md @@ -6,5 +6,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Batch.md b/docs/models/Batch.md index 4c2147ea..39e875c0 100644 --- a/docs/models/Batch.md +++ b/docs/models/Batch.md @@ -27,5 +27,3 @@ Name | Type | Description | Notes **ExternalBatchId** | **string** | A string that uniquely identifies the external batch | [readonly] **ProcessedAt** | **DateTimeOffset** | The date and time the batch was processed in ShipEngine | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/BatchResponseError.md b/docs/models/BatchResponseError.md index 7021c465..eb2809a4 100644 --- a/docs/models/BatchResponseError.md +++ b/docs/models/BatchResponseError.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **ExternalShipmentId** | **string** | An external shipment id associated with the shipment | [optional] [readonly] **ShipmentId** | **string** | A string that uniquely identifies the shipment | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/BatchStatus.md b/docs/models/BatchStatus.md index ef74cfb0..e6e921e0 100644 --- a/docs/models/BatchStatus.md +++ b/docs/models/BatchStatus.md @@ -6,5 +6,3 @@ The possible batch status values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/BatchesSortBy.md b/docs/models/BatchesSortBy.md index 22830c55..34e83ed6 100644 --- a/docs/models/BatchesSortBy.md +++ b/docs/models/BatchesSortBy.md @@ -6,5 +6,3 @@ The possible batches sort by values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/BillToParty.md b/docs/models/BillToParty.md index 2f9c9f4f..99f167c5 100644 --- a/docs/models/BillToParty.md +++ b/docs/models/BillToParty.md @@ -6,5 +6,3 @@ The possible bill to party values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/BulkRate.md b/docs/models/BulkRate.md index a52d0451..b3cceab9 100644 --- a/docs/models/BulkRate.md +++ b/docs/models/BulkRate.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **ShipmentId** | **string** | A string that uniquely identifies the shipment | [readonly] **Status** | **RateResponseStatus** | | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CalculateRatesRequestBody.md b/docs/models/CalculateRatesRequestBody.md index 855eec69..f6bf988d 100644 --- a/docs/models/CalculateRatesRequestBody.md +++ b/docs/models/CalculateRatesRequestBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **RateOptions** | [**RateRequestBody**](RateRequestBody.md) | The rate options | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CalculateRatesResponseBody.md b/docs/models/CalculateRatesResponseBody.md index 6f16a087..fabd9823 100644 --- a/docs/models/CalculateRatesResponseBody.md +++ b/docs/models/CalculateRatesResponseBody.md @@ -34,5 +34,3 @@ Name | Type | Description | Notes **TaxIdentifiers** | [**List<TaxIdentifier>**](TaxIdentifier.md) | | [optional] **WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Carrier.md b/docs/models/Carrier.md index 8cb315c7..c2f9cc0d 100644 --- a/docs/models/Carrier.md +++ b/docs/models/Carrier.md @@ -21,5 +21,3 @@ Name | Type | Description | Notes **Services** | [**List<Service>**](Service.md) | A list of services that are offered by the carrier | [optional] [readonly] **SupportsLabelMessages** | **bool** | The carrier supports adding custom label messages to an order. | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CarrierAdvancedOption.md b/docs/models/CarrierAdvancedOption.md index 52de6d7d..6b297a7b 100644 --- a/docs/models/CarrierAdvancedOption.md +++ b/docs/models/CarrierAdvancedOption.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **Description** | **string** | Description of option | [optional] [readonly] **Name** | **string** | Name of advanced option | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CarrierName.md b/docs/models/CarrierName.md index b7b23d5a..2b03dafe 100644 --- a/docs/models/CarrierName.md +++ b/docs/models/CarrierName.md @@ -6,5 +6,3 @@ The shipping carriers that are supported by ShipEngine Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CarrierNameWithSettings.md b/docs/models/CarrierNameWithSettings.md index d256f185..0f219b89 100644 --- a/docs/models/CarrierNameWithSettings.md +++ b/docs/models/CarrierNameWithSettings.md @@ -6,5 +6,3 @@ The shipping carriers for which ShipEngine supports carrier settings Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CollectOnDelivery.md b/docs/models/CollectOnDelivery.md index 59e1df1d..39566631 100644 --- a/docs/models/CollectOnDelivery.md +++ b/docs/models/CollectOnDelivery.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **PaymentAmount** | [**PaymentAmount**](PaymentAmount.md) | | [optional] **PaymentType** | **CollectOnDeliveryPaymentType** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CollectOnDeliveryPaymentType.md b/docs/models/CollectOnDeliveryPaymentType.md index 567540e1..8de01901 100644 --- a/docs/models/CollectOnDeliveryPaymentType.md +++ b/docs/models/CollectOnDeliveryPaymentType.md @@ -6,5 +6,3 @@ Types of payment that are supported Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CompareBulkRatesRequestBody.md b/docs/models/CompareBulkRatesRequestBody.md index f9332855..a3fd9334 100644 --- a/docs/models/CompareBulkRatesRequestBody.md +++ b/docs/models/CompareBulkRatesRequestBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **RateOptions** | [**RateRequestBody**](RateRequestBody.md) | The rate options | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectAccessWorldwideRequestBody.md b/docs/models/ConnectAccessWorldwideRequestBody.md index 9eac6f00..d1b49f7c 100644 --- a/docs/models/ConnectAccessWorldwideRequestBody.md +++ b/docs/models/ConnectAccessWorldwideRequestBody.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **Password** | **string** | Access Worldwide Password | **Username** | **string** | Access Worldwide Username | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectAmazonBuyShippingRequestBody.md b/docs/models/ConnectAmazonBuyShippingRequestBody.md index f0065ce6..4e7911eb 100644 --- a/docs/models/ConnectAmazonBuyShippingRequestBody.md +++ b/docs/models/ConnectAmazonBuyShippingRequestBody.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **MwsAuthToken** | **string** | | **Nickname** | **string** | Nickname to be associated with the account connection | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectAmazonShippingUk.md b/docs/models/ConnectAmazonShippingUk.md index d9ef2978..438340ac 100644 --- a/docs/models/ConnectAmazonShippingUk.md +++ b/docs/models/ConnectAmazonShippingUk.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **AuthCode** | **string** | Amazon UK Shipping auth code. | **Nickname** | **string** | The nickname associated with the carrier connection | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectApcRequestBody.md b/docs/models/ConnectApcRequestBody.md index 3db54da2..a529eba5 100644 --- a/docs/models/ConnectApcRequestBody.md +++ b/docs/models/ConnectApcRequestBody.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **Password** | **string** | The password for the APC account | **Username** | **string** | The username for the APC account | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectAsendiaRequestBody.md b/docs/models/ConnectAsendiaRequestBody.md index 6beffe38..f0879c10 100644 --- a/docs/models/ConnectAsendiaRequestBody.md +++ b/docs/models/ConnectAsendiaRequestBody.md @@ -13,5 +13,3 @@ Name | Type | Description | Notes **Username** | **string** | Asendia username | **SubAccountNumber** | **string** | Asendia sub account number | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectAustraliaPostRequestBody.md b/docs/models/ConnectAustraliaPostRequestBody.md index 45436f0d..05e26666 100644 --- a/docs/models/ConnectAustraliaPostRequestBody.md +++ b/docs/models/ConnectAustraliaPostRequestBody.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **ApiSecret** | **string** | API secret | **Nickname** | **string** | Nickname | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectCanadaPostRequestBody.md b/docs/models/ConnectCanadaPostRequestBody.md index 9f24ac2b..36dc9825 100644 --- a/docs/models/ConnectCanadaPostRequestBody.md +++ b/docs/models/ConnectCanadaPostRequestBody.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **ContractId** | **string** | Canada Post Account Contract ID | **Nickname** | **string** | Nickname | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectCarrierRequestBody.md b/docs/models/ConnectCarrierRequestBody.md index 227cdb07..bfa45f5c 100644 --- a/docs/models/ConnectCarrierRequestBody.md +++ b/docs/models/ConnectCarrierRequestBody.md @@ -5,5 +5,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectCarrierResponseBody.md b/docs/models/ConnectCarrierResponseBody.md index f908046c..3f5dbf4c 100644 --- a/docs/models/ConnectCarrierResponseBody.md +++ b/docs/models/ConnectCarrierResponseBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **CarrierId** | **string** | A string that uniquely identifies the carrier | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectDhlEcommerceRequestBody.md b/docs/models/ConnectDhlEcommerceRequestBody.md index b8eb92ec..496fd0eb 100644 --- a/docs/models/ConnectDhlEcommerceRequestBody.md +++ b/docs/models/ConnectDhlEcommerceRequestBody.md @@ -21,5 +21,3 @@ Name | Type | Description | Notes **SoftwareName** | **string** | | [optional] **SoldTo** | **string** | Sold To field | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectDhlExpressAuRequestBody.md b/docs/models/ConnectDhlExpressAuRequestBody.md index 78109d0c..3882bbfe 100644 --- a/docs/models/ConnectDhlExpressAuRequestBody.md +++ b/docs/models/ConnectDhlExpressAuRequestBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **AccountNumber** | **string** | Account number | **Nickname** | **string** | Nickname | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectDhlExpressCaRequestBody.md b/docs/models/ConnectDhlExpressCaRequestBody.md index a7aef443..88e4a7b5 100644 --- a/docs/models/ConnectDhlExpressCaRequestBody.md +++ b/docs/models/ConnectDhlExpressCaRequestBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **AccountNumber** | **string** | Account number | **Nickname** | **string** | Nickname | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectDhlExpressRequestBody.md b/docs/models/ConnectDhlExpressRequestBody.md index 1e5ac8b7..62808f9c 100644 --- a/docs/models/ConnectDhlExpressRequestBody.md +++ b/docs/models/ConnectDhlExpressRequestBody.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **Password** | **string** | Required if site id is provided | [optional] **SiteId** | **string** | Required if password is provided | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectDhlExpressUkRequestBody.md b/docs/models/ConnectDhlExpressUkRequestBody.md index 70e8a37b..f01b33d2 100644 --- a/docs/models/ConnectDhlExpressUkRequestBody.md +++ b/docs/models/ConnectDhlExpressUkRequestBody.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **Password** | **string** | Password | **SiteId** | **string** | A string that uniquely identifies the site | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectDpdRequestBody.md b/docs/models/ConnectDpdRequestBody.md index 49426e0d..6db1ed51 100644 --- a/docs/models/ConnectDpdRequestBody.md +++ b/docs/models/ConnectDpdRequestBody.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **Nickname** | **string** | Nickname | **Password** | **string** | Password | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectEndiciaRequestBody.md b/docs/models/ConnectEndiciaRequestBody.md index b84f81d5..b0d5738e 100644 --- a/docs/models/ConnectEndiciaRequestBody.md +++ b/docs/models/ConnectEndiciaRequestBody.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **Nickname** | **string** | Nickname | **Passphrase** | **string** | Passphrase | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectFedexRequestBody.md b/docs/models/ConnectFedexRequestBody.md index 12de0bbe..cd87f03b 100644 --- a/docs/models/ConnectFedexRequestBody.md +++ b/docs/models/ConnectFedexRequestBody.md @@ -21,5 +21,3 @@ Name | Type | Description | Notes **Company** | **string** | The company | [optional] **MeterNumber** | **string** | Meter number | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectFedexUkRequestBody.md b/docs/models/ConnectFedexUkRequestBody.md index 1a0138d8..0d1db8cf 100644 --- a/docs/models/ConnectFedexUkRequestBody.md +++ b/docs/models/ConnectFedexUkRequestBody.md @@ -21,5 +21,3 @@ Name | Type | Description | Notes **Company** | **string** | The company | [optional] **MeterNumber** | **string** | Meter number | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectFirstmileRequestBody.md b/docs/models/ConnectFirstmileRequestBody.md index 4218bce0..e75ead8e 100644 --- a/docs/models/ConnectFirstmileRequestBody.md +++ b/docs/models/ConnectFirstmileRequestBody.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **Password** | **string** | Password | **ProfileName** | **string** | Profile name | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectImexRequestBody.md b/docs/models/ConnectImexRequestBody.md index 216391e7..b3ae56d7 100644 --- a/docs/models/ConnectImexRequestBody.md +++ b/docs/models/ConnectImexRequestBody.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **Password** | **string** | Password | **Username** | **string** | Username | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectInsurerRequestBody.md b/docs/models/ConnectInsurerRequestBody.md index 4c191d35..2ec59ff3 100644 --- a/docs/models/ConnectInsurerRequestBody.md +++ b/docs/models/ConnectInsurerRequestBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Email** | **string** | An email address. | **PolicyId** | **string** | | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectLasershipRequestBody.md b/docs/models/ConnectLasershipRequestBody.md index eaee5452..93f48799 100644 --- a/docs/models/ConnectLasershipRequestBody.md +++ b/docs/models/ConnectLasershipRequestBody.md @@ -32,5 +32,3 @@ Name | Type | Description | Notes **Instructions** | **String** | Instructions | [optional] **Phone** | **String** | Phone | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectNewgisticsRequestBody.md b/docs/models/ConnectNewgisticsRequestBody.md index c79666e0..89cef297 100644 --- a/docs/models/ConnectNewgisticsRequestBody.md +++ b/docs/models/ConnectNewgisticsRequestBody.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **MailerId** | **int** | Mailer id | [optional] **MerchantId** | **int** | Merchant id | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectOntracRequestBody.md b/docs/models/ConnectOntracRequestBody.md index cdaa9155..aa079a22 100644 --- a/docs/models/ConnectOntracRequestBody.md +++ b/docs/models/ConnectOntracRequestBody.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **Nickname** | **string** | Nickname | **Password** | **string** | Password | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectPurolatorRequestBody.md b/docs/models/ConnectPurolatorRequestBody.md index 6662b8f2..62709e5d 100644 --- a/docs/models/ConnectPurolatorRequestBody.md +++ b/docs/models/ConnectPurolatorRequestBody.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **ActivationKey** | **string** | Activation key | **Nickname** | **string** | Nickname | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectRoyalMailRequestBody.md b/docs/models/ConnectRoyalMailRequestBody.md index 593d7d18..439fb6db 100644 --- a/docs/models/ConnectRoyalMailRequestBody.md +++ b/docs/models/ConnectRoyalMailRequestBody.md @@ -18,5 +18,3 @@ Name | Type | Description | Notes **StreetLine2** | **string** | Street line2 | [optional] **StreetLine3** | **string** | Street line3 | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectRrDonnelleyRequestBody.md b/docs/models/ConnectRrDonnelleyRequestBody.md index 0ca1a856..a894d913 100644 --- a/docs/models/ConnectRrDonnelleyRequestBody.md +++ b/docs/models/ConnectRrDonnelleyRequestBody.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **Password** | **string** | Password | **Username** | **string** | Username | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectSekoRequestBody.md b/docs/models/ConnectSekoRequestBody.md index c74af586..b91cce6d 100644 --- a/docs/models/ConnectSekoRequestBody.md +++ b/docs/models/ConnectSekoRequestBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **AccessKey** | **string** | Seko Account Access Key | **Nickname** | **string** | Nickname | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectSendleRequestBody.md b/docs/models/ConnectSendleRequestBody.md index d1914e73..5c3278de 100644 --- a/docs/models/ConnectSendleRequestBody.md +++ b/docs/models/ConnectSendleRequestBody.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **Nickname** | **string** | Nickname | **SendleId** | **string** | A string that uniquely identifies the sendle | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectStampsRequestBody.md b/docs/models/ConnectStampsRequestBody.md index a17fac57..78622a5f 100644 --- a/docs/models/ConnectStampsRequestBody.md +++ b/docs/models/ConnectStampsRequestBody.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **Password** | **string** | Password | **Username** | **string** | Username | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ConnectUpsRequestBody.md b/docs/models/ConnectUpsRequestBody.md index f6004def..3887d0d1 100644 --- a/docs/models/ConnectUpsRequestBody.md +++ b/docs/models/ConnectUpsRequestBody.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **AccountPostalCode** | **string** | Account Postal Code | **Nickname** | **string** | Nickname | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ContactDetails.md b/docs/models/ContactDetails.md index a6257b17..cc0f63ed 100644 --- a/docs/models/ContactDetails.md +++ b/docs/models/ContactDetails.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Name** | **string** | | **Phone** | **string** | Phone number associated | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateAccountSettingsImageRequestBody.md b/docs/models/CreateAccountSettingsImageRequestBody.md index 3a64deb3..bc11d308 100644 --- a/docs/models/CreateAccountSettingsImageRequestBody.md +++ b/docs/models/CreateAccountSettingsImageRequestBody.md @@ -13,5 +13,3 @@ Name | Type | Description | Notes **LabelImageId** | **string** | A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded. | [optional] [readonly] **ModifiedAt** | **DateTimeOffset** | The date and time that the image was modified in ShipEngine. | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateAndProcessBatchRequestBody.md b/docs/models/CreateAndProcessBatchRequestBody.md index a7663a2b..8c505503 100644 --- a/docs/models/CreateAndProcessBatchRequestBody.md +++ b/docs/models/CreateAndProcessBatchRequestBody.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **RateIds** | **List<string>** | Array of rate IDs used in the batch | [optional] **ShipmentIds** | **List<string>** | Array of shipment IDs used in the batch | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateAndProcessBatchRequestBodyProcessLabels.md b/docs/models/CreateAndProcessBatchRequestBodyProcessLabels.md index 120fdcdd..b8cd6196 100644 --- a/docs/models/CreateAndProcessBatchRequestBodyProcessLabels.md +++ b/docs/models/CreateAndProcessBatchRequestBodyProcessLabels.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **LabelLayout** | **LabelLayout** | | [optional] [default to "4x6"] **ShipDate** | **DateTimeOffset** | The Ship date the batch is being processed for | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateAndValidateShipment.md b/docs/models/CreateAndValidateShipment.md index 72993dcb..64ae8fde 100644 --- a/docs/models/CreateAndValidateShipment.md +++ b/docs/models/CreateAndValidateShipment.md @@ -35,5 +35,3 @@ Name | Type | Description | Notes **TotalWeight** | [**Weight**](Weight.md) | The combined weight of all packages in the shipment | [optional] [readonly] **WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateBatchRequest.md b/docs/models/CreateBatchRequest.md index c0f541ff..ad5cee1a 100644 --- a/docs/models/CreateBatchRequest.md +++ b/docs/models/CreateBatchRequest.md @@ -5,5 +5,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateBatchRequestBody.md b/docs/models/CreateBatchRequestBody.md index 05dbbeb4..677e275d 100644 --- a/docs/models/CreateBatchRequestBody.md +++ b/docs/models/CreateBatchRequestBody.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **RateIds** | **List<string>** | Array of rate IDs used in the batch | [optional] **ShipmentIds** | **List<string>** | Array of shipment IDs used in the batch | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateBatchResponseBody.md b/docs/models/CreateBatchResponseBody.md index f756c8c0..8a4f6e87 100644 --- a/docs/models/CreateBatchResponseBody.md +++ b/docs/models/CreateBatchResponseBody.md @@ -27,5 +27,3 @@ Name | Type | Description | Notes **ExternalBatchId** | **string** | A string that uniquely identifies the external batch | [readonly] **ProcessedAt** | **DateTimeOffset** | The date and time the batch was processed in ShipEngine | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateLabelFromRateRequestBody.md b/docs/models/CreateLabelFromRateRequestBody.md index 5f7e7a3c..4fff7ad4 100644 --- a/docs/models/CreateLabelFromRateRequestBody.md +++ b/docs/models/CreateLabelFromRateRequestBody.md @@ -14,5 +14,3 @@ Name | Type | Description | Notes **LabelLayout** | **LabelLayout** | | [optional] **ValidateAddress** | **ValidateAddress** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateLabelFromRateResponseBody.md b/docs/models/CreateLabelFromRateResponseBody.md index 9ce72b50..809cb55d 100644 --- a/docs/models/CreateLabelFromRateResponseBody.md +++ b/docs/models/CreateLabelFromRateResponseBody.md @@ -45,5 +45,3 @@ Name | Type | Description | Notes **Voided** | **bool** | Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) | [optional] [readonly] **VoidedAt** | **DateTimeOffset** | The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateLabelFromShipmentRequestBody.md b/docs/models/CreateLabelFromShipmentRequestBody.md index 630455ec..a54c8161 100644 --- a/docs/models/CreateLabelFromShipmentRequestBody.md +++ b/docs/models/CreateLabelFromShipmentRequestBody.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **LabelLayout** | **LabelLayout** | | [optional] **ValidateAddress** | **ValidateAddress** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateLabelFromShipmentResponseBody.md b/docs/models/CreateLabelFromShipmentResponseBody.md index 86517d99..1d4ec3d2 100644 --- a/docs/models/CreateLabelFromShipmentResponseBody.md +++ b/docs/models/CreateLabelFromShipmentResponseBody.md @@ -45,5 +45,3 @@ Name | Type | Description | Notes **Voided** | **bool** | Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) | [optional] [readonly] **VoidedAt** | **DateTimeOffset** | The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateLabelRequestBody.md b/docs/models/CreateLabelRequestBody.md index 1b37db62..98987dbc 100644 --- a/docs/models/CreateLabelRequestBody.md +++ b/docs/models/CreateLabelRequestBody.md @@ -20,5 +20,3 @@ Name | Type | Description | Notes **TestLabel** | **bool** | Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. | [optional] [default to false] **ValidateAddress** | **ValidateAddress** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateLabelResponseBody.md b/docs/models/CreateLabelResponseBody.md index 019d1219..1e5f4ff6 100644 --- a/docs/models/CreateLabelResponseBody.md +++ b/docs/models/CreateLabelResponseBody.md @@ -45,5 +45,3 @@ Name | Type | Description | Notes **ValidateAddress** | **ValidateAddress** | | [optional] **VoidedAt** | **DateTimeOffset** | The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateManifestByObjectRequestBody.md b/docs/models/CreateManifestByObjectRequestBody.md index f89edd55..7782cca1 100644 --- a/docs/models/CreateManifestByObjectRequestBody.md +++ b/docs/models/CreateManifestByObjectRequestBody.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **ExcludedLabelIds** | **List<string>** | The list of label ids to exclude from the manifest | [optional] **LabelIds** | **List<string>** | The list of label ids to include for the manifest | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateManifestLabelIdsRequestBody.md b/docs/models/CreateManifestLabelIdsRequestBody.md index b1e35eb3..a8b34989 100644 --- a/docs/models/CreateManifestLabelIdsRequestBody.md +++ b/docs/models/CreateManifestLabelIdsRequestBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **LabelIds** | **List<string>** | The list of label ids to include in the manifest | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateManifestRequestBody.md b/docs/models/CreateManifestRequestBody.md index 278ff30b..94ef174d 100644 --- a/docs/models/CreateManifestRequestBody.md +++ b/docs/models/CreateManifestRequestBody.md @@ -5,5 +5,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateManifestResponseBody.md b/docs/models/CreateManifestResponseBody.md index ac6abdc0..6cc3fd95 100644 --- a/docs/models/CreateManifestResponseBody.md +++ b/docs/models/CreateManifestResponseBody.md @@ -20,5 +20,3 @@ Name | Type | Description | Notes **ManifestRequests** | [**List<ManifestRequest>**](ManifestRequest.md) | Resulting manifest requests with statuses | [optional] **Manifests** | [**List<Manifest>**](Manifest.md) | Resulting Manifests | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreatePackageTypeRequestBody.md b/docs/models/CreatePackageTypeRequestBody.md index fba42ca1..c232c2a8 100644 --- a/docs/models/CreatePackageTypeRequestBody.md +++ b/docs/models/CreatePackageTypeRequestBody.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **Dimensions** | [**Dimensions**](Dimensions.md) | The custom dimensions for the package. | [optional] **PackageId** | **string** | A string that uniquely identifies the package. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreatePackageTypeResponseBody.md b/docs/models/CreatePackageTypeResponseBody.md index c5486cb5..7004ec0f 100644 --- a/docs/models/CreatePackageTypeResponseBody.md +++ b/docs/models/CreatePackageTypeResponseBody.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **Dimensions** | [**Dimensions**](Dimensions.md) | The custom dimensions for the package. | [optional] **PackageId** | **string** | A string that uniquely identifies the package. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateReturnLabelRequestBody.md b/docs/models/CreateReturnLabelRequestBody.md index 51d06985..50d5c946 100644 --- a/docs/models/CreateReturnLabelRequestBody.md +++ b/docs/models/CreateReturnLabelRequestBody.md @@ -12,5 +12,3 @@ Name | Type | Description | Notes **LabelImageId** | **string** | The label image resource that was used to create a custom label image. | [optional] **LabelLayout** | **LabelLayout** | 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. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateReturnLabelResponseBody.md b/docs/models/CreateReturnLabelResponseBody.md index e02fad2b..59cadf6a 100644 --- a/docs/models/CreateReturnLabelResponseBody.md +++ b/docs/models/CreateReturnLabelResponseBody.md @@ -45,5 +45,3 @@ Name | Type | Description | Notes **Voided** | **bool** | Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) | [optional] [readonly] **VoidedAt** | **DateTimeOffset** | The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateShipmentResponseBodyFields.md b/docs/models/CreateShipmentResponseBodyFields.md index 12dfd4cf..6468b8f0 100644 --- a/docs/models/CreateShipmentResponseBodyFields.md +++ b/docs/models/CreateShipmentResponseBodyFields.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes **AddressValidation** | [**AddressValidationResult**](AddressValidationResult.md) | The address validation | [optional] **Errors** | **List<string>** | An array of errors that occurred while creating shipment. | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateShipmentsRequestBody.md b/docs/models/CreateShipmentsRequestBody.md index 1be3c9e7..bb415132 100644 --- a/docs/models/CreateShipmentsRequestBody.md +++ b/docs/models/CreateShipmentsRequestBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Shipments** | [**List<AddressValidatingShipment>**](AddressValidatingShipment.md) | An array of shipments to be created. | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateShipmentsResponseBody.md b/docs/models/CreateShipmentsResponseBody.md index 06a1a951..c9aa6243 100644 --- a/docs/models/CreateShipmentsResponseBody.md +++ b/docs/models/CreateShipmentsResponseBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Shipments** | [**List<CreateAndValidateShipment>**](CreateAndValidateShipment.md) | An array of shipments that were created. | **HasErrors** | **bool** | Indicates if errors occured while creating the shipments | [default to false] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateTagResponseBody.md b/docs/models/CreateTagResponseBody.md index c31a5f6e..7f7990a3 100644 --- a/docs/models/CreateTagResponseBody.md +++ b/docs/models/CreateTagResponseBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | The tag name. | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateWarehouseRequestBody.md b/docs/models/CreateWarehouseRequestBody.md index 05a66ad8..0e5b549d 100644 --- a/docs/models/CreateWarehouseRequestBody.md +++ b/docs/models/CreateWarehouseRequestBody.md @@ -12,5 +12,3 @@ Name | Type | Description | Notes **ReturnAddress** | [**Address**](Address.md) | The return address associated with the warehouse | [optional] **WarehouseId** | **string** | A string that uniquely identifies the warehouse | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateWarehouseResponseBody.md b/docs/models/CreateWarehouseResponseBody.md index 1473ff52..83f0353c 100644 --- a/docs/models/CreateWarehouseResponseBody.md +++ b/docs/models/CreateWarehouseResponseBody.md @@ -12,5 +12,3 @@ Name | Type | Description | Notes **WarehouseId** | **string** | A string that uniquely identifies the warehouse | [readonly] **IsDefault** | **bool** | Designates which single warehouse is the default on the account | [optional] [default to false] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateWebhookRequestBody.md b/docs/models/CreateWebhookRequestBody.md index 1d556bae..223fb53e 100644 --- a/docs/models/CreateWebhookRequestBody.md +++ b/docs/models/CreateWebhookRequestBody.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **Url** | **string** | The url that the webhook sends the request to | **Headers** | [**List<WebhookHeader>**](WebhookHeader.md) | Array of custom webhook headers | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CreateWebhookResponseBody.md b/docs/models/CreateWebhookResponseBody.md index e0dff4a0..dbf1bce5 100644 --- a/docs/models/CreateWebhookResponseBody.md +++ b/docs/models/CreateWebhookResponseBody.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **WebhookId** | **string** | A string that uniquely identifies the webhook | [readonly] **Headers** | [**List<WebhookHeader>**](WebhookHeader.md) | Array of custom webhook headers | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/CustomsItem.md b/docs/models/CustomsItem.md index 1ec4cdea..297e93e3 100644 --- a/docs/models/CustomsItem.md +++ b/docs/models/CustomsItem.md @@ -17,5 +17,3 @@ Name | Type | Description | Notes **ValueCurrency** | **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] **Weight** | [**Weight**](Weight.md) | The item weight | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/DangerousAmount.md b/docs/models/DangerousAmount.md index 86226d6e..5cbe9a09 100644 --- a/docs/models/DangerousAmount.md +++ b/docs/models/DangerousAmount.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Amount** | **decimal** | The amount of dangerous goods. | [optional] [default to 0M] **Unit** | **string** | The unit of dangerous goods. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/DangerousGoods.md b/docs/models/DangerousGoods.md index c2acbbf5..a6d9c03e 100644 --- a/docs/models/DangerousGoods.md +++ b/docs/models/DangerousGoods.md @@ -25,5 +25,3 @@ Name | Type | Description | Notes **TransportMean** | **TransportMean** | | [optional] **TunnelCode** | **string** | Defines which types of tunnels the shipment is allowed to go through | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/DefaultLabelLayout.md b/docs/models/DefaultLabelLayout.md index adfb8a6e..ddddd504 100644 --- a/docs/models/DefaultLabelLayout.md +++ b/docs/models/DefaultLabelLayout.md @@ -6,5 +6,3 @@ The possible default label layout values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/DeletePickupByIdResponseBody.md b/docs/models/DeletePickupByIdResponseBody.md index 9a3f412d..bb6d4d15 100644 --- a/docs/models/DeletePickupByIdResponseBody.md +++ b/docs/models/DeletePickupByIdResponseBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **PickupId** | **string** | Pickup Resource ID | **RequestId** | **Guid** | A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/DeleteScheduledPickupResponseBody.md b/docs/models/DeleteScheduledPickupResponseBody.md index 27a45f0d..6c4d7890 100644 --- a/docs/models/DeleteScheduledPickupResponseBody.md +++ b/docs/models/DeleteScheduledPickupResponseBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **PickupId** | **string** | Pickup Resource ID | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/DeliveryConfirmation.md b/docs/models/DeliveryConfirmation.md index 59faf7eb..49002f11 100644 --- a/docs/models/DeliveryConfirmation.md +++ b/docs/models/DeliveryConfirmation.md @@ -6,5 +6,3 @@ The possible delivery confirmation values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/DeprecatedManifest.md b/docs/models/DeprecatedManifest.md index fed530cf..ddff748b 100644 --- a/docs/models/DeprecatedManifest.md +++ b/docs/models/DeprecatedManifest.md @@ -16,5 +16,3 @@ Name | Type | Description | Notes **SubmissionId** | **string** | A string that uniquely identifies the submission | [optional] **WarehouseId** | **string** | A string that uniquely identifies the warehouse | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/DhlExpressAccountSettings.md b/docs/models/DhlExpressAccountSettings.md index 51ff150a..acd4d9c6 100644 --- a/docs/models/DhlExpressAccountSettings.md +++ b/docs/models/DhlExpressAccountSettings.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **Nickname** | **string** | Account nickname | [optional] **ShouldHideAccountNumberOnArchiveDoc** | **bool** | Indicates if the account number should be hidden on the archive documentation | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/DhlExpressSettingsResponseBody.md b/docs/models/DhlExpressSettingsResponseBody.md index b808b2c2..ac466617 100644 --- a/docs/models/DhlExpressSettingsResponseBody.md +++ b/docs/models/DhlExpressSettingsResponseBody.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **Nickname** | **string** | Account nickname | [optional] **ShouldHideAccountNumberOnArchiveDoc** | **bool** | Indicates if the account number should be hidden on the archive documentation | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/DimensionUnit.md b/docs/models/DimensionUnit.md index 41cce7fd..40748f28 100644 --- a/docs/models/DimensionUnit.md +++ b/docs/models/DimensionUnit.md @@ -6,5 +6,3 @@ The dimension units that are supported by ShipEngine. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Dimensions.md b/docs/models/Dimensions.md index b43ab138..ab1656ef 100644 --- a/docs/models/Dimensions.md +++ b/docs/models/Dimensions.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **Length** | **decimal** | The length of the package, in the specified unit | [default to 0M] **Width** | **decimal** | The width of the package, in the specified unit | [default to 0M] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/DisplayScheme.md b/docs/models/DisplayScheme.md index 02a3a037..712e40bc 100644 --- a/docs/models/DisplayScheme.md +++ b/docs/models/DisplayScheme.md @@ -6,5 +6,3 @@ The display format that the label should be shown in. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Error.md b/docs/models/Error.md index 1654a873..41246cdf 100644 --- a/docs/models/Error.md +++ b/docs/models/Error.md @@ -13,5 +13,3 @@ Name | Type | Description | Notes **CarrierId** | **string** | A string that uniquely identifies the carrier that generated the error. | [optional] [readonly] **FieldName** | **string** | The name of the field that caused the error | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ErrorCode.md b/docs/models/ErrorCode.md index 448fbeb3..776071e9 100644 --- a/docs/models/ErrorCode.md +++ b/docs/models/ErrorCode.md @@ -6,5 +6,3 @@ The error code specified for the failed API Call Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ErrorResponseBody.md b/docs/models/ErrorResponseBody.md index 5aa4eb43..f75ba94b 100644 --- a/docs/models/ErrorResponseBody.md +++ b/docs/models/ErrorResponseBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Errors** | [**List<Error>**](Error.md) | The errors associated with the failed API call | [readonly] **RequestId** | **Guid** | A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ErrorSource.md b/docs/models/ErrorSource.md index 960cfc2e..ae4b5511 100644 --- a/docs/models/ErrorSource.md +++ b/docs/models/ErrorSource.md @@ -6,5 +6,3 @@ The source of the error, as indicated by the name this informs us if the API cal Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ErrorType.md b/docs/models/ErrorType.md index 640606f3..931a47f5 100644 --- a/docs/models/ErrorType.md +++ b/docs/models/ErrorType.md @@ -6,5 +6,3 @@ The type of error Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ErrorWithLabelIdResponseBody.md b/docs/models/ErrorWithLabelIdResponseBody.md index c5ac2ef3..9457170c 100644 --- a/docs/models/ErrorWithLabelIdResponseBody.md +++ b/docs/models/ErrorWithLabelIdResponseBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Errors** | [**List<Error>**](Error.md) | The errors associated with the failed API call | [readonly] **RequestId** | **Guid** | A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/EstimateRatesRequestBody.md b/docs/models/EstimateRatesRequestBody.md index e068ab33..8eb9fcfa 100644 --- a/docs/models/EstimateRatesRequestBody.md +++ b/docs/models/EstimateRatesRequestBody.md @@ -19,5 +19,3 @@ Name | Type | Description | Notes **Confirmation** | **DeliveryConfirmation** | | [optional] **Dimensions** | [**Dimensions**](Dimensions.md) | The dimensions of the package | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/FedexAccountSettings.md b/docs/models/FedexAccountSettings.md index 8d1df898..3cf86ed5 100644 --- a/docs/models/FedexAccountSettings.md +++ b/docs/models/FedexAccountSettings.md @@ -13,5 +13,3 @@ Name | Type | Description | Notes **SmartPostEndorsement** | **AncillaryServiceEndorsement** | | [optional] **SmartPostHub** | **SmartPostHub** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/FedexAccountSettingsRequestBody.md b/docs/models/FedexAccountSettingsRequestBody.md index 5b32ee65..27409d65 100644 --- a/docs/models/FedexAccountSettingsRequestBody.md +++ b/docs/models/FedexAccountSettingsRequestBody.md @@ -13,5 +13,3 @@ Name | Type | Description | Notes **SmartPostEndorsement** | **AncillaryServiceEndorsement** | | [optional] **SmartPostHub** | **SmartPostHub** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/FedexPickupType.md b/docs/models/FedexPickupType.md index 73b38180..e1cbe43c 100644 --- a/docs/models/FedexPickupType.md +++ b/docs/models/FedexPickupType.md @@ -6,5 +6,3 @@ Tax identifier type for customs declaration |Pickup Type |Descrip Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/FedexSettingsResponseBody.md b/docs/models/FedexSettingsResponseBody.md index b785a759..ae3bf739 100644 --- a/docs/models/FedexSettingsResponseBody.md +++ b/docs/models/FedexSettingsResponseBody.md @@ -13,5 +13,3 @@ Name | Type | Description | Notes **SmartPostEndorsement** | **AncillaryServiceEndorsement** | | [optional] **SmartPostHub** | **SmartPostHub** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetAccountSettingsImagesResponseBody.md b/docs/models/GetAccountSettingsImagesResponseBody.md index d7732ffd..b36b1ba3 100644 --- a/docs/models/GetAccountSettingsImagesResponseBody.md +++ b/docs/models/GetAccountSettingsImagesResponseBody.md @@ -13,5 +13,3 @@ Name | Type | Description | Notes **ModifiedAt** | **DateTimeOffset** | The date and time that the image was modified in ShipEngine. | [optional] [readonly] **Name** | **string** | A human readable name for the image. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetAccountSettingsResponseBody.md b/docs/models/GetAccountSettingsResponseBody.md index c9656e10..1d85fbbf 100644 --- a/docs/models/GetAccountSettingsResponseBody.md +++ b/docs/models/GetAccountSettingsResponseBody.md @@ -6,5 +6,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DefaultLabelLayout** | **DefaultLabelLayout** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetBatchByExternalIdResponseBody.md b/docs/models/GetBatchByExternalIdResponseBody.md index aa8eff33..eaf60a8b 100644 --- a/docs/models/GetBatchByExternalIdResponseBody.md +++ b/docs/models/GetBatchByExternalIdResponseBody.md @@ -27,5 +27,3 @@ Name | Type | Description | Notes **ExternalBatchId** | **string** | A string that uniquely identifies the external batch | [readonly] **ProcessedAt** | **DateTimeOffset** | The date and time the batch was processed in ShipEngine | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetBatchByIdResponseBody.md b/docs/models/GetBatchByIdResponseBody.md index 67d54d49..86ed34c9 100644 --- a/docs/models/GetBatchByIdResponseBody.md +++ b/docs/models/GetBatchByIdResponseBody.md @@ -27,5 +27,3 @@ Name | Type | Description | Notes **ExternalBatchId** | **string** | A string that uniquely identifies the external batch | [readonly] **ProcessedAt** | **DateTimeOffset** | The date and time the batch was processed in ShipEngine | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetCarrierByIdResponseBody.md b/docs/models/GetCarrierByIdResponseBody.md index b48cab12..077f31cf 100644 --- a/docs/models/GetCarrierByIdResponseBody.md +++ b/docs/models/GetCarrierByIdResponseBody.md @@ -21,5 +21,3 @@ Name | Type | Description | Notes **Services** | [**List<Service>**](Service.md) | A list of services that are offered by the carrier | [optional] [readonly] **SupportsLabelMessages** | **bool** | The carrier supports adding custom label messages to an order. | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetCarrierOptionsResponseBody.md b/docs/models/GetCarrierOptionsResponseBody.md index 99a4c144..056bfcdb 100644 --- a/docs/models/GetCarrierOptionsResponseBody.md +++ b/docs/models/GetCarrierOptionsResponseBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Options** | [**List<CarrierAdvancedOption>**](CarrierAdvancedOption.md) | AN array of carrier options | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetCarrierSettingsResponseBody.md b/docs/models/GetCarrierSettingsResponseBody.md index db8e4c60..09397118 100644 --- a/docs/models/GetCarrierSettingsResponseBody.md +++ b/docs/models/GetCarrierSettingsResponseBody.md @@ -5,5 +5,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetCarriersResponseBody.md b/docs/models/GetCarriersResponseBody.md index c49ca53a..08891970 100644 --- a/docs/models/GetCarriersResponseBody.md +++ b/docs/models/GetCarriersResponseBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Errors** | [**List<Error>**](Error.md) | The errors associated with the failed API call | [readonly] **RequestId** | **Guid** | A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetInsuranceBalanceResponseBody.md b/docs/models/GetInsuranceBalanceResponseBody.md index 290135fe..a54866e3 100644 --- a/docs/models/GetInsuranceBalanceResponseBody.md +++ b/docs/models/GetInsuranceBalanceResponseBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Amount** | **decimal** | The monetary amount, in the specified currency. | **Currency** | **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 | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetLabelByExternalShipmentIdResponseBody.md b/docs/models/GetLabelByExternalShipmentIdResponseBody.md index 8d6a57ab..71950a4b 100644 --- a/docs/models/GetLabelByExternalShipmentIdResponseBody.md +++ b/docs/models/GetLabelByExternalShipmentIdResponseBody.md @@ -45,5 +45,3 @@ Name | Type | Description | Notes **Voided** | **bool** | Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) | [optional] [readonly] **VoidedAt** | **DateTimeOffset** | The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetLabelByIdResponseBody.md b/docs/models/GetLabelByIdResponseBody.md index 1f08c551..4b4fb7ed 100644 --- a/docs/models/GetLabelByIdResponseBody.md +++ b/docs/models/GetLabelByIdResponseBody.md @@ -45,5 +45,3 @@ Name | Type | Description | Notes **Voided** | **bool** | Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) | [optional] [readonly] **VoidedAt** | **DateTimeOffset** | The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetManifestByIdResponseBody.md b/docs/models/GetManifestByIdResponseBody.md index fd2c7b22..aa0c721e 100644 --- a/docs/models/GetManifestByIdResponseBody.md +++ b/docs/models/GetManifestByIdResponseBody.md @@ -16,5 +16,3 @@ Name | Type | Description | Notes **SubmissionId** | **string** | A string that uniquely identifies the submission | [readonly] **WarehouseId** | **string** | A string that uniquely identifies the warehouse | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetPackageTypeByIdResponseBody.md b/docs/models/GetPackageTypeByIdResponseBody.md index 17c6dc0e..a92dad24 100644 --- a/docs/models/GetPackageTypeByIdResponseBody.md +++ b/docs/models/GetPackageTypeByIdResponseBody.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **Dimensions** | [**Dimensions**](Dimensions.md) | The custom dimensions for the package. | [optional] **PackageId** | **string** | A string that uniquely identifies the package. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetPickupByIdResponseBody.md b/docs/models/GetPickupByIdResponseBody.md index ca65d186..17867951 100644 --- a/docs/models/GetPickupByIdResponseBody.md +++ b/docs/models/GetPickupByIdResponseBody.md @@ -19,5 +19,3 @@ Name | Type | Description | Notes **PickupNotes** | **string** | Used by some carriers to give special instructions for a package pickup | [optional] **PickupWindows** | [**List<PickupWindows>**](PickupWindows.md) | An array of available pickup windows. Carriers can return multiple times that they will pickup packages. | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetPickupsResponseBody.md b/docs/models/GetPickupsResponseBody.md index 33b36fff..b7a140f3 100644 --- a/docs/models/GetPickupsResponseBody.md +++ b/docs/models/GetPickupsResponseBody.md @@ -12,5 +12,3 @@ Name | Type | Description | Notes **RequestId** | **Guid** | A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur | **Total** | **long** | The total number of pickups returned | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetRateByIdResponseBody.md b/docs/models/GetRateByIdResponseBody.md index 40d4904f..62e1ea9a 100644 --- a/docs/models/GetRateByIdResponseBody.md +++ b/docs/models/GetRateByIdResponseBody.md @@ -33,5 +33,3 @@ Name | Type | Description | Notes **TaxAmount** | [**MonetaryValue**](MonetaryValue.md) | Tariff and additional taxes associated with an international shipment. | [optional] [readonly] **Zone** | **int** | Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetServicePointByIdResponseBody.md b/docs/models/GetServicePointByIdResponseBody.md index 8ebe9953..cfab0704 100644 --- a/docs/models/GetServicePointByIdResponseBody.md +++ b/docs/models/GetServicePointByIdResponseBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ServicePoint** | [**GetServicePointByIdResponseBodyServicePoint**](GetServicePointByIdResponseBodyServicePoint.md) | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetServicePointByIdResponseBodyServicePoint.md b/docs/models/GetServicePointByIdResponseBodyServicePoint.md index 616d5d2c..0eca8a95 100644 --- a/docs/models/GetServicePointByIdResponseBodyServicePoint.md +++ b/docs/models/GetServicePointByIdResponseBodyServicePoint.md @@ -20,5 +20,3 @@ Name | Type | Description | Notes **StateProvince** | **string** | The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. | [optional] **Type** | **string** | Service point type | [optional] [default to TypeEnum.Pudo] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetServicePointsRequest.md b/docs/models/GetServicePointsRequest.md index 0851ff1d..71b86ff9 100644 --- a/docs/models/GetServicePointsRequest.md +++ b/docs/models/GetServicePointsRequest.md @@ -5,5 +5,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetServicePointsRequestBody.md b/docs/models/GetServicePointsRequestBody.md index 43d5af7a..5c1d4ebf 100644 --- a/docs/models/GetServicePointsRequestBody.md +++ b/docs/models/GetServicePointsRequestBody.md @@ -14,5 +14,3 @@ Name | Type | Description | Notes **Radius** | **int** | Search radius in kilometers | [optional] **Shipment** | [**GetServicePointsRequestBodyShipment**](GetServicePointsRequestBodyShipment.md) | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetServicePointsRequestBodyAddress.md b/docs/models/GetServicePointsRequestBodyAddress.md index deedea62..8abc77eb 100644 --- a/docs/models/GetServicePointsRequestBodyAddress.md +++ b/docs/models/GetServicePointsRequestBodyAddress.md @@ -13,5 +13,3 @@ Name | Type | Description | Notes **PostalCode** | **string** | postal code | [optional] **StateProvince** | **string** | The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetServicePointsRequestBodyProvidersInner.md b/docs/models/GetServicePointsRequestBodyProvidersInner.md index 8cbbf08d..7308c73a 100644 --- a/docs/models/GetServicePointsRequestBodyProvidersInner.md +++ b/docs/models/GetServicePointsRequestBodyProvidersInner.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes **CarrierId** | **string** | Uniquely identifies a carrier connection | [optional] **ServiceCode** | **List<string>** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetServicePointsRequestBodyShipment.md b/docs/models/GetServicePointsRequestBodyShipment.md index f84fdf2d..aeb61488 100644 --- a/docs/models/GetServicePointsRequestBodyShipment.md +++ b/docs/models/GetServicePointsRequestBodyShipment.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Packages** | [**List<GetServicePointsRequestBodyShipmentPackagesInner>**](GetServicePointsRequestBodyShipmentPackagesInner.md) | An array of package dimensions | [optional] **TotalWeight** | [**Weight**](Weight.md) | Shipment total weight | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetServicePointsRequestBodyShipmentPackagesInner.md b/docs/models/GetServicePointsRequestBodyShipmentPackagesInner.md index f98c3049..a475bf2b 100644 --- a/docs/models/GetServicePointsRequestBodyShipmentPackagesInner.md +++ b/docs/models/GetServicePointsRequestBodyShipmentPackagesInner.md @@ -6,5 +6,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Dimensions** | [**Dimensions**](Dimensions.md) | The package dimensions | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetShipmentByExternalIdResponseBody.md b/docs/models/GetShipmentByExternalIdResponseBody.md index ff54e09a..5bd48b6c 100644 --- a/docs/models/GetShipmentByExternalIdResponseBody.md +++ b/docs/models/GetShipmentByExternalIdResponseBody.md @@ -33,5 +33,3 @@ Name | Type | Description | Notes **TaxIdentifiers** | [**List<TaxIdentifier>**](TaxIdentifier.md) | | [optional] **WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetShipmentByIdResponseBody.md b/docs/models/GetShipmentByIdResponseBody.md index 9fde878d..fc9a9720 100644 --- a/docs/models/GetShipmentByIdResponseBody.md +++ b/docs/models/GetShipmentByIdResponseBody.md @@ -33,5 +33,3 @@ Name | Type | Description | Notes **TaxIdentifiers** | [**List<TaxIdentifier>**](TaxIdentifier.md) | | [optional] **WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetTrackingLogFromLabelResponseBody.md b/docs/models/GetTrackingLogFromLabelResponseBody.md index 2bf8bf3b..5c08a11f 100644 --- a/docs/models/GetTrackingLogFromLabelResponseBody.md +++ b/docs/models/GetTrackingLogFromLabelResponseBody.md @@ -22,5 +22,3 @@ Name | Type | Description | Notes **StatusDetailDescription** | **string** | Status detail description | [optional] [readonly] **TrackingUrl** | **string** | Carrier Tracking Url, if available | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetTrackingLogResponseBody.md b/docs/models/GetTrackingLogResponseBody.md index 65edc88a..7f650ff9 100644 --- a/docs/models/GetTrackingLogResponseBody.md +++ b/docs/models/GetTrackingLogResponseBody.md @@ -22,5 +22,3 @@ Name | Type | Description | Notes **StatusDetailCode** | **StatusDetailCode** | | [optional] **StatusDetailDescription** | **string** | Status detail description | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetWarehouseByIdResponseBody.md b/docs/models/GetWarehouseByIdResponseBody.md index d0ee28d3..2b5dab6a 100644 --- a/docs/models/GetWarehouseByIdResponseBody.md +++ b/docs/models/GetWarehouseByIdResponseBody.md @@ -12,5 +12,3 @@ Name | Type | Description | Notes **WarehouseId** | **string** | A string that uniquely identifies the warehouse | [readonly] **IsDefault** | **bool** | Designates which single warehouse is the default on the account | [optional] [default to false] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/GetWebhookByIdResponseBody.md b/docs/models/GetWebhookByIdResponseBody.md index e90468bc..3d868e26 100644 --- a/docs/models/GetWebhookByIdResponseBody.md +++ b/docs/models/GetWebhookByIdResponseBody.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **WebhookId** | **string** | A string that uniquely identifies the webhook | [readonly] **Headers** | [**List<WebhookHeader>**](WebhookHeader.md) | Array of custom webhook headers | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/IdentifierType.md b/docs/models/IdentifierType.md index 6af513b8..fbec44f1 100644 --- a/docs/models/IdentifierType.md +++ b/docs/models/IdentifierType.md @@ -6,5 +6,3 @@ Tax identifier type for customs declaration |Pickup Type | Description |- -- Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ImporterOfRecords.md b/docs/models/ImporterOfRecords.md index b43fe4c6..eaec0557 100644 --- a/docs/models/ImporterOfRecords.md +++ b/docs/models/ImporterOfRecords.md @@ -17,5 +17,3 @@ Name | Type | Description | Notes **Phone** | **string** | The phone number of a contact person at this address. The format of this phone number varies depending on the country. | [optional] **StateProvince** | **string** | The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/InsuranceProvider.md b/docs/models/InsuranceProvider.md index 56f6aa1e..e71ccc37 100644 --- a/docs/models/InsuranceProvider.md +++ b/docs/models/InsuranceProvider.md @@ -6,5 +6,3 @@ The possible insurance provider values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/InternationalShipmentOptions.md b/docs/models/InternationalShipmentOptions.md index 370d474f..dead2ff2 100644 --- a/docs/models/InternationalShipmentOptions.md +++ b/docs/models/InternationalShipmentOptions.md @@ -14,5 +14,3 @@ Name | Type | Description | Notes **InvoiceAdditionalDetails** | [**InvoiceAdditionalDetails**](InvoiceAdditionalDetails.md) | | [optional] **TermsOfTradeCode** | **AllowedIncoterms** | Specifies the supported terms of trade code (incoterms) | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/InvoiceAdditionalDetails.md b/docs/models/InvoiceAdditionalDetails.md index 38e48291..7a3bdb99 100644 --- a/docs/models/InvoiceAdditionalDetails.md +++ b/docs/models/InvoiceAdditionalDetails.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **OtherCharge** | [**MonetaryValue**](MonetaryValue.md) | Other charge for shipment. | [optional] **OtherChargeDescription** | **string** | Description for the other charge (if provided). | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Label.md b/docs/models/Label.md index a2571a55..6d99d562 100644 --- a/docs/models/Label.md +++ b/docs/models/Label.md @@ -45,5 +45,3 @@ Name | Type | Description | Notes **Voided** | **bool** | Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) | [optional] [readonly] **VoidedAt** | **DateTimeOffset** | The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/LabelChargeEvent.md b/docs/models/LabelChargeEvent.md index 22b5a3d7..7e911b4c 100644 --- a/docs/models/LabelChargeEvent.md +++ b/docs/models/LabelChargeEvent.md @@ -6,5 +6,3 @@ Determines when the user's account will be charged for the label. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/LabelDownload.md b/docs/models/LabelDownload.md index c98ab089..0ea59414 100644 --- a/docs/models/LabelDownload.md +++ b/docs/models/LabelDownload.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **Png** | **string** | The URL for the png generated label | [optional] **Zpl** | **string** | The URL for the zpl generated label | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/LabelDownloadType.md b/docs/models/LabelDownloadType.md index 3b7577aa..857bc454 100644 --- a/docs/models/LabelDownloadType.md +++ b/docs/models/LabelDownloadType.md @@ -6,5 +6,3 @@ There are two different ways to [download a label](https://www.shipengine.com/do Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/LabelFormat.md b/docs/models/LabelFormat.md index fbaff6c7..f219e34c 100644 --- a/docs/models/LabelFormat.md +++ b/docs/models/LabelFormat.md @@ -6,5 +6,3 @@ The possible file formats in which shipping labels can be downloaded. We recomm Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/LabelLayout.md b/docs/models/LabelLayout.md index 31b83808..950666bc 100644 --- a/docs/models/LabelLayout.md +++ b/docs/models/LabelLayout.md @@ -6,5 +6,3 @@ The available layouts (sizes) in which shipping labels can be downloaded. The l Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/LabelMessages.md b/docs/models/LabelMessages.md index ae5c0927..23547907 100644 --- a/docs/models/LabelMessages.md +++ b/docs/models/LabelMessages.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **Reference2** | **string** | The second line of the custom label message. Some carriers may prefix this line with something like \"INV\", \"Reference 2\", \"Trx Ref No.\", etc. | **Reference3** | **string** | The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc. | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/LabelPackage.md b/docs/models/LabelPackage.md index a8f70930..6a6256ab 100644 --- a/docs/models/LabelPackage.md +++ b/docs/models/LabelPackage.md @@ -24,5 +24,3 @@ Name | Type | Description | Notes **Sequence** | **int** | Package sequence | [optional] [readonly] **TrackingNumber** | **string** | The tracking number for the package. The format depends on the carrier. | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/LabelPackagesInner.md b/docs/models/LabelPackagesInner.md index e7b301f2..f65eae43 100644 --- a/docs/models/LabelPackagesInner.md +++ b/docs/models/LabelPackagesInner.md @@ -24,5 +24,3 @@ Name | Type | Description | Notes **Sequence** | **int** | Package sequence | [optional] [readonly] **TrackingNumber** | **string** | The tracking number for the package. The format depends on the carrier. | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/LabelRequest.md b/docs/models/LabelRequest.md index 159d20de..51d6645a 100644 --- a/docs/models/LabelRequest.md +++ b/docs/models/LabelRequest.md @@ -18,5 +18,3 @@ Name | Type | Description | Notes **TestLabel** | **bool** | Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. | [optional] [default to false] **ValidateAddress** | **ValidateAddress** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/LabelStatus.md b/docs/models/LabelStatus.md index c816d4d5..73a16d58 100644 --- a/docs/models/LabelStatus.md +++ b/docs/models/LabelStatus.md @@ -6,5 +6,3 @@ The possible statuses that a [shipping label](https://www.shipengine.com/docs/la Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Link.md b/docs/models/Link.md index 4d7eb5a3..1ad9612a 100644 --- a/docs/models/Link.md +++ b/docs/models/Link.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Href** | **string** | The URL of the linked resource, if any | **Type** | **string** | The type of resource, or the type of relationship to the parent resource | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListAccountImagesResponseBody.md b/docs/models/ListAccountImagesResponseBody.md index 2a776edd..5b8a92ae 100644 --- a/docs/models/ListAccountImagesResponseBody.md +++ b/docs/models/ListAccountImagesResponseBody.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **Pages** | **int** | The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero. | **Total** | **int** | The total number of items across all pages of results | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListAccountSettingsBody.md b/docs/models/ListAccountSettingsBody.md index 642b8c28..5dc37b5a 100644 --- a/docs/models/ListAccountSettingsBody.md +++ b/docs/models/ListAccountSettingsBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DefaultLabelLayout** | **DefaultLabelLayout** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListAccountSettingsImagesResponseBody.md b/docs/models/ListAccountSettingsImagesResponseBody.md index cc9583bf..9c54f299 100644 --- a/docs/models/ListAccountSettingsImagesResponseBody.md +++ b/docs/models/ListAccountSettingsImagesResponseBody.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **Pages** | **int** | The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero. | **Total** | **int** | The total number of items across all pages of results | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListBatchErrorsResponseBody.md b/docs/models/ListBatchErrorsResponseBody.md index 3ff20a12..44c65487 100644 --- a/docs/models/ListBatchErrorsResponseBody.md +++ b/docs/models/ListBatchErrorsResponseBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Errors** | [**List<BatchResponseError>**](BatchResponseError.md) | The errors currently associated with the batch | [readonly] **Links** | [**PaginationLink**](PaginationLink.md) | | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListBatchesResponseBody.md b/docs/models/ListBatchesResponseBody.md index 67571b26..80b94f38 100644 --- a/docs/models/ListBatchesResponseBody.md +++ b/docs/models/ListBatchesResponseBody.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **Pages** | **int** | The total number of batch pages the API call returned | [readonly] **Total** | **long** | The total number of batches the API call returned | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListCarrierPackageTypesResponseBody.md b/docs/models/ListCarrierPackageTypesResponseBody.md index 30122a5e..dfcfca35 100644 --- a/docs/models/ListCarrierPackageTypesResponseBody.md +++ b/docs/models/ListCarrierPackageTypesResponseBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Packages** | [**List<PackageType>**](PackageType.md) | An array of custom package types | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListCarrierServicesResponseBody.md b/docs/models/ListCarrierServicesResponseBody.md index 54186e2b..0a4a9235 100644 --- a/docs/models/ListCarrierServicesResponseBody.md +++ b/docs/models/ListCarrierServicesResponseBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Services** | [**List<Service>**](Service.md) | An array of services associated with the carrier | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListCarriersResponseBody.md b/docs/models/ListCarriersResponseBody.md index 6583aba5..72dde86c 100644 --- a/docs/models/ListCarriersResponseBody.md +++ b/docs/models/ListCarriersResponseBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Carriers** | [**List<Carrier>**](Carrier.md) | The carrier response body | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListLabelsResponseBody.md b/docs/models/ListLabelsResponseBody.md index ba7c328b..e9ace808 100644 --- a/docs/models/ListLabelsResponseBody.md +++ b/docs/models/ListLabelsResponseBody.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **Pages** | **int** | The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero. | **Total** | **int** | The total number of items across all pages of results | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListManifestsResponseBody.md b/docs/models/ListManifestsResponseBody.md index d136a3b4..17400b14 100644 --- a/docs/models/ListManifestsResponseBody.md +++ b/docs/models/ListManifestsResponseBody.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **Pages** | **int** | Total number of pages for list manifests results | [readonly] **Total** | **long** | The total number of manifests returned | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListPackageTypesResponseBody.md b/docs/models/ListPackageTypesResponseBody.md index 42e3c097..cfc4f7c0 100644 --- a/docs/models/ListPackageTypesResponseBody.md +++ b/docs/models/ListPackageTypesResponseBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Packages** | [**List<PackageType>**](PackageType.md) | An array of custom package types | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListPickupResponseBody.md b/docs/models/ListPickupResponseBody.md index e89ff9b7..aa9517cb 100644 --- a/docs/models/ListPickupResponseBody.md +++ b/docs/models/ListPickupResponseBody.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **Pickups** | [**List<Pickup>**](Pickup.md) | An array of pickups associated with the user's account. | **Total** | **long** | The total number of pickups returned | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListServicePointsResponseBody.md b/docs/models/ListServicePointsResponseBody.md index 85c2ea68..4bd69b1d 100644 --- a/docs/models/ListServicePointsResponseBody.md +++ b/docs/models/ListServicePointsResponseBody.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **Long** | **double** | The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html | [optional] **ServicePoints** | [**List<ListServicePointsResponseBodyServicePointsInner>**](ListServicePointsResponseBodyServicePointsInner.md) | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListServicePointsResponseBodyServicePointsInner.md b/docs/models/ListServicePointsResponseBodyServicePointsInner.md index 59c37a82..5e92d473 100644 --- a/docs/models/ListServicePointsResponseBodyServicePointsInner.md +++ b/docs/models/ListServicePointsResponseBodyServicePointsInner.md @@ -21,5 +21,3 @@ Name | Type | Description | Notes **StateProvince** | **string** | The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. | [optional] **Type** | **string** | Service point type | [optional] [default to TypeEnum.Pudo] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.md b/docs/models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.md index eb6ed092..e99c6bc2 100644 --- a/docs/models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.md +++ b/docs/models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperation.md @@ -13,5 +13,3 @@ Name | Type | Description | Notes **Tuesday** | [**List<ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner>**](ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md) | | [optional] **Wednesday** | [**List<ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner>**](ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md) | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md b/docs/models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md index 08f61488..2628c341 100644 --- a/docs/models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md +++ b/docs/models/ListServicePointsResponseBodyServicePointsInnerHoursOfOperationMondayInner.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes **Close** | **string** | Closing time | [optional] **Open** | **string** | Opening time | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListShipmentRatesResponseBody.md b/docs/models/ListShipmentRatesResponseBody.md index 547691de..7ee4eb57 100644 --- a/docs/models/ListShipmentRatesResponseBody.md +++ b/docs/models/ListShipmentRatesResponseBody.md @@ -13,5 +13,3 @@ Name | Type | Description | Notes **ShipmentId** | **string** | A string that uniquely identifies the shipment | [readonly] **Status** | **RateResponseStatus** | | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListShipmentsResponseBody.md b/docs/models/ListShipmentsResponseBody.md index 04aa267d..3b7bb5a4 100644 --- a/docs/models/ListShipmentsResponseBody.md +++ b/docs/models/ListShipmentsResponseBody.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **Shipments** | [**List<Shipment>**](Shipment.md) | The list of shipments returned by the api call | [readonly] **Total** | **long** | Total number of shipments returned by the api call | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListTagsResponseBody.md b/docs/models/ListTagsResponseBody.md index 0c53be83..70cf561f 100644 --- a/docs/models/ListTagsResponseBody.md +++ b/docs/models/ListTagsResponseBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Tags** | [**List<Tag>**](Tag.md) | The array of tags returned by the API call | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ListWarehousesResponseBody.md b/docs/models/ListWarehousesResponseBody.md index d48778f7..2f76371c 100644 --- a/docs/models/ListWarehousesResponseBody.md +++ b/docs/models/ListWarehousesResponseBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Warehouses** | [**List<Warehouse>**](Warehouse.md) | The array of warehouses returned by the API call | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Manifest.md b/docs/models/Manifest.md index 28bb2f1b..4cf53de5 100644 --- a/docs/models/Manifest.md +++ b/docs/models/Manifest.md @@ -16,5 +16,3 @@ Name | Type | Description | Notes **SubmissionId** | **string** | A string that uniquely identifies the submission | [optional] [readonly] **WarehouseId** | **string** | A string that uniquely identifies the warehouse | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ManifestDownload.md b/docs/models/ManifestDownload.md index d96f2e0d..32634de2 100644 --- a/docs/models/ManifestDownload.md +++ b/docs/models/ManifestDownload.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Href** | **string** | The URL of the linked resource, if any | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ManifestRequest.md b/docs/models/ManifestRequest.md index 9bc2fe86..5fdefabe 100644 --- a/docs/models/ManifestRequest.md +++ b/docs/models/ManifestRequest.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **ManifestRequestId** | **string** | A string that uniquely identifies a manifest request | [optional] [readonly] **Status** | **ManifestRequestStatus** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ManifestRequestStatus.md b/docs/models/ManifestRequestStatus.md index 72782c83..37ee9580 100644 --- a/docs/models/ManifestRequestStatus.md +++ b/docs/models/ManifestRequestStatus.md @@ -6,5 +6,3 @@ The possible statuses of a manifest request Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Manifests.md b/docs/models/Manifests.md index 4453ee2b..92f4c7b8 100644 --- a/docs/models/Manifests.md +++ b/docs/models/Manifests.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **VarManifests** | [**List<Manifest>**](Manifest.md) | Resulting Manifests | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ManifestsRequests.md b/docs/models/ManifestsRequests.md index 61000aa0..87e4a3d2 100644 --- a/docs/models/ManifestsRequests.md +++ b/docs/models/ManifestsRequests.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ManifestRequests** | [**List<ManifestRequest>**](ManifestRequest.md) | Resulting manifest requests with statuses | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ModifyBatch.md b/docs/models/ModifyBatch.md index ceea43cd..5879d497 100644 --- a/docs/models/ModifyBatch.md +++ b/docs/models/ModifyBatch.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **RateIds** | **List<string>** | Array of Rate IDs to be modifed on the batch | [optional] **ShipmentIds** | **List<string>** | The Shipment Ids to be modified on the batch | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/MonetaryValue.md b/docs/models/MonetaryValue.md index 87eac086..c7530d3b 100644 --- a/docs/models/MonetaryValue.md +++ b/docs/models/MonetaryValue.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Amount** | **decimal** | The monetary amount, in the specified currency. | **Currency** | **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 | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/NonDelivery.md b/docs/models/NonDelivery.md index 4100991b..2f116b82 100644 --- a/docs/models/NonDelivery.md +++ b/docs/models/NonDelivery.md @@ -6,5 +6,3 @@ The possible non delivery values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/OptionalLink.md b/docs/models/OptionalLink.md index d54cb2ea..7fd11d2f 100644 --- a/docs/models/OptionalLink.md +++ b/docs/models/OptionalLink.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Href** | **string** | The URL of the linked resource, if any | [optional] **Type** | **string** | The type of resource, or the type of relationship to the parent resource | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/OrderSourceName.md b/docs/models/OrderSourceName.md index 50f6ee3b..3c7ed8ff 100644 --- a/docs/models/OrderSourceName.md +++ b/docs/models/OrderSourceName.md @@ -6,5 +6,3 @@ The order sources that are supported by ShipEngine Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/OriginType.md b/docs/models/OriginType.md index e5b32544..38694602 100644 --- a/docs/models/OriginType.md +++ b/docs/models/OriginType.md @@ -6,5 +6,3 @@ Indicates if the package will be picked up or dropped off by the carrier Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Package.md b/docs/models/Package.md index 5c0ab329..2589af51 100644 --- a/docs/models/Package.md +++ b/docs/models/Package.md @@ -18,5 +18,3 @@ Name | Type | Description | Notes **ShipmentPackageId** | **string** | A string that uniquely identifies this shipment package | [optional] [readonly] **TrackingNumber** | **string** | The tracking number for the package. The format depends on the carrier. | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/PackageContents.md b/docs/models/PackageContents.md index 22912757..3185a86f 100644 --- a/docs/models/PackageContents.md +++ b/docs/models/PackageContents.md @@ -6,5 +6,3 @@ The possible package contents values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/PackageType.md b/docs/models/PackageType.md index 8cb76c01..da261e51 100644 --- a/docs/models/PackageType.md +++ b/docs/models/PackageType.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **Dimensions** | [**Dimensions**](Dimensions.md) | The custom dimensions for the package. | [optional] **PackageId** | **string** | A string that uniquely identifies the package. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/PackagingGroup.md b/docs/models/PackagingGroup.md index 107c7f7f..c8359796 100644 --- a/docs/models/PackagingGroup.md +++ b/docs/models/PackagingGroup.md @@ -5,5 +5,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/PackagingInstructionSection.md b/docs/models/PackagingInstructionSection.md index a53af93b..c1470a12 100644 --- a/docs/models/PackagingInstructionSection.md +++ b/docs/models/PackagingInstructionSection.md @@ -5,5 +5,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/PagedListResponseBody.md b/docs/models/PagedListResponseBody.md index 5fd40054..99fb204c 100644 --- a/docs/models/PagedListResponseBody.md +++ b/docs/models/PagedListResponseBody.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **Pages** | **int** | The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero. | **Total** | **int** | The total number of items across all pages of results | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/PaginationLink.md b/docs/models/PaginationLink.md index 9c561d72..8cfd75b0 100644 --- a/docs/models/PaginationLink.md +++ b/docs/models/PaginationLink.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **Next** | [**OptionalLink**](OptionalLink.md) | The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`. | **Prev** | [**OptionalLink**](OptionalLink.md) | The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater. | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/PaperlessDownload.md b/docs/models/PaperlessDownload.md index 999c235c..d0591bb7 100644 --- a/docs/models/PaperlessDownload.md +++ b/docs/models/PaperlessDownload.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **Href** | **string** | The URL of the linked resource, if any | [optional] **Instructions** | **string** | The instructions for the paperless download. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ParseAddressRequestBody.md b/docs/models/ParseAddressRequestBody.md index 93ca4513..8350d981 100644 --- a/docs/models/ParseAddressRequestBody.md +++ b/docs/models/ParseAddressRequestBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Text** | **string** | The unstructured text that contains address-related entities | **Address** | [**PartialAddress**](PartialAddress.md) | You can optionally provide any already-known address 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. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ParseAddressResponseBody.md b/docs/models/ParseAddressResponseBody.md index d0ad89ea..31493d65 100644 --- a/docs/models/ParseAddressResponseBody.md +++ b/docs/models/ParseAddressResponseBody.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **Entities** | [**List<RecognizedEntity>**](RecognizedEntity.md) | All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, or an address line. Each entity includes the original text and the parsed value. | **Score** | **double** | A confidence score between zero and one that indicates how certain the API is that it understood the text. | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ParseShipmentRequestBody.md b/docs/models/ParseShipmentRequestBody.md index d68be319..3d0d9689 100644 --- a/docs/models/ParseShipmentRequestBody.md +++ b/docs/models/ParseShipmentRequestBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Text** | **string** | The unstructured text that contains shipping-related entities | **Shipment** | [**PartialShipment**](PartialShipment.md) | You can optionally provide a `shipment` object 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. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ParseShipmentResponseBody.md b/docs/models/ParseShipmentResponseBody.md index 130af7a3..fc378ad4 100644 --- a/docs/models/ParseShipmentResponseBody.md +++ b/docs/models/ParseShipmentResponseBody.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **Score** | **double** | A confidence score between zero and one that indicates how certain the API is that it understood the text. | **Shipment** | [**PartialShipment**](PartialShipment.md) | The parsed shipment. This shipment may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > **Note:** The shipment-recognition API does not currently perform any validation of the parsed addresses, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the addresses are correct. | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/PartialAddress.md b/docs/models/PartialAddress.md index 005f15f4..68f34df3 100644 --- a/docs/models/PartialAddress.md +++ b/docs/models/PartialAddress.md @@ -18,5 +18,3 @@ Name | Type | Description | Notes **PostalCode** | **string** | postal code | [optional] **StateProvince** | **string** | The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/PartialShipment.md b/docs/models/PartialShipment.md index 259329db..8b9ead28 100644 --- a/docs/models/PartialShipment.md +++ b/docs/models/PartialShipment.md @@ -33,5 +33,3 @@ Name | Type | Description | Notes **TotalWeight** | [**Weight**](Weight.md) | The combined weight of all packages in the shipment | [optional] [readonly] **WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/PartialShippingAddress.md b/docs/models/PartialShippingAddress.md index 6211b0e8..dee29483 100644 --- a/docs/models/PartialShippingAddress.md +++ b/docs/models/PartialShippingAddress.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Instructions** | **string** | Additional text about how to handle the shipment at this address. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/PartialShippingAddressTo.md b/docs/models/PartialShippingAddressTo.md index cd79e267..bd78369c 100644 --- a/docs/models/PartialShippingAddressTo.md +++ b/docs/models/PartialShippingAddressTo.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Geolocation** | [**List<PartialShippingAddressToGeolocationInner>**](PartialShippingAddressToGeolocationInner.md) | | [optional] **Instructions** | **string** | Additional text about how to handle the shipment at this address. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/PartialShippingAddressToGeolocationInner.md b/docs/models/PartialShippingAddressToGeolocationInner.md index c9b628f0..71f2b8bd 100644 --- a/docs/models/PartialShippingAddressToGeolocationInner.md +++ b/docs/models/PartialShippingAddressToGeolocationInner.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes **Type** | **string** | Enum of available type of geolocation items: - 'what3words' functionality allows to specify a location by providing 3 words that have been assign to the specific location see [link](https://what3words.com/business) for more details. | [optional] **Value** | **string** | value of the geolocation item | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/PaymentAmount.md b/docs/models/PaymentAmount.md index 74e5e482..ee9fde8d 100644 --- a/docs/models/PaymentAmount.md +++ b/docs/models/PaymentAmount.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes **Amount** | **decimal** | | [optional] **Currency** | **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] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Pickup.md b/docs/models/Pickup.md index 99f3ec54..23d8d827 100644 --- a/docs/models/Pickup.md +++ b/docs/models/Pickup.md @@ -18,5 +18,3 @@ Name | Type | Description | Notes **PickupWindows** | [**List<PickupWindows>**](PickupWindows.md) | An array of available pickup windows. Carriers can return multiple times that they will pickup packages. | [optional] [readonly] **WarehouseId** | **string** | The warehouse_id associated with the pickup | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/PickupResponseBody.md b/docs/models/PickupResponseBody.md index ccc561e8..3dc97a86 100644 --- a/docs/models/PickupResponseBody.md +++ b/docs/models/PickupResponseBody.md @@ -18,5 +18,3 @@ Name | Type | Description | Notes **PickupNotes** | **string** | Used by some carriers to give special instructions for a package pickup | [optional] **PickupWindows** | [**List<PickupWindows>**](PickupWindows.md) | An array of available pickup windows. Carriers can return multiple times that they will pickup packages. | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/PickupWindow.md b/docs/models/PickupWindow.md index 49e56e9e..10d86c5f 100644 --- a/docs/models/PickupWindow.md +++ b/docs/models/PickupWindow.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **EndAt** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. | **StartAt** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/PickupWindows.md b/docs/models/PickupWindows.md index 7b768b16..35f0bf0d 100644 --- a/docs/models/PickupWindows.md +++ b/docs/models/PickupWindows.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes **EndAt** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. | [optional] **StartAt** | **DateTimeOffset** | An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ProcessBatchRequestBody.md b/docs/models/ProcessBatchRequestBody.md index 4d16250f..27a29ea9 100644 --- a/docs/models/ProcessBatchRequestBody.md +++ b/docs/models/ProcessBatchRequestBody.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **LabelLayout** | **LabelLayout** | | [optional] [default to "4x6"] **ShipDate** | **DateTimeOffset** | The Ship date the batch is being processed for | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Products.md b/docs/models/Products.md index 0c578aba..c3b7bd89 100644 --- a/docs/models/Products.md +++ b/docs/models/Products.md @@ -20,5 +20,3 @@ Name | Type | Description | Notes **VatRate** | **decimal** | VAT rate applicable to the item | [optional] **Weight** | [**Weight**](Weight.md) | The item weight | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/PurchaseLabelWithoutShipment.md b/docs/models/PurchaseLabelWithoutShipment.md index 83b5b2d0..92eabe0a 100644 --- a/docs/models/PurchaseLabelWithoutShipment.md +++ b/docs/models/PurchaseLabelWithoutShipment.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **LabelLayout** | **LabelLayout** | | [optional] **ValidateAddress** | **ValidateAddress** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Rate.md b/docs/models/Rate.md index f176ac33..25d07237 100644 --- a/docs/models/Rate.md +++ b/docs/models/Rate.md @@ -33,5 +33,3 @@ Name | Type | Description | Notes **TaxAmount** | [**MonetaryValue**](MonetaryValue.md) | Tariff and additional taxes associated with an international shipment. | [optional] [readonly] **Zone** | **int** | Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RateDetail.md b/docs/models/RateDetail.md index 9e592aa9..61501693 100644 --- a/docs/models/RateDetail.md +++ b/docs/models/RateDetail.md @@ -13,5 +13,3 @@ Name | Type | Description | Notes **RateDetailAttributes** | [**RateDetailAttributes**](RateDetailAttributes.md) | If applicable, contains additional data about a rate detail of a specific type, e.g. VAT | [optional] **RateDetailType** | **RateDetailType** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RateDetailAttributes.md b/docs/models/RateDetailAttributes.md index 11d20660..74cfe9ab 100644 --- a/docs/models/RateDetailAttributes.md +++ b/docs/models/RateDetailAttributes.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **TaxPercentage** | **decimal** | Tax percentage, e.g. 20 for 20%, added to the shipping cost | [optional] **TaxType** | **TaxType** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RateDetailType.md b/docs/models/RateDetailType.md index a3de1ad9..d64074ef 100644 --- a/docs/models/RateDetailType.md +++ b/docs/models/RateDetailType.md @@ -6,5 +6,3 @@ The possible rate detail type values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RateEstimate.md b/docs/models/RateEstimate.md index 2f39b0d2..158f3f38 100644 --- a/docs/models/RateEstimate.md +++ b/docs/models/RateEstimate.md @@ -30,5 +30,3 @@ Name | Type | Description | Notes **TaxAmount** | [**MonetaryValue**](MonetaryValue.md) | Tariff and additional taxes associated with an international shipment. | [optional] [readonly] **Zone** | **int** | Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of custom zones that vary depending upon the ship_to and ship_from location | [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RateEstimateByCarrierId.md b/docs/models/RateEstimateByCarrierId.md index 1b11d104..4cb80320 100644 --- a/docs/models/RateEstimateByCarrierId.md +++ b/docs/models/RateEstimateByCarrierId.md @@ -6,5 +6,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **CarrierId** | **string** | A string that uniquely identifies the carrier | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RateEstimateByCarrierIds.md b/docs/models/RateEstimateByCarrierIds.md index 7e345d17..43e670c1 100644 --- a/docs/models/RateEstimateByCarrierIds.md +++ b/docs/models/RateEstimateByCarrierIds.md @@ -6,5 +6,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **CarrierIds** | **List<string>** | Array of Carrier Ids | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RateEstimateOptions.md b/docs/models/RateEstimateOptions.md index 11efabfd..85a5d7a6 100644 --- a/docs/models/RateEstimateOptions.md +++ b/docs/models/RateEstimateOptions.md @@ -18,5 +18,3 @@ Name | Type | Description | Notes **ToStateProvince** | **string** | To state province | [optional] **Weight** | [**Weight**](Weight.md) | The weight of the package | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RateRequestBody.md b/docs/models/RateRequestBody.md index ab1c00dc..0bc7eb3e 100644 --- a/docs/models/RateRequestBody.md +++ b/docs/models/RateRequestBody.md @@ -12,5 +12,3 @@ Name | Type | Description | Notes **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] **ServiceCodes** | **List<string>** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RateRequestByShipmentIds.md b/docs/models/RateRequestByShipmentIds.md index eb985e0b..82c0a333 100644 --- a/docs/models/RateRequestByShipmentIds.md +++ b/docs/models/RateRequestByShipmentIds.md @@ -6,5 +6,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ShipmentIds** | **List<string>** | The array of shipment IDs | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RateRequestByShipments.md b/docs/models/RateRequestByShipments.md index fb7986f5..2bb7d6e5 100644 --- a/docs/models/RateRequestByShipments.md +++ b/docs/models/RateRequestByShipments.md @@ -6,5 +6,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Shipments** | [**List<AddressValidatingShipment>**](AddressValidatingShipment.md) | The array of shipments to get bulk rate estimates for | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RateRequestOptions.md b/docs/models/RateRequestOptions.md index 561b7427..4384fbb2 100644 --- a/docs/models/RateRequestOptions.md +++ b/docs/models/RateRequestOptions.md @@ -6,5 +6,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **RateOptions** | [**RateRequestBody**](RateRequestBody.md) | The rate options | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RateRequestRateOptions.md b/docs/models/RateRequestRateOptions.md index 10cb755d..d9386cff 100644 --- a/docs/models/RateRequestRateOptions.md +++ b/docs/models/RateRequestRateOptions.md @@ -6,5 +6,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **RateOptions** | [**RateRequestBody**](RateRequestBody.md) | The rate options | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RateResponse.md b/docs/models/RateResponse.md index 3221997f..29a5a5da 100644 --- a/docs/models/RateResponse.md +++ b/docs/models/RateResponse.md @@ -6,5 +6,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **VarRateResponse** | [**RatesInformation**](RatesInformation.md) | The rates response | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RateResponseStatus.md b/docs/models/RateResponseStatus.md index 2cf1a07b..b7d5c723 100644 --- a/docs/models/RateResponseStatus.md +++ b/docs/models/RateResponseStatus.md @@ -6,5 +6,3 @@ The possible rate response status values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RateShipmentRequest.md b/docs/models/RateShipmentRequest.md index 06c217f5..f20663da 100644 --- a/docs/models/RateShipmentRequest.md +++ b/docs/models/RateShipmentRequest.md @@ -6,5 +6,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Shipment** | [**AddressValidatingShipment**](AddressValidatingShipment.md) | The shipment object | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RateType.md b/docs/models/RateType.md index 1c63a1ed..185f0e51 100644 --- a/docs/models/RateType.md +++ b/docs/models/RateType.md @@ -6,5 +6,3 @@ The possible rate type values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RatesInformation.md b/docs/models/RatesInformation.md index 7327188b..5765c0ae 100644 --- a/docs/models/RatesInformation.md +++ b/docs/models/RatesInformation.md @@ -13,5 +13,3 @@ Name | Type | Description | Notes **ShipmentId** | **string** | A string that uniquely identifies the shipment | [optional] [readonly] **Status** | **RateResponseStatus** | | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ReasonCode.md b/docs/models/ReasonCode.md index 777a595a..58fc1611 100644 --- a/docs/models/ReasonCode.md +++ b/docs/models/ReasonCode.md @@ -6,5 +6,3 @@ The possible normalized reasons a label void request may not have been approved Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RecognizedEntity.md b/docs/models/RecognizedEntity.md index fe102ec1..da8b4c9b 100644 --- a/docs/models/RecognizedEntity.md +++ b/docs/models/RecognizedEntity.md @@ -12,5 +12,3 @@ Name | Type | Description | Notes **Type** | **string** | The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.) | **Result** | **Dictionary<string, Object>** | The normalized value of the entity. Most entity results have a `value` field, which is the normalized value of the entity. For example, if the substring \"john doe\" was recognized as a \"person\" entity, then the value might be normalized to have proper capitalization (e.g. \"John Doe\"). Or if the substring \"ft worth\" was recognized as a \"city\" entity, then the value might be normalized to \"Fort Worth\". Some entities have other information in addition to, or instead of a `value`. For example, a \"dimensions\" entity will have separate fields for `length`, `width`, `height`, and `unit`. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Redirect.md b/docs/models/Redirect.md index 623a8aa9..0b2dfcb2 100644 --- a/docs/models/Redirect.md +++ b/docs/models/Redirect.md @@ -6,5 +6,3 @@ The resource to return a redirect URL to. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RegulationLevel.md b/docs/models/RegulationLevel.md index 63c8aaa7..a3badf09 100644 --- a/docs/models/RegulationLevel.md +++ b/docs/models/RegulationLevel.md @@ -5,5 +5,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/RemoveFromBatchRequestBody.md b/docs/models/RemoveFromBatchRequestBody.md index 611793c6..a65c55c8 100644 --- a/docs/models/RemoveFromBatchRequestBody.md +++ b/docs/models/RemoveFromBatchRequestBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **RateIds** | **List<string>** | Array of Rate IDs to be modifed on the batch | [optional] **ShipmentIds** | **List<string>** | The Shipment Ids to be modified on the batch | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ResponseMessage.md b/docs/models/ResponseMessage.md index e44fc15d..609ee3fb 100644 --- a/docs/models/ResponseMessage.md +++ b/docs/models/ResponseMessage.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **Type** | **AddressValidationMessageType** | | [readonly] **DetailCode** | **AddressValidationDetailCode** | | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/SchedulePickupRequestBody.md b/docs/models/SchedulePickupRequestBody.md index 785485d9..a026ef2b 100644 --- a/docs/models/SchedulePickupRequestBody.md +++ b/docs/models/SchedulePickupRequestBody.md @@ -18,5 +18,3 @@ Name | Type | Description | Notes **PickupWindows** | [**List<PickupWindows>**](PickupWindows.md) | An array of available pickup windows. Carriers can return multiple times that they will pickup packages. | [optional] [readonly] **WarehouseId** | **string** | The warehouse_id associated with the pickup | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/SchedulePickupResponseBody.md b/docs/models/SchedulePickupResponseBody.md index 4f8f0d2e..29a57e24 100644 --- a/docs/models/SchedulePickupResponseBody.md +++ b/docs/models/SchedulePickupResponseBody.md @@ -19,5 +19,3 @@ Name | Type | Description | Notes **PickupWindows** | [**List<PickupWindows>**](PickupWindows.md) | An array of available pickup windows. Carriers can return multiple times that they will pickup packages. | [optional] [readonly] **WarehouseId** | **string** | The warehouse_id associated with the pickup | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Service.md b/docs/models/Service.md index 5c8345f7..d370da05 100644 --- a/docs/models/Service.md +++ b/docs/models/Service.md @@ -13,5 +13,3 @@ Name | Type | Description | Notes **Name** | **string** | User friendly service name | [optional] [readonly] **ServiceCode** | **string** | service code | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Shipment.md b/docs/models/Shipment.md index c266d6ff..593cb1b3 100644 --- a/docs/models/Shipment.md +++ b/docs/models/Shipment.md @@ -33,5 +33,3 @@ Name | Type | Description | Notes **TaxIdentifiers** | [**List<TaxIdentifier>**](TaxIdentifier.md) | | [optional] **WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ShipmentIdRequest.md b/docs/models/ShipmentIdRequest.md index c653f77c..a398f565 100644 --- a/docs/models/ShipmentIdRequest.md +++ b/docs/models/ShipmentIdRequest.md @@ -6,5 +6,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ShipmentId** | **string** | A string that uniquely identifies the shipment | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ShipmentItem.md b/docs/models/ShipmentItem.md index 153bf554..76295713 100644 --- a/docs/models/ShipmentItem.md +++ b/docs/models/ShipmentItem.md @@ -15,5 +15,3 @@ Name | Type | Description | Notes **SalesOrderItemId** | **string** | sales order item id | [optional] **Sku** | **string** | Item Stock Keeping Unit | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ShipmentRequest.md b/docs/models/ShipmentRequest.md index 2fea4dd0..b71e9a10 100644 --- a/docs/models/ShipmentRequest.md +++ b/docs/models/ShipmentRequest.md @@ -27,5 +27,3 @@ Name | Type | Description | Notes **TaxIdentifiers** | [**List<TaxIdentifier>**](TaxIdentifier.md) | | [optional] **WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ShipmentStatus.md b/docs/models/ShipmentStatus.md index a18e7c3c..2ebe21a5 100644 --- a/docs/models/ShipmentStatus.md +++ b/docs/models/ShipmentStatus.md @@ -6,5 +6,3 @@ The possible shipment status values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ShipmentsSortBy.md b/docs/models/ShipmentsSortBy.md index 412a132e..66ceea76 100644 --- a/docs/models/ShipmentsSortBy.md +++ b/docs/models/ShipmentsSortBy.md @@ -6,5 +6,3 @@ The possible shipments sort by values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ShippingAddress.md b/docs/models/ShippingAddress.md index 381edf4a..e6bbad3f 100644 --- a/docs/models/ShippingAddress.md +++ b/docs/models/ShippingAddress.md @@ -18,5 +18,3 @@ Name | Type | Description | Notes **Instructions** | **string** | Additional text about how to handle the shipment at this address. | [optional] **Phone** | **string** | The phone number of a contact person at this address. The format of this phone number varies depending on the country. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ShippingAddressFrom.md b/docs/models/ShippingAddressFrom.md index 4d554f40..08d0f4fa 100644 --- a/docs/models/ShippingAddressFrom.md +++ b/docs/models/ShippingAddressFrom.md @@ -18,5 +18,3 @@ Name | Type | Description | Notes **Email** | **string** | Email for the address owner. | [optional] **Instructions** | **string** | Additional text about how to handle the shipment at this address. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ShippingAddressTo.md b/docs/models/ShippingAddressTo.md index 55ff3b0a..82ebdb1b 100644 --- a/docs/models/ShippingAddressTo.md +++ b/docs/models/ShippingAddressTo.md @@ -19,5 +19,3 @@ Name | Type | Description | Notes **Instructions** | **string** | Additional text about how to handle the shipment at this address. | [optional] **Phone** | **string** | The phone number of a contact person at this address. The format of this phone number varies depending on the country. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/SmartPostHub.md b/docs/models/SmartPostHub.md index 405c4c25..2c8e6bb3 100644 --- a/docs/models/SmartPostHub.md +++ b/docs/models/SmartPostHub.md @@ -6,5 +6,3 @@ The possible smart post hub values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/SortDir.md b/docs/models/SortDir.md index 40799365..36b9f634 100644 --- a/docs/models/SortDir.md +++ b/docs/models/SortDir.md @@ -6,5 +6,3 @@ Controls the sort order of queries |Value |Description |:- -- -- -- --|:- - Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/StatusCode.md b/docs/models/StatusCode.md index fddc991b..845e3188 100644 --- a/docs/models/StatusCode.md +++ b/docs/models/StatusCode.md @@ -6,5 +6,3 @@ The tracking status codes |Value |Description |:- -- -- -- -- |:- -- -- Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/StatusDetailCode.md b/docs/models/StatusDetailCode.md index 095e3a78..41afedc5 100644 --- a/docs/models/StatusDetailCode.md +++ b/docs/models/StatusDetailCode.md @@ -6,5 +6,3 @@ The tracking status detail codes |Value |Description |:- -- -- -- -- |:- Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Tag.md b/docs/models/Tag.md index 20bc0d3b..34cb6bed 100644 --- a/docs/models/Tag.md +++ b/docs/models/Tag.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | The tag name. | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/TagShipmentResponseBody.md b/docs/models/TagShipmentResponseBody.md index b3204152..f40aa2d7 100644 --- a/docs/models/TagShipmentResponseBody.md +++ b/docs/models/TagShipmentResponseBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Tags** | **List<string>** | | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/TaxIdentifier.md b/docs/models/TaxIdentifier.md index c87ec78f..c9ee2f59 100644 --- a/docs/models/TaxIdentifier.md +++ b/docs/models/TaxIdentifier.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **TaxableEntityType** | **TaxableEntityType** | | **Value** | **string** | The value of the identifier | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/TaxType.md b/docs/models/TaxType.md index 780fe4ae..c7dd6389 100644 --- a/docs/models/TaxType.md +++ b/docs/models/TaxType.md @@ -6,5 +6,3 @@ Type of a tax added to shipping cost Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/TaxableEntityType.md b/docs/models/TaxableEntityType.md index 2dc94941..ef14cbc7 100644 --- a/docs/models/TaxableEntityType.md +++ b/docs/models/TaxableEntityType.md @@ -6,5 +6,3 @@ The taxable entity type for this tax item. Valid values include the following | Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/TokensGetEphemeralTokenResponseBodyYaml.md b/docs/models/TokensGetEphemeralTokenResponseBodyYaml.md index ef1b0672..32d4e6b1 100644 --- a/docs/models/TokensGetEphemeralTokenResponseBodyYaml.md +++ b/docs/models/TokensGetEphemeralTokenResponseBodyYaml.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes **RedirectUrl** | **string** | The redirect url formatted with the requested token. | [optional] **Token** | **string** | The requested token that expires in 10 seconds. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/TrackEvent.md b/docs/models/TrackEvent.md index 8d3df63f..7c08616b 100644 --- a/docs/models/TrackEvent.md +++ b/docs/models/TrackEvent.md @@ -25,5 +25,3 @@ Name | Type | Description | Notes **StatusDetailCode** | **StatusDetailCode** | | [optional] **StatusDetailDescription** | **string** | Event Status Detail Description | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/TrackingInformation.md b/docs/models/TrackingInformation.md index 8378ed63..e7878b70 100644 --- a/docs/models/TrackingInformation.md +++ b/docs/models/TrackingInformation.md @@ -22,5 +22,3 @@ Name | Type | Description | Notes **TrackingNumber** | **string** | A tracking number for a package. The format depends on the carrier. | [optional] **TrackingUrl** | **string** | Carrier Tracking Url, if available | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/TrackingStatus.md b/docs/models/TrackingStatus.md index ef841298..dffbc992 100644 --- a/docs/models/TrackingStatus.md +++ b/docs/models/TrackingStatus.md @@ -6,5 +6,3 @@ The different statuses that can apply to a shipment. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/TransportMean.md b/docs/models/TransportMean.md index f776b5e6..ce10ff96 100644 --- a/docs/models/TransportMean.md +++ b/docs/models/TransportMean.md @@ -5,5 +5,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpdateAccountSettingsImageRequestBody.md b/docs/models/UpdateAccountSettingsImageRequestBody.md index e8b801ca..66f236b7 100644 --- a/docs/models/UpdateAccountSettingsImageRequestBody.md +++ b/docs/models/UpdateAccountSettingsImageRequestBody.md @@ -13,5 +13,3 @@ Name | Type | Description | Notes **ModifiedAt** | **DateTimeOffset** | The date and time that the image was modified in ShipEngine. | [optional] [readonly] **Name** | **string** | A human readable name for the image. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpdateAmazonBuyShippingRequestBody.md b/docs/models/UpdateAmazonBuyShippingRequestBody.md index 5b6868b6..030f90c1 100644 --- a/docs/models/UpdateAmazonBuyShippingRequestBody.md +++ b/docs/models/UpdateAmazonBuyShippingRequestBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Email** | **string** | Email | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpdateCarrierSettingsRequestBody.md b/docs/models/UpdateCarrierSettingsRequestBody.md index e9c8e81c..bf77f7a2 100644 --- a/docs/models/UpdateCarrierSettingsRequestBody.md +++ b/docs/models/UpdateCarrierSettingsRequestBody.md @@ -5,5 +5,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpdateDhlExpressSettingsRequestBody.md b/docs/models/UpdateDhlExpressSettingsRequestBody.md index 5e1a8999..32b75259 100644 --- a/docs/models/UpdateDhlExpressSettingsRequestBody.md +++ b/docs/models/UpdateDhlExpressSettingsRequestBody.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **Nickname** | **string** | Account nickname | [optional] **ShouldHideAccountNumberOnArchiveDoc** | **bool** | Indicates if the account number should be hidden on the archive documentation | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpdateFedexSettingsRequestBody.md b/docs/models/UpdateFedexSettingsRequestBody.md index 3b485263..3e03465e 100644 --- a/docs/models/UpdateFedexSettingsRequestBody.md +++ b/docs/models/UpdateFedexSettingsRequestBody.md @@ -13,5 +13,3 @@ Name | Type | Description | Notes **SmartPostEndorsement** | **AncillaryServiceEndorsement** | | [optional] **SmartPostHub** | **SmartPostHub** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpdateNewgisticsSettingsRequestBody.md b/docs/models/UpdateNewgisticsSettingsRequestBody.md index 80dfc573..ea73176c 100644 --- a/docs/models/UpdateNewgisticsSettingsRequestBody.md +++ b/docs/models/UpdateNewgisticsSettingsRequestBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **IncludeBarcodeWithOrderNumber** | **bool** | | [optional] **ReceiveEmailOnManifestProcessing** | **bool** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpdatePackageTypeRequestBody.md b/docs/models/UpdatePackageTypeRequestBody.md index 37a795f3..e8023bf3 100644 --- a/docs/models/UpdatePackageTypeRequestBody.md +++ b/docs/models/UpdatePackageTypeRequestBody.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **Dimensions** | [**Dimensions**](Dimensions.md) | The custom dimensions for the package. | [optional] **PackageId** | **string** | A string that uniquely identifies the package. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpdateShipmentFields.md b/docs/models/UpdateShipmentFields.md index f8930a07..e651926a 100644 --- a/docs/models/UpdateShipmentFields.md +++ b/docs/models/UpdateShipmentFields.md @@ -6,5 +6,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ValidateAddress** | **ValidateAddress** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpdateShipmentRequestBody.md b/docs/models/UpdateShipmentRequestBody.md index ac4dbcd3..fc8645a9 100644 --- a/docs/models/UpdateShipmentRequestBody.md +++ b/docs/models/UpdateShipmentRequestBody.md @@ -34,5 +34,3 @@ Name | Type | Description | Notes **ValidateAddress** | **ValidateAddress** | | [optional] **WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpdateShipmentResponseBody.md b/docs/models/UpdateShipmentResponseBody.md index 8d3883f6..048d8fdb 100644 --- a/docs/models/UpdateShipmentResponseBody.md +++ b/docs/models/UpdateShipmentResponseBody.md @@ -35,5 +35,3 @@ Name | Type | Description | Notes **TaxIdentifiers** | [**List<TaxIdentifier>**](TaxIdentifier.md) | | [optional] **WarehouseId** | **string** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpdateShipmentsTags.md b/docs/models/UpdateShipmentsTags.md index 8f232098..20cadb09 100644 --- a/docs/models/UpdateShipmentsTags.md +++ b/docs/models/UpdateShipmentsTags.md @@ -6,5 +6,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ShipmentsTags** | [**List<UpdateShipmentsTagsShipmentsTagsInner>**](UpdateShipmentsTagsShipmentsTagsInner.md) | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpdateShipmentsTagsRequestBody.md b/docs/models/UpdateShipmentsTagsRequestBody.md index a52a00d0..9079b5c8 100644 --- a/docs/models/UpdateShipmentsTagsRequestBody.md +++ b/docs/models/UpdateShipmentsTagsRequestBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ShipmentsTags** | [**List<UpdateShipmentsTagsShipmentsTagsInner>**](UpdateShipmentsTagsShipmentsTagsInner.md) | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpdateShipmentsTagsShipmentsTagsInner.md b/docs/models/UpdateShipmentsTagsShipmentsTagsInner.md index 719737f2..372827f8 100644 --- a/docs/models/UpdateShipmentsTagsShipmentsTagsInner.md +++ b/docs/models/UpdateShipmentsTagsShipmentsTagsInner.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes **ShipmentId** | **string** | | [optional] **Tags** | **List<string>** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpdateUpsSettingsRequestBody.md b/docs/models/UpdateUpsSettingsRequestBody.md index 75628d46..92071dfb 100644 --- a/docs/models/UpdateUpsSettingsRequestBody.md +++ b/docs/models/UpdateUpsSettingsRequestBody.md @@ -18,5 +18,3 @@ Name | Type | Description | Notes **UseNegotiatedRates** | **bool** | The use negotiated rates | [optional] **UseOrderNumberOnMailInnovationsLabels** | **bool** | The use order number on mail innovations labels | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpdateWarehouseRequestBody.md b/docs/models/UpdateWarehouseRequestBody.md index 2dd2e121..8ba47eeb 100644 --- a/docs/models/UpdateWarehouseRequestBody.md +++ b/docs/models/UpdateWarehouseRequestBody.md @@ -12,5 +12,3 @@ Name | Type | Description | Notes **ReturnAddress** | [**Address**](Address.md) | The return address associated with the warehouse | [optional] **WarehouseId** | **string** | A string that uniquely identifies the warehouse | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpdateWarehouseSettingsRequestBody.md b/docs/models/UpdateWarehouseSettingsRequestBody.md index e860bfe4..257c4946 100644 --- a/docs/models/UpdateWarehouseSettingsRequestBody.md +++ b/docs/models/UpdateWarehouseSettingsRequestBody.md @@ -7,5 +7,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **IsDefault** | **bool** | The default property on the warehouse. | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpdateWebhookRequestBody.md b/docs/models/UpdateWebhookRequestBody.md index c0923c0c..ee351936 100644 --- a/docs/models/UpdateWebhookRequestBody.md +++ b/docs/models/UpdateWebhookRequestBody.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Headers** | [**List<WebhookHeader>**](WebhookHeader.md) | Array of custom webhook headers | [optional] **Url** | **string** | The url that the wehbook sends the request | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpsAccountSettings.md b/docs/models/UpsAccountSettings.md index 96d03167..1e57f3e9 100644 --- a/docs/models/UpsAccountSettings.md +++ b/docs/models/UpsAccountSettings.md @@ -18,5 +18,3 @@ Name | Type | Description | Notes **UseNegotiatedRates** | **bool** | The use negotiated rates | [optional] **UseOrderNumberOnMailInnovationsLabels** | **bool** | The use order number on mail innovations labels | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpsInvoice.md b/docs/models/UpsInvoice.md index 1b3515a1..2113a97c 100644 --- a/docs/models/UpsInvoice.md +++ b/docs/models/UpsInvoice.md @@ -11,5 +11,3 @@ Name | Type | Description | Notes **InvoiceDate** | **DateTimeOffset** | invoice date | [optional] **InvoiceNumber** | **string** | invoice number | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpsPickupType.md b/docs/models/UpsPickupType.md index cee9e2d0..8d1c16ed 100644 --- a/docs/models/UpsPickupType.md +++ b/docs/models/UpsPickupType.md @@ -6,5 +6,3 @@ The possible ups pickup type values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/UpsSettingsResponseBody.md b/docs/models/UpsSettingsResponseBody.md index f35e57f5..90004596 100644 --- a/docs/models/UpsSettingsResponseBody.md +++ b/docs/models/UpsSettingsResponseBody.md @@ -18,5 +18,3 @@ Name | Type | Description | Notes **UseNegotiatedRates** | **bool** | The use negotiated rates | [optional] **UseOrderNumberOnMailInnovationsLabels** | **bool** | The use order number on mail innovations labels | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ValidateAddress.md b/docs/models/ValidateAddress.md index 50de9e85..653f2ea5 100644 --- a/docs/models/ValidateAddress.md +++ b/docs/models/ValidateAddress.md @@ -6,5 +6,3 @@ The possible validate address values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ValidateShipmentFields.md b/docs/models/ValidateShipmentFields.md index 595f0da3..30ef90aa 100644 --- a/docs/models/ValidateShipmentFields.md +++ b/docs/models/ValidateShipmentFields.md @@ -6,5 +6,3 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ValidateAddress** | **ValidateAddress** | | [optional] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/ValidationStatus.md b/docs/models/ValidationStatus.md index a0bf339b..e06a9572 100644 --- a/docs/models/ValidationStatus.md +++ b/docs/models/ValidationStatus.md @@ -6,5 +6,3 @@ The possible validation status values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/VoidLabelResponseBody.md b/docs/models/VoidLabelResponseBody.md index e9f5a9f3..5bb7dc09 100644 --- a/docs/models/VoidLabelResponseBody.md +++ b/docs/models/VoidLabelResponseBody.md @@ -9,5 +9,3 @@ Name | Type | Description | Notes **Message** | **string** | | [readonly] **ReasonCode** | **ReasonCode** | Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later. | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Warehouse.md b/docs/models/Warehouse.md index 4e6cd16b..d9a2f43d 100644 --- a/docs/models/Warehouse.md +++ b/docs/models/Warehouse.md @@ -12,5 +12,3 @@ Name | Type | Description | Notes **ReturnAddress** | [**Address**](Address.md) | The return address associated with the warehouse | [optional] **WarehouseId** | **string** | A string that uniquely identifies the warehouse | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Webhook.md b/docs/models/Webhook.md index 408dcf31..e9d40f5d 100644 --- a/docs/models/Webhook.md +++ b/docs/models/Webhook.md @@ -10,5 +10,3 @@ Name | Type | Description | Notes **Url** | **string** | The url that the webhook sends the request to | [optional] **WebhookId** | **string** | A string that uniquely identifies the webhook | [optional] [readonly] -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/WebhookEvent.md b/docs/models/WebhookEvent.md index db867e07..f37a9f4a 100644 --- a/docs/models/WebhookEvent.md +++ b/docs/models/WebhookEvent.md @@ -6,5 +6,3 @@ The possible webook event values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/WebhookHeader.md b/docs/models/WebhookHeader.md index a49ab549..1be43d38 100644 --- a/docs/models/WebhookHeader.md +++ b/docs/models/WebhookHeader.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Key** | **string** | Key/name of a header | **Value** | **string** | Value of a header | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/Weight.md b/docs/models/Weight.md index b69fa94d..bef119a3 100644 --- a/docs/models/Weight.md +++ b/docs/models/Weight.md @@ -8,5 +8,3 @@ Name | Type | Description | Notes **Unit** | **WeightUnit** | | **Value** | **decimal** | The weight, in the specified unit | -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/models/WeightUnit.md b/docs/models/WeightUnit.md index dce05419..83e78a3a 100644 --- a/docs/models/WeightUnit.md +++ b/docs/models/WeightUnit.md @@ -6,5 +6,3 @@ The possible weight unit values Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/generation/templates/README.solution.mustache b/generation/templates/README.solution.mustache index 7cfb5ae7..87038859 100644 --- a/generation/templates/README.solution.mustache +++ b/generation/templates/README.solution.mustache @@ -61,17 +61,6 @@ API | Method | Description {{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{baseName}}* | [**{{operationId}}**]({{apiDocPath}}/{{classname}}.md#{{operationIdLowerCase}}) | {{{summary}}} {{/operation}}{{/operations}}{{/apis}}{{/apiInfo}} - -## Models - -{{#modelPackage}} -{{#models}}{{#model}} - [{{{classname}}}]({{modelDocPath}}/{{{classname}}}.md) -{{/model}}{{/models}} -{{/modelPackage}} -{{^modelPackage}} -No model defined in this package -{{/modelPackage}} - ## Legacy Methods These methods have been deprecated in favor of the methods listed above, but are still in the SDK. diff --git a/generation/templates/api_doc.mustache b/generation/templates/api_doc.mustache index ae9377ba..8cc15665 100644 --- a/generation/templates/api_doc.mustache +++ b/generation/templates/api_doc.mustache @@ -73,7 +73,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. | | {{#allParams}} -| **{{paramName}}** | {{#isFile}}**{{dataType}}**{{/isFile}}{{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isFile}}[**{{dataType}}**]({{#isContainer}}{{baseType}}{{/isContainer}}{{^isContainer}}{{dataType}}{{/isContainer}}.md){{/isFile}}{{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#defaultValue}}[default to {{.}}]{{/defaultValue}} | +| **{{paramName}}** | {{#isFile}}**{{dataType}}**{{/isFile}}{{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isFile}}[**{{dataType}}**](../../{{modelDocPath}}/{{#isContainer}}{{baseType}}{{/isContainer}}{{^isContainer}}{{dataType}}{{/isContainer}}.md){{/isFile}}{{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#defaultValue}}[default to {{.}}]{{/defaultValue}} | {{/allParams}} | **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. | | @@ -81,7 +81,5 @@ namespace Example {{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{returnType}}**](../models/{{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}void (empty response body){{/returnType}} -[[Back to top]](#) [[Back to API list]](../{{#useGenericHost}}../{{/useGenericHost}}README.md#documentation-for-api-endpoints) [[Back to Model list]](../{{#useGenericHost}}../{{/useGenericHost}}README.md#documentation-for-models) [[Back to README]](../{{#useGenericHost}}../{{/useGenericHost}}README.md) - {{/operation}} {{/operations}} diff --git a/generation/templates/model_doc.mustache b/generation/templates/model_doc.mustache index 3c7f8b2d..63c38fd3 100644 --- a/generation/templates/model_doc.mustache +++ b/generation/templates/model_doc.mustache @@ -16,7 +16,5 @@ Name | Type | Description | Notes {{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}} {{/vars}} -[[Back to Model list]](../{{#useGenericHost}}../{{/useGenericHost}}README.md#documentation-for-models) [[Back to API list]](../{{#useGenericHost}}../{{/useGenericHost}}README.md#documentation-for-api-endpoints) [[Back to README]](../{{#useGenericHost}}../{{/useGenericHost}}README.md) - {{/model}} {{/models}} From 3c254e641f4fca80a8245a1bbc0077f511fded06 Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Wed, 5 Feb 2025 10:53:47 -0600 Subject: [PATCH 39/42] Update .NET version in README --- README.md | 4 ++-- generation/templates/README.solution.mustache | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 840c1958..61b7dbf2 100644 --- a/README.md +++ b/README.md @@ -172,7 +172,7 @@ To build the project locally on your computer: 1. **Clone this repo**
`git clone https://github.com/ShipEngine/shipengine-dotnet.git` -2. **Install [.NET 5.x](https://dotnet.microsoft.com/download)** +2. **Install [.NET 8.x](https://dotnet.microsoft.com/download)** 3. **Install dependencies**
`dotnet restore` @@ -186,7 +186,7 @@ To build the project locally on your computer: 6. **Run the tests**
`dotnet test`

By default, the test project targets all supported frameworks, if your environment only supports a subset then you can specify in the CLI.

- `dotnet test -f net5.0` + `dotnet test -f net8.0` ### Generating from OpenAPI diff --git a/generation/templates/README.solution.mustache b/generation/templates/README.solution.mustache index 87038859..82c2424c 100644 --- a/generation/templates/README.solution.mustache +++ b/generation/templates/README.solution.mustache @@ -87,7 +87,7 @@ To build the project locally on your computer: 1. **Clone this repo**
`git clone https://github.com/ShipEngine/shipengine-dotnet.git` -2. **Install [.NET 5.x](https://dotnet.microsoft.com/download)** +2. **Install [.NET 8.x](https://dotnet.microsoft.com/download)** 3. **Install dependencies**
`dotnet restore` @@ -101,7 +101,7 @@ To build the project locally on your computer: 6. **Run the tests**
`dotnet test`

By default, the test project targets all supported frameworks, if your environment only supports a subset then you can specify in the CLI.

- `dotnet test -f net5.0` + `dotnet test -f net8.0` ### Generating from OpenAPI From 160eab8900b56700ed639de816908924099ead98 Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Wed, 5 Feb 2025 10:59:37 -0600 Subject: [PATCH 40/42] Update supported .NET versions --- README.md | 5 +++-- generation/templates/README.solution.mustache | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 61b7dbf2..05833c50 100644 --- a/README.md +++ b/README.md @@ -43,8 +43,9 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap ## Frameworks supported -- .NET Core >=1.0 -- .NET Framework >=4.6 +- .NET Standard >=2.0 +- .NET Core >=2.0 +- .NET Framework >=4.6.2 ## Methods diff --git a/generation/templates/README.solution.mustache b/generation/templates/README.solution.mustache index 82c2424c..3dd0d480 100644 --- a/generation/templates/README.solution.mustache +++ b/generation/templates/README.solution.mustache @@ -49,8 +49,9 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap ## Frameworks supported {{#netStandard}} -- .NET Core >=1.0 -- .NET Framework >=4.6 +- .NET Standard >=2.0 +- .NET Core >=2.0 +- .NET Framework >=4.6.2 {{/netStandard}} From 6bb706f5fd90a24e9d426784e1f5acb75f89cb4b Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Wed, 5 Feb 2025 11:02:34 -0600 Subject: [PATCH 41/42] Formatting --- ShipEngineSDK/Enums/ErrorCode.cs | 2 +- ShipEngineSDK/PublicAPI.Unshipped.txt | 214 ++++---------------------- 2 files changed, 27 insertions(+), 189 deletions(-) diff --git a/ShipEngineSDK/Enums/ErrorCode.cs b/ShipEngineSDK/Enums/ErrorCode.cs index 6060009d..386ab59f 100644 --- a/ShipEngineSDK/Enums/ErrorCode.cs +++ b/ShipEngineSDK/Enums/ErrorCode.cs @@ -273,7 +273,7 @@ public enum ErrorCode /// [EnumMember(Value = "funding_source_error")] FundingSourceError, - + /// /// The attempted operation does not support multiple packages. /// diff --git a/ShipEngineSDK/PublicAPI.Unshipped.txt b/ShipEngineSDK/PublicAPI.Unshipped.txt index 843fbde3..ef285a19 100644 --- a/ShipEngineSDK/PublicAPI.Unshipped.txt +++ b/ShipEngineSDK/PublicAPI.Unshipped.txt @@ -2,8 +2,10 @@ abstract ShipEngineSDK.Model.AbstractOpenAPISchema.ActualInstance.set -> void abstract ShipEngineSDK.Model.AbstractOpenAPISchema.ToJson() -> string! const ShipEngineSDK.Client.ClientUtils.DateTimeFormat = "o" -> string! +const System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.RefStructs = "RefStructs" -> string! +const System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.RequiredMembers = "RequiredMembers" -> string! override ShipEngineSDK.DateJsonConverter.Read(ref System.Text.Json.Utf8JsonReader reader, System.Type! typeToConvert, System.Text.Json.JsonSerializerOptions! options) -> System.DateTime -override ShipEngineSDK.DateJsonConverter.Write(System.Text.Json.Utf8JsonWriter! writer, System.DateTime dateTimeValue, System.Text.Json.JsonSerializerOptions! options) -> void +override ShipEngineSDK.DateJsonConverter.Write(System.Text.Json.Utf8JsonWriter! writer, System.DateTime value, System.Text.Json.JsonSerializerOptions! options) -> void override ShipEngineSDK.Model.AccountSettings.ToString() -> string! override ShipEngineSDK.Model.AccountSettingsImages.ImageContentTypeEnum.ToString() -> string! override ShipEngineSDK.Model.AccountSettingsImages.ToString() -> string! @@ -388,6 +390,15 @@ ShipEngineSDK.Client.Multimap.this[TKey key].get -> System.Collect ShipEngineSDK.Client.Multimap.this[TKey key].set -> void ShipEngineSDK.Client.Multimap.TryGetValue(TKey key, out System.Collections.Generic.IList! value) -> bool ShipEngineSDK.Client.Multimap.Values.get -> System.Collections.Generic.ICollection!>! +ShipEngineSDK.Common.AdvancedShipmentOptions.CertificateNumber.get -> string? +ShipEngineSDK.Common.AdvancedShipmentOptions.CertificateNumber.set -> void +ShipEngineSDK.Common.AdvancedShipmentOptions.InvoiceNumber.get -> string? +ShipEngineSDK.Common.AdvancedShipmentOptions.InvoiceNumber.set -> void +ShipEngineSDK.Common.AdvancedShipmentOptions.LicenseNumber.get -> string? +ShipEngineSDK.Common.AdvancedShipmentOptions.LicenseNumber.set -> void +ShipEngineSDK.Common.Enums.InsuranceProvider.FundingSource = 4 -> ShipEngineSDK.Common.Enums.InsuranceProvider +ShipEngineSDK.Common.Enums.InsuranceProvider.ParcelGuard = 5 -> ShipEngineSDK.Common.Enums.InsuranceProvider +ShipEngineSDK.Common.Enums.TrackingStatusCode.SP = 7 -> ShipEngineSDK.Common.Enums.TrackingStatusCode ShipEngineSDK.Common.Error.ErrorCode.get -> ShipEngineSDK.Enums.ErrorCode ShipEngineSDK.Common.Error.ErrorSource.get -> ShipEngineSDK.Enums.ErrorSource ShipEngineSDK.Common.Error.ErrorType.get -> ShipEngineSDK.Enums.ErrorType @@ -445,6 +456,9 @@ ShipEngineSDK.Enums.ErrorType.BusinessRules = 3 -> ShipEngineSDK.Enums.ErrorType ShipEngineSDK.Enums.ErrorType.Security = 1 -> ShipEngineSDK.Enums.ErrorType ShipEngineSDK.Enums.ErrorType.System = 4 -> ShipEngineSDK.Enums.ErrorType ShipEngineSDK.Enums.ErrorType.Validation = 2 -> ShipEngineSDK.Enums.ErrorType +ShipEngineSDK.ErrorCode.MultipackageNotSupported = 41 -> ShipEngineSDK.ErrorCode +ShipEngineSDK.ErrorType.FundingSources = 6 -> ShipEngineSDK.ErrorType +ShipEngineSDK.ErrorType.Wallet = 5 -> ShipEngineSDK.ErrorType ShipEngineSDK.IShipEngine.AddFundsToCarrier(string! carrierId, ShipEngineSDK.Model.AddFundsToCarrierRequestBody! addFundsToCarrierRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.AddFundsToCarrier(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, ShipEngineSDK.Model.AddFundsToCarrierRequestBody! addFundsToCarrierRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.AddFundsToInsurance(ShipEngineSDK.Model.AddFundsToInsuranceRequestBody! addFundsToInsuranceRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! @@ -632,7 +646,7 @@ ShipEngineSDK.IShipEngine.ValidateAddress(System.Net.Http.HttpClient! methodClie ShipEngineSDK.IShipEngine.VoidLabel(string! labelId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.IShipEngine.VoidLabel(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! ShipEngineSDK.Model.AbstractOpenAPISchema -ShipEngineSDK.Model.AbstractOpenAPISchema.AbstractOpenAPISchema() -> void +ShipEngineSDK.Model.AbstractOpenAPISchema.AbstractOpenAPISchema(string! schemaType) -> void ShipEngineSDK.Model.AbstractOpenAPISchema.IsNullable.get -> bool ShipEngineSDK.Model.AbstractOpenAPISchema.IsNullable.set -> void ShipEngineSDK.Model.AbstractOpenAPISchema.SchemaType.get -> string! @@ -5120,192 +5134,11 @@ ShipEngineSDK.RequestOptions.Operation.set -> void ShipEngineSDK.RequestOptions.PathParameters.get -> System.Collections.Generic.Dictionary! ShipEngineSDK.RequestOptions.QueryParameters.get -> ShipEngineSDK.Client.Multimap! ShipEngineSDK.RequestOptions.RequestOptions(string! path) -> void -ShipEngineSDK.ShipEngine.AddFundsToCarrier(string! carrierId, ShipEngineSDK.Model.AddFundsToCarrierRequestBody! addFundsToCarrierRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.AddFundsToCarrier(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, ShipEngineSDK.Model.AddFundsToCarrierRequestBody! addFundsToCarrierRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.AddFundsToInsurance(ShipEngineSDK.Model.AddFundsToInsuranceRequestBody! addFundsToInsuranceRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.AddFundsToInsurance(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.AddFundsToInsuranceRequestBody! addFundsToInsuranceRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.AddToBatch(string! batchId, ShipEngineSDK.Model.AddToBatchRequestBody! addToBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.AddToBatch(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, ShipEngineSDK.Model.AddToBatchRequestBody! addToBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CalculateRates(ShipEngineSDK.Model.CalculateRatesRequestBody! calculateRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CalculateRates(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CalculateRatesRequestBody! calculateRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CancelShipments(string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CancelShipments(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CompareBulkRates(ShipEngineSDK.Model.CompareBulkRatesRequestBody! compareBulkRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! -ShipEngineSDK.ShipEngine.CompareBulkRates(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CompareBulkRatesRequestBody! compareBulkRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! -ShipEngineSDK.ShipEngine.ConnectCarrier(ShipEngineSDK.Model.CarrierName! carrierName, ShipEngineSDK.Model.ConnectCarrierRequestBody! connectCarrierRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ConnectCarrier(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierName! carrierName, ShipEngineSDK.Model.ConnectCarrierRequestBody! connectCarrierRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ConnectInsurer(ShipEngineSDK.Model.ConnectInsurerRequestBody! connectInsurerRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ConnectInsurer(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ConnectInsurerRequestBody! connectInsurerRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateAccountImage(ShipEngineSDK.Model.CreateAccountSettingsImageRequestBody! createAccountSettingsImageRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateAccountImage(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateAccountSettingsImageRequestBody! createAccountSettingsImageRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateBatch(ShipEngineSDK.Model.CreateBatchRequest! createBatchRequest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateBatch(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateBatchRequest! createBatchRequest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateLabel(ShipEngineSDK.Model.CreateLabelRequestBody! createLabelRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateLabel(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateLabelRequestBody! createLabelRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateLabelFromRate(string! rateId, ShipEngineSDK.Model.CreateLabelFromRateRequestBody! createLabelFromRateRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateLabelFromRate(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! rateId, ShipEngineSDK.Model.CreateLabelFromRateRequestBody! createLabelFromRateRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateLabelFromShipment(string! shipmentId, ShipEngineSDK.Model.CreateLabelFromShipmentRequestBody! createLabelFromShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateLabelFromShipment(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, ShipEngineSDK.Model.CreateLabelFromShipmentRequestBody! createLabelFromShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateManifest(ShipEngineSDK.Model.CreateManifestRequestBody! createManifestRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateManifest(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateManifestRequestBody! createManifestRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreatePackageType(ShipEngineSDK.Model.CreatePackageTypeRequestBody! createPackageTypeRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreatePackageType(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreatePackageTypeRequestBody! createPackageTypeRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateReturnLabel(string! labelId, ShipEngineSDK.Model.CreateReturnLabelRequestBody! createReturnLabelRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateReturnLabel(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelId, ShipEngineSDK.Model.CreateReturnLabelRequestBody! createReturnLabelRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateShipments(ShipEngineSDK.Model.CreateShipmentsRequestBody! createShipmentsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateShipments(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateShipmentsRequestBody! createShipmentsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateTag(string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateTag(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateWarehouse(ShipEngineSDK.Model.CreateWarehouseRequestBody! createWarehouseRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateWarehouse(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateWarehouseRequestBody! createWarehouseRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateWebhook(ShipEngineSDK.Model.CreateWebhookRequestBody! createWebhookRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.CreateWebhook(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CreateWebhookRequestBody! createWebhookRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeleteAccountImageById(string! labelImageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeleteAccountImageById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelImageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeleteBatch(string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeleteBatch(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeletePackageType(string! packageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeletePackageType(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! packageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeleteScheduledPickup(string! pickupId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeleteScheduledPickup(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! pickupId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeleteTag(string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeleteTag(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeleteWarehouse(string! warehouseId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeleteWarehouse(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! warehouseId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeleteWebhook(string! webhookId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DeleteWebhook(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! webhookId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DisconnectCarrier(ShipEngineSDK.Model.CarrierName! carrierName, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DisconnectCarrier(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierName! carrierName, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DisconnectCarrierById(string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DisconnectCarrierById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DisconnectInsurer(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DisconnectInsurer(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DownloadFile(string! subdir, string! filename, string! dir, string! download = null, int? rotation = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.DownloadFile(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! subdir, string! filename, string! dir, string! download = null, int? rotation = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.EstimateRates(ShipEngineSDK.Model.EstimateRatesRequestBody! estimateRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! -ShipEngineSDK.ShipEngine.EstimateRates(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.EstimateRatesRequestBody! estimateRatesRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! -ShipEngineSDK.ShipEngine.GetAccountSettingsImagesById(string! labelImageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetAccountSettingsImagesById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelImageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetBatchByExternalId(string! externalBatchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetBatchByExternalId(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! externalBatchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetBatchById(string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetBatchById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetCarrierById(string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetCarrierById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetCarrierOptions(string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetCarrierOptions(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetCarrierSettings(ShipEngineSDK.Model.CarrierNameWithSettings! carrierName, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetCarrierSettings(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierNameWithSettings! carrierName, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetInsuranceBalance(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetInsuranceBalance(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetLabelByExternalShipmentId(string! externalShipmentId, ShipEngineSDK.Model.LabelDownloadType? labelDownloadType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetLabelByExternalShipmentId(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! externalShipmentId, ShipEngineSDK.Model.LabelDownloadType? labelDownloadType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetLabelById(string! labelId, ShipEngineSDK.Model.LabelDownloadType? labelDownloadType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetLabelById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelId, ShipEngineSDK.Model.LabelDownloadType? labelDownloadType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetManifestById(string! manifestId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetManifestById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! manifestId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetManifestRequestById(string! manifestRequestId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetManifestRequestById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! manifestRequestId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetPackageTypeById(string! packageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetPackageTypeById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! packageId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetPickupById(string! pickupId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetPickupById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! pickupId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetRateById(string! rateId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetRateById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! rateId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetShipmentByExternalId(string! externalShipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetShipmentByExternalId(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! externalShipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetShipmentById(string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetShipmentById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetTrackingLog(string! carrierCode = null, string! trackingNumber = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetTrackingLog(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierCode = null, string! trackingNumber = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetTrackingLogFromLabel(string! labelId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetTrackingLogFromLabel(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetWarehouseById(string! warehouseId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetWarehouseById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! warehouseId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetWebhookById(string! webhookId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.GetWebhookById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! webhookId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListAccountImages(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListAccountImages(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListAccountSettings(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListAccountSettings(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListBatchErrors(string! batchId, int? page = null, int? pagesize = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListBatchErrors(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, int? page = null, int? pagesize = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListBatches(ShipEngineSDK.Model.BatchStatus? status = null, int? page = null, int? pageSize = null, ShipEngineSDK.Model.SortDir? sortDir = null, string! batchNumber = null, ShipEngineSDK.Model.BatchesSortBy? sortBy = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListBatches(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.BatchStatus? status = null, int? page = null, int? pageSize = null, ShipEngineSDK.Model.SortDir? sortDir = null, string! batchNumber = null, ShipEngineSDK.Model.BatchesSortBy? sortBy = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListCarrierPackageTypes(string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListCarrierPackageTypes(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListCarriers(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListCarriers(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListCarrierServices(string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListCarrierServices(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListLabels(ShipEngineSDK.Model.LabelStatus? labelStatus = null, string! serviceCode = null, string! carrierId = null, string! trackingNumber = null, string! batchId = null, string! rateId = null, string! shipmentId = null, string! warehouseId = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, int? page = null, int? pageSize = null, ShipEngineSDK.Model.SortDir? sortDir = null, string! sortBy = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListLabels(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.LabelStatus? labelStatus = null, string! serviceCode = null, string! carrierId = null, string! trackingNumber = null, string! batchId = null, string! rateId = null, string! shipmentId = null, string! warehouseId = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, int? page = null, int? pageSize = null, ShipEngineSDK.Model.SortDir? sortDir = null, string! sortBy = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListManifests(string! warehouseId = null, System.DateTime? shipDateStart = null, System.DateTime? shipDateEnd = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, string! carrierId = null, int? page = null, int? pageSize = null, System.Collections.Generic.List! labelIds = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListManifests(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! warehouseId = null, System.DateTime? shipDateStart = null, System.DateTime? shipDateEnd = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, string! carrierId = null, int? page = null, int? pageSize = null, System.Collections.Generic.List! labelIds = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListPackageTypes(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListPackageTypes(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListScheduledPickups(string! carrierId = null, string! warehouseId = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, int? page = null, int? pageSize = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListScheduledPickups(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierId = null, string! warehouseId = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, int? page = null, int? pageSize = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListShipmentRates(string! shipmentId, System.DateTime? createdAtStart = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListShipmentRates(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, System.DateTime? createdAtStart = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListShipments(ShipEngineSDK.Model.ShipmentStatus? shipmentStatus = null, string! batchId = null, string! tag = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, System.DateTime? modifiedAtStart = null, System.DateTime? modifiedAtEnd = null, int? page = null, int? pageSize = null, string! salesOrderId = null, ShipEngineSDK.Model.SortDir? sortDir = null, ShipEngineSDK.Model.ShipmentsSortBy? sortBy = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListShipments(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ShipmentStatus? shipmentStatus = null, string! batchId = null, string! tag = null, System.DateTime? createdAtStart = null, System.DateTime? createdAtEnd = null, System.DateTime? modifiedAtStart = null, System.DateTime? modifiedAtEnd = null, int? page = null, int? pageSize = null, string! salesOrderId = null, ShipEngineSDK.Model.SortDir? sortDir = null, ShipEngineSDK.Model.ShipmentsSortBy? sortBy = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListTags(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListTags(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListWarehouses(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListWarehouses(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ListWebhooks(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! -ShipEngineSDK.ShipEngine.ListWebhooks(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! -ShipEngineSDK.ShipEngine.ParseAddress(ShipEngineSDK.Model.ParseAddressRequestBody! parseAddressRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ParseAddress(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ParseAddressRequestBody! parseAddressRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ParseShipment(ShipEngineSDK.Model.ParseShipmentRequestBody! parseShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ParseShipment(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.ParseShipmentRequestBody! parseShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ProcessBatch(string! batchId, ShipEngineSDK.Model.ProcessBatchRequestBody! processBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ProcessBatch(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, ShipEngineSDK.Model.ProcessBatchRequestBody! processBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.RemoveFromBatch(string! batchId, ShipEngineSDK.Model.RemoveFromBatchRequestBody! removeFromBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.RemoveFromBatch(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, ShipEngineSDK.Model.RemoveFromBatchRequestBody! removeFromBatchRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.RenameTag(string! tagName, string! newTagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.RenameTag(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! tagName, string! newTagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.SchedulePickup(ShipEngineSDK.Model.SchedulePickupRequestBody! schedulePickupRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.SchedulePickup(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.SchedulePickupRequestBody! schedulePickupRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ServicePointsGetById(string! carrierCode, string! countryCode, string! servicePointId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ServicePointsGetById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierCode, string! countryCode, string! servicePointId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ServicePointsList(ShipEngineSDK.Model.GetServicePointsRequest! getServicePointsRequest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ServicePointsList(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.GetServicePointsRequest! getServicePointsRequest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ShipmentsListTags(string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ShipmentsListTags(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ShipmentsUpdateTags(ShipEngineSDK.Model.UpdateShipmentsTagsRequestBody! updateShipmentsTagsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ShipmentsUpdateTags(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.UpdateShipmentsTagsRequestBody! updateShipmentsTagsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.StartTracking(string! carrierCode = null, string! trackingNumber = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.StartTracking(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierCode = null, string! trackingNumber = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.StopTracking(string! carrierCode = null, string! trackingNumber = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.StopTracking(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! carrierCode = null, string! trackingNumber = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.TagShipment(string! shipmentId, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.TagShipment(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.TokensGetEphemeralToken(ShipEngineSDK.Model.Redirect? redirect = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.TokensGetEphemeralToken(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.Redirect? redirect = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UntagShipment(string! shipmentId, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UntagShipment(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, string! tagName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateAccountSettingsImagesById(string! labelImageId, ShipEngineSDK.Model.UpdateAccountSettingsImageRequestBody! updateAccountSettingsImageRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateAccountSettingsImagesById(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelImageId, ShipEngineSDK.Model.UpdateAccountSettingsImageRequestBody! updateAccountSettingsImageRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateBatch(string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateBatch(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! batchId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateCarrierSettings(ShipEngineSDK.Model.CarrierNameWithSettings! carrierName, string! carrierId, ShipEngineSDK.Model.UpdateCarrierSettingsRequestBody! updateCarrierSettingsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateCarrierSettings(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, ShipEngineSDK.Model.CarrierNameWithSettings! carrierName, string! carrierId, ShipEngineSDK.Model.UpdateCarrierSettingsRequestBody! updateCarrierSettingsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdatePackageType(string! packageId, ShipEngineSDK.Model.UpdatePackageTypeRequestBody! updatePackageTypeRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdatePackageType(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! packageId, ShipEngineSDK.Model.UpdatePackageTypeRequestBody! updatePackageTypeRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateShipment(string! shipmentId, ShipEngineSDK.Model.UpdateShipmentRequestBody! updateShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateShipment(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! shipmentId, ShipEngineSDK.Model.UpdateShipmentRequestBody! updateShipmentRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateWarehouse(string! warehouseId, ShipEngineSDK.Model.UpdateWarehouseRequestBody! updateWarehouseRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateWarehouse(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! warehouseId, ShipEngineSDK.Model.UpdateWarehouseRequestBody! updateWarehouseRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateWarehouseSettings(string! warehouseId, ShipEngineSDK.Model.UpdateWarehouseSettingsRequestBody! updateWarehouseSettingsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateWarehouseSettings(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! warehouseId, ShipEngineSDK.Model.UpdateWarehouseSettingsRequestBody! updateWarehouseSettingsRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateWebhook(string! webhookId, ShipEngineSDK.Model.UpdateWebhookRequestBody! updateWebhookRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.UpdateWebhook(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! webhookId, ShipEngineSDK.Model.UpdateWebhookRequestBody! updateWebhookRequestBody, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.ValidateAddress(System.Collections.Generic.List! addressToValidate, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! -ShipEngineSDK.ShipEngine.ValidateAddress(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, System.Collections.Generic.List! addressToValidate, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!>! -ShipEngineSDK.ShipEngine.VoidLabel(string! labelId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! -ShipEngineSDK.ShipEngine.VoidLabel(System.Net.Http.HttpClient! methodClient, ShipEngineSDK.Config! methodConfig, string! labelId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task! +ShipEngineSDK.ShipEngine.ModifyRequest(System.Action! modifyRequest) -> ShipEngineSDK.ShipEngine! +ShipEngineSDK.ShipEngine.ShipEngine(ShipEngineSDK.Config! config, System.Net.Http.HttpClient! httpClient) -> void +ShipEngineSDK.ShipEngine.WithRequestModifier(System.Action! modifier) -> ShipEngineSDK.ShipEngine! +ShipEngineSDK.ShipEngineClient.requestModifiers -> System.Collections.Generic.IEnumerable!>! +ShipEngineSDK.ShipEngineClient.ShipEngineClient(System.Collections.Generic.IEnumerable!>! requestModifiers) -> void ShipEngineSDK.ShipEngineException.ErrorCode.get -> ShipEngineSDK.Enums.ErrorCode ShipEngineSDK.ShipEngineException.ErrorSource.get -> ShipEngineSDK.Enums.ErrorSource ShipEngineSDK.ShipEngineException.ErrorType.get -> ShipEngineSDK.Enums.ErrorType @@ -5738,6 +5571,11 @@ static ShipEngineSDK.Model.WeightUnit.Gram.get -> ShipEngineSDK.Model.WeightUnit static ShipEngineSDK.Model.WeightUnit.Kilogram.get -> ShipEngineSDK.Model.WeightUnit! static ShipEngineSDK.Model.WeightUnit.Ounce.get -> ShipEngineSDK.Model.WeightUnit! static ShipEngineSDK.Model.WeightUnit.Pound.get -> ShipEngineSDK.Model.WeightUnit! +System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute +System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.CompilerFeatureRequiredAttribute(string! featureName) -> void +System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName.get -> string! +System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.IsOptional.get -> bool +System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.IsOptional.init -> void virtual ShipEngineSDK.Model.AccountSettings.ToJson(System.Text.Json.JsonSerializerOptions! options) -> string! virtual ShipEngineSDK.Model.AccountSettingsImages.ToJson(System.Text.Json.JsonSerializerOptions! options) -> string! virtual ShipEngineSDK.Model.AddFundsToCarrierRequestBody.ToJson(System.Text.Json.JsonSerializerOptions! options) -> string! From e9f28aebc18caa52c18332893ad99c445d3f8757 Mon Sep 17 00:00:00 2001 From: Andrew Benz Date: Wed, 5 Feb 2025 11:11:07 -0600 Subject: [PATCH 42/42] Remove dead code --- .github/workflows/ci-cd.yaml | 19 ------------------- .openapi-generator-ignore | 2 -- 2 files changed, 21 deletions(-) diff --git a/.github/workflows/ci-cd.yaml b/.github/workflows/ci-cd.yaml index 0a4acb2d..b3c8736d 100644 --- a/.github/workflows/ci-cd.yaml +++ b/.github/workflows/ci-cd.yaml @@ -75,25 +75,6 @@ jobs: ls -Rlh ShipEngineSDK.Test/TestResults/*/coverage.info cat ShipEngineSDK.Test/TestResults/*/coverage.info > ShipEngineSDK.Test/TestResults/lcov.info - # - name: Send code coverage results to Coveralls - # uses: coverallsapp/github-action@v1.1.0 - # with: - # github-token: ${{ secrets.GITHUB_TOKEN }} - # parallel: true - # flag-name: run-${{ matrix.test_number }} - # path-to-lcov: ShipEngineSDK.Test/TestResults/lcov.info - - # coverage: - # name: Code Coverage - # needs: dot_net_core_test - # runs-on: ubuntu-latest - # steps: - # - name: Coveralls Finished - # uses: coverallsapp/github-action@master - # with: - # github-token: ${{ secrets.github_token }} - # parallel-finished: true - nuget-deploy: runs-on: ubuntu-latest needs: [dot_net_framework_test, dot_net_core_test] diff --git a/.openapi-generator-ignore b/.openapi-generator-ignore index 648ec835..ba8fc96d 100644 --- a/.openapi-generator-ignore +++ b/.openapi-generator-ignore @@ -31,9 +31,7 @@ ShipEngineSDK/Client/*.cs ShipEngineSDK/Extensions/*.cs # We should re-enable these eventually -#README.md */README.md -#docs/**/* docs/scripts/* ShipEngineSDK.Test/*/*.cs api/**